FastTimerServiceClient Class Reference

Inheritance diagram for FastTimerServiceClient:

Public Member Functions
	FastTimerServiceClient (edm::ParameterSet const &)
	~FastTimerServiceClient ()
Public Member Functions inherited from DQMEDHarvester
virtual void	analyze (edm::Event const &, edm::EventSetup const &) final
virtual void	beginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) final
virtual void	beginRun (edm::Run const &, edm::EventSetup const &)
	DQMEDHarvester (void)
virtual void	endJob () final
virtual void	endLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) final
virtual void	endRun (edm::Run const &, edm::EventSetup const &)
Public Member Functions inherited from edm::one::EDAnalyzer< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks, edm::one::SharedResources >
	EDAnalyzer ()=default
Public Member Functions inherited from edm::one::EDAnalyzerBase
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDAnalyzerBase ()
Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

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

Private Member Functions
void	dqmEndJob (DQMStore::IBooker &booker, DQMStore::IGetter &getter) override
void	dqmEndLuminosityBlock (DQMStore::IBooker &booker, DQMStore::IGetter &getter, edm::LuminosityBlock const &, edm::EventSetup const &) override
void	fillPathSummaryPlots (DQMStore::IBooker &booker, DQMStore::IGetter &getter, double events, std::string const &path)
void	fillProcessSummaryPlots (DQMStore::IBooker &booker, DQMStore::IGetter &getter, std::string const &path)
void	fillSummaryPlots (DQMStore::IBooker &booker, DQMStore::IGetter &getter)

Private Attributes
std::string	m_dqm_path

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType
Protected Member Functions inherited from edm::one::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
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 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 26 of file FastTimerServiceClient.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 45 of file FastTimerServiceClient.cc.

                                                                             :
  m_dqm_path( config.getUntrackedParameter<std::string>( "dqmPath" ) )
{
}

FastTimerServiceClient::~FastTimerServiceClient

(

)

Definition at line 50 of file FastTimerServiceClient.cc.

{
}

Member Function Documentation

void FastTimerServiceClient::dqmEndJob ( DQMStore::IBooker &  booker, DQMStore::IGetter &  getter  )

overrideprivatevirtual

Implements DQMEDHarvester.

Definition at line 55 of file FastTimerServiceClient.cc.

References fillSummaryPlots().

{
  fillSummaryPlots(booker, getter);
}

void FastTimerServiceClient::dqmEndLuminosityBlock ( DQMStore::IBooker &  booker, DQMStore::IGetter &  getter, edm::LuminosityBlock const &  lumi, edm::EventSetup const &  setup  )

overrideprivatevirtual

Reimplemented from DQMEDHarvester.

Definition at line 61 of file FastTimerServiceClient.cc.

References fillSummaryPlots().

{
  fillSummaryPlots(booker, getter);
}

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

static

Definition at line 227 of file FastTimerServiceClient.cc.

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

                                                                                    {
  // The following says we do not know what parameters are allowed so do no validation
  // Please change this to state exactly what you do use, even if it is no parameters
  edm::ParameterSetDescription desc;
  desc.addUntracked<std::string>( "dqmPath", "HLT/TimerService");
  descriptions.add("fastTimerServiceClient", desc);
}

void FastTimerServiceClient::fillPathSummaryPlots ( DQMStore::IBooker &  booker, DQMStore::IGetter &  getter, double  events, std::string const &  path  )

private

Definition at line 115 of file FastTimerServiceClient.cc.

References PDRates::average, DQMStore::IBooker::book1D(), counter, postValidation_cfi::efficiency, DQMStore::IGetter::get(), MonitorElement::getTH1F(), MonitorElement::getTProfile(), i, diffTwoXMLs::label, max(), bookConverter::min, n, or, AlCaHLTBitMon_ParallelJobs::p, mergeAndRegister::paths, DQMStore::IBooker::setCurrentFolder(), findQualityFiles::size, AlCaHLTBitMon_QueryRunRegistry::string, edmStreamStallGrapher::t, and pileupDistInMC::total.

