#include <MetricsSvc.h>

Inheritance diagram for EL::MetricsSvc:

Collaboration diagram for EL::MetricsSvc:

Public Member Functions
void	testInvariant () const
	effects: test the invariant of this object guarantee: no-fail
	MetricsSvc ()
	effects: standard constructor.
	~MetricsSvc ()
	effects: standard destructor.
virtual const char *	GetName () const override
	effects: return the name of this algorithm guarantee: no-fail
IWorker *	wk () const
	description: the worker that is controlling us guarantee: no-fail
void	book (const TH1 &hist)
	book the given histogram
TH1 *	hist (const std::string &name) const
	get the histogram with the given name
asg::SgEvent *	evtStore () const
	get the (main) event store for this algorithm
virtual const std::string &	name () const

MsgStream &	msg () const
	messaging interface
MsgStream &	msg (int level) const
	the message stream for this object, configured for the given level
bool	msgLvl (int lvl) const
	whether we are configured to print messages at the given level
void	setMsgLevel (int level)
	set the message level for the message stream for this object

Static Public Attributes
static const std::string	name
	description: the name of the service

Private Member Functions
virtual StatusCode	fileExecute () override
	effects: do all the processing that needs to be done once per file guarantee: no-fail
virtual StatusCode	endOfFile () override
	effects: do the post-processing for each input file guarantee: basic failures: out of memory failures: in/out trees or input file not available
virtual StatusCode	histInitialize () override
	effects: create the output TTrees guarantee: basic failures: out of memory failures: output already exists
virtual StatusCode	execute () override
	effects: process the next event guarantee: no-fail
virtual StatusCode	histFinalize () override
	effects: do the job post-processing guarantee: basic failures: out of memory failures: in/out trees or input file not available
	ClassDef (MetricsSvc, 1)
virtual StatusCode	setupJob (Job &job)
	effects: give the algorithm a chance to intialize the job with anything this algorithm needs.
virtual StatusCode	changeInput (bool firstFile)
	effects: do all changes to work with a new input file, e.g.
virtual StatusCode	initialize ()
	effects: do everything that needs to be done before running the algorithm, e.g.
virtual StatusCode	postExecute ()
	effects: do the post-processing for the event guarantee: basic failures: algorithm dependent rationale: this is mainly used for specialized services that need to get input from subsequent algorithms before filling their event data
virtual StatusCode	finalize ()
	effects: do everything that needs to be done after completing work on this worker guarantee: basic failures: algorithm dependent rationale: currently there is no use foreseen, but this routine is provided regardless
virtual bool	hasName (const std::string &name) const
	returns: whether this algorithm has the given name guarantee: basic failures: algorithm dependent rationale: this is to allow an algorithm to be known by multiple names.
void	sysSetupJob (Job &job)
	effects: give the algorithm a chance to intialize the job with anything this algorithm needs.

Private Attributes
TTree *	m_fileMetrics
	description: the file cache metrics
TTree *	m_jobMetrics
	description: the job metrics
Int_t	m_filesRead
	description: the number of files processed
Int_t	m_eventsRead
	description: the number of events processed
TBenchmark *	m_benchmark
	description: the benchmark object used rationale: this is a pointer to avoid including the header in this file
Int_t	m_nBranches = 0
	buffers for the per-file cache-stats branches
Int_t	m_nLearn = 0
Double_t	m_cacheEfficiency = 0
Double_t	m_cacheEfficiencyRel = 0
Long64_t	m_bytesRead = 0
Int_t	m_readCalls = 0
Long64_t	m_noCacheBytesRead = 0
Int_t	m_noCacheReadCalls = 0
Int_t	m_readaheadSize = 0
Long64_t	m_bytesReadExtra = 0
IWorker *	m_wk
asg::SgEvent *	m_evtStorePtr = nullptr
	the value of evtStore
asg::SgEvent	m_evtStore
	when configured, the object returned by evtStore
MsgStream *	m_msg = nullptr
	the message stream, if it has been instantiated
std::string	m_msgName
	the algorithm name for which the message stream has been instantiated
int	m_msgLevel = 3
	the message level configured
std::string	m_nameCache
	the cache for name

Detailed Description

Definition at line 18 of file MetricsSvc.h.

Constructor & Destructor Documentation

◆ MetricsSvc()

EL::MetricsSvc::MetricsSvc ( )

effects: standard constructor.

guarantee: no-fail

Definition at line 33 of file MetricsSvc.cxx.

  : m_fileMetrics (0), m_jobMetrics (0), m_filesRead (0)
  , m_eventsRead (0), m_benchmark (0)
{
  RCU_NEW_INVARIANT (this);
}

◆ ~MetricsSvc()

EL::MetricsSvc::~MetricsSvc ( )

effects: standard destructor.

