---

edm::JobReport Class Reference

#include <FWCore/MessageLogger/interface/JobReport.h>

Inheritance diagram for edm::JobReport:

List of all members.

Public Types
typedef unsigned int	RunNumber
typedef std::size_t	Token
Public Member Functions
std::string	dumpFiles (void)
	debug/test util
void	eventReadFromFile (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.
void	eventWrittenToFile (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.
void	inputFileClosed (Token fileToken)
	Report that the input file identified by the given Token has been closed.
Token	inputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, std::string const &inputSourceClassName, std::string const &moduleLabel, std::vector< std::string > const &branchNames)
Token	inputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, 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.
	JobReport (std::ostream *outputStream)
	JobReport ()
void	outputFileClosed (Token fileToken)
	Report that the output file identified by the given Token has been closed.
Token	outputFileOpened (std::string const &physicalFileName, std::string const &logicalFileName, std::string const &catalog, std::string const &outputModuleClassName, std::string const &moduleLabel, std::vector< std::string > const &branchNames)
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::vector< std::string > const &branchNames)
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::vector< std::string > const &branchNames)
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)
	Report that an output file has been opened.
void	overrideContributingInputs (Token outputToken, std::vector< Token > const &inputTokens)
	Override the list of input files seen by an output file for use with EdmFastMerge.
