DQMService Class Reference

#include <DQMService.h>

Public Types
typedef dqm::legacy::DQMStore	DQMStore
typedef dqm::legacy::MonitorElement	MonitorElement

Public Member Functions
	DQMService (const edm::ParameterSet &pset, edm::ActivityRegistry &ar)
void	flush (edm::StreamContext const &sc)
void	flushStandalone ()
	~DQMService ()

Private Member Functions
void	shutdown ()

Private Attributes
lat::Regexp *	filter_
double	lastFlush_
DQMBasicNet *	net_
double	publishFrequency_
DQMStore *	store_

Detailed Description

A bridge to udpate the DQM network layer at the end of every event.

Definition at line 15 of file DQMService.h.

Member Typedef Documentation

typedef dqm::legacy::DQMStore DQMService::DQMStore

Definition at line 17 of file DQMService.h.

typedef dqm::legacy::MonitorElement DQMService::MonitorElement

Definition at line 18 of file DQMService.h.

Constructor & Destructor Documentation

DQMService::DQMService	(	const edm::ParameterSet &	pset,
		edm::ActivityRegistry &	ar
	)

Definition at line 27 of file DQMService.cc.

References DQMNet::debug(), MillePedeFileConverter_cfg::e, Exception, ALCARECOTkAlBeamHalo_cff::filter, filter_, flush(), edm::ParameterSet::getUntrackedParameter(), query::host, net_, query::port, publishFrequency_, DQMNet::start(), AlCaHLTBitMon_QueryRunRegistry::string, DQMNet::updateToCollector(), edm::ActivityRegistry::watchPostEvent(), and edm::ActivityRegistry::watchPostStreamEndLumi().

    : store_(&*edm::Service<DQMStore>()), net_(nullptr), filter_(nullptr), lastFlush_(0), publishFrequency_(5.0) {
  ar.watchPostEvent(this, &DQMService::flush);
  ar.watchPostStreamEndLumi(this, &DQMService::flush);

  std::string host = pset.getUntrackedParameter<std::string>("collectorHost", "");
  int port = pset.getUntrackedParameter<int>("collectorPort", 9090);
  bool verbose = pset.getUntrackedParameter<bool>("verbose", false);
  publishFrequency_ = pset.getUntrackedParameter<double>("publishFrequency", publishFrequency_);
  std::string filter = pset.getUntrackedParameter<std::string>("filter", "");

  if (!host.empty() && port > 0) {
    net_ = new DQMBasicNet;
    net_->debug(verbose);
    net_->updateToCollector(host, port);
    net_->start();
  }

  if (!filter.empty()) {
    try {
      filter_ = new lat::Regexp(filter);
      if (!filter_->valid())
        throw cms::Exception("DQMService") << "Invalid 'filter' parameter value '" << filter << "':"
                                           << " bad regular expression syntax at character " << filter_->errorOffset()
                                           << ": " << filter_->errorMessage();
      filter_->study();
    } catch (lat::Error &e) {
      throw cms::Exception("DQMService") << "Invalid regular expression 'filter' parameter value '" << filter
                                         << "': " << e.explain();
    }
  }
}

DQMService::~DQMService

(

)

Definition at line 60 of file DQMService.cc.

References shutdown().

{ shutdown(); }

Member Function Documentation

void DQMService::flush

(

edm::StreamContext const &

sc

)

Definition at line 156 of file DQMService.cc.

References flushStandalone().

Referenced by DQMService().

                                                 {
  // Call a function independent to the framework
  flushStandalone();
}

void DQMService::flushStandalone

(

)

Definition at line 65 of file DQMService.cc.

References edmScanValgrind::buffer, dqm::impl::MonitorElement::data_, dqm::dqmstoreimpl::DQMStore::data_, DQMNet::CoreObject::dirname, DQMNet::dqmhash(), MillePedeFileConverter_cfg::e, filter_, DQMNet::CoreObject::flags, reco_skim_cfg_mod::fullpath, dqm::legacy::MonitorElement::getRootObject(), DQMNet::Object::hash, mps_fire::i, MonitorElementData::INT, dqm::impl::MonitorElement::kind(), lastFlush_, DQMNet::Object::lastreq, DQMNet::lock(), hlt_dqm_clientPB-live_cfg::me, net_, EcalTangentSkim_cfg::o, DQMNet::CoreObject::objname, DQMNet::packQualityData(), dqm::impl::MonitorElement::packScalarData(), publishFrequency_, DQMNet::Object::qdata, DQMNet::CoreObject::qreports, DQMNet::Object::rawdata, MonitorElementData::REAL, dqm::impl::MonitorElement::reference_, DQMBasicNet::removeLocalExcept(), DQMBasicNet::reserveLocalSpace(), dqm::dqmstoreimpl::DQMStore::reset(), DQMNet::Object::scalar, postprocess-scan-build::seen, DQMNet::sendLocalChanges(), store_, MonitorElementData::STRING, AlCaHLTBitMon_QueryRunRegistry::string, DQMNet::CoreObject::tag, DQMNet::unlock(), DQMBasicNet::updateLocalObject(), BeamSplash_cfg::version, DQMNet::CoreObject::version, and dqm::impl::MonitorElement::wasUpdated().