Referenced by fillProcessSummaryPlots().

                                                                                                                                              {
  // note: the following checks need to be kept separate, as any of these histograms might be missing
  // if any of them is filled, size will have the total number of paths, and "paths" can be used to extract the list of labels
  MonitorElement * me;
  TProfile const * paths = nullptr;
  uint32_t         size  = 0;

  // extract the list of Paths and EndPaths from the summary plots
  if (( me = getter.get(current_path + "/paths_active_time") )) {
    paths = me->getTProfile();
    size  = paths->GetXaxis()->GetNbins();
  } else
  if (( me = getter.get(current_path + "/paths_total_time") )) {
    paths = me->getTProfile();
    size  = paths->GetXaxis()->GetNbins();
  } else
  if (( me = getter.get(current_path + "/paths_exclusive_time") )) {
    paths = me->getTProfile();
    size  = paths->GetXaxis()->GetNbins();
  }

  if (paths == nullptr)
    return;

  // for each path, fill histograms with
  //  - the average time spent in each module (total time spent in that module, averaged over all events)
  //  - the running time spent in each module (total time spent in that module, averaged over the events where that module actually ran)
  //  - the "efficiency" of each module (number of time a module succeded divided by the number of times the has run)
  booker.setCurrentFolder(current_path + "/Paths");
  for (uint32_t p = 1; p <= size; ++p) {
    // extract the list of Paths and EndPaths from the bin labels of one of the summary plots
    std::string label = paths->GetXaxis()->GetBinLabel(p);
    MonitorElement * me_counter = getter.get( current_path + "/Paths/" + label + "_module_counter" );
    MonitorElement * me_total   = getter.get( current_path + "/Paths/" + label + "_module_total" );
    if (me_counter == 0 or me_total == 0)
      continue;
    TH1F * counter = me_counter->getTH1F();
    TH1F * total   = me_total  ->getTH1F();
    uint32_t bins = counter->GetXaxis()->GetNbins();
    double   min  = counter->GetXaxis()->GetXmin();
    double   max  = counter->GetXaxis()->GetXmax();
    booker.setCurrentFolder(current_path + "/Paths");

    TH1F * average;
    TH1F * running;
    TH1F * efficiency;
    MonitorElement * me;

    me = getter.get( current_path + "/Paths/" + label + "_module_average" );
    if (me) {
      average = me->getTH1F();
      assert( me->getTH1F()->GetXaxis()->GetNbins() == (int) bins );
      assert( me->getTH1F()->GetXaxis()->GetXmin()  == min );
      assert( me->getTH1F()->GetXaxis()->GetXmax()  == max );
      average->Reset();
    } else {
      average = booker.book1D(label + "_module_average", label + " module average", bins, min, max)->getTH1F();
      average->SetYTitle("processing time [ms]");
      for (uint32_t i = 1; i <= bins; ++i) {
        const char * module = counter->GetXaxis()->GetBinLabel(i);
        average->GetXaxis()->SetBinLabel(i, module);
      }
    }

    me = getter.get( current_path + "/Paths/" + label + "_module_running" );
    if (me) {
      running = me->getTH1F();
      assert( me->getTH1F()->GetXaxis()->GetNbins() == (int) bins );
      assert( me->getTH1F()->GetXaxis()->GetXmin()  == min );
      assert( me->getTH1F()->GetXaxis()->GetXmax()  == max );
      running->Reset();
    } else {
      running = booker.book1D(label + "_module_running", label + " module running", bins, min, max)->getTH1F();
      running->SetYTitle("processing time [ms]");
      for (uint32_t i = 1; i <= bins; ++i) {
        const char * module = counter->GetXaxis()->GetBinLabel(i);
        running->GetXaxis()->SetBinLabel(i, module);
      }
    }

    me = getter.get( current_path + "/Paths/" + label + "_module_efficiency" );
    if (me) {
      efficiency = me->getTH1F();
      assert( me->getTH1F()->GetXaxis()->GetNbins() == (int) bins );
      assert( me->getTH1F()->GetXaxis()->GetXmin()  == min );
      assert( me->getTH1F()->GetXaxis()->GetXmax()  == max );
      efficiency->Reset();
    } else {
      efficiency = booker.book1D(label + "_module_efficiency", label + " module efficiency", bins, min, max)->getTH1F();
      efficiency->SetYTitle("filter efficiency");
      efficiency->SetMaximum(1.05);
      for (uint32_t i = 1; i <= bins; ++i) {
        const char * module = counter->GetXaxis()->GetBinLabel(i);
        efficiency->GetXaxis()->SetBinLabel(i, module);
      }
    }

    for (uint32_t i = 1; i <= bins; ++i) {
      double t = total  ->GetBinContent(i);
      double n = counter->GetBinContent(i);
      double p = counter->GetBinContent(i+1);
      average ->SetBinContent(i, t / events);
      if (n) {
        running   ->SetBinContent(i, t / n);
        efficiency->SetBinContent(i, p / n);
      }
    }
  }

}

