TriggerRatesMonitor Class Reference

Inheritance diagram for TriggerRatesMonitor:

Public Member Functions
	TriggerRatesMonitor (edm::ParameterSet const &)
	~TriggerRatesMonitor () override=default
Public Member Functions inherited from DQMGlobalEDAnalyzer< RunBasedHistograms >
void	accumulate (edm::StreamID id, edm::Event const &event, edm::EventSetup const &setup) const final
virtual void	bookHistograms (DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &, RunBasedHistograms &) const=0
virtual void	dqmEndRun (edm::Run const &, edm::EventSetup const &, RunBasedHistograms const &) const
	DQMGlobalEDAnalyzer ()
std::shared_ptr< RunBasedHistograms >	globalBeginRun (edm::Run const &run, edm::EventSetup const &setup) const final
void	globalEndRun (edm::Run const &, edm::EventSetup const &) const final
void	globalEndRunProduce (edm::Run &run, edm::EventSetup const &setup) const final
Public Member Functions inherited from edm::global::EDProducer< edm::RunCache< RunBasedHistograms >, edm::EndRunProducer, edm::Accumulator, Args... >
	EDProducer ()=default
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndRuns () const final
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
	~EDProducerBase () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
std::vector< bool > const &	recordProvenanceList () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...
	~ProducerBase () noexcept(false) 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 &&)=default
	EDConsumerBase (EDConsumerBase const &)=delete
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 &	operator= (EDConsumerBase &&)=default
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
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::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	bookHistograms (DQMStore::IBooker &, 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 constexpr const char *const	s_tcds_trigger_types []

Additional Inherited Members
Public Types inherited from DQMGlobalEDAnalyzer< RunBasedHistograms >
typedef dqm::reco::DQMStore	DQMStore
typedef dqm::reco::MonitorElement	MonitorElement
Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
ProducesCollector	producesCollector ()
Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (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)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Definition at line 104 of file TriggerRatesMonitor.cc.

Constructor & Destructor Documentation

TriggerRatesMonitor()

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

explicit

Definition at line 159 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::~TriggerRatesMonitor ( )

overridedefault

Member Function Documentation

bookHistograms()

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

overrideprivate

Definition at line 222 of file TriggerRatesMonitor.cc.

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

References ztail::d, contentValuesFiles::datasets, dqm-mbProfile::format, mps_fire::i, dqmiolumiharvest::j, label, m_dqm_path, m_lumisections_range, Skims_PA_cff::name, or, s_tcds_trigger_types, singleTopDQM_cfi::setup, str, HLT_2018_cff::streams, AlCaHLTBitMon_QueryRunRegistry::string, and overlapproblemtsosanalyzer_cfi::title.

dqmAnalyze()

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

overrideprivatevirtual

Implements DQMGlobalEDAnalyzer< RunBasedHistograms >.

Definition at line 324 of file TriggerRatesMonitor.cc.

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

References ztail::d, edm::get(), PDWG_DiJetAODSkim_cff::hltResults, mps_fire::i, dqmiolumiharvest::j, m_hlt_results, m_l1t_results, GlobalAlgBlk::maxPhysicsTriggers, castor_dqm_sourceclient_file_cfg::path, and bookConverter::results.

dqmBeginRun()

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

overrideprivatevirtual

Reimplemented from DQMGlobalEDAnalyzer< RunBasedHistograms >.

Definition at line 166 of file TriggerRatesMonitor.cc.

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

References contentValuesFiles::datasets, mps_fire::i, SummaryClient_cfi::labels, edm::EDConsumerBase::labelsForToken(), m_hlt_results, GlobalAlgBlk::maxPhysicsTriggers, castor_dqm_sourceclient_file_cfg::path, Skims_PA_cff::paths, writedatasetfile::run, s_tcds_trigger_types, singleTopDQM_cfi::setup, HLT_2018_cff::streams, and tier0::unique().

fillDescriptions()

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

static

Definition at line 150 of file TriggerRatesMonitor.cc.

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

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

Member Data Documentation

m_dqm_path

const std::string TriggerRatesMonitor::m_dqm_path

private

Definition at line 143 of file TriggerRatesMonitor.cc.

Referenced by bookHistograms().

m_hlt_results

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

private

Definition at line 142 of file TriggerRatesMonitor.cc.

Referenced by dqmAnalyze(), and dqmBeginRun().

m_l1t_results

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

private

Definition at line 141 of file TriggerRatesMonitor.cc.

Referenced by dqmAnalyze().

m_lumisections_range

const uint32_t TriggerRatesMonitor::m_lumisections_range

private

Definition at line 144 of file TriggerRatesMonitor.cc.

Referenced by bookHistograms().

s_tcds_trigger_types

constexpr const char *const TriggerRatesMonitor::s_tcds_trigger_types

staticconstexprprivate

Initial value:

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

Definition at line 121 of file TriggerRatesMonitor.cc.

Referenced by bookHistograms(), and dqmBeginRun().