Inheritance diagram for mfplugins::ELsyslog:

Classes
struct	Config

Public Types
using	Parameters = fhicl::WrappedTable< Config >

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)

void	setThreshold (ELseverityLevel sv)

virtual void	log (mf::ErrorObj &)

virtual void	finish ()

virtual void	summary ()

Protected Member Functions
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
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}

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)

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.

Member Enumeration Documentation

enum mf::service::ELdestination::flag_enum

inherited

Enumerator
NO_LINE_BREAKS
TIMESTAMP
MILLISECOND
MODULE
SUBROUTINE
TEXT
SOME_CONTEXT
SERIAL
FULL_CONTEXT
TIME_SEPARATE
EPILOGUE_SEPARATE
NFLAGS

Definition at line 26 of file ELdestination.h.

                    {
       NO_LINE_BREAKS,
       TIMESTAMP,
       MILLISECOND,
       MODULE,
       SUBROUTINE,
       TEXT,
       SOME_CONTEXT,
       SERIAL,
       FULL_CONTEXT,
       TIME_SEPARATE,
       EPILOGUE_SEPARATE,
       NFLAGS
     };

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 mf::service::ELdestination::emitToken	(	std::ostream &	os,
		std::string const &	s,
		bool	nl = `false`,
		bool	preambleMode = `false`
	)

protectedinherited

Definition at line 390 of file ELdestination.cc.

References mf::service::ELdestination::charsOnLine_, mf::service::ELdestination::format_, art::detail::indent(), and mf::service::ELdestination::MsgFormatSettings::lineLength.

Referenced by mf::service::ELostreamOutput::ELostreamOutput(), mf::service::ELdestination::fillPrefix(), mf::service::ELdestination::fillSuffix(), and mf::service::ELdestination::fillUsrMsg().

   {
     string const indent(6, ' ');
     if (s.empty()) {
       if (nl) {
         os << '\n';
         charsOnLine_ = 0UL;
       }
       return;
     }
     if (!preambleMode) {
       os << s;
       return;
     }
     char const first = s[0];
     char const second = (s.length() < 2) ? '\0' : s[1];
     char const last = (s.length() < 2) ? '\0' : s[s.length() - 1];
     char const last2 = (s.length() < 3) ? '\0' : s[s.length() - 2];
     // checking -2 because the very last char is sometimes a ' '
     // inserted by ErrorLog::operator<<
     // Accounts for newline @ the beginning of the string
     if (first == '\n' || (charsOnLine_ + s.length()) > format_.lineLength) {
       charsOnLine_ = 0UL;
       if (second != ' ') {
         os << ' ';
         ++charsOnLine_;
       }
       if (first == '\n') {
         os << s.substr(1);
       } else {
         os << s;
       }
     } else {
       os << s;
     }
     if ((last == '\n') || (last2 == '\n')) {
       os << indent;
       if (last != ' ') {
         os << ' ';
       }
       charsOnLine_ = indent.length() + 1UL;
     }
     if (nl) {
       os << '\n';
       charsOnLine_ = 0UL;
     } else {
       charsOnLine_ += s.length();
     }
   }

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

overrideprivatevirtual

Reimplemented from mf::service::ELdestination.

Definition at line 55 of file syslog_mfPlugin.cc.

