edm::service::ELstatistics Class Reference

#include <ELstatistics.h>

Inheritance diagram for edm::service::ELstatistics:

Public Member Functions
	ELstatistics ()
	ELstatistics (std::ostream &osp)
	ELstatistics (int spaceLimit)
	ELstatistics (int spaceLimit, std::ostream &osp)
	ELstatistics (const ELstatistics &orig)
bool	log (const edm::ErrorObj &msg) override
void	noTerminationSummary ()
ELstatistics &	operator= (const ELstatistics &orig)=delete
void	summary (unsigned long overfullWaitCount)
void	summaryForJobReport (std::map< std::string, double > &sm)
void	wipe () override
	~ELstatistics () override
Public Member Functions inherited from edm::service::ELdestination
virtual void	attachEpilogue ()
virtual void	attachTime ()
virtual void	changeFile (std::ostream &os)
virtual void	changeFile (const std::string &filename)
	ELdestination ()
	ELdestination (const ELdestination &orig)=delete
virtual void	excludeModule (std::string const &moduleName)
virtual void	filterModule (std::string const &moduleName)
virtual void	finish ()
virtual void	flush ()
virtual int	getLineLength () const
virtual std::string	getNewline () const
virtual void	ignoreModule (std::string const &moduleName)
virtual void	includeContext ()
virtual void	includeModule ()
virtual void	includeSerial ()
virtual void	includeSubroutine ()
virtual void	includeText ()
virtual void	includeTime ()
ELdestination &	operator= (const ELdestination &orig)=delete
virtual void	respondToModule (std::string const &moduleName)
virtual void	separateEpilogue ()
virtual void	separateTime ()
void	setInterval (const std::string &s, int interval)
void	setInterval (const messagelogger::ELseverityLevel &sv, int interval)
void	setLimit (const std::string &s, int n)
void	setLimit (const messagelogger::ELseverityLevel &sv, int n)
virtual int	setLineLength (int len)
virtual void	setTableLimit (int n)
void	setThreshold (const messagelogger::ELseverityLevel &sv)
void	setTimespan (const std::string &s, int n)
void	setTimespan (const messagelogger::ELseverityLevel &sv, int n)
void	setTraceThreshold (const messagelogger::ELseverityLevel &sv)
virtual void	suppressContext ()
virtual void	suppressModule ()
virtual void	suppressSerial ()
virtual void	suppressSubroutine ()
virtual void	suppressText ()
virtual void	suppressTime ()
virtual bool	thisShouldBeIgnored (std::string const &s) const
virtual void	useContext ()
virtual void	useFullContext ()
virtual	~ELdestination ()

Static Public Member Functions
static void	noteGroupedCategory (std::string const &cat)

Protected Member Functions
void	clearSummary ()
std::map< ELextendedID, StatsCount >	statisticsMap () const
void	zero () override

Static Protected Member Functions
static std::string	formSummary (ELmap_stats &stats)

Protected Attributes
bool	printAtTermination
ELmap_stats	stats
int	tableLimit
std::ostream &	termStream
bool	updatedStats
Protected Attributes inherited from edm::service::ELdestination
bool	ignoreMostModules
std::unordered_set< std::string >	ignoreThese
std::string	indent
ELlimitsTable	limits
int	lineLength
std::string	newline
std::string	preamble
bool	respondToMostModules
std::unordered_set< std::string >	respondToThese
messagelogger::ELseverityLevel	threshold
messagelogger::ELseverityLevel	traceThreshold

Static Protected Attributes
static std::set< std::string >	groupedCategories
Static Protected Attributes inherited from edm::service::ELdestination
static const int	defaultLineLength = 80

Private Member Functions
std::string	dualLogName (std::string const &s)
void	summary (std::ostream &os, std::string_view title)

Friends
class	ELadministrator

Detailed Description

Definition at line 49 of file ELstatistics.h.

Constructor & Destructor Documentation

ELstatistics() [1/5]

edm::service::ELstatistics::ELstatistics

(

)

Definition at line 75 of file ELstatistics.cc.

