#include <DQMFileSaverPB.h>

Inheritance diagram for dqm::DQMFileSaverPB:

Public Member Functions
	DQMFileSaverPB (const edm::ParameterSet &ps)

	~DQMFileSaverPB () override

Public Member Functions inherited from dqm::DQMFileSaverBase
	DQMFileSaverBase (const edm::ParameterSet &ps)

	~DQMFileSaverBase () override

Public Member Functions inherited from edm::global::EDAnalyzer< edm::RunCache< NoCache >, edm::LuminosityBlockCache< NoCache > >
	EDAnalyzer ()=default

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsStreamLuminosityBlocks () const final

bool	wantsStreamRuns () const final

Public Member Functions inherited from edm::global::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

	~EDAnalyzerBase () 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 boost::property_tree::ptree	fillJson (int run, int lumi, const std::string &dataFilePathName, const std::string &transferDestinationStr, const std::string &mergeTypeStr, evf::FastMonitoringService *fms)

Static Public Member Functions inherited from dqm::DQMFileSaverBase
static void	fillDescription (edm::ParameterSetDescription &d)

Static Public Member Functions inherited from edm::global::EDAnalyzerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Protected Member Functions
void	initRun () const override

void	saveLumi (const FileParameters &fp) const override

void	savePB (DQMStore *store, std::string const &filename, int run, int lumi) const

void	saveRun (const FileParameters &fp) const override

Protected Member Functions inherited from dqm::DQMFileSaverBase
void	analyze (edm::StreamID, const edm::Event &e, const edm::EventSetup &) const final

std::shared_ptr< NoCache >	globalBeginLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) const final

std::shared_ptr< NoCache >	globalBeginRun (const edm::Run &, const edm::EventSetup &) const final

void	globalEndLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) const final

void	globalEndRun (const edm::Run &, const edm::EventSetup &) const final

void	logFileAction (const std::string &msg, const std::string &fileName) const

void	saveJobReport (const std::string &filename) const

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)

Protected Attributes
bool	fakeFilterUnitMode_

std::string	mergeType_

std::string	streamLabel_

std::string	transferDestination_

Protected Attributes inherited from dqm::DQMFileSaverBase
FileParameters	initial_fp_

std::mutex	initial_fp_lock_

Additional Inherited Members
Public Types inherited from dqm::DQMFileSaverBase
typedef dqm::legacy::DQMStore	DQMStore

typedef dqm::legacy::MonitorElement	MonitorElement

Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Static Protected Member Functions inherited from dqm::DQMFileSaverBase
static const std::string	filename (const FileParameters &fp, bool useLumi=false)

Detailed Description

Definition at line 15 of file DQMFileSaverPB.h.

Constructor & Destructor Documentation

◆ DQMFileSaverPB()

DQMFileSaverPB::DQMFileSaverPB ( const edm::ParameterSet & ps )

Definition at line 32 of file DQMFileSaverPB.cc.

                                                         : DQMFileSaverBase(ps) {
   fakeFilterUnitMode_ = ps.getUntrackedParameter<bool>("fakeFilterUnitMode", false);
   streamLabel_ = ps.getUntrackedParameter<std::string>("streamLabel", "streamDQMHistograms");
  
   transferDestination_ = "";
   mergeType_ = "";
 }

References fakeFilterUnitMode_, edm::ParameterSet::getUntrackedParameter(), mergeType_, streamLabel_, AlCaHLTBitMon_QueryRunRegistry::string, and transferDestination_.

◆ ~DQMFileSaverPB()

DQMFileSaverPB::~DQMFileSaverPB ( )

overridedefault

Member Function Documentation

◆ fillDescriptions()

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

static

Definition at line 191 of file DQMFileSaverPB.cc.

                                                                                 {
   edm::ParameterSetDescription desc;
   desc.setComment("Saves histograms from DQM store, HLT->pb workflow.");
  
   desc.addUntracked<bool>("fakeFilterUnitMode", false)->setComment("If set, EvFDaqDirector is emulated and not used.");
  
   desc.addUntracked<std::string>("streamLabel", "streamDQMHistograms")->setComment("Label of the stream.");
  
   DQMFileSaverBase::fillDescription(desc);
  
   // Changed to use addDefault instead of add here because previously
   // DQMFileSaverOnline and DQMFileSaverPB both used the module label
   // "saver" which caused conflicting cfi filenames to be generated.
   // add could be used if unique module labels were given.
   descriptions.addDefault(desc);
 }

