mfplugins::ELsyslog Class Reference

Inheritance diagram for mfplugins::ELsyslog:

Classes
struct	Config

Public Types
using	Parameters = fhicl::WrappedTable< Config >
Public Types inherited from mf::service::ELdestination
enum	flag_enum {   NO_LINE_BREAKS, TIMESTAMP, MILLISECOND, MODULE,   SUBROUTINE, TEXT, SOME_CONTEXT, SERIAL,   FULL_CONTEXT, TIME_SEPARATE, EPILOGUE_SEPARATE, NFLAGS }

Public Member Functions
	ELsyslog (Parameters const &pset)
Public Member Functions inherited from mf::service::ELdestination
virtual	~ELdestination () noexcept=default
	ELdestination (Config const &)
	ELdestination (ELdestination const &)=delete
	ELdestination (ELdestination &&)=delete
ELdestination &	operator= (ELdestination const &)=delete
ELdestination &	operator= (ELdestination &&)=delete
void	setThreshold (ELseverityLevel sv)
virtual void	log (mf::ErrorObj &)
virtual void	finish ()
virtual void	summary ()

Private Member Functions
void	fillPrefix (ostringstream &, ErrorObj const &) override
void	fillUsrMsg (ostringstream &, ErrorObj const &) override
void	fillSuffix (ostringstream &, ErrorObj const &) override
void	routePayload (ostringstream const &, ErrorObj const &) override
int	syslogLevel (ELseverityLevel)

Additional Inherited Members
Protected Member Functions inherited from mf::service::ELdestination
std::string	summarizeContext (std::string const &)
void	emitToken (std::ostream &os, std::string const &s, bool nl=false, bool preambleMode=false)
std::string	formSummary ()
bool	skipMsg (ELextendedID const &)
void	resetLimiters ()
void	resetMsgCounters ()
virtual void	flush ()
Protected Attributes inherited from mf::service::ELdestination
ELseverityLevel	threshold_
MsgFormatSettings	format_
int	defaultLimit_
int	defaultReportEvery_
int	defaultTimespan_
std::map< std::string const, CategoryParams >	categoryParams_
std::map< ELextendedID const, XidLimiter >	xidLimiters_
std::map< ELextendedID const, StatsCount >	statsMap_
bool	outputStatistics_ {false}
bool	updatedStats_ {false}
bool	reset_ {false}

Detailed Description

Definition at line 28 of file syslog_mfPlugin.cc.

Member Typedef Documentation

using mfplugins::ELsyslog::Parameters = fhicl::WrappedTable<Config>

Definition at line 35 of file syslog_mfPlugin.cc.

Constructor & Destructor Documentation

mfplugins::ELsyslog::ELsyslog

(

Parameters const &

pset

)

Definition at line 48 of file syslog_mfPlugin.cc.

    : ELdestination{pset().elDestConfig()}
  {
    openlog("MF", 0, LOG_LOCAL0);
  }

Member Function Documentation

void mfplugins::ELsyslog::fillPrefix ( ostringstream &  oss, ErrorObj const &  msg  )

overrideprivatevirtual

Reimplemented from mf::service::ELdestination.

Definition at line 55 of file syslog_mfPlugin.cc.

  {
    auto const& xid = msg.xid();
    oss << format_.timestamp(msg.timestamp()) << '|' << xid.hostname() << '|'
        << xid.hostaddr() << '|' << xid.severity().getName() << '|' << xid.id()
        << '|' << xid.application() << '|' << xid.pid() << '|'
        << mf::GetIteration() << '|' << xid.module() << '|';
  }

void mfplugins::ELsyslog::fillSuffix ( ostringstream &  , ErrorObj const &    )

overrideprivatevirtual

Reimplemented from mf::service::ELdestination.

Definition at line 75 of file syslog_mfPlugin.cc.

  {}

void mfplugins::ELsyslog::fillUsrMsg ( ostringstream &  oss, ErrorObj const &  msg  )

overrideprivatevirtual

Reimplemented from mf::service::ELdestination.

Definition at line 65 of file syslog_mfPlugin.cc.

  {
    ostringstream buf;
    ELdestination::fillUsrMsg(buf, msg);
    string const& usrMsg =
      !buf.str().compare(0, 1, "\n") ? buf.str().erase(0, 1) : buf.str();
    oss << usrMsg;
  }

void mfplugins::ELsyslog::routePayload ( ostringstream const &  oss, ErrorObj const &  msg  )

overrideprivatevirtual

Reimplemented from mf::service::ELdestination.

Definition at line 79 of file syslog_mfPlugin.cc.

  {
    int const severity = syslogLevel(msg.xid().severity());
    syslog(severity, "%s", oss.str().data());
  }

int mfplugins::ELsyslog::syslogLevel ( ELseverityLevel  severity )

private

Definition at line 86 of file syslog_mfPlugin.cc.

  {
    //  Following syslog levels not used:
    //     LOG_EMERG  ; //0
    //     LOG_ALERT  ; //1
    //     LOG_NOTICE ; //5
    switch (severity.getLevel()) { // Used by:
    case ELseverityLevel::ELsev_severe:
      return LOG_CRIT; // LogAbsolute, LogSystem
    case ELseverityLevel::ELsev_error:
      return LOG_ERR; // LogError, LogProblem
    case ELseverityLevel::ELsev_warning:
      return LOG_WARNING; // LogPrint, LogWarning
    case ELseverityLevel::ELsev_info:
      return LOG_INFO; // LogInfo, LogVerbatim
    case ELseverityLevel::ELsev_success:
      return LOG_DEBUG; // LogDebug, LogTrace
    default:
      throw mf::Exception(mf::errors::LogicError)
        << "ELseverityLevel: " << severity
        << " not currently supported for syslog destination\n";
    }
    return -1;
  }

---

The documentation for this class was generated from the following file:

• messagefacility/messagefacility/plugins/syslog_mfPlugin.cc