void	overrideEventsRead (Token fileToken, const int 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.
void	overrideEventsWritten (Token fileToken, const int 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.
void	reportAnalysisFile (std::string const &fileName, std::map< std::string, std::string > const &fileData)
void	reportDataType (Token fileToken, std::string const &dataType)
	Report the data type of a file after it has been opened Needed since the data type isnt known until an event has been read.
void	reportError (std::string const &shortDesc, std::string const &longDesc, int const &exitCode)
void	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.
void	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.
void	reportInputLumiSection (unsigned int run, unsigned int lumiSectId)
	API for reporting a Lumi Section to the job report.
void	reportInputRunNumber (unsigned int run)
	API to report a run read from input.
void	reportLumiSection (unsigned int run, unsigned int lumiSectId)
	API for reporting a Lumi Section to the job report.
void	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.
void	reportMemoryInfo (std::map< std::string, double > const &memoryData)
	Report Memory statistics Invoked by the Memory service to send an end of job summary about memory usage for inclusion in the job report.
void	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.
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)
	Performance Reports.
void	reportPSetHash (std::string const &hashValue)
	Report PSetHash.
void	reportRandomStateFile (std::string const &name)
	Report the name of the random engine persistency file.
void	reportRunNumber (unsigned int run)
	API to report the a run written to output.
void	reportSkippedEvent (unsigned int run, unsigned int event)
void	reportSkippedFile (std::string const &pfn, std::string const &lfn)
	Report Skipped File.
void	reportStorageStats (std::string const &data)
	Report Storage Statistics.
void	reportTimingInfo (std::map< std::string, double > const &timingData)
	Report Timing statistics Invoked by the Timing service to send an end of job summary about time taken for inclusion in the job report.
	~JobReport ()
Protected Member Functions
boost::scoped_ptr < JobReportImpl > &	impl ()
Private Attributes
boost::scoped_ptr< JobReportImpl >	impl_
Classes
struct	InputFile
	Description: Holds information about an InputFile. More...
struct	JobReportImpl
struct	LumiSectionReport
	Description: Holds information about a Lumi section associated to a file. More...
struct	OutputFile
	Description: Holds information about an OutputFile. More...
struct	RunReport

---

Detailed Description

Definition at line 37 of file JobReport.h.

---

Member Typedef Documentation

typedef unsigned int edm::JobReport::RunNumber

Definition at line 39 of file JobReport.h.

typedef std::size_t edm::JobReport::Token

Definition at line 40 of file JobReport.h.

---

Constructor & Destructor Documentation

JobReport::JobReport

(

)

Definition at line 432 of file JobReport.cc.

                         :
      impl_(new JobReportImpl(0)) {
    }

JobReport::JobReport

(

std::ostream *

outputStream

)

Definition at line 436 of file JobReport.cc.

References impl_.

                                             :
       impl_(new JobReportImpl(iOstream) ) {
         if(impl_->ost_) {
           *(impl_->ost_)<<"<FrameworkJobReport>\n";
         }
       }

JobReport::~JobReport

(

)

Definition at line 424 of file JobReport.cc.

References flush().

                        {
    impl_->writeGeneratorInfo();
    impl_->flushFiles();
    if(impl_->ost_) {
      *(impl_->ost_)<<"</FrameworkJobReport>\n"<<std::flush;
    }
  }

---

Member Function Documentation

std::string JobReport::dumpFiles

(

void

)

debug/test util

Definition at line 935 of file JobReport.cc.

References f, edm::JobReport::InputFile::logicalFileName, alivecheck_mergeAndRegister::msg, and edm::JobReport::InputFile::physicalFileName.

                          {

    std::ostringstream msg;

    std::vector<JobReport::OutputFile>::iterator f;

    for (f = impl_->outputFiles_.begin();
         f != impl_->outputFiles_.end(); f++){

      msg << "\n<File>";
      msg << *f;

      msg << "\n<LumiSections>";
      //std::vector<JobReport::LumiSectionReport>::iterator iLumi;
      //for (iLumi = f->lumiSections.begin();
      //     iLumi != f->lumiSections.end(); iLumi++){
      //  msg << *iLumi;
      //}
      //msg << "\n</LumiSections>\n";
      msg << "\n<Inputs>";
      std::vector<JobReport::Token>::iterator iInput;
      for (iInput = f->contributingInputs.begin();
           iInput != f->contributingInputs.end(); iInput++) {
        JobReport::InputFile inpFile = impl_->inputFiles_[*iInput];
        msg <<"\n<Input>";
        msg <<"\n  <LFN>" << inpFile.logicalFileName << "</LFN>";
        msg <<"\n  <PFN>" << inpFile.physicalFileName << "</PFN>";
        msg <<"\n</Input>";
      }
      msg << "\n</Inputs>";
      msg << "\n</File>";

    }

    return msg.str();

  }

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 494 of file JobReport.cc.

References f, and edm::JobReport::InputFile::numEventsRead.

    {
      JobReport::InputFile& f = impl_->getInputFileForToken(fileToken);
      f.numEventsRead++;
      //f.runsSeen.insert(run);
    }

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 620 of file JobReport.cc.

References f, and edm::JobReport::OutputFile::numEventsWritten.

    {
      JobReport::OutputFile& f = impl_->getOutputFileForToken(fileToken);
      f.numEventsWritten++;
      //f.runsSeen.insert(run);
    }

boost::scoped_ptr<JobReportImpl>& edm::JobReport::impl

(

)

[inline, protected]

Definition at line 462 of file JobReport.h.

References impl_.

{return impl_;}

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 509 of file JobReport.cc.

References f, and edm::JobReport::InputFile::fileHasBeenClosed.

    {
      JobReport::InputFile& f = impl_->getInputFileForToken(fileToken);
      // Dump information to the MessageLogger's JobSummary
      // about this file.
      // After setting the file to 'closed', we will no longer be able
      // to reference it by ID.
      f.fileHasBeenClosed = true;
      impl_->writeInputFile(f);
    }

JobReport::Token JobReport::inputFileOpened	(	std::string const &	physicalFileName,
		std::string const &	logicalFileName,
		std::string const &	catalog,
		std::string const &	inputSourceClassName,
		std::string const &	moduleLabel,
		std::vector< std::string > const &	branchNames
	)

Definition at line 477 of file JobReport.cc.

    {
      return this->inputFileOpened(physicalFileName,
                                   logicalFileName,
                                   catalog,
                                   inputSourceClassName,
                                   moduleLabel,
                                   "",
                                   branchNames);
    }

JobReport::Token JobReport::inputFileOpened	(	std::string const &	physicalFileName,
		std::string const &	logicalFileName,
		std::string const &	catalog,
		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 444 of file JobReport.cc.

References edm::JobReport::InputFile::branchNames, edm::JobReport::InputFile::catalog, edm::JobReport::InputFile::fileHasBeenClosed, edm::JobReport::InputFile::guid, edm::JobReport::InputFile::inputSourceClassName, edm::JobReport::InputFile::logicalFileName, edm::JobReport::InputFile::moduleLabel, edm::JobReport::InputFile::numEventsRead, edm::JobReport::InputFile::physicalFileName, and r.

    {
      // Do we have to worry about thread safety here? Or is this
      // service used in a way to make this safe?
      impl_->inputFiles_.push_back(JobReport::InputFile());
      JobReport::InputFile& r = impl_->inputFiles_.back();

      r.logicalFileName      = logicalFileName;
      r.physicalFileName     = physicalFileName;
      r.catalog              = catalog;
      r.inputSourceClassName = inputSourceClassName;
      r.moduleLabel          = moduleLabel;
      r.guid                 = guid;
      // r.runsSeen is not modified
      r.numEventsRead        = 0;
      r.branchNames          = branchNames;
      r.fileHasBeenClosed    = false;

      JobReport::Token newToken = impl_->inputFiles_.size()-1;
        //
       // Add the new input file token to all output files
      //  currently open.
      impl_->insertInputForOutputs(newToken);
      return newToken;
    }

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 629 of file JobReport.cc.

References f, and edm::JobReport::OutputFile::fileHasBeenClosed.

    {
      JobReport::OutputFile& f = impl_->getOutputFileForToken(fileToken);
      // Dump information to the MessageLogger's JobSummary
      // about this file.
      // After setting the file to 'closed', we will no longer be able
      // to reference it by ID.
      f.fileHasBeenClosed = true;
      impl_->writeOutputFile(f);

    }

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::vector< std::string > const &	branchNames
	)

Definition at line 599 of file JobReport.cc.

  {

    return this->outputFileOpened(physicalFileName,
                                  logicalFileName,
                                  catalog,
                                  outputModuleClassName,
                                  moduleLabel,
                                  "",
                                  "",
                                  branchNames);
  }

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::vector< std::string > const &	branchNames
	)