void FastTimerServiceClient::fillProcessSummaryPlots ( DQMStore::IBooker &  booker, DQMStore::IGetter &  getter, std::string const &  path  )

private

Definition at line 89 of file FastTimerServiceClient.cc.

References DQMStore::IGetter::dirExists(), patZpeak::events, fillPathSummaryPlots(), DQMStore::IGetter::get(), DQMStore::IGetter::getSubdirs(), MonitorElement::getTH1F(), relval_parameters_module::process_name, and DQMStore::IBooker::setCurrentFolder().

Referenced by fillSummaryPlots().

                                                                                                                                  {
  MonitorElement * me = getter.get(current_path + "/event");
  if (me == 0)
    // no FastTimerService DQM information
    return;

  double events = me->getTH1F()->GetEntries();

  // look for per-process directories
  static const boost::regex process_name(".*/process .*");
  booker.setCurrentFolder(current_path);
  std::vector<std::string> subdirs = getter.getSubdirs();
  for (auto const & subdir: subdirs) {
    if (boost::regex_match(subdir, process_name)) {
      // look for per-path plots inside each per-process directory
      if (getter.dirExists(subdir + "/Paths"))
        fillPathSummaryPlots(booker, getter, events, subdir);
    }
  }

  // look for per-path plots inside the current directory
  if (getter.dirExists(current_path + "/Paths"))
    fillPathSummaryPlots(booker, getter, events, current_path);
}

void FastTimerServiceClient::fillSummaryPlots ( DQMStore::IBooker &  booker, DQMStore::IGetter &  getter  )

private

Definition at line 67 of file FastTimerServiceClient.cc.

References fillProcessSummaryPlots(), DQMStore::IGetter::get(), DQMStore::IGetter::getSubdirs(), m_dqm_path, and DQMStore::IBooker::setCurrentFolder().

Referenced by dqmEndJob(), and dqmEndLuminosityBlock().

{
  if (getter.get(m_dqm_path + "/event")) {
    // the plots are directly in the configured folder
    fillProcessSummaryPlots(booker, getter, m_dqm_path);
  } else {
    static const boost::regex running_n_processes(".*/Running [0-9]+ processes");
    booker.setCurrentFolder(m_dqm_path);
    std::vector<std::string> subdirs = getter.getSubdirs();
    for (auto const & subdir: subdirs) {
      if (boost::regex_match(subdir, running_n_processes)) {
        // the plots are in a per-number-of-processes folder
        if (getter.get(subdir + "/event"))
          fillProcessSummaryPlots(booker, getter, subdir);
      }
    }
  }
}

Member Data Documentation

std::string FastTimerServiceClient::m_dqm_path

private

Definition at line 34 of file FastTimerServiceClient.cc.

Referenced by fillSummaryPlots().