guarantee: no-fail

Definition at line 42 of file MetricsSvc.cxx.

{
  RCU_DESTROY_INVARIANT (this);
  if (m_benchmark) { delete m_benchmark; }
}

Member Function Documentation

◆ book()

void EL::Algorithm::book ( const TH1 & hist )

inherited

book the given histogram

Guarantee: strong

Failures: histogram booking error

◆ changeInput()

virtual StatusCode EL::Algorithm::changeInput ( bool firstFile )

privatevirtualinherited

effects: do all changes to work with a new input file, e.g.

set new branch addresses. if firstFile is set, this method is called just before init() is called

Warning: If a file is split across multiple jobs this will be called more than once. This only happens for specific batch drivers and/or if it is explicitly configured by the user. With PROOF it could even happen multiple times within the same job, and while PROOF is no longer supported that behavior may come back if support for a similar framework is added in the future. As such, this method should not be used for accounting that relies to be called exactly once per file, take a look at fileExecute() if you want something that is guaranteed to be executed exactly once per input file.

Warning: The execution order of changeInput and fileExecute is currently unspecified.

guarantee: basic failures: algorithm dependent

Reimplemented in EL::DuplicateChecker, EL::NTupleSvc, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::UnitTestSkim, and MD::FormulaSvc.

◆ ClassDef()

EL::MetricsSvc::ClassDef	(	MetricsSvc	,
		1	)

private

◆ endOfFile()

EL::StatusCode EL::MetricsSvc::endOfFile ( )

overrideprivatevirtual

effects: do the post-processing for each input file guarantee: basic failures: out of memory failures: in/out trees or input file not available

Reimplemented from EL::Algorithm.

Definition at line 86 of file MetricsSvc.cxx.

{
  RCU_CHANGE_INVARIANT (this);
  RCU_ASSERT(m_fileMetrics); 
  RCU_ASSERT(wk()->inputFile()); 
  RCU_ASSERT(wk()->tree()); 
  TTreeCache *tc = (TTreeCache*)wk()->inputFile()->GetCacheRead(wk()->tree());
  if (tc) {
    // update the member buffers wired to the branches in histInitialize
    m_nBranches = tc->GetCachedBranches()->GetEntries();
    m_nLearn = tc->GetLearnEntries();
    m_cacheEfficiency = tc->GetEfficiency ();
    m_cacheEfficiencyRel = tc->GetEfficiencyRel ();
    m_bytesRead = tc->GetBytesRead ();
    m_readCalls = tc->GetReadCalls ();
    m_noCacheBytesRead = tc->GetNoCacheBytesRead ();
    m_noCacheReadCalls = tc->GetNoCacheReadCalls ();
    m_readaheadSize = TFile::GetReadaheadSize ();
    m_bytesReadExtra = tc->GetBytesReadExtra ();
    m_fileMetrics->Fill ();
  }
  return EL::StatusCode::SUCCESS;
}

◆ evtStore()

asg::SgEvent * EL::Algorithm::evtStore ( ) const

inherited

get the (main) event store for this algorithm

This is mostly to mirror the method of the same name in AthAlgorithm, allowing to make the tutorial instructions more dual-use.

Guarantee: strong

Failures: out of memory I
job not configured for xAODs

◆ execute()

EL::StatusCode EL::MetricsSvc::execute ( )

overrideprivatevirtual

effects: process the next event guarantee: no-fail

Reimplemented from EL::Algorithm.

Definition at line 112 of file MetricsSvc.cxx.

{
  RCU_CHANGE_INVARIANT (this);
  m_eventsRead ++;
  return EL::StatusCode::SUCCESS;
}

◆ fileExecute()

EL::StatusCode EL::MetricsSvc::fileExecute ( )

overrideprivatevirtual

effects: do all the processing that needs to be done once per file guarantee: no-fail

Reimplemented from EL::Algorithm.

Definition at line 77 of file MetricsSvc.cxx.

{
  RCU_CHANGE_INVARIANT (this);
  m_filesRead ++;
  return EL::StatusCode::SUCCESS;
}

◆ finalize()

virtual StatusCode EL::Algorithm::finalize ( )

privatevirtualinherited

effects: do everything that needs to be done after completing work on this worker guarantee: basic failures: algorithm dependent rationale: currently there is no use foreseen, but this routine is provided regardless

Reimplemented in EL::UnitTestAlg1, EL::UnitTestAlg, and EL::UnitTestAlgXAOD.

◆ GetName()

const char * EL::MetricsSvc::GetName ( ) const

overridevirtual

effects: return the name of this algorithm guarantee: no-fail

Definition at line 26 of file MetricsSvc.cxx.

{
  RCU_READ_INVARIANT (this);
  return name.c_str();
}

◆ hasName()

