TriggerRatesMonitor Class Reference

Inheritance diagram for TriggerRatesMonitor:

Public Member Functions
	TriggerRatesMonitor (edm::ParameterSet const &)
	~TriggerRatesMonitor () override=default
Public Member Functions inherited from edm::global::EDAnalyzer< edm::RunCache< RunBasedHistograms >, Args... >
	EDAnalyzer ()=default
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () const
	~EDAnalyzerBase () override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::global::EDAnalyzerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	bookHistograms (DQMStore::ConcurrentBooker &, edm::Run const &, edm::EventSetup const &, RunBasedHistograms &) const override
void	dqmAnalyze (edm::Event const &, edm::EventSetup const &, RunBasedHistograms const &) const override
void	dqmBeginRun (edm::Run const &, edm::EventSetup const &, RunBasedHistograms &) const override

Private Attributes
const std::string	m_dqm_path
const edm::EDGetTokenT< edm::TriggerResults >	m_hlt_results
const edm::EDGetTokenT< GlobalAlgBlkBxCollection >	m_l1t_results
const uint32_t	m_lumisections_range

Static Private Attributes
static const char *const	s_tcds_trigger_types []

Additional Inherited Members
Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Definition at line 112 of file TriggerRatesMonitor.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 168 of file TriggerRatesMonitor.cc.

                                                                       :
  // module configuration
  m_l1t_results(consumes<GlobalAlgBlkBxCollection>( config.getUntrackedParameter<edm::InputTag>( "l1tResults" ) )),
  m_hlt_results(consumes<edm::TriggerResults>(      config.getUntrackedParameter<edm::InputTag>( "hltResults" ) )),
  m_dqm_path(                                       config.getUntrackedParameter<std::string>(   "dqmPath" ) ),
  m_lumisections_range(                             config.getUntrackedParameter<uint32_t>(      "lumisectionRange" ) )
{
}

TriggerRatesMonitor::~TriggerRatesMonitor ( )

overridedefault

Member Function Documentation

void TriggerRatesMonitor::bookHistograms ( DQMStore::ConcurrentBooker &  booker, edm::Run const &  run, edm::EventSetup const &  setup, RunBasedHistograms &  histograms  ) const

overrideprivatevirtual

Implements DQMGlobalEDAnalyzer< RunBasedHistograms >.

Definition at line 232 of file TriggerRatesMonitor.cc.

References DQMStore::ConcurrentBooker::book1D(), edmIntegrityCheck::d, edmIntegrityCheck::datasets, cmsPerfStripChart::format, mps_fire::i, label, m_dqm_path, m_lumisections_range, dataset::name, or, s_tcds_trigger_types, DQMStore::IBooker::setCurrentFolder(), GeneralSetup::setup(), str, AlCaHLTBitMon_QueryRunRegistry::string, and fftjetcommon_cfi::title.

