HLTLogMonitorFilter Class Reference

#include <Work/HLTLogMonitorFilter/src/HLTLogMonitorFilter.cc>

Inheritance diagram for HLTLogMonitorFilter:

Classes
struct	CategoryEntry

Public Member Functions
	HLTLogMonitorFilter (const edm::ParameterSet &)
	~HLTLogMonitorFilter ()
Public Member Functions inherited from edm::EDFilter
	EDFilter ()
virtual	~EDFilter ()
Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
boost::function< void(const BranchDescription &)>	registrationCallback () const
	used by the fwk to register list of products More...
virtual	~ProducerBase ()

Private Types
typedef std::map< std::string, CategoryEntry >	CategoryMap

Private Member Functions
CategoryEntry &	addCategory (const std::string &category, uint32_t threshold)
	create a new entry for the given category, with the given threshold value More...
virtual void	beginJob (void)
	EDFilter beginJob method. More...
virtual void	endJob (void)
	EDFilter endJob method. More...
virtual bool	filter (edm::Event &, const edm::EventSetup &)
	EDFilter accept method. More...
CategoryEntry &	getCategory (const std::string &category)
	return the entry for requested category, if it exists, or create a new one with the default threshold value More...
bool	knownCategory (const std::string &category)
	check if the requested category has a valid entry More...
void	summary (void)
	summarize to LogInfo More...

Private Attributes
CategoryMap	m_data
uint32_t	m_prescale

Additional Inherited Members
Public Types inherited from edm::EDFilter
typedef EDFilter	ModuleType
typedef WorkerT< EDFilter >	WorkerType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Static Public Member Functions inherited from edm::EDFilter
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
Protected Member Functions inherited from edm::EDFilter
CurrentProcessingContext const *	currentContext () const
Protected Member Functions inherited from edm::ProducerBase
template<class TProducer , class TMethod >
void	callWhenNewProductsRegistered (TProducer *iProd, TMethod iMethod)

Detailed Description

Description: Accept events if any LogError or LogWarning was raised

Implementation: <Notes on="" implementation>="">

Definition at line 36 of file HLTLogMonitorFilter.cc.

Member Typedef Documentation

typedef std::map<std::string, CategoryEntry> HLTLogMonitorFilter::CategoryMap

private

Definition at line 79 of file HLTLogMonitorFilter.cc.

Constructor & Destructor Documentation

HLTLogMonitorFilter::HLTLogMonitorFilter ( const edm::ParameterSet &  config )

explicit

Definition at line 126 of file HLTLogMonitorFilter.cc.

References addCategory(), ecalBxOrbitNumberGrapher_cfg::categories, python.rootplot.argparse::category, edm::ParameterSet::getParameter(), m_prescale, mergeVDriftHistosByStation::name, and dtDQMClient_cfg::threshold.

                                                                       :
  m_prescale(),
  m_data()
{
  m_prescale = config.getParameter<uint32_t>("default_threshold");

  typedef std::vector<edm::ParameterSet> VPSet; 
  const VPSet & categories = config.getParameter<VPSet>("categories");
  for (VPSet::const_iterator category = categories.begin(); category != categories.end(); ++category) {
    const std::string & name = category->getParameter<std::string>("name");
    uint32_t threshold       = category->getParameter<uint32_t>("threshold");
    addCategory(name, threshold);
  }

  produces<std::vector<edm::ErrorSummaryEntry> >();
}

HLTLogMonitorFilter::~HLTLogMonitorFilter

(

)

Definition at line 143 of file HLTLogMonitorFilter.cc.

{
}

Member Function Documentation

HLTLogMonitorFilter::CategoryEntry & HLTLogMonitorFilter::addCategory ( const std::string &  category, uint32_t  threshold  )

private

create a new entry for the given category, with the given threshold value

Definition at line 218 of file HLTLogMonitorFilter.cc.

References python.rootplot.argparse::category, edm::hlt::Exception, m_data, and query::result.

Referenced by HLTLogMonitorFilter().

                                                                                                                  {
  // check after inserting, as either the new CategoryEntry is needed, or an error condition is raised
  std::pair<CategoryMap::iterator, bool> result = m_data.insert( std::make_pair(category, CategoryEntry(threshold)) );
  if (not result.second)
    throw cms::Exception("Configuration") << "Duplicate entry for category " << category;
  return result.first->second;
}

void HLTLogMonitorFilter::beginJob ( void  )

privatevirtual

EDFilter beginJob method.

Reimplemented from edm::EDFilter.

Definition at line 203 of file HLTLogMonitorFilter.cc.

References edm::MessageSender::errorSummaryIsBeingKept.

                                       {
  edm::MessageSender::errorSummaryIsBeingKept = true;
}

void HLTLogMonitorFilter::endJob ( void  )

privatevirtual

EDFilter endJob method.

Reimplemented from edm::EDFilter.

Definition at line 207 of file HLTLogMonitorFilter.cc.