References DMR_cfg::cerr.

        : ELdestination(),
          tableLimit(-1),
          stats(),
          updatedStats(false),
          termStream(std::cerr),
          printAtTermination(true) {
#ifdef ELstatisticsCONSTRUCTOR_TRACE
      std::cerr << "Constructor for ELstatistics()\n";
#endif

    }  // ELstatistics()

ELstatistics() [2/5]

edm::service::ELstatistics::ELstatistics

(

std::ostream &

osp

)

Definition at line 88 of file ELstatistics.cc.

References DMR_cfg::cerr.

        : ELdestination(), tableLimit(-1), stats(), updatedStats(false), termStream(osp), printAtTermination(true) {
#ifdef ELstatisticsCONSTRUCTOR_TRACE
      std::cerr << "Constructor for ELstatistics(osp)\n";
#endif

    }  // ELstatistics()

ELstatistics() [3/5]

edm::service::ELstatistics::ELstatistics

(

int

spaceLimit

)

Definition at line 96 of file ELstatistics.cc.

References DMR_cfg::cerr.

        : ELdestination(),
          tableLimit(spaceLimit),
          stats(),
          updatedStats(false),
          termStream(std::cerr),
          printAtTermination(true) {
#ifdef ELstatisticsCONSTRUCTOR_TRACE
      std::cerr << "Constructor for ELstatistics(spaceLimit)\n";
#endif

    }  // ELstatistics()

ELstatistics() [4/5]

edm::service::ELstatistics::ELstatistics	(	int	spaceLimit,
		std::ostream &	osp
	)

Definition at line 109 of file ELstatistics.cc.

References DMR_cfg::cerr.

        : ELdestination(),
          tableLimit(spaceLimit),
          stats(),
          updatedStats(false),
          termStream(osp),
          printAtTermination(true) {
#ifdef ELstatisticsCONSTRUCTOR_TRACE
      std::cerr << "Constructor for ELstatistics(spaceLimit,osp)\n";
#endif

    }  // ELstatistics()

ELstatistics() [5/5]

edm::service::ELstatistics::ELstatistics

(

const ELstatistics &

orig

)

Definition at line 122 of file ELstatistics.cc.

References DMR_cfg::cerr, edm::service::ELdestination::ignoreMostModules, edm::service::ELdestination::ignoreThese, edm::service::ELdestination::respondToMostModules, and edm::service::ELdestination::respondToThese.

        : ELdestination(),
          tableLimit(orig.tableLimit),
          stats(orig.stats),
          updatedStats(orig.updatedStats),
          termStream(orig.termStream),
          printAtTermination(orig.printAtTermination) {
#ifdef ELstatisticsCONSTRUCTOR_TRACE
      std::cerr << "Copy constructor for ELstatistics()\n";
#endif

      ignoreMostModules = orig.ignoreMostModules;
      respondToThese = orig.respondToThese;
      respondToMostModules = orig.respondToMostModules;
      ignoreThese = orig.ignoreThese;

    }  // ELstatistics()

~ELstatistics()

edm::service::ELstatistics::~ELstatistics ( )

override

Definition at line 140 of file ELstatistics.cc.

References DMR_cfg::cerr, printAtTermination, summary(), termStream, and updatedStats.

                                {
#ifdef ELstatisticsCONSTRUCTOR_TRACE
      std::cerr << "Destructor for ELstatistics\n";
#endif

      if (updatedStats && printAtTermination)
        summary(termStream, "Termination Summary");

    }  // ~ELstatistics()

Member Function Documentation

clearSummary()

void edm::service::ELstatistics::clearSummary ( )

protected

Definition at line 199 of file ELstatistics.cc.

References edm::service::ELdestination::limits, alignCSCRings::s, stats, and edm::service::ELlimitsTable::zero().

                                    {
      limits.zero();
      ELmap_stats::iterator s;
      for (s = stats.begin(); s != stats.end(); ++s) {
        (*s).second.n = 0;
        (*s).second.context1 = (*s).second.context2 = (*s).second.contextLast = "";
      }

    }  // clearSummary()

dualLogName()