{
  // book the overall event count and event types histograms
  booker.setCurrentFolder( m_dqm_path );
  histograms.events_processed = booker.book1D("events", "Processed events vs. lumisection", m_lumisections_range + 1, -0.5, m_lumisections_range + 0.5);
  booker.setCurrentFolder( m_dqm_path + "/TCDS" );
  for (unsigned int i = 0; i < sizeof(s_tcds_trigger_types)/sizeof(const char *); ++i)
    if (s_tcds_trigger_types[i]) {
      std::string const & title = (boost::format("%s events vs. lumisection") % s_tcds_trigger_types[i]).str();
      histograms.tcds_counts[i] = booker.book1D(s_tcds_trigger_types[i], title, m_lumisections_range + 1, -0.5, m_lumisections_range + 0.5);
    }

  // book the rate histograms for the L1 triggers that are included in the L1 menu
  booker.setCurrentFolder( m_dqm_path + "/L1T" );
  auto const& l1tMenu = edm::get<L1TUtmTriggerMenu, L1TUtmTriggerMenuRcd>(setup);
  for (auto const & keyval: l1tMenu.getAlgorithmMap()) {
    unsigned int bit = keyval.second.getIndex();
    bool masked = false;        // FIXME read L1 masks once they will be avaiable in the EventSetup
    std::string const & name  = (boost::format("%s (bit %d)") % keyval.first % bit).str();
    std::string const & title = (boost::format("%s (bit %d)%s vs. lumisection") % keyval.first % bit % (masked ? " (masked)" : "")).str();
    histograms.l1t_counts.at(bit) = booker.book1D(name, title, m_lumisections_range + 1, -0.5, m_lumisections_range + 0.5);
  }

  if (histograms.hltConfig.inited()) {

    auto const & datasets = histograms.hltConfig.datasetNames();

    // book the rate histograms for the HLT triggers
    for (unsigned int d = 0; d < datasets.size(); ++d) {
      booker.setCurrentFolder( m_dqm_path + "/HLT/" + datasets[d]);
      for (unsigned int i = 0; i < histograms.datasets[d].size(); ++i) {
    unsigned int index = histograms.datasets[d][i];
    std::string const & name = histograms.hltConfig.triggerName(index);
    histograms.hlt_by_dataset_counts[d][i].pass_l1_seed  = booker.book1D(name + "_pass_L1_seed",     name + " pass L1 seed, vs. lumisection",     m_lumisections_range + 1,   -0.5,   m_lumisections_range + 0.5);
    histograms.hlt_by_dataset_counts[d][i].pass_prescale = booker.book1D(name + "_pass_prescaler",   name + " pass prescaler, vs. lumisection",   m_lumisections_range + 1,   -0.5,   m_lumisections_range + 0.5);
    histograms.hlt_by_dataset_counts[d][i].accept        = booker.book1D(name + "_accept",           name + " accept, vs. lumisection",           m_lumisections_range + 1,   -0.5,   m_lumisections_range + 0.5);
    histograms.hlt_by_dataset_counts[d][i].reject        = booker.book1D(name + "_reject",           name + " reject, vs. lumisection",           m_lumisections_range + 1,   -0.5,   m_lumisections_range + 0.5);
    histograms.hlt_by_dataset_counts[d][i].error         = booker.book1D(name + "_error",            name + " error, vs. lumisection",            m_lumisections_range + 1,   -0.5,   m_lumisections_range + 0.5);
      }

      //      booker.setCurrentFolder( m_dqm_path + "/HLT/" + datasets[d]);
      for (unsigned int i: histograms.datasets[d]) {

    // look for the index of the (last) L1 seed and prescale module in each path
    histograms.hltIndices[i].index_l1_seed  = histograms.hltConfig.size(i);
    histograms.hltIndices[i].index_prescale = histograms.hltConfig.size(i);
    for (unsigned int j = 0; j < histograms.hltConfig.size(i); ++j) {
      std::string const & label = histograms.hltConfig.moduleLabel(i, j);
      std::string const & type  = histograms.hltConfig.moduleType(label);
      if (type == "HLTL1TSeed" or type == "HLTLevel1GTSeed" or type == "HLTLevel1Activity" or type == "HLTLevel1Pattern") {
        // there might be more L1 seed filters in sequence
        // keep looking and store the index of the last one
        histograms.hltIndices[i].index_l1_seed  = j;
      } else if (type == "HLTPrescaler") {
        // there should be only one prescaler in a path, and it should follow all L1 seed filters
        histograms.hltIndices[i].index_prescale = j;
        break;
      }
    }
      }
    }

    // book the HLT datasets rate histograms
    booker.setCurrentFolder( m_dqm_path + "/Datasets" );
    for (unsigned int i = 0; i < datasets.size(); ++i)
      histograms.dataset_counts[i] = booker.book1D(datasets[i], datasets[i], m_lumisections_range + 1, -0.5, m_lumisections_range + 0.5);
   
    // book the HLT streams rate histograms
    booker.setCurrentFolder( m_dqm_path + "/Streams" );
    auto const & streams = histograms.hltConfig.streamNames();
    for (unsigned int i = 0; i < streams.size(); ++i)
      histograms.stream_counts[i] = booker.book1D(streams[i],  streams[i],  m_lumisections_range + 1, -0.5, m_lumisections_range + 0.5);
  }

}

void TriggerRatesMonitor::dqmAnalyze ( edm::Event const &  event, edm::EventSetup const &  setup, RunBasedHistograms const &  histograms  ) const

overrideprivate