References edm::ConfigurationDescriptions::addDefault(), edm::ParameterSetDescription::addUntracked(), dqm::DQMFileSaverBase::fillDescription(), edm::ParameterSetDescription::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

◆ fillJson()

boost::property_tree::ptree DQMFileSaverPB::fillJson	(	int	run,
		int	lumi,
		const std::string &	dataFilePathName,
		const std::string &	transferDestinationStr,
		const std::string &	mergeTypeStr,
		evf::FastMonitoringService *	fms
	)

static

Definition at line 109 of file DQMFileSaverPB.cc.

                                                                                     {
   namespace bpt = boost::property_tree;
   namespace bfs = boost::filesystem;
  
   bpt::ptree pt;
  
   int hostnameReturn;
   char host[32];
   hostnameReturn = gethostname(host, sizeof(host));
   if (hostnameReturn == -1)
     throw cms::Exception("fillJson") << "Internal error, cannot get host name";
  
   int pid = getpid();
   std::ostringstream oss_pid;
   oss_pid << pid;
  
   int nProcessed = fms ? (fms->getEventsProcessedForLumi(lumi)) : -1;
  
   // Stat the data file: if not there, throw
   std::string dataFileName;
   struct stat dataFileStat;
   dataFileStat.st_size = 0;
   if (nProcessed) {
     if (stat(dataFilePathName.c_str(), &dataFileStat) != 0)
       throw cms::Exception("fillJson") << "Internal error, cannot get data file: " << dataFilePathName;
     // Extract only the data file name from the full path
     dataFileName = bfs::path(dataFilePathName).filename().string();
   }
   // The availability test of the FastMonitoringService was done in the ctor.
   bpt::ptree data;
   bpt::ptree processedEvents, acceptedEvents, errorEvents, bitmask, fileList, fileSize, inputFiles, fileAdler32,
       transferDestination, mergeType, hltErrorEvents;
  
   processedEvents.put("", nProcessed);  // Processed events
   acceptedEvents.put("", nProcessed);   // Accepted events, same as processed for our purposes
  
   errorEvents.put("", 0);                               // Error events
   bitmask.put("", 0);                                   // Bitmask of abs of CMSSW return code
   fileList.put("", dataFileName);                       // Data file the information refers to
   fileSize.put("", dataFileStat.st_size);               // Size in bytes of the data file
   inputFiles.put("", "");                               // We do not care about input files!
   fileAdler32.put("", -1);                              // placeholder to match output json definition
   transferDestination.put("", transferDestinationStr);  // SM Transfer destination field
   mergeType.put("", mergeTypeStr);                      // SM Transfer destination field
   hltErrorEvents.put("", 0);                            // Error events
  
   data.push_back(std::make_pair("", processedEvents));
   data.push_back(std::make_pair("", acceptedEvents));
   data.push_back(std::make_pair("", errorEvents));
   data.push_back(std::make_pair("", bitmask));
   data.push_back(std::make_pair("", fileList));
   data.push_back(std::make_pair("", fileSize));
   data.push_back(std::make_pair("", inputFiles));
   data.push_back(std::make_pair("", fileAdler32));
   data.push_back(std::make_pair("", transferDestination));
   data.push_back(std::make_pair("", mergeType));
   data.push_back(std::make_pair("", hltErrorEvents));
  
   pt.add_child("data", data);
  
   if (fms == nullptr) {
     pt.put("definition", "/fakeDefinition.jsn");
   } else {
     // The availability test of the EvFDaqDirector Service was done in the ctor.
     bfs::path outJsonDefName{
         edm::Service<evf::EvFDaqDirector>()->baseRunDir()};  //we assume this file is written bu the EvF Output module
     outJsonDefName /= (std::string("output_") + oss_pid.str() + std::string(".jsd"));
     pt.put("definition", outJsonDefName.string());
   }
  
   char sourceInfo[64];  //host and pid information
   sprintf(sourceInfo, "%s_%d", host, pid);
   pt.put("source", sourceInfo);
  
   return pt;
 }

References data, Exception, evf::FastMonitoringService::getEventsProcessedForLumi(), query::host, varParsingExample::inputFiles, castor_dqm_sourceclient_file_cfg::path, DiDispStaMuonMonitor_cfi::pt, hgcalPlots::stat, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by saveLumi().

◆ initRun()

void DQMFileSaverPB::initRun ( ) const

overrideprotectedvirtual

Reimplemented from dqm::DQMFileSaverBase.