std::string edm::service::ELstatistics::dualLogName ( std::string const &  s )

private

Definition at line 468 of file ELstatistics.cc.

References alignCSCRings::s.

Referenced by summaryForJobReport().

                                                          {
      if (s == "LogDebug")
        return "LogDebug_LogTrace";
      if (s == "LogInfo")
        return "LogInfo_LogVerbatim";
      if (s == "LogWarning")
        return "LogWarnng_LogPrint";
      if (s == "LogError")
        return "LogError_LogProblem";
      if (s == "LogSystem")
        return "LogSystem_LogAbsolute";
      return "UnusedSeverity";
    }

formSummary()

std::string edm::service::ELstatistics::formSummary ( ELmap_stats &  stats )

staticprotected

Definition at line 217 of file ELstatistics.cc.

References eostools::cat(), g, edm::messagelogger::ELseverityLevel::getLevel(), edm::ELseverityLevel::getName(), groupedCategories, mps_fire::i, dqmdumpme::k, dttmaxenums::L, dqmiodumpmetadata::n, edm::ELseverityLevel::nLevels, chargedHadronTrackResolutionFilter_cfi::p3, alignCSCRings::s, edm::ELextendedID::severity, interestingDetIdCollectionProducer_cfi::severityLevel, stats, AlCaHLTBitMon_QueryRunRegistry::string, and submitPVValidationJobs::t.

Referenced by summary().

                                                          {
      // Major changes 8/16/07 mf, including making this
      // a static member function instead of a free function

      using std::ios; /* _base ? */
      using std::left;
      using std::right;
      using std::setw;

      std::ostringstream s;
      int n = 0;

      // -----  Summary part I:
      //
      bool ftnote(false);

      struct part3 {
        long n, t;
        part3() : n(0L), t(0L) { ; }
      } p3[ELseverityLevel::nLevels];

      std::set<std::string>::iterator gcEnd = groupedCategories.end();
      std::set<std::string> gCats = groupedCategories;  // TEMP FOR DEBUGGING SANITY
      for (ELmap_stats::const_iterator i = stats.begin(); i != stats.end(); ++i) {
        // If this is a grouped category, wait till later to output its stats
        std::string cat = (*i).first.id;
        if (groupedCategories.find(cat) != gcEnd) {  // 8/16/07 mf
          continue;                                  // We will process these categories later
        }

        // -----  Emit new process and 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 << right << std::setw(5) << ++n << ' ' << left << std::setw(20) << (*i).first.id.substr(0, 20) << ' ' << left
          << std::setw(2) << (*i).first.severity.getSymbol() << ' ' << left << std::setw(16)
          << (*i).first.module.substr(0, 16) << ' ' << left << std::setw(16) << (*i).first.subroutine.substr(0, 16)
          << right << std::setw(7) << (*i).second.n << left << std::setw(1) << ((*i).second.ignoredFlag ? '*' : ' ')
          << right << std::setw(8) << (*i).second.aggregateN << '\n';
        ftnote = ftnote || (*i).second.ignoredFlag;

        // -----  Obtain information for Part III, below:
        //
        ELextendedID xid = (*i).first;
        p3[xid.severity.getLevel()].n += (*i).second.n;
        p3[xid.severity.getLevel()].t += (*i).second.aggregateN;
      }  // for i

      // ----- Part Ia:  The grouped categories
      for (std::set<std::string>::iterator g = groupedCategories.begin(); g != gcEnd; ++g) {
        int groupTotal = 0;
        int groupAggregateN = 0;
        ELseverityLevel severityLevel;
        bool groupIgnored = true;
        for (ELmap_stats::const_iterator i = stats.begin(); i != stats.end(); ++i) {
          if ((*i).first.id == *g) {
            if (groupTotal == 0)
              severityLevel = (*i).first.severity;
            groupIgnored &= (*i).second.ignoredFlag;
            groupAggregateN += (*i).second.aggregateN;
            ++groupTotal;
          }
        }  // for i
        if (groupTotal > 0) {
          // -----  Emit detailed message information:
          //
          s << right << std::setw(5) << ++n << ' ' << left << std::setw(20) << (*g).substr(0, 20) << ' ' << left
            << std::setw(2) << severityLevel.getSymbol() << ' ' << left << std::setw(16) << "  <Any Module>  " << ' '
            << left << std::setw(16) << "<Any Function>" << right << std::setw(7) << groupTotal << left << std::setw(1)
            << (groupIgnored ? '*' : ' ') << right << std::setw(8) << groupAggregateN << '\n';
          ftnote = ftnote || groupIgnored;

          // -----  Obtain information for Part III, below:
          //
          int lev = severityLevel.getLevel();
          p3[lev].n += groupTotal;
          p3[lev].t += groupAggregateN;
        }  // end if groupTotal>0
      }    // for g

      // -----  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 (ELmap_stats::const_iterator i = stats.begin(); i != stats.end(); ++i) {
        std::string cat = (*i).first.id;
        if (groupedCategories.find(cat) != gcEnd) {  // 8/16/07 mf
          continue;                                  // We will process these categories later
        }
        if (n == 0) {
          s << '\n'
            << " type    category    Examples: "
               "run/evt        run/evt          run/evt\n"
            << " ---- -------------------- ----"
               "------------ ---------------- ----------------\n";
        }
        s << right << std::setw(5) << ++n << ' ' << left << std::setw(20) << (*i).first.id.c_str() << ' ' << left
          << std::setw(16) << (*i).second.context1.c_str() << ' ' << left << std::setw(16)
          << (*i).second.context2.c_str() << ' ' << (*i).second.contextLast.c_str() << '\n';
      }  // for

      // -----  Summary part III:
      //
      s << "\nSeverity    # Occurrences   Total Occurrences\n"
        << "--------    -------------   -----------------\n";
      for (int k = 0; k < ELseverityLevel::nLevels; ++k) {
        if (p3[k].n != 0 || p3[k].t != 0) {
          s << left << std::setw(8) << ELseverityLevel(ELseverityLevel::ELsev_(k)).getName().c_str() << right
            << std::setw(17) << p3[k].n << right << std::setw(20) << p3[k].t << '\n';
        }
      }  // for

      return s.str();

    }  // formSummary()