Definition at line 309 of file TriggerRatesMonitor.cc.

References edm::HLTPathStatus::accept(), edm::HLTGlobalStatus::at(), edmIntegrityCheck::d, DEFINE_FWK_MODULE, edm::HLTPathStatus::error(), edm::EventBase::experimentType(), edm::get(), SelectingProcedure_cff::hltResults, mps_fire::i, edm::HLTPathStatus::index(), m_hlt_results, m_l1t_results, GlobalAlgBlk::maxPhysicsTriggers, callgraph::path, and edm::HLTGlobalStatus::size().

{
  unsigned int lumisection = event.luminosityBlock();

  // monitor the overall event count and event types rates
  histograms.events_processed.fill(lumisection);
  if (histograms.tcds_counts[event.experimentType()])
    histograms.tcds_counts[event.experimentType()].fill(lumisection);

  // monitor the L1 triggers rates
  auto const & bxvector = edm::get(event, m_l1t_results);
  if (not bxvector.isEmpty(0)) {
    auto const & results = bxvector.at(0, 0);
    for (unsigned int i = 0; i < GlobalAlgBlk::maxPhysicsTriggers; ++i)
      if (results.getAlgoDecisionFinal(i))
        if (histograms.l1t_counts[i])
          histograms.l1t_counts[i].fill(lumisection);
  }

  // monitor the HLT triggers and datsets rates
  if (histograms.hltConfig.inited()) {
    edm::TriggerResults const & hltResults = edm::get(event, m_hlt_results);
    if (hltResults.size() == histograms.hltIndices.size()) {
    } else {
      edm::LogWarning("TriggerRatesMonitor") << "This should never happen: the number of HLT paths has changed since the beginning of the run";
    }

    for (unsigned int d = 0; d < histograms.datasets.size(); ++d) {
      for (unsigned int i: histograms.datasets[d])
        if (hltResults.at(i).accept()) {
          histograms.dataset_counts[d].fill(lumisection);
          // ensure each dataset is incremented only once per event
          break;
        }
      for (unsigned int i = 0; i < histograms.datasets[d].size(); ++i) {
    unsigned int index = histograms.datasets[d][i];
    edm::HLTPathStatus const & path = hltResults.at(index);

        if (path.index() > histograms.hltIndices[index].index_l1_seed)
          histograms.hlt_by_dataset_counts[d][i].pass_l1_seed.fill(lumisection);
        if (path.index() > histograms.hltIndices[index].index_prescale)
          histograms.hlt_by_dataset_counts[d][i].pass_prescale.fill(lumisection);
        if (path.accept())
          histograms.hlt_by_dataset_counts[d][i].accept.fill(lumisection);
        else if (path.error())
          histograms.hlt_by_dataset_counts[d][i].error .fill(lumisection);
        else
          histograms.hlt_by_dataset_counts[d][i].reject.fill(lumisection);
      }
    }

    for (unsigned int i = 0; i < histograms.streams.size(); ++i)
      for (unsigned int j: histograms.streams[i])
        if (hltResults.at(j).accept()) {
          histograms.stream_counts[i].fill(lumisection);
          // ensure each stream is incremented only once per event
          break;
        }
  }
}

void TriggerRatesMonitor::dqmBeginRun ( edm::Run const &  run, edm::EventSetup const &  setup, RunBasedHistograms &  histograms  ) const

overrideprivatevirtual

Reimplemented from DQMGlobalEDAnalyzer< RunBasedHistograms >.

Definition at line 177 of file TriggerRatesMonitor.cc.

References edmIntegrityCheck::datasets, mps_fire::i, tablePrinter::labels, edm::EDConsumerBase::labelsForToken(), m_hlt_results, GlobalAlgBlk::maxPhysicsTriggers, callgraph::path, edm::ProductLabels::process, s_tcds_trigger_types, and tier0::unique().