References edm::MessageSender::errorSummaryIsBeingKept, and summary().

                                     {
  edm::MessageSender::errorSummaryIsBeingKept = false;
  summary();
}

bool HLTLogMonitorFilter::filter ( edm::Event &  event, const edm::EventSetup &  setup  )

privatevirtual

EDFilter accept method.

Implements edm::EDFilter.

Definition at line 153 of file HLTLogMonitorFilter.cc.

References accept(), HLTLogMonitorFilter::CategoryEntry::accept(), python.rootplot.argparse::category, benchmark_cfg::errors, edm::MessageSender::errorSummaryMap, edm::MessageSender::freshError, getCategory(), i, m_data, findQualityFiles::size, and confdb::splitter().

                                                                              {
  // no LogErrors or LogWarnings, skip processing and reject the event
  if (not edm::MessageSender::freshError)
    return false;

  // clear "done" flag in all Categories
  BOOST_FOREACH(CategoryMap::value_type & entry, m_data)
    entry.second.done = false;

  // look at the LogErrors and LogWarnings, and accept the event if at least one is under threshold or matches the prescale
  bool accept = false;
  std::string category;

  typedef std::map<edm::ErrorSummaryMapKey, unsigned int> ErrorSummaryMap;
  BOOST_FOREACH(const ErrorSummaryMap::value_type & entry, edm::MessageSender::errorSummaryMap) {
    // split the message category
    typedef boost::split_iterator<std::string::const_iterator> splitter;
    for (splitter i = boost::make_split_iterator(entry.first.category, boost::first_finder("|", boost::is_equal()));
         i != splitter();
         ++i)
    {
      // extract the substring corresponding to the split_iterator
      // FIXME: this can be avoided if the m_data map is keyed on boost::sub_range<std::string>
      category.assign(i->begin(), i->end());

      // access the message category, or create a new one as needed, and check the prescale
      if (getCategory(category).accept())
        accept = true;
    }
  }

  // harvest the errors, but only if the filter will accept the event
  std::auto_ptr<std::vector<edm::ErrorSummaryEntry> > errors(new std::vector<edm::ErrorSummaryEntry>());
  if (accept) {
    errors->reserve( edm::MessageSender::errorSummaryMap.size() );
    BOOST_FOREACH(const ErrorSummaryMap::value_type & entry, edm::MessageSender::errorSummaryMap) {
      errors->push_back(entry.first);        // sets category, module and severity
      errors->back().count = entry.second;   // count is 0 in key; set it to correct value (see FWCore/MessageLogger/src/LoggedErrorsSummary.cc)
    }
  }
  event.put(errors);

  // clear the errorSummaryMap
  edm::MessageSender::errorSummaryMap.clear();
  edm::MessageSender::freshError = false;

  return accept;
}

HLTLogMonitorFilter::CategoryEntry & HLTLogMonitorFilter::getCategory ( const std::string &  category )

private

return the entry for requested category, if it exists, or create a new one with the default threshold value

Definition at line 227 of file HLTLogMonitorFilter.cc.

References i, m_data, and m_prescale.

Referenced by filter().

                                                                                              {
  // check before inserting, to avoid the construction of a CategoryEntry object
  CategoryMap::iterator i = m_data.find(category);
  if (i != m_data.end())
    return i->second;
  else
    return m_data.insert( std::make_pair(category, CategoryEntry(m_prescale)) ).first->second;
}

bool HLTLogMonitorFilter::knownCategory ( const std::string &  category )

private

check if the requested category has a valid entry

Definition at line 213 of file HLTLogMonitorFilter.cc.

References m_data.

                                                                  {
  return (m_data.find( category ) != m_data.end());
}

void HLTLogMonitorFilter::summary ( void  )

private

summarize to LogInfo

Definition at line 237 of file HLTLogMonitorFilter.cc.

References m_data, and dbtoconf::out.

Referenced by endJob().

                                      {
  std::stringstream out;
  out << "Log-Report ---------- HLTLogMonitorFilter Summary ------------\n"
      << "Log-Report  Threshold   Prescale     Issued   Accepted   Rejected Category\n";
  BOOST_FOREACH(const CategoryMap::value_type & entry, m_data) {
    out << "Log-Report "
        << std::right
        << std::setw(10) << entry.second.threshold << ' '
        << std::setw(10) << entry.second.prescale  << ' '
        << std::setw(10) << entry.second.counter   << ' '
        << std::setw(10) << entry.second.accepted  << ' '
        << std::setw(10) << (entry.second.counter - entry.second.accepted) << ' '
        << std::left     << entry.first            << '\n';
  }
  edm::LogVerbatim("Report") << out.str();
}

Member Data Documentation

CategoryMap HLTLogMonitorFilter::m_data

private

Definition at line 107 of file HLTLogMonitorFilter.cc.

Referenced by addCategory(), filter(), getCategory(), knownCategory(), and summary().

uint32_t HLTLogMonitorFilter::m_prescale

private

Definition at line 106 of file HLTLogMonitorFilter.cc.

Referenced by getCategory(), and HLTLogMonitorFilter().