Definition at line 577 of file JobReport.cc.

    {
      return this->outputFileOpened(physicalFileName,
                                    logicalFileName,
                                    catalog,
                                    outputModuleClassName,
                                    moduleLabel,
                                    guid,
                                    "",
                                    branchNames);

    }

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::vector< std::string > const &	branchNames
	)

Definition at line 554 of file JobReport.cc.

    {
      return this->outputFileOpened(physicalFileName,
                                    logicalFileName,
                                    catalog,
                                    outputModuleClassName,
                                    moduleLabel,
                                    guid,
                                    "",
                                    "NO_BRANCH_HASH",
                                    branchNames);


    }

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 521 of file JobReport.cc.

References edm::JobReport::OutputFile::branchHash, edm::JobReport::OutputFile::branchNames, edm::JobReport::OutputFile::catalog, edm::JobReport::OutputFile::contributingInputs, edm::JobReport::OutputFile::dataType, edm::JobReport::OutputFile::fileHasBeenClosed, edm::JobReport::OutputFile::guid, edm::JobReport::OutputFile::logicalFileName, edm::JobReport::OutputFile::moduleLabel, edm::JobReport::OutputFile::numEventsWritten, edm::JobReport::OutputFile::outputModuleClassName, edm::JobReport::OutputFile::physicalFileName, and r.

    {
      impl_->outputFiles_.push_back(JobReport::OutputFile());
      JobReport::OutputFile& r = impl_->outputFiles_.back();

      r.logicalFileName       = logicalFileName;
      r.physicalFileName      = physicalFileName;
      r.catalog               = catalog;
      r.outputModuleClassName = outputModuleClassName;
      r.moduleLabel           = moduleLabel;
      r.guid           = guid;
      r.dataType = dataType;
      r.branchHash = branchHash;
      // r.runsSeen is not modified
      r.numEventsWritten      = 0;
      r.branchNames           = branchNames;
      r.fileHasBeenClosed     = false;
        //
       // Init list of contributors to list of open input file Tokens
      //
      r.contributingInputs = std::vector<JobReport::Token>(impl_->openInputFiles());
      return impl_->outputFiles_.size()-1;
    }

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 662 of file JobReport.cc.

References edm::JobReport::OutputFile::contributingInputs, and f.

    {
       // Get the required output file instance using the token
      JobReport::OutputFile& f = impl_->getOutputFileForToken(outputToken);
      // override its contributing inputs data
      f.contributingInputs = inputTokens;
    }