virtual bool EL::Algorithm::hasName ( const std::string & name ) const

privatevirtualinherited

returns: whether this algorithm has the given name guarantee: basic failures: algorithm dependent rationale: this is to allow an algorithm to be known by multiple names.

this is needed for NTupleSvc, so that it can be located with and without the output tree name.

Reimplemented in EL::NTupleSvc.

◆ hist()

TH1 * EL::Algorithm::hist ( const std::string & name ) const

inherited

get the histogram with the given name

Guarantee: strong

Failures: histogram not found

◆ histFinalize()

EL::StatusCode EL::MetricsSvc::histFinalize ( )

overrideprivatevirtual

effects: do the job post-processing guarantee: basic failures: out of memory failures: in/out trees or input file not available

Reimplemented from EL::Algorithm.

Definition at line 121 of file MetricsSvc.cxx.

{
  RCU_CHANGE_INVARIANT (this);
  m_benchmark->Stop("loopmetrics");
  m_jobMetrics->Branch("eventsRead", &m_eventsRead, "eventsRead/I");
  m_jobMetrics->Branch("filesRead", &m_filesRead, "filesRead/I");
  Float_t realTime = m_benchmark->GetRealTime("loopmetrics");
  m_jobMetrics->Branch("loopWallTime", &realTime, "loopWallTime/F");
  Float_t cpuTime = m_benchmark->GetCpuTime("loopmetrics");
  m_jobMetrics->Branch("loopCpuTime", &cpuTime, "loopCpuTime/F");
  Float_t evtsWallSec = m_eventsRead / (realTime != 0 ? realTime : 1.);
  m_jobMetrics->Branch("eventsPerWallSec", &evtsWallSec, "eventsPerWallSec/F");
  Float_t evtsCpuSec = m_eventsRead / (cpuTime != 0 ? cpuTime : 1.);  
  m_jobMetrics->Branch("eventsPerCpuSec", &evtsCpuSec, "eventsPerCpuSec/F");
  m_jobMetrics->Fill();
  return EL::StatusCode::SUCCESS;
}

◆ histInitialize()

EL::StatusCode EL::MetricsSvc::histInitialize ( )

overrideprivatevirtual

effects: create the output TTrees guarantee: basic failures: out of memory failures: output already exists

Reimplemented from EL::Algorithm.

Definition at line 50 of file MetricsSvc.cxx.

{ 
  RCU_CHANGE_INVARIANT (this);
  m_benchmark = new TBenchmark;
  m_benchmark->Start("loopmetrics");
  wk()->addOutput (m_fileMetrics = new TTree ("EventLoop_Metrics/cacheStats",
                          "TTree cache stats per file"));
  wk()->addOutput (m_jobMetrics = new TTree ("EventLoop_Metrics/jobs",
                         "event throughput per job"));
 
  // Create the per-file branches once, pointing at the member buffers, so
  // that the branch addresses stay valid across every per-file Fill().
  m_fileMetrics->Branch ("nBranches", &m_nBranches, "nBranches/I");
  m_fileMetrics->Branch ("learnEntries", &m_nLearn, "learnEntries/I");
  m_fileMetrics->Branch ("cacheEfficiency", &m_cacheEfficiency, "cacheEfficiency/D");
  m_fileMetrics->Branch ("cacheEfficiencyRel", &m_cacheEfficiencyRel, "cacheEfficiencyRel/D");
  m_fileMetrics->Branch ("bytesRead", &m_bytesRead, "bytesRead/L");
  m_fileMetrics->Branch ("readCalls", &m_readCalls, "readCalls/I");
  m_fileMetrics->Branch ("noCacheBytesRead", &m_noCacheBytesRead, "noCacheBytesRead/L");
  m_fileMetrics->Branch ("noCacheReadCalls", &m_noCacheReadCalls, "noCacheReadCalls/I");
  m_fileMetrics->Branch ("readaheadSize", &m_readaheadSize, "readaheadSize/I");
  m_fileMetrics->Branch ("bytesReadExtra", &m_bytesReadExtra, "bytesReadExtra/L");
  return EL::StatusCode::SUCCESS;
}

◆ initialize()

virtual StatusCode EL::Algorithm::initialize ( )

privatevirtualinherited

effects: do everything that needs to be done before running the algorithm, e.g.

create output n-tuples and histograms. this method is called only once right after changeInput(true) is called guarantee: basic failures: algorithm dependent rationale: in principle all this work could be done on changeInput(true). However, providing this method should make it easier for the user to set up all his outputs and to do so only once.

Reimplemented in EL::AlgSelect, EL::DuplicateChecker, EL::NTupleSvc, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::UnitTestSkim, MD::AlgCFlow, and MD::AlgHist.

◆ msg() [1/2]

MsgStream & EL::Algorithm::msg ( ) const

inherited

