artdaq_pcp_mmv_plugin  1.03.04
artdaq::PCPMMVMetric Class Referencefinal

An instance of the MetricPlugin class that sends metric data to PCPMMV. More...

Inheritance diagram for artdaq::PCPMMVMetric:

Public Member Functions

 PCPMMVMetric (fhicl::ParameterSet const &pset, std::string const &app_name, std::string const &metric_name)
 Construct an instance of the PCPMMV metric. More...
 
std::string getLibName () const override
 Gets the unique library name of this plugin. More...
 
void stopMetrics_ () override
 PCPMMV does not need any specific action on stop.
 
void startMetrics_ () override
 PCPMMV does not need any specific action on start.
 
void sendMetric_ (const std::string &name, const std::string &value, const std::string &unit, const std::chrono::system_clock::time_point &) override
 Send a string metric to PCPMMV. More...
 
void sendMetric_ (const std::string &name, const int &value, const std::string &unit, const std::chrono::system_clock::time_point &) override
 Send a integer metric to PCPMMV. More...
 
void sendMetric_ (const std::string &name, const double &value, const std::string &unit, const std::chrono::system_clock::time_point &) override
 Send a double metric to PCPMMV. More...
 
void sendMetric_ (const std::string &name, const float &value, const std::string &unit, const std::chrono::system_clock::time_point &) override
 Send a float metric to PCPMMV. More...
 
void sendMetric_ (const std::string &name, const uint64_t &value, const std::string &unit, const std::chrono::system_clock::time_point &) override
 Send an unsigned long metric to PCPMMV. More...
 

Detailed Description

An instance of the MetricPlugin class that sends metric data to PCPMMV.

pmlogger must be configured to log the artdaq metrics so that the web display will retrieve them. Run artdaq, and ensure that the metrics are now available through pminfo -f mmv. Then, run (as root) cd /var/lib/pcp/pmlogger;pmlogconf -r config.default and restart pmlogger.

Definition at line 34 of file pcpmmv_metric.cc.

Constructor & Destructor Documentation

artdaq::PCPMMVMetric::PCPMMVMetric ( fhicl::ParameterSet const &  pset,
std::string const &  app_name,
std::string const &  metric_name 
)
inlineexplicit

Construct an instance of the PCPMMV metric.

Parameters
psetParameter set with which to configure the MetricPlugin.
app_nameName of the application sending metrics
metric_nameName for this metric instance

pcp_domain_number can be used to change the domain parameter seconds_before_init determines how long the metric will wait, collecting metric names before starting to log metrics (to reduce the number of stop/init cycles)

Definition at line 190 of file pcpmmv_metric.cc.

Member Function Documentation

std::string artdaq::PCPMMVMetric::getLibName ( ) const
inlineoverride

Gets the unique library name of this plugin.

Returns
The library name of this plugin, "PCPMMV".

Definition at line 205 of file pcpmmv_metric.cc.

void artdaq::PCPMMVMetric::sendMetric_ ( const std::string &  name,
const std::string &  value,
const std::string &  unit,
const std::chrono::system_clock::time_point &   
)
inlineoverride

Send a string metric to PCPMMV.

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric

Definition at line 223 of file pcpmmv_metric.cc.

void artdaq::PCPMMVMetric::sendMetric_ ( const std::string &  name,
const int &  value,
const std::string &  unit,
const std::chrono::system_clock::time_point &   
)
inlineoverride

Send a integer metric to PCPMMV.

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric

Definition at line 275 of file pcpmmv_metric.cc.

void artdaq::PCPMMVMetric::sendMetric_ ( const std::string &  name,
const double &  value,
const std::string &  unit,
const std::chrono::system_clock::time_point &   
)
inlineoverride

Send a double metric to PCPMMV.

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric

Definition at line 321 of file pcpmmv_metric.cc.

void artdaq::PCPMMVMetric::sendMetric_ ( const std::string &  name,
const float &  value,
const std::string &  unit,
const std::chrono::system_clock::time_point &   
)
inlineoverride

Send a float metric to PCPMMV.

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric

Definition at line 367 of file pcpmmv_metric.cc.

void artdaq::PCPMMVMetric::sendMetric_ ( const std::string &  name,
const uint64_t &  value,
const std::string &  unit,
const std::chrono::system_clock::time_point &   
)
inlineoverride

Send an unsigned long metric to PCPMMV.

Parameters
nameName of the metric
valueValue of the metric
unitUnits of the metric

Definition at line 413 of file pcpmmv_metric.cc.


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