Definition at line 42 of file DQMFileSaverPB.cc.

                                    {
   if (!fakeFilterUnitMode_) {
     transferDestination_ = edm::Service<evf::EvFDaqDirector>()->getStreamDestinations(streamLabel_);
     mergeType_ = edm::Service<evf::EvFDaqDirector>()->getStreamMergeType(streamLabel_, evf::MergeTypePB);
   }
  
   if (!fakeFilterUnitMode_) {
     evf::EvFDaqDirector* daqDirector = (evf::EvFDaqDirector*)(edm::Service<evf::EvFDaqDirector>().operator->());
     const std::string initFileName = daqDirector->getInitFilePath(streamLabel_);
     std::ofstream file(initFileName);
     file.close();
   }
 }

References fakeFilterUnitMode_, FrontierConditions_GlobalTag_cff::file, evf::EvFDaqDirector::getInitFilePath(), mergeType_, evf::MergeTypePB, streamLabel_, AlCaHLTBitMon_QueryRunRegistry::string, and transferDestination_.

◆ saveLumi()

void DQMFileSaverPB::saveLumi ( const FileParameters & fp ) const

overrideprotectedvirtual

Reimplemented from dqm::DQMFileSaverBase.

Definition at line 56 of file DQMFileSaverPB.cc.

                                                             {
   // get from DAQ2 services where to store the files according to their format
   namespace bpt = boost::property_tree;
  
   std::string openJsonFilePathName;
   std::string jsonFilePathName;
   std::string openHistoFilePathName;
   std::string histoFilePathName;
  
   evf::FastMonitoringService* fms = nullptr;
   edm::Service<DQMStore> store;
  
   // create the files names
   if (fakeFilterUnitMode_) {
     std::string runDir = str(boost::format("%s/run%06d") % fp.path_ % fp.run_);
     std::string baseName = str(boost::format("%s/run%06d_ls%04d_%s") % runDir % fp.run_ % fp.lumi_ % streamLabel_);
  
     boost::filesystem::create_directories(runDir);
  
     jsonFilePathName = baseName + ".jsn";
     openJsonFilePathName = jsonFilePathName + ".open";
  
     histoFilePathName = baseName + ".pb";
     openHistoFilePathName = histoFilePathName + ".open";
   } else {
     openJsonFilePathName = edm::Service<evf::EvFDaqDirector>()->getOpenOutputJsonFilePath(fp.lumi_, streamLabel_);
     jsonFilePathName = edm::Service<evf::EvFDaqDirector>()->getOutputJsonFilePath(fp.lumi_, streamLabel_);
  
     openHistoFilePathName =
         edm::Service<evf::EvFDaqDirector>()->getOpenProtocolBufferHistogramFilePath(fp.lumi_, streamLabel_);
     histoFilePathName = edm::Service<evf::EvFDaqDirector>()->getProtocolBufferHistogramFilePath(fp.lumi_, streamLabel_);
  
     fms = (evf::FastMonitoringService*)(edm::Service<evf::MicroStateService>().operator->());
   }
  
   if (fms ? fms->getEventsProcessedForLumi(fp.lumi_) : true) {
     // Save the file in the open directory.
     this->savePB(&*store, openHistoFilePathName, fp.run_, fp.lumi_);
  
     // Now move the the data and json files into the output directory.
     ::rename(openHistoFilePathName.c_str(), histoFilePathName.c_str());
   }
  
   // Write the json file in the open directory.
   bpt::ptree pt = fillJson(fp.run_, fp.lumi_, histoFilePathName, transferDestination_, mergeType_, fms);
   write_json(openJsonFilePathName, pt);
   ::rename(openJsonFilePathName.c_str(), jsonFilePathName.c_str());
 }

References fakeFilterUnitMode_, fillJson(), dqm-mbProfile::format, personalPlayback::fp, evf::FastMonitoringService::getEventsProcessedForLumi(), mergeType_, DiDispStaMuonMonitor_cfi::pt, savePB(), str, streamLabel_, AlCaHLTBitMon_QueryRunRegistry::string, and transferDestination_.

◆ savePB()

void DQMFileSaverPB::savePB	(	DQMStore *	store,
		std::string const &	filename,
		int	run,
		int	lumi
	)		const

protected