{
  histograms.events_processed.reset();
  histograms.tcds_counts.clear();
  histograms.tcds_counts.resize(sizeof(s_tcds_trigger_types)/sizeof(const char *));

  // cache the L1 trigger menu
  histograms.l1t_counts.clear();
  histograms.l1t_counts.resize(GlobalAlgBlk::maxPhysicsTriggers);

  // initialise the HLTConfigProvider
  bool changed = true;
  edm::EDConsumerBase::Labels labels;
  labelsForToken(m_hlt_results, labels);
  if (histograms.hltConfig.init(run, setup, labels.process, changed)) {
    histograms.hltIndices.resize(histograms.hltConfig.size());

    unsigned int datasets = histograms.hltConfig.datasetNames().size();
    histograms.hlt_by_dataset_counts.clear();
    histograms.hlt_by_dataset_counts.resize(datasets);
    
    histograms.datasets.clear();
    histograms.datasets.resize(datasets);
    for (unsigned int i = 0; i < datasets; ++i) {
      auto const & paths = histograms.hltConfig.datasetContent(i);
      histograms.hlt_by_dataset_counts[i].resize(paths.size());
      histograms.datasets[i].reserve(paths.size());
      for (auto const & path: paths) {
        histograms.datasets[i].push_back(histograms.hltConfig.triggerIndex(path));
      }
    }
    histograms.dataset_counts.clear();
    histograms.dataset_counts.resize(datasets);

    unsigned int streams = histograms.hltConfig.streamNames().size();
    histograms.streams.clear();
    histograms.streams.resize(streams);
    for (unsigned int i = 0; i < streams; ++i) {
      for (auto const & dataset : histograms.hltConfig.streamContent(i)) {
        for (auto const & path : histograms.hltConfig.datasetContent(dataset))
          histograms.streams[i].push_back(histograms.hltConfig.triggerIndex(path));
      }
      std::sort(histograms.streams[i].begin(), histograms.streams[i].end());
      auto unique_end = std::unique(histograms.streams[i].begin(), histograms.streams[i].end());
      histograms.streams[i].resize(unique_end - histograms.streams[i].begin());
      histograms.streams[i].shrink_to_fit();
    }
    histograms.stream_counts.clear();
    histograms.stream_counts.resize(streams);
  } else {
    // HLTConfigProvider not initialised, skip the the HLT monitoring
    edm::LogError("TriggerRatesMonitor") << "failed to initialise HLTConfigProvider, the HLT trigger and datasets rates will not be monitored";
  }
}

void TriggerRatesMonitor::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 157 of file TriggerRatesMonitor.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), and AlCaHLTBitMon_QueryRunRegistry::string.

{
  edm::ParameterSetDescription desc;
  desc.addUntracked<edm::InputTag>( "l1tResults",       edm::InputTag("gtStage2Digis"));
  desc.addUntracked<edm::InputTag>( "hltResults",       edm::InputTag("TriggerResults"));
  desc.addUntracked<std::string>(   "dqmPath",          "HLT/TriggerRates" );
  desc.addUntracked<uint32_t>(      "lumisectionRange", 2500 );             // ~16 hours
  descriptions.add("triggerRatesMonitor", desc);
}

Member Data Documentation

const std::string TriggerRatesMonitor::m_dqm_path

private

Definition at line 148 of file TriggerRatesMonitor.cc.

Referenced by bookHistograms().

const edm::EDGetTokenT<edm::TriggerResults> TriggerRatesMonitor::m_hlt_results

private

Definition at line 147 of file TriggerRatesMonitor.cc.

Referenced by dqmAnalyze(), and dqmBeginRun().

const edm::EDGetTokenT<GlobalAlgBlkBxCollection> TriggerRatesMonitor::m_l1t_results

private

Definition at line 146 of file TriggerRatesMonitor.cc.

Referenced by dqmAnalyze().

const uint32_t TriggerRatesMonitor::m_lumisections_range

private

Definition at line 149 of file TriggerRatesMonitor.cc.

Referenced by bookHistograms().

const char *const TriggerRatesMonitor::s_tcds_trigger_types

staticprivate

Initial value:

= {
    "Empty",           
    "Physics",         
    "Calibration",     
    "Random",          
    "Auxiliary",       
     0 ,           
     0 ,           
     0 ,           
    "Cyclic",          
    "Bunch-pattern",   
    "Software",        
    "TTS",             
     0 ,           
     0 ,           
     0 ,           
     0             
  }

Definition at line 126 of file TriggerRatesMonitor.cc.

Referenced by bookHistograms(), and dqmBeginRun().