Referenced by flush().

                                 {
  // Avoid sending updates excessively often.
  uint64_t version = lat::Time::current().ns();
  double vtime = version * 1e-9;
  if (vtime - lastFlush_ < publishFrequency_)
    return;

  // OK, send an update.
  if (net_) {
    DQMNet::Object o;
    std::set<std::string> seen;
    std::string fullpath;

    // Lock the network layer so we can modify the data.
    net_->lock();
    bool updated = false;

    // Find updated contents and update the network cache.
    DQMStore::MEMap::iterator i, e;
    net_->reserveLocalSpace(store_->data_.size());
    for (i = store_->data_.begin(), e = store_->data_.end(); i != e; ++i) {
      const MonitorElement &me = *i;
      fullpath.clear();
      fullpath += *me.data_.dirname;
      if (!me.data_.dirname->empty())
        fullpath += '/';
      fullpath += me.data_.objname;

      if (filter_ && filter_->search(fullpath) < 0)
        continue;

      seen.insert(fullpath);
      if (!me.wasUpdated())
        continue;

      o.lastreq = 0;
      o.hash = DQMNet::dqmhash(fullpath.c_str(), fullpath.size());
      o.flags = me.data_.flags;
      o.tag = me.data_.tag;
      o.version = version;
      o.dirname = me.data_.dirname;
      o.objname = me.data_.objname;
      assert(o.rawdata.empty());
      assert(o.scalar.empty());
      assert(o.qdata.empty());

      // Pack object and reference, scalar and quality data.
      switch (me.kind()) {
        case MonitorElement::Kind::INT:
        case MonitorElement::Kind::REAL:
        case MonitorElement::Kind::STRING:
          me.packScalarData(o.scalar, "");
          break;

        default: {
          TBufferFile buffer(TBufferFile::kWrite);
          buffer.WriteObject(me.getRootObject());
          if (me.reference_)
            buffer.WriteObject(me.reference_);
          else
            buffer.WriteObjectAny(nullptr, nullptr);
          o.rawdata.resize(buffer.Length());
          memcpy(&o.rawdata[0], buffer.Buffer(), buffer.Length());
          DQMNet::packQualityData(o.qdata, me.data_.qreports);
          break;
        }
      }

      // Update.
      net_->updateLocalObject(o);
      DQMNet::DataBlob().swap(o.rawdata);
      std::string().swap(o.scalar);
      std::string().swap(o.qdata);
      updated = true;
    }

    // Find removed contents and clear the network cache.
    if (net_->removeLocalExcept(seen))
      updated = true;

    // Unlock the network layer.
    net_->unlock();

    // Tell network to flush if we updated something.
    if (updated)
      net_->sendLocalChanges();
  }

  store_->reset();
  lastFlush_ = lat::Time::current().ns() * 1e-9;
}

void DQMService::shutdown ( )

private

Definition at line 162 of file DQMService.cc.

References net_, and DQMNet::shutdown().

Referenced by ~DQMService().

                          {
  // If we have a network, let it go.
  if (net_)
    net_->shutdown();
}

Member Data Documentation

lat::Regexp* DQMService::filter_

private

Definition at line 31 of file DQMService.h.

Referenced by DQMService(), and flushStandalone().

double DQMService::lastFlush_

private

Definition at line 32 of file DQMService.h.

Referenced by flushStandalone().

DQMBasicNet* DQMService::net_

private

Definition at line 30 of file DQMService.h.

Referenced by DQMService(), flushStandalone(), and shutdown().

double DQMService::publishFrequency_

private

Definition at line 33 of file DQMService.h.

Referenced by DQMService(), and flushStandalone().

DQMStore* DQMService::store_

private

Definition at line 29 of file DQMService.h.

Referenced by flushStandalone().