void JobReport::overrideEventsRead	(	Token	fileToken,
		const int	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 652 of file JobReport.cc.

References f, and edm::JobReport::InputFile::numEventsRead.

    {
      // Get the required input file instance using the token
      JobReport::InputFile& f = impl_->getInputFileForToken(fileToken);
      // set the events read parameter to the provided value
      f.numEventsRead = eventsRead;

    }

void JobReport::overrideEventsWritten	(	Token	fileToken,
		const int	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 642 of file JobReport.cc.

References f, and edm::JobReport::OutputFile::numEventsWritten.

    {
      // Get the required output file instance using the token
      JobReport::OutputFile& f = impl_->getOutputFileForToken(fileToken);
      // set the eventsWritten parameter to the provided value
      f.numEventsWritten = eventsWritten;

    }

void JobReport::reportAnalysisFile	(	std::string const &	fileName,
		std::map< std::string, std::string > const &	fileData
	)

Definition at line 718 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

                                                                                                       {

    if(impl_->ost_) {
      std::ostream& msg = *(impl_->ost_);
      //std::ostringstream msg;
      msg << "<AnalysisFile>\n"
          << "  <FileName>" << fileName <<"</FileName>\n";

      std::map<std::string, std::string>::const_iterator pos;
      for (pos = fileData.begin(); pos != fileData.end(); ++pos){
        msg <<  "  <" << pos->first
            <<  "  Value=\"" << pos->second  << "\" />"
            <<  "\n";
      }

      msg << "</AnalysisFile>\n";
      //LogError("FwkJob") << msg.str();
      msg <<std::flush;
    }


  }

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 isnt known until an event has been read.

Definition at line 502 of file JobReport.cc.

References edm::JobReport::OutputFile::dataType, and f.

    {
      JobReport::OutputFile& f = impl_->getOutputFileForToken(fileToken);
      f.dataType = dataType;
    }

void JobReport::reportError	(	std::string const &	shortDesc,
		std::string const &	longDesc,
		int const &	exitCode
	)

Definition at line 743 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

  {
    if(impl_->ost_) {
      std::ostream& msg = *(impl_->ost_);
      //std::ostringstream msg;
      msg << "<FrameworkError ExitStatus=\""<< exitCode
        <<"\" Type=\"" << shortDesc <<"\" >\n";
      msg << "<![CDATA[\n" << longDesc << "\n]]>\n";
      msg << "</FrameworkError>\n";
      //LogError("FwkJob") << msg.str();
      msg <<std::flush;
    }
  }

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 703 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

Referenced by edm::printBadAllocException(), edm::printCmsException(), edm::printStdException(), and edm::printUnknownException().

  {
    if(impl_->ost_) {
      std::ostream& msg =*(impl_->ost_);
      msg << "<FrameworkError ExitStatus=\"1\" Type=\"" << shortDesc <<"\" >\n";
      msg << "<![CDATA[\n" << longDesc << "\n]]>\n";
      msg << "</FrameworkError>\n";
   //LogError("FwkJob") << msg.str();
      msg << std::flush;
    }
  }

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 854 of file JobReport.cc.

  {

    impl_->addGeneratorInfo(name, value);
  }

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 688 of file JobReport.cc.

                                                                            {
    impl_->associateInputLumiSection(run, lumiSectId);
  }

void JobReport::reportInputRunNumber

(

unsigned int

run

)

API to report a run read from input.

Definition at line 697 of file JobReport.cc.

                                                 {
    impl_->associateInputRun(run);
  }

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 684 of file JobReport.cc.

                                                                       {
    impl_->associateLumiSection(run, lumiSectId);
  }

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 809 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

                                                                   {

    if(impl_->ost_) {
      std::ostream& msg=*(impl_->ost_);
      msg << "<MemoryService>\n";

      std::vector<std::string>::const_iterator pos;
      for (pos = memoryData.begin(); pos != memoryData.end(); ++pos){
        msg << *pos << "\n";
      }
      msg << "</MemoryService>\n";
      msg << std::flush;
    }
  }

void JobReport::reportMemoryInfo

(

std::map< std::string, double > const &

memoryData

)

Report Memory statistics Invoked by the Memory service to send an end of job summary about memory usage for inclusion in the job report.

Definition at line 792 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

                                                                        {

    if(impl_->ost_) {
      std::ostream& msg=*(impl_->ost_);
      msg << "<MemoryService>\n";
      std::map<std::string, double>::const_iterator pos;
      for (pos = memoryData.begin(); pos != memoryData.end(); ++pos){
        msg <<  "  <" << pos->first
        <<  "  Value=\"" << pos->second  << "\" />"
        <<  "\n";
      }
      msg << "</MemoryService>\n";
      msg << std::flush;
    }
  }

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 825 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

                                                                          {

    if(impl_->ost_) {
      std::ostream& msg=*(impl_->ost_);
      msg << "<MessageSummary>\n";
      std::map<std::string, double>::const_iterator pos;
      for (pos = messageData.begin(); pos != messageData.end(); ++pos){
        msg <<  "  <" << pos->first
        <<  "  Value=\"" << pos->second  << "\" />"
        <<  "\n";
      }
      msg << "</MessageSummary>\n";
      msg << std::flush;
    }
  }

void JobReport::reportPerformanceForModule	(	std::string const &	metricClass,
		std::string const &	moduleName,
		std::map< std::string, std::string > const &	metrics
	)

Definition at line 910 of file JobReport.cc.

References flush(), iter, and alivecheck_mergeAndRegister::msg.

  {
    if(impl_->ost_){
      std::ostream& msg =*(impl_->ost_);
      msg << "<PerformanceReport>\n"
        << "  <PerformanceModule Metric=\"" << metricClass << "\" "
        << " Module=\""<< moduleName << "\" >\n";

      std::map<std::string, std::string>::const_iterator iter;
      for( iter = metrics.begin(); iter != metrics.end(); ++iter ) {
        msg << "    <Metric Name=\"" << iter->first << "\" "
        <<"Value=\"" << iter->second << "\"/>\n";
      }

      msg << "  </PerformanceModule>\n"
        << "</PerformanceReport>\n";
      msg << std::flush;
      //LogInfo("FwkJob") << msg.str();
    }
  }

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 888 of file JobReport.cc.

References flush(), iter, and alivecheck_mergeAndRegister::msg.

  {
    if(impl_->ost_){
      std::ostream& msg =*(impl_->ost_);
      msg << "<PerformanceReport>\n"
        << "  <PerformanceSummary Metric=\"" << metricClass << "\">\n";

      std::map<std::string, std::string>::const_iterator iter;
      for( iter = metrics.begin(); iter != metrics.end(); ++iter ) {
        msg << "    <Metric Name=\"" << iter->first << "\" "
        <<"Value=\"" << iter->second << "\"/>\n";
      }

      msg << "  </PerformanceSummary>\n"
        << "</PerformanceReport>\n";
      msg << std::flush;
      //LogInfo("FwkJob") << msg.str();
    }
  }

void JobReport::reportPSetHash

(

std::string const &

hashValue

)

Report PSetHash.

Definition at line 874 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

  {
    if(impl_->ost_){
      std::ostream& msg =*(impl_->ost_);
      msg << "<PSetHash>"
        <<  hashValue
        <<  "</PSetHash>\n";
      //LogInfo("FwkJob") << msg.str();
      msg << std::flush;
    }
  }

void JobReport::reportRandomStateFile

(

std::string const &

name

)

Report the name of the random engine persistency file.

Definition at line 861 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

  {
    if(impl_->ost_) {
      std::ostream& msg = *(impl_->ost_);
      msg << "<RandomServiceStateFile>\n"
        << name << "\n"
        <<  "</RandomServiceStateFile>\n";
      //LogInfo("FwkJob") << msg.str();
      msg << std::flush;
    }
  }

void JobReport::reportRunNumber

(

unsigned int

run

)

API to report the a run written to output.

Definition at line 693 of file JobReport.cc.

                                            {
    impl_->associateRun(run);
  }

void JobReport::reportSkippedEvent	(	unsigned int	run,
		unsigned int	event
	)

Definition at line 672 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

    {
      if(impl_->ost_) {
        std::ostream& msg = *(impl_->ost_);
        msg << "<SkippedEvent Run=\"" << run << "\"";
        msg << " Event=\"" << event << "\" />\n";
        msg <<std::flush;
        //LogInfo("FwkJob") << msg.str();
      }
    }

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 760 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

                                                     {

    if(impl_->ost_) {
      std::ostream& msg = *(impl_->ost_);
      msg << "<SkippedFile Pfn=\"" << pfn << "\"";
      msg << " Lfn=\"" << lfn << "\" />\n";
      msg <<std::flush;
      //LogInfo("FwkJob") << msg.str();

    }
  }

void JobReport::reportStorageStats

(

std::string const &

data

)

Report Storage Statistics.

Definition at line 842 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

  {
    if(impl_->ost_) {
      std::ostream& msg = *(impl_->ost_);
      msg << "<StorageStatistics>\n"
        << data << "\n"
        <<  "</StorageStatistics>\n";
      //LogInfo("FwkJob") << msg.str();
      msg << std::flush;
    }
  }

void JobReport::reportTimingInfo

(

std::map< std::string, double > const &

timingData

)

Report Timing statistics Invoked by the Timing service to send an end of job summary about time taken for inclusion in the job report.

Definition at line 774 of file JobReport.cc.

References flush(), and alivecheck_mergeAndRegister::msg.

                                                                        {

    if(impl_->ost_) {
      std::ostream& msg=*(impl_->ost_);
      msg << "<TimingService>\n";
      std::map<std::string, double>::const_iterator pos;
      for (pos = timingData.begin(); pos != timingData.end(); ++pos){
        msg <<  "  <" << pos->first
        <<  "  Value=\"" << pos->second  << "\" />"
        <<  "\n";
      }
      msg << "</TimingService>\n";
      //LogInfo("FwkJob") << msg.str();
      msg << std::flush;
    }
  }

---

Member Data Documentation

boost::scoped_ptr<JobReportImpl> edm::JobReport::impl_ [private]

Definition at line 465 of file JobReport.h.

Referenced by impl(), and JobReport().

---

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

• FWCore/MessageLogger/interface/JobReport.h
• FWCore/MessageLogger/src/JobReport.cc

---