messaging interface

this is the interface to work with the standard messaging macros from AsgTools. Instead of enums I pass ints, so that I can avoid the include dependency (forward declarations are only allowed for enum classes AFAIK).

the standard message stream for this object

Guarantee: strong

Failures: code not compiled with AsgTools support

◆ msg() [2/2]

MsgStream & EL::Algorithm::msg ( int level ) const

inherited

the message stream for this object, configured for the given level

Guarantee: strong

Failures: code not compiled with AsgTools support

◆ msgLvl()

bool EL::Algorithm::msgLvl ( int lvl ) const

inherited

whether we are configured to print messages at the given level

Guarantee: no-fail

◆ name()

virtual const std::string & EL::Algorithm::name ( ) const

virtualinherited

◆ postExecute()

virtual StatusCode EL::Algorithm::postExecute ( )

privatevirtualinherited

effects: do the post-processing for the event guarantee: basic failures: algorithm dependent rationale: this is mainly used for specialized services that need to get input from subsequent algorithms before filling their event data

Reimplemented in EL::NTupleSvc.

◆ setMsgLevel()

void EL::Algorithm::setMsgLevel ( int level )

inherited

set the message level for the message stream for this object

Guarantee: no-fail

◆ setupJob()

virtual StatusCode EL::Algorithm::setupJob ( Job & job )

privatevirtualinherited

effects: give the algorithm a chance to intialize the job with anything this algorithm needs.

this method is automatically called before the algorithm is actually added to the job. guarantee: basic failures: algorithm dependent rationale: this is currently used to give algorithms a chance to register their output datasets, but can also be used for other stuff.

Reimplemented in EL::AlgSelect, EL::DuplicateChecker, EL::NTupleSvc, EL::UnitTestAlg1, EL::UnitTestAlg, EL::UnitTestAlgXAOD, EL::VomsProxySvc, MD::AlgCFlow, and MD::AlgHist.

◆ sysSetupJob()

void EL::Algorithm::sysSetupJob ( Job & job )

privateinherited

effects: give the algorithm a chance to intialize the job with anything this algorithm needs.

this method is automatically called before the algorithm is actually added to the job. guarantee: basic failures: algorithm dependent rationale: this is currently used to give algorithms a chance to register their output datasets, but can also be used for other stuff.

◆ testInvariant()

void EL::MetricsSvc::testInvariant ( ) const

effects: test the invariant of this object guarantee: no-fail

Definition at line 23 of file MetricsSvc.cxx.

24{}

◆ wk()

IWorker * EL::Algorithm::wk ( ) const

inherited

description: the worker that is controlling us guarantee: no-fail

Member Data Documentation

◆ m_benchmark

TBenchmark* EL::MetricsSvc::m_benchmark

private

description: the benchmark object used rationale: this is a pointer to avoid including the header in this file

Definition at line 117 of file MetricsSvc.h.

◆ m_bytesRead

Long64_t EL::MetricsSvc::m_bytesRead = 0

private

Definition at line 129 of file MetricsSvc.h.

◆ m_bytesReadExtra

Long64_t EL::MetricsSvc::m_bytesReadExtra = 0

private

Definition at line 134 of file MetricsSvc.h.

◆ m_cacheEfficiency

Double_t EL::MetricsSvc::m_cacheEfficiency = 0

private

Definition at line 127 of file MetricsSvc.h.

std::string EL::Algorithm::m_nameCache

mutableprivateinherited

the cache for name

Definition at line 343 of file Algorithm.h.

◆ m_nBranches

Int_t EL::MetricsSvc::m_nBranches = 0

private

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MetricsSvc()

◆ ~MetricsSvc()

Member Function Documentation

◆ book()

◆ changeInput()

◆ ClassDef()

◆ endOfFile()

◆ evtStore()

◆ execute()

◆ fileExecute()

◆ finalize()

◆ GetName()

◆ hasName()

◆ hist()

◆ histFinalize()

◆ histInitialize()

◆ initialize()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ postExecute()

◆ setMsgLevel()

◆ setupJob()

◆ sysSetupJob()

◆ testInvariant()

◆ wk()

Member Data Documentation

◆ m_benchmark

◆ m_bytesRead

◆ m_bytesReadExtra

◆ m_cacheEfficiency

◆ m_cacheEfficiencyRel

◆ m_eventsRead

◆ m_evtStore

◆ m_evtStorePtr

◆ m_fileMetrics

◆ m_filesRead

◆ m_jobMetrics

◆ m_msg

◆ m_msgLevel

◆ m_msgName

◆ m_nameCache

◆ m_nBranches

◆ m_nLearn

◆ m_noCacheBytesRead

◆ m_noCacheReadCalls

◆ m_readaheadSize

◆ m_readCalls

◆ m_wk

◆ name