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 const &pset, std::string const &app_name)
	Construct an instance of the Ganglia metric. More...
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 const &  pset, std::string const &  app_name  )

inlineexplicit

Construct an instance of the Ganglia metric.

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)).
app_name	Name of the application sending metrics

Definition at line 35 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 53 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

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

Definition at line 69 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

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

Definition at line 81 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

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

Definition at line 93 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

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

Definition at line 105 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

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

Definition at line 117 of file ganglia_metric.cc.

---

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

• artdaq_ganglia_plugin/artdaq-ganglia-plugin/ganglia_metric.cc