log()

bool edm::service::ELstatistics::log ( const edm::ErrorObj &  msg )

overridevirtual

Reimplemented from edm::service::ELdestination.

Definition at line 154 of file ELstatistics.cc.

References DMR_cfg::cerr, mps_check::msg, alignCSCRings::s, stats, tableLimit, edm::service::ELdestination::thisShouldBeIgnored(), edm::service::ELdestination::threshold, and updatedStats.

                                                 {
#ifdef ELstatsLOG_TRACE
      std::cerr << "  =:=:=: Log to an ELstatistics\n";
#endif

      // See if this message is to be counted.

      if (msg.xid().severity < threshold)
        return false;
      if (thisShouldBeIgnored(msg.xid().module))
        return false;

      // Account for this message, making a new table entry if needed:
      //
      ELmap_stats::iterator s = stats.find(msg.xid());
      if (s == stats.end()) {
        if (tableLimit < 0 || static_cast<int>(stats.size()) < tableLimit) {
          stats[msg.xid()] = StatsCount();
          s = stats.find(msg.xid());
        }
      }
#ifdef ELstatsLOG_TRACE
      std::cerr << "    =:=:=: Message accounted for in stats \n";
#endif
      if (s != stats.end()) {
        (*s).second.add(summarizeContext(msg.context()), msg.reactedTo());

        updatedStats = true;
#ifdef ELstatsLOG_TRACE
        std::cerr << "    =:=:=: Updated stats \n";
#endif
      }

      // For the purposes of telling whether any log destination has reacted
      // to the message, the statistics destination does not count:
      //

#ifdef ELstatsLOG_TRACE
      std::cerr << "  =:=:=: log(msg) done (stats) \n";
#endif

      return false;

    }  // log()

noteGroupedCategory()

void edm::service::ELstatistics::noteGroupedCategory ( std::string const &  cat )