References mf::service::ELdestination::format_, mf::GetIteration(), mf::ErrorObj::timestamp(), mf::service::ELdestination::MsgFormatSettings::timestamp(), and mf::ErrorObj::xid().

   {
     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.

76 {}

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

overrideprivatevirtual

Reimplemented from mf::service::ELdestination.

Definition at line 65 of file syslog_mfPlugin.cc.

References mf::service::ELdestination::fillUsrMsg().

   {
     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 mf::service::ELdestination::finish ( )

virtualinherited

Definition at line 703 of file ELdestination.cc.

704 {}

void mf::service::ELdestination::flush ( )

protectedvirtualinherited

Definition at line 715 of file ELdestination.cc.

References mf::ELwarning, and mf::service::ELdestination::log().

   {
     ErrorObj msg{ELwarning, "ELdestination"s};
     msg << "Call to unimplemented flush()!";
     log(msg);
   }

string mf::service::ELdestination::formSummary ( )

protectedinherited

Definition at line 576 of file ELdestination.cc.

References art::left(), n, mf::ELseverityLevel::nLevels, art::right(), and mf::service::ELdestination::statsMap_.

Referenced by mf::service::ELstatistics::summary(), and mf::service::ELdestination::summary().

   {
     ostringstream s;
     int n{};
     // -----  Summary part I:
     //
     bool ftnote{false};
     struct part3 {
       long n{}, t{};
     } p3[ELseverityLevel::nLevels];
     for (auto const& [xid, count] : statsMap_) {
       auto const& cat = xid.id();
       // -----  Emit new part I header, if needed:
       //
       if (n == 0) {
         s << "\n";
         s << " type     category        sev    module        subroutine      "
              "  count    total\n"
           << " ---- -------------------- -- ---------------- "
              "----------------  -----    -----\n";
       }
       // -----  Emit detailed message information:
       //
       s
         // Type
         << right << setw(5) << ++n
         << ' '
         // Category
         << left << setw(20) << cat.substr(0, 20)
         << ' '
         // Severity
         << left << setw(2) << xid.severity().getSymbol()
         << ' '
         // Module
         << left << setw(16) << xid.module().substr(0, 16)
         << ' '
         // Subroutine
         << left << setw(16)
         << xid.subroutine().substr(0, 16)
         // Count
         << right << setw(7) << count.n_ << left << setw(1)
         << (count.ignoredFlag_ ? '*' : ' ')
         // Total Count
         << right << setw(8) << count.aggregateN_ << '\n';
       ftnote = ftnote || count.ignoredFlag_;
       // -----  Obtain information for Part III, below:
       //
       p3[xid.severity().getLevel()].n += count.n_;
       p3[xid.severity().getLevel()].t += count.aggregateN_;
     }
     // -----  Provide footnote to part I, if needed:
     //
     if (ftnote) {
       s << "\n* Some occurrences of this message were suppressed in all "
            "logs, due to limits.\n";
     }
     // -----  Summary part II:
     //
     n = 0;
     for (auto const& pr : statsMap_) {
       auto const& xid = pr.first;
       auto const& count = pr.second;
       string const& cat = xid.id();
       if (n == 0) {
         s << '\n'
           << " type    category    Examples: run/evt        run/evt          "
              "run/evt\n"
           << " ---- -------------------- ---------------- ---------------- "
              "----------------\n";
       }
       s
         // Type
         << right << setw(5) << ++n
         << ' '
         // Category
         << left << setw(20) << cat
         << ' '
         // Context1
         << left << setw(16) << count.context1_.c_str()
         << ' '
         // Context2
         << left << setw(16) << count.context2_.c_str()
         << ' '
         // ContextLast
         << count.contextLast_ << '\n';
     }
     // -----  Summary part III:
     //
     s << '\n'
       << "Severity    # Occurrences   Total Occurrences\n"
       << "--------    -------------   -----------------\n";
     for (int k = 0; k < ELseverityLevel::nLevels; ++k) {
       if (p3[k].n != 0 || p3[k].t != 0) {
         s
           // Severity
           << left << setw(8)
           << ELseverityLevel{ELseverityLevel::ELsev_(k)}.getName().c_str()
           // Occurrences
           << right << setw(17)
           << p3[k].n
           // Total Occurrences
           << right << setw(20) << p3[k].t << '\n';
       }
     }
     return s.str();
   }

void mf::service::ELdestination::log ( mf::ErrorObj & msg )

virtualinherited

Reimplemented in mf::service::ELstatistics.

Definition at line 547 of file ELdestination.cc.

Referenced by mf::service::ELdestination::flush().

   {
     if (msg.xid().severity() < threshold_) {
       if (outputStatistics_) {
         statsMap_[msg.xid()].add(summarizeContext(msg.context()), false);
         updatedStats_ = true;
       }
       return;
     }
     if (skipMsg(msg.xid())) {
       if (outputStatistics_) {
         statsMap_[msg.xid()].add(summarizeContext(msg.context()), false);
         updatedStats_ = true;
       }
       return;
     }
     msg.setReactedTo(true);
     ostringstream payload;
     fillPrefix(payload, msg);
     fillUsrMsg(payload, msg);
     fillSuffix(payload, msg);
     routePayload(payload, msg);
     if (outputStatistics_) {
       statsMap_[msg.xid()].add(summarizeContext(msg.context()), true);
       updatedStats_ = true;
     }
   }

void mf::service::ELdestination::resetLimiters ( )

protectedinherited

Definition at line 819 of file ELdestination.cc.

References mf::service::ELdestination::xidLimiters_.

Referenced by mf::service::ELstatistics::summary(), and mf::service::ELdestination::summary().

   {
     xidLimiters_.clear();
   }

void mf::service::ELdestination::resetMsgCounters ( )

protectedinherited

Definition at line 813 of file ELdestination.cc.

References mf::service::ELdestination::statsMap_.

Referenced by mf::service::ELstatistics::summary(), and mf::service::ELdestination::summary().

   {
     statsMap_.clear();
   }

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.

References mf::ELextendedID::severity(), syslogLevel(), and mf::ErrorObj::xid().

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

void mf::service::ELdestination::setThreshold ( ELseverityLevel sv )

inherited

Definition at line 709 of file ELdestination.cc.

References mf::service::ELdestination::threshold_.

   {
     threshold_ = sv;
   }

bool mf::service::ELdestination::skipMsg ( ELextendedID const & xid )

protectedinherited

Definition at line 726 of file ELdestination.cc.

Referenced by mf::service::ELstatistics::log(), and mf::service::ELdestination::log().

   {
     auto xl_iter = xidLimiters_.find(xid);
     if (xl_iter == xidLimiters_.end()) {
       // Need to create and initialize a limiter for this xid.
       int limit{defaultLimit_};
       int reportEvery{defaultReportEvery_};
       int timespan{defaultTimespan_};
       // Does the category of this xid have explicit limits?
       auto cp_iter = categoryParams_.find(xid.id());
       if (cp_iter != categoryParams_.end()) {
         // Category limits found, use them.
         auto const& cp = cp_iter->second;
         limit = (cp.limit_ < 0) ? defaultLimit_ : cp.limit_;
         reportEvery =
           (cp.reportEvery_ < 0) ? defaultReportEvery_ : cp.reportEvery_;
         timespan = (cp.timespan_ < 0) ? defaultTimespan_ : cp.timespan_;
       }
       XidLimiter& limiter = xidLimiters_[xid];
       limiter.previousTimestamp_ = time(0);
       limiter.msgCount_ = 0;
       limiter.skippedMsgCount_ =
         reportEvery - 1; // So that the FIRST of the prescaled messages emerges
       limiter.limit_ = limit;
       limiter.reportEvery_ = reportEvery;
       limiter.timespan_ = timespan;
       xl_iter = xidLimiters_.find(xid);
     }
     XidLimiter& limiter = xl_iter->second;
     time_t now = time(0);
     // Has it been so long that we should restart counting toward the limit?
     if ((limiter.timespan_ >= 0) &&
         (difftime(now, limiter.previousTimestamp_) >= limiter.timespan_)) {
       limiter.msgCount_ = 0;
       if (limiter.reportEvery_ > 0) {
         // So this message will be reacted to
         limiter.skippedMsgCount_ = limiter.reportEvery_ - 1;
       } else {
         limiter.skippedMsgCount_ = 0;
       }
     }
     limiter.previousTimestamp_ = now;
     ++limiter.msgCount_;
     ++limiter.skippedMsgCount_;
     if (limiter.skippedMsgCount_ < limiter.reportEvery_) {
       // Skip message.
       return true;
     }
     if (limiter.limit_ == 0) {
       // Zero limit - never react to this
       // Skip message.
       return true;
     }
     if ((limiter.limit_ < 0) || (limiter.msgCount_ <= limiter.limit_)) {
       limiter.skippedMsgCount_ = 0;
       // Accept message.
       return false;
     }
     // Now we are over the limit - have we exceeded limit by 2^N * limit?
     long diff = limiter.msgCount_ - limiter.limit_;
     long r = diff / limiter.limit_;
     if (r * limiter.limit_ != diff) {
       // Not a multiple of limit - don't react
       // Skip message.
       return true;
     }
     if (r == 1) {
       // Exactly twice limit - react
       limiter.skippedMsgCount_ = 0;
       // Accept message.
       return false;
     }
     while (r > 1) {
       if ((r & 1) != 0) {
         // Not 2**msgCount_ times limit - don't react
         // Skip message.
         return true;
       }
       r >>= 1;
     }
     // If you never get an odd number till one, r is 2**msgCount_ so react
     limiter.skippedMsgCount_ = 0;
     // Accept message.
     return false;
   }

string mf::service::ELdestination::summarizeContext ( std::string const & )

protectedinherited

Definition at line 360 of file ELdestination.cc.

Referenced by mf::service::ELstatistics::log(), and mf::service::ELdestination::log().

   {
     if (c.substr(0, 4) != "Run:") {
       return c;
     }
     istringstream is(c);
     string runWord;
     int run;
     is >> runWord >> run;
     if (!is) {
       return c;
     }
     if (runWord != "Run:") {
       return c;
     }
     string eventWord;
     int event;
     is >> eventWord >> event;
     if (!is) {
       return c;
     }
     if (eventWord != "Event:") {
       return c;
     }
     ostringstream os;
     os << run << "/" << event;
     return os.str();
   }

void mf::service::ELdestination::summary ( )

virtualinherited

Reimplemented in mf::service::ELstatistics.

Definition at line 686 of file ELdestination.cc.

References mf::ELzeroSeverity, mf::service::ELdestination::formSummary(), mf::service::ELdestination::outputStatistics_, mf::service::ELdestination::reset_, mf::service::ELdestination::resetLimiters(), mf::service::ELdestination::resetMsgCounters(), mf::service::ELdestination::routePayload(), and mf::service::ELdestination::updatedStats_.

   {
     if (outputStatistics_ && updatedStats_) {
       ostringstream payload;
       payload << "\n=============================================\n\n"
               << "MessageLogger Summary\n"
               << formSummary();
       routePayload(payload, ErrorObj{ELzeroSeverity, "No ostream"s});
     }
     updatedStats_ = false;
     if (reset_) {
       resetMsgCounters();
       resetLimiters();
     }
   }

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

private

Definition at line 86 of file syslog_mfPlugin.cc.

References mf::ELseverityLevel::ELsev_error, mf::ELseverityLevel::ELsev_info, mf::ELseverityLevel::ELsev_severe, mf::ELseverityLevel::ELsev_success, mf::ELseverityLevel::ELsev_warning, mf::ELseverityLevel::getLevel(), and mf::errors::LogicError.

Referenced by routePayload().

   {
     //  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;
   }