Definition at line 208 of file DQMFileSaverPB.cc.

                                                                                                {
   using google::protobuf::io::FileOutputStream;
   using google::protobuf::io::GzipOutputStream;
   using google::protobuf::io::StringOutputStream;
  
   unsigned int nme = 0;
  
   dqmstorepb::ROOTFilePB dqmstore_message;
  
   // We save all histograms, indifferent of the lumi flag: even tough we save per lumi, this is a *snapshot*.
   auto mes = store->getAllContents("");
   for (auto const me : mes) {
     TBufferFile buffer(TBufferFile::kWrite);
     if (me->kind() < MonitorElement::Kind::TH1F) {
       TObjString object(me->tagString().c_str());
       buffer.WriteObject(&object);
     } else {
       buffer.WriteObject(me->getRootObject());
     }
     dqmstorepb::ROOTFilePB::Histo& histo = *dqmstore_message.add_histo();
     histo.set_full_pathname(me->getFullname());
     uint32_t flags = 0;
     flags |= (uint32_t)me->kind();
     if (me->getLumiFlag())
       flags |= DQMNet::DQM_PROP_LUMI;
     if (me->getEfficiencyFlag())
       flags |= DQMNet::DQM_PROP_EFFICIENCY_PLOT;
     histo.set_flags(flags);
     histo.set_size(buffer.Length());
     histo.set_streamed_histo((void const*)buffer.Buffer(), buffer.Length());
  
     // Save quality reports if this is not in reference section.
     // XXX not supported by protobuf files.
  
     // Save efficiency tag, if any.
     // XXX not supported by protobuf files.
  
     // Save tag if any.
     // XXX not supported by protobuf files.
  
     // Count saved histograms
     ++nme;
   }
  
   int filedescriptor =
       ::open(filename.c_str(), O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
   FileOutputStream file_stream(filedescriptor);
   GzipOutputStream::Options options;
   options.format = GzipOutputStream::GZIP;
   options.compression_level = 1;
   GzipOutputStream gzip_stream(&file_stream, options);
   dqmstore_message.SerializeToZeroCopyStream(&gzip_stream);
  
   // Flush the internal streams before closing the fd.
   gzip_stream.Close();
   file_stream.Close();
   ::close(filedescriptor);
  
   // Maybe make some noise.
   edm::LogInfo("DQMFileSaverPB") << "savePB: successfully wrote " << nme << " objects  "
                                  << "into DQM file '" << filename << "'\n";
 }

References dqmstorepb::ROOTFilePB::add_histo(), edmScanValgrind::buffer, DQMNet::DQM_PROP_EFFICIENCY_PLOT, DQMNet::DQM_PROP_LUMI, dqm::DQMFileSaverBase::filename(), HLT_2018_cff::flags, dqm::implementation::IGetter::getAllContents(), timingPdfMaker::histo, hlt_dqm_clientPB-live_cfg::me, resolutioncreator_cfi::object, AlcaSiPixelAliHarvester0T_cff::options, and MonitorElementData::TH1F.

Referenced by saveLumi().

◆ saveRun()

void DQMFileSaverPB::saveRun ( const FileParameters & fp ) const

overrideprotectedvirtual

Reimplemented from dqm::DQMFileSaverBase.

Definition at line 105 of file DQMFileSaverPB.cc.

                                                            {
   // no saving for the run
 }

Member Data Documentation

◆ fakeFilterUnitMode_

bool dqm::DQMFileSaverPB::fakeFilterUnitMode_

protected

Definition at line 35 of file DQMFileSaverPB.h.

Referenced by DQMFileSaverPB(), initRun(), and saveLumi().

◆ mergeType_

std::string dqm::DQMFileSaverPB::mergeType_

mutableprotected

Definition at line 38 of file DQMFileSaverPB.h.

Referenced by DQMFileSaverPB(), initRun(), and saveLumi().

◆ streamLabel_

std::string dqm::DQMFileSaverPB::streamLabel_

protected

Definition at line 36 of file DQMFileSaverPB.h.

Referenced by DQMFileSaverPB(), initRun(), and saveLumi().

◆ transferDestination_

std::string dqm::DQMFileSaverPB::transferDestination_

mutableprotected

Definition at line 37 of file DQMFileSaverPB.h.

Referenced by DQMFileSaverPB(), initRun(), and saveLumi().

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DQMFileSaverPB()

◆ ~DQMFileSaverPB()

Member Function Documentation

◆ fillDescriptions()

◆ fillJson()

◆ initRun()

◆ saveLumi()

◆ savePB()

◆ saveRun()

Member Data Documentation

◆ fakeFilterUnitMode_

◆ mergeType_

◆ streamLabel_

◆ transferDestination_