#include <JobReport.h>
Classes | |
struct | InputFile |
struct | JobReportImpl |
struct | LumiSectionReport |
struct | OutputFile |
struct | RunReport |
Public Types | |
typedef unsigned int | RunNumber |
typedef std::size_t | Token |
Public Member Functions | |
void | childAfterFork (std::string const &jobReportFile, unsigned int childIndex, unsigned int numberOfChildren) |
New output file for child. More... | |
std::string | dumpFiles (void) |
debug/test util More... | |
void | eventReadFromFile (Token fileToken, unsigned int run, unsigned int event) |
void | eventWrittenToFile (Token fileToken, unsigned int run, unsigned int event) |
void | inputFileClosed (Token fileToken) |
Token | inputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, std::string const &inputType, std::string const &inputSourceClassName, std::string const &moduleLabel, std::string const &guid, std::vector< std::string > const &branchNames) |
JobReport () | |
JobReport (std::ostream *outputStream) | |
void | outputFileClosed (Token fileToken) |
Token | outputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, std::string const &outputModuleClassName, std::string const &moduleLabel, std::string const &guid, std::string const &dataType, std::string const &branchHash, std::vector< std::string > const &branchNames) |
void | overrideContributingInputs (Token outputToken, std::vector< Token > const &inputTokens) |
void | overrideEventsRead (Token fileToken, int const eventsRead) |
void | overrideEventsWritten (Token fileToken, int const eventsWritten) |
void | parentAfterFork (std::string const &jobReportFile) |
void | parentBeforeFork (std::string const &jobReportFile, unsigned int numberOfChildren) |
void | reportAnalysisFile (std::string const &fileName, std::map< std::string, std::string > const &fileData) |
void | reportDataType (Token fileToken, std::string const &dataType) |
void | reportError (std::string const &shortDesc, std::string const &longDesc) |
void | reportError (std::string const &shortDesc, std::string const &longDesc, int const &exitCode) |
void | reportFallbackAttempt (std::string const &pfn, std::string const &lfn, std::string const &err) |
void | reportFastClonedBranches (std::set< std::string > const &fastClonedBranches, long long nEvents) |
Inform the job report that branches have been fast Cloned. More... | |
void | reportFastCopyingStatus (Token t, std::string const &inputFileName, bool fastCopying) |
void | reportGeneratorInfo (std::string const &name, std::string const &value) |
void | reportInputLumiSection (unsigned int run, unsigned int lumiSectId) |
void | reportInputRunNumber (unsigned int run) |
void | reportLumiSection (unsigned int run, unsigned int lumiSectId) |
void | reportMemoryInfo (std::vector< std::string > const &memoryData) |
void | reportMessageInfo (std::map< std::string, double > const &messageData) |
void | reportPerformanceForModule (std::string const &metricClass, std::string const &moduleName, std::map< std::string, std::string > const &metrics) |
void | reportPerformanceSummary (std::string const &metricClass, std::map< std::string, std::string > const &metrics) |
void | reportPSetHash (std::string const &hashValue) |
void | reportRandomStateFile (std::string const &name) |
void | reportReadBranch (std::string const &branchName) |
Inform the job report that a branch has been read. More... | |
void | reportReadBranches () |
void | reportRunNumber (unsigned int run) |
void | reportSkippedEvent (unsigned int run, unsigned int event) |
void | reportSkippedFile (std::string const &pfn, std::string const &lfn) |
~JobReport () | |
Protected Member Functions | |
boost::scoped_ptr < JobReportImpl > & | impl () |
Private Attributes | |
boost::scoped_ptr< JobReportImpl > | impl_ |
Definition at line 40 of file JobReport.h.
typedef unsigned int edm::JobReport::RunNumber |
Definition at line 42 of file JobReport.h.
typedef std::size_t edm::JobReport::Token |
Definition at line 43 of file JobReport.h.
JobReport::JobReport | ( | ) |
Definition at line 435 of file JobReport.cc.
JobReport::JobReport | ( | std::ostream * | outputStream | ) |
JobReport::~JobReport | ( | ) |
void JobReport::childAfterFork | ( | std::string const & | jobReportFile, |
unsigned int | childIndex, | ||
unsigned int | numberOfChildren | ||
) |
New output file for child.
Definition at line 492 of file JobReport.cc.
References impl_, and AlCaHLTBitMon_ParallelJobs::p.
std::string JobReport::dumpFiles | ( | void | ) |
debug/test util
Definition at line 888 of file JobReport.cc.
References f, edm::findOrDefault(), impl_, edm::JobReport::InputFile::logicalFileName, lumiQueryAPI::msg, and edm::JobReport::InputFile::physicalFileName.
void JobReport::eventReadFromFile | ( | JobReport::Token | fileToken, |
unsigned int | run, | ||
unsigned int | event | ||
) |
Report that the event with the given id has been read from the file identified by the given Token.
Definition at line 537 of file JobReport.cc.
References f, impl_, and edm::JobReport::InputFile::numEventsRead.
void JobReport::eventWrittenToFile | ( | JobReport::Token | fileToken, |
unsigned int | run, | ||
unsigned int | event | ||
) |
Report that the event with the given id has been written to the file identified by the given Token.
Definition at line 593 of file JobReport.cc.
References f, impl_, and edm::JobReport::OutputFile::numEventsWritten.
|
inlineprotected |
Definition at line 431 of file JobReport.h.
References impl_.
Referenced by edm::service::JobReportService::frameworkShutdownOnFailure(), and edm::service::JobReportService::postEndJob().
void JobReport::inputFileClosed | ( | JobReport::Token | fileToken | ) |
Report that the input file identified by the given Token has been closed. An exception will be thrown if the given Token was not obtained from inputFileOpened.
Definition at line 550 of file JobReport.cc.
References f, edm::JobReport::InputFile::fileHasBeenClosed, and impl_.
Referenced by DQMRootSource::closeFile_().
JobReport::Token JobReport::inputFileOpened | ( | std::string const & | physicalFileName, |
std::string const & | logicalFileName, | ||
std::string const & | catalog, | ||
std::string const & | inputType, | ||
std::string const & | inputSourceClassName, | ||
std::string const & | moduleLabel, | ||
std::string const & | guid, | ||
std::vector< std::string > const & | branchNames | ||
) |
Report that an input file has been opened. The returned Token should be used for later identification of this file.
Definition at line 502 of file JobReport.cc.
References edm::JobReport::InputFile::branchNames, validate_alignment_devdb10_cfg::catalog, edm::JobReport::InputFile::catalog, edm::JobReport::InputFile::fastClonedBranches, edm::JobReport::InputFile::fileHasBeenClosed, edm::JobReport::InputFile::guid, impl_, edm::JobReport::InputFile::inputSourceClassName, edm::JobReport::InputFile::inputType, edm::JobReport::InputFile::logicalFileName, edm::JobReport::InputFile::moduleLabel, edm::JobReport::InputFile::numEventsRead, edm::JobReport::InputFile::physicalFileName, and alignCSCRings::r.
Referenced by DQMRootSource::readFile_().
void JobReport::outputFileClosed | ( | JobReport::Token | fileToken | ) |
Report that the output file identified by the given Token has been closed. An exception will be thrown if the given Token was not obtained from outputFileOpened.
Definition at line 600 of file JobReport.cc.
References f, edm::JobReport::OutputFile::fileHasBeenClosed, and impl_.
Referenced by DQMRootOutputModule::finishEndFile().
JobReport::Token JobReport::outputFileOpened | ( | std::string const & | physicalFileName, |
std::string const & | logicalFileName, | ||
std::string const & | catalog, | ||
std::string const & | outputModuleClassName, | ||
std::string const & | moduleLabel, | ||
std::string const & | guid, | ||
std::string const & | dataType, | ||
std::string const & | branchHash, | ||
std::vector< std::string > const & | branchNames | ||
) |
Report that an output file has been opened. The returned Token should be used for later identification of this file.
Definition at line 561 of file JobReport.cc.
References edm::JobReport::OutputFile::branchHash, edm::JobReport::OutputFile::branchNames, validate_alignment_devdb10_cfg::catalog, edm::JobReport::OutputFile::catalog, edm::JobReport::OutputFile::contributingInputs, dtTPAnalyzer_cfg::dataType, edm::JobReport::OutputFile::dataType, edm::JobReport::OutputFile::fileHasBeenClosed, edm::JobReport::OutputFile::guid, impl_, edm::JobReport::OutputFile::logicalFileName, edm::JobReport::OutputFile::moduleLabel, edm::JobReport::OutputFile::numEventsWritten, edm::JobReport::OutputFile::outputModuleClassName, edm::JobReport::OutputFile::physicalFileName, and alignCSCRings::r.
Referenced by DQMRootOutputModule::openFile().
void JobReport::overrideContributingInputs | ( | Token | outputToken, |
std::vector< Token > const & | inputTokens | ||
) |
Override the list of input files seen by an output file for use with EdmFastMerge
Definition at line 633 of file JobReport.cc.
References edm::JobReport::OutputFile::contributingInputs, f, and impl_.
void JobReport::overrideEventsRead | ( | Token | fileToken, |
int const | eventsRead | ||
) |
For use by fast merge: Since the event by event counter cant be used for fast merges, use this method to forcibly set the events read count for an input file before reporting it closed
Definition at line 625 of file JobReport.cc.
References f, impl_, and edm::JobReport::InputFile::numEventsRead.
void JobReport::overrideEventsWritten | ( | Token | fileToken, |
int const | eventsWritten | ||
) |
For use by fast merge: Since the event by event counter cant be used for fast merges, use this method to forcibly set the events written count for an output file before reporting it closed
Definition at line 617 of file JobReport.cc.
References f, impl_, and edm::JobReport::OutputFile::numEventsWritten.
void JobReport::parentAfterFork | ( | std::string const & | jobReportFile | ) |
Definition at line 488 of file JobReport.cc.
void JobReport::parentBeforeFork | ( | std::string const & | jobReportFile, |
unsigned int | numberOfChildren | ||
) |
Definition at line 470 of file JobReport.cc.
References i, impl_, and AlCaHLTBitMon_ParallelJobs::p.
void JobReport::reportAnalysisFile | ( | std::string const & | fileName, |
std::map< std::string, std::string > const & | fileData | ||
) |
Definition at line 685 of file JobReport.cc.
References impl_, lumiQueryAPI::msg, and pos.
Referenced by TFileService::afterBeginJob(), DQMStoreStats::calcstats(), PCLMetadataWriter::endRun(), and DQMFileSaver::saveJobReport().
void JobReport::reportDataType | ( | Token | fileToken, |
std::string const & | dataType | ||
) |
Report the data type of a file after it has been opened Needed since the data type isn't known until an event has been read
Definition at line 544 of file JobReport.cc.
References dtTPAnalyzer_cfg::dataType, edm::JobReport::OutputFile::dataType, f, and impl_.
void JobReport::reportError | ( | std::string const & | shortDesc, |
std::string const & | longDesc | ||
) |
Report an exception, providing details of the problem as a short description (Eg "XXXError") and a long description (Eg "XXX crashed because...") Also overload this method to accept an optional standard exit code
Definition at line 672 of file JobReport.cc.
References impl_, and lumiQueryAPI::msg.
Referenced by edm::printCmsException(), and edm::printCmsExceptionWarning().
void JobReport::reportError | ( | std::string const & | shortDesc, |
std::string const & | longDesc, | ||
int const & | exitCode | ||
) |
void JobReport::reportFallbackAttempt | ( | std::string const & | pfn, |
std::string const & | lfn, | ||
std::string const & | err | ||
) |
Definition at line 735 of file JobReport.cc.
References impl_, lumiQueryAPI::msg, and TiXmlElement::SetAttribute().
void JobReport::reportFastClonedBranches | ( | std::set< std::string > const & | fastClonedBranches, |
long long | nEvents | ||
) |
Inform the job report that branches have been fast Cloned.
Definition at line 806 of file JobReport.cc.
void JobReport::reportFastCopyingStatus | ( | JobReport::Token | fileToken, |
std::string const & | inputFileName, | ||
bool | fastCopying | ||
) |
Definition at line 611 of file JobReport.cc.
References f, edm::JobReport::OutputFile::fastCopyingInputs, and impl_.
void JobReport::reportGeneratorInfo | ( | std::string const & | name, |
std::string const & | value | ||
) |
Report key/value style generator/lumi information Eg: reportGeneratorInfo("CrossSection" , "ValueHere") No special chars in the value string.
Definition at line 816 of file JobReport.cc.
References impl_.
void JobReport::reportInputLumiSection | ( | unsigned int | run, |
unsigned int | lumiSectId | ||
) |
API for reporting a Lumi Section to the job report. for input files, call only if lumi section is physically read from the input file
Definition at line 658 of file JobReport.cc.
References impl_.
Referenced by DQMRootSource::readLuminosityBlock_().
void JobReport::reportInputRunNumber | ( | unsigned int | run | ) |
API to report a run read from input
Definition at line 667 of file JobReport.cc.
References impl_.
Referenced by DQMRootSource::readRun_().
void JobReport::reportLumiSection | ( | unsigned int | run, |
unsigned int | lumiSectId | ||
) |
API for reporting a Lumi Section to the job report. for output files, call only if lumi section is written to the output file
Definition at line 653 of file JobReport.cc.
References impl_.
Referenced by DQMRootOutputModule::writeLuminosityBlock().
void JobReport::reportMemoryInfo | ( | std::vector< std::string > const & | memoryData | ) |
Report Memory statistics ALTERNATE FORM - USING THIS MAY NECESSITATE CHANGES IN PARSING XML! Invoked by the Memory service to send an end of job summary about memory usage for inclusion in the job report
Definition at line 749 of file JobReport.cc.
References impl_, lumiQueryAPI::msg, and pos.
void JobReport::reportMessageInfo | ( | std::map< std::string, double > const & | messageData | ) |
Report Message statistics Invoked by the MessageLogger service to send an end of job summary about numbers of various categories messages issued for inclusion in the job report
Definition at line 764 of file JobReport.cc.
References impl_, lumiQueryAPI::msg, and pos.
Referenced by edm::service::MessageLogger::SummarizeInJobReport().
void JobReport::reportPerformanceForModule | ( | std::string const & | metricClass, |
std::string const & | moduleName, | ||
std::map< std::string, std::string > const & | metrics | ||
) |
void JobReport::reportPerformanceSummary | ( | std::string const & | metricClass, |
std::map< std::string, std::string > const & | metrics | ||
) |
Performance Reports
Two categories: Summary for entire job and module for a specific module Each one requires a performance metric class such as Timing, Memory, CPU, Trigger etc.
Definition at line 844 of file JobReport.cc.
References impl_, and lumiQueryAPI::msg.
Referenced by TFileAdaptor::termination().
void JobReport::reportPSetHash | ( | std::string const & | hashValue | ) |
Report PSetHash
Definition at line 832 of file JobReport.cc.
References impl_, and lumiQueryAPI::msg.
void JobReport::reportRandomStateFile | ( | std::string const & | name | ) |
Report the name of the random engine persistency file
Definition at line 820 of file JobReport.cc.
References impl_, and lumiQueryAPI::msg.
void JobReport::reportReadBranch | ( | std::string const & | branchName | ) |
Inform the job report that a branch has been read.
Definition at line 798 of file JobReport.cc.
References impl_.
void JobReport::reportReadBranches | ( | ) |
Report read branches Invoked by the source that reads ROOT/EDM files at the end of a job to report which product branches in the Events tree have been read, with a count of the number of events for which the branch was read.
Definition at line 780 of file JobReport.cc.
References impl_, and TiXmlElement::SetAttribute().
void JobReport::reportRunNumber | ( | unsigned int | run | ) |
API to report the a run written to output
Definition at line 663 of file JobReport.cc.
References impl_.
Referenced by DQMRootOutputModule::writeRun().
void JobReport::reportSkippedEvent | ( | unsigned int | run, |
unsigned int | event | ||
) |
void JobReport::reportSkippedFile | ( | std::string const & | pfn, |
std::string const & | lfn | ||
) |
Report Skipped File
Report that a file has been skipped due to it not being found.
Definition at line 721 of file JobReport.cc.
References impl_, lumiQueryAPI::msg, and TiXmlElement::SetAttribute().
|
private |
Definition at line 434 of file JobReport.h.
Referenced by childAfterFork(), dumpFiles(), eventReadFromFile(), eventWrittenToFile(), impl(), inputFileClosed(), inputFileOpened(), JobReport(), outputFileClosed(), outputFileOpened(), overrideContributingInputs(), overrideEventsRead(), overrideEventsWritten(), parentBeforeFork(), reportAnalysisFile(), reportDataType(), reportError(), reportFallbackAttempt(), reportFastClonedBranches(), reportFastCopyingStatus(), reportGeneratorInfo(), reportInputLumiSection(), reportInputRunNumber(), reportLumiSection(), reportMemoryInfo(), reportMessageInfo(), reportPerformanceForModule(), reportPerformanceSummary(), reportPSetHash(), reportRandomStateFile(), reportReadBranch(), reportReadBranches(), reportRunNumber(), reportSkippedEvent(), reportSkippedFile(), and ~JobReport().