artdaq_ganglia_plugin  v1_02_05
 All Classes Namespaces Files Functions
Public Member Functions | List of all members
artdaq::GangliaMetric Class Reference

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

+ Inheritance diagram for artdaq::GangliaMetric:

Public Member Functions

 GangliaMetric (fhicl::ParameterSet pset)
 
std::string getLibName () const override
 Gets the unique library name of this plugin. More...
 
void stopMetrics_ () override
 Ganglia does not need any specific action on stop.
 
void startMetrics_ () override
 Ganglia does not need any specific action on start.
 
void sendMetric_ (const std::string &name, const std::string &value, const std::string &unit) override
 Send a string metric to Ganglia. More...
 
void sendMetric_ (const std::string &name, const int &value, const std::string &unit) override
 Send a integer metric to Ganglia (truncated to int32) More...
 
void sendMetric_ (const std::string &name, const double &value, const std::string &unit) override
 Send a double metric to Ganglia. More...
 
void sendMetric_ (const std::string &name, const float &value, const std::string &unit) override
 Send a float metric to Ganglia. More...
 
void sendMetric_ (const std::string &name, const unsigned long int &value, const std::string &unit) override
 Send an unsigned long metric to Ganglia (truncated to uint32) More...
 

Detailed Description

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

Definition at line 22 of file ganglia_metric.cc.

Constructor & Destructor Documentation

artdaq::GangliaMetric::GangliaMetric ( fhicl::ParameterSet  pset)
inlineexplicit
Parameters
psetParameter set with which to configure the MetricPlugin. Also includes "configFile" (path to gmond.conf), "group" (Group for metrics) and "cluster" (Cluster tag to use (optional)).

Definition at line 34 of file ganglia_metric.cc.

Member Function Documentation

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

Gets the unique library name of this plugin.

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

Definition at line 52 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const std::string &  value,
const std::string &  unit 
)
inlineoverride

Send a string metric to Ganglia.

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

Definition at line 68 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const int &  value,
const std::string &  unit 
)
inlineoverride

Send a integer metric to Ganglia (truncated to int32)

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

Definition at line 80 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const double &  value,
const std::string &  unit 
)
inlineoverride

Send a double metric to Ganglia.

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

Definition at line 92 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const float &  value,
const std::string &  unit 
)
inlineoverride

Send a float metric to Ganglia.

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

Definition at line 104 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const unsigned long int &  value,
const std::string &  unit 
)
inlineoverride

Send an unsigned long metric to Ganglia (truncated to uint32)

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

Definition at line 116 of file ganglia_metric.cc.


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