artdaq_utilities  v1_04_10
artdaq::MetricPlugin Class Referenceabstract
Inheritance diagram for artdaq::MetricPlugin:
artdaq::FileMetric artdaq::GraphiteMetric artdaq::MsgFacilityMetric artdaq::PeriodicReportMetric artdaq::ProcFileMetric

Classes

struct  Config
 

Public Types

using Parameters = fhicl::WrappedTable< Config >
 

Public Member Functions

 MetricPlugin (fhicl::ParameterSet const &ps, std::string const &app_name)
 
virtual std::string getLibName () const
 
void addMetricData (std::unique_ptr< MetricData > const &data)
 
void sendMetrics (bool forceSend=false, std::chrono::steady_clock::time_point interval_end=std::chrono::steady_clock::now())
 
void startMetrics ()
 
void stopMetrics ()
 
void setRunLevel (int level)
 
int getRunLevel () const
 

Protected Member Functions

virtual void sendMetric_ (const std::string &name, const std::string &value, const std::string &unit)=0
 
virtual void sendMetric_ (const std::string &name, const int &value, const std::string &unit)=0
 
virtual void sendMetric_ (const std::string &name, const double &value, const std::string &unit)=0
 
virtual void sendMetric_ (const std::string &name, const float &value, const std::string &unit)=0
 
virtual void sendMetric_ (const std::string &name, const long unsigned int &value, const std::string &unit)=0
 
virtual void startMetrics_ ()=0
 
virtual void stopMetrics_ ()=0
 

Protected Attributes

int runLevel_
 
fhicl::ParameterSet pset
 The ParameterSet used to configure the MetricPlugin.
 
double accumulationTime_
 
std::string app_name_
 Name of the application which is sending metrics to this plugin.
 
bool inhibit_
 Whether to inhibit all metric sending.
 

Detailed Description

Definition at line 29 of file MetricPlugin.hh.

Member Data Documentation

double artdaq::MetricPlugin::accumulationTime_
protected

The amount of time to average metric values; except for accumulate=false metrics, will be the interval at which each metric is sent.

Definition at line 378 of file MetricPlugin.hh.

int artdaq::MetricPlugin::runLevel_
protected

The threshold for sending metrics to the underlying storage. Metrics with level <= to runLevel_ will be sent.

Definition at line 375 of file MetricPlugin.hh.


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