static

Definition at line 484 of file ELstatistics.cc.

References eostools::cat(), and groupedCategories.

Referenced by edm::service::ThreadSafeLogMessageLoggerScribe::runCommand().

{ groupedCategories.insert(cat); }

noTerminationSummary()

void edm::service::ELstatistics::noTerminationSummary

(

)

Definition at line 361 of file ELstatistics.cc.

References printAtTermination.

{ printAtTermination = false; }

operator=()

ELstatistics& edm::service::ELstatistics::operator= ( const ELstatistics &  orig )

delete

statisticsMap()

std::map< ELextendedID, StatsCount > edm::service::ELstatistics::statisticsMap ( ) const

protected

Definition at line 363 of file ELstatistics.cc.

References stats.

                                                                       {
      return std::map<ELextendedID, StatsCount>(stats);
    }

summary() [1/2]

void edm::service::ELstatistics::summary

(

unsigned long

overfullWaitCount

)

Definition at line 351 of file ELstatistics.cc.

References formSummary(), stats, termStream, and updatedStats.

Referenced by ~ELstatistics().

                                                              {
      termStream << "\n=============================================\n\n"
                 << "MessageLogger Summary" << std::endl
                 << formSummary(stats) << std::endl
                 << "dropped waiting message count " << overfullWaitCount << std::endl
                 << std::flush;
      updatedStats = false;

    }  // summary()

summary() [2/2]

void edm::service::ELstatistics::summary ( std::ostream &  os, std::string_view  title  )

private

Definition at line 345 of file ELstatistics.cc.

References formSummary(), stats, runGCPTkAlMap::title, and updatedStats.

                                                                   {
      os << title << std::endl << formSummary(stats) << std::flush;
      updatedStats = false;

    }  // summary()

summaryForJobReport()

void edm::service::ELstatistics::summaryForJobReport

(

std::map< std::string, double > &

sm

)

Definition at line 368 of file ELstatistics.cc.

