artdaq::GangliaMetric Class Reference

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

List of all members.

Public Member Functions

 GangliaMetric (fhicl::ParameterSet pset)
std::string getLibName () const override
 Gets the unique library name of this plugin.
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.
void sendMetric_ (const std::string &name, const int &value, const std::string &unit) override
 Send a integer metric to Ganglia (truncated to int32).
void sendMetric_ (const std::string &name, const double &value, const std::string &unit) override
 Send a double metric to Ganglia.
void sendMetric_ (const std::string &name, const float &value, const std::string &unit) override
 Send a float metric to Ganglia.
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).

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  )  [inline, explicit]
Parameters:
pset Parameter 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 [inline, override]

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 unsigned long int &  value,
const std::string &  unit 
) [inline, override]

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

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Definition at line 116 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const float &  value,
const std::string &  unit 
) [inline, override]

Send a float metric to Ganglia.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Definition at line 104 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const double &  value,
const std::string &  unit 
) [inline, override]

Send a double metric to Ganglia.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Definition at line 92 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const int &  value,
const std::string &  unit 
) [inline, override]

Send a integer metric to Ganglia (truncated to int32).

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Definition at line 80 of file ganglia_metric.cc.

void artdaq::GangliaMetric::sendMetric_ ( const std::string &  name,
const std::string &  value,
const std::string &  unit 
) [inline, override]

Send a string metric to Ganglia.

Parameters:
name Name of the metric
value Value of the metric
unit Units of the metric

Definition at line 68 of file ganglia_metric.cc.


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

Generated on 6 Feb 2018 for artdaq_ganglia_plugin by  doxygen 1.6.1