References eostools::cat(), dualLogName(), g, edm::messagelogger::ELseverityLevel::getLevel(), edm::ELseverityLevel::getName(), groupedCategories, mps_fire::i, dqmdumpme::k, dttmaxenums::L, dqmiodumpmetadata::n, edm::ELseverityLevel::nLevels, chargedHadronTrackResolutionFilter_cfi::p3, alignCSCRings::s, edm::ELextendedID::severity, interestingDetIdCollectionProducer_cfi::severityLevel, ALPAKA_ACCELERATOR_NAMESPACE::ecal::reconstruction::internal::barrel::sm(), stats, AlCaHLTBitMon_QueryRunRegistry::string, and submitPVValidationJobs::t.

                                                                        {
      struct part3 {
        long n, t;
        part3() : n(0L), t(0L) { ; }
      } p3[ELseverityLevel::nLevels];

      std::set<std::string>::iterator gcEnd = groupedCategories.end();
      std::set<std::string> gCats = groupedCategories;  // TEMP FOR DEBUGGING SANITY

      // ----- Part I:  The ungrouped categories
      for (ELmap_stats::const_iterator i = stats.begin(); i != stats.end(); ++i) {
        // If this is a grouped category, wait till later to output its stats
        std::string cat = (*i).first.id;
        if (groupedCategories.find(cat) != gcEnd) {
          continue;  // We will process these categories later
        }

        // -----  Emit detailed message information:
        //
        std::ostringstream s;
        s << "Category_";
        std::string sevSymbol = (*i).first.severity.getSymbol();
        if (sevSymbol[0] == '-')
          sevSymbol = sevSymbol.substr(1);
        s << sevSymbol << "_" << (*i).first.id;
        int n = (*i).second.aggregateN;
        std::string catstr = s.str();
        if (sm.find(catstr) != sm.end()) {
          sm[catstr] += n;
        } else {
          sm[catstr] = n;
        }
        // -----  Obtain information for Part III, below:
        //
        ELextendedID xid = (*i).first;
        p3[xid.severity.getLevel()].n += (*i).second.n;
        p3[xid.severity.getLevel()].t += (*i).second.aggregateN;
      }  // for i

      // ----- Part Ia:  The grouped categories
      for (std::set<std::string>::iterator g = groupedCategories.begin(); g != gcEnd; ++g) {
        int groupTotal = 0;
        int groupAggregateN = 0;
        ELseverityLevel severityLevel;
        for (ELmap_stats::const_iterator i = stats.begin(); i != stats.end(); ++i) {
          if ((*i).first.id == *g) {
            if (groupTotal == 0)
              severityLevel = (*i).first.severity;
            groupAggregateN += (*i).second.aggregateN;
            ++groupTotal;
          }
        }  // for i
        if (groupTotal > 0) {
          // -----  Emit detailed message information:
          //
          std::ostringstream s;
          s << "Category_";
          std::string sevSymbol = severityLevel.getSymbol();
          if (sevSymbol[0] == '-')
            sevSymbol = sevSymbol.substr(1);
          s << sevSymbol << "_" << *g;
          int n = groupAggregateN;
          std::string catstr = s.str();
          if (sm.find(catstr) != sm.end()) {
            sm[catstr] += n;
          } else {
            sm[catstr] = n;
          }

          // -----  Obtain information for Part III, below:
          //
          int lev = severityLevel.getLevel();
          p3[lev].n += groupTotal;
          p3[lev].t += groupAggregateN;
        }  // end if groupTotal>0
      }    // for g

      // part II (sample event numbers) does not exist for the job report.

      // -----  Summary part III:
      //
      for (int k = 0; k < ELseverityLevel::nLevels; ++k) {
        //if ( p3[k].t != 0 )  {
        if (true) {
          std::string sevName;
          sevName = ELseverityLevel(ELseverityLevel::ELsev_(k)).getName();
          if (sevName == "Severe")
            sevName = "System";
          if (sevName == "Success")
            sevName = "Debug";
          sevName = std::string("Log") + sevName;
          sevName = dualLogName(sevName);
          if (sevName != "UnusedSeverity") {
            sm[sevName] = p3[k].t;
          }
        }
      }  // for k

    }  // summaryForJobReport()

wipe()

void edm::service::ELstatistics::wipe ( )

overridevirtual

Reimplemented from edm::service::ELdestination.

Definition at line 209 of file ELstatistics.cc.

References edm::service::ELdestination::limits, stats, and edm::service::ELlimitsTable::wipe().

                            {
      limits.wipe();
      stats.erase(stats.begin(), stats.end());  //stats.clear();

    }  // wipe()

zero()

void edm::service::ELstatistics::zero ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 215 of file ELstatistics.cc.

References edm::service::ELdestination::limits, and edm::service::ELlimitsTable::zero().

{ limits.zero(); }  // zero()

Friends And Related Function Documentation

ELadministrator

friend class ELadministrator

friend

Definition at line 50 of file ELstatistics.h.

Member Data Documentation

groupedCategories

std::set< std::string > edm::service::ELstatistics::groupedCategories

staticprotected

Definition at line 97 of file ELstatistics.h.

Referenced by formSummary(), noteGroupedCategory(), and summaryForJobReport().

printAtTermination

bool edm::service::ELstatistics::printAtTermination

protected

Definition at line 95 of file ELstatistics.h.

Referenced by noTerminationSummary(), and ~ELstatistics().

stats

ELmap_stats edm::service::ELstatistics::stats

protected

Definition at line 91 of file ELstatistics.h.

Referenced by clearSummary(), formSummary(), log(), statisticsMap(), summary(), summaryForJobReport(), and wipe().

tableLimit

int edm::service::ELstatistics::tableLimit

protected

Definition at line 90 of file ELstatistics.h.

Referenced by log().

termStream

std::ostream& edm::service::ELstatistics::termStream

protected

Definition at line 93 of file ELstatistics.h.

Referenced by summary(), and ~ELstatistics().

updatedStats

bool edm::service::ELstatistics::updatedStats

protected

Definition at line 92 of file ELstatistics.h.

Referenced by log(), summary(), and ~ELstatistics().