artdaq::MsgFacilityMetric Class Reference

A MetricPlugin class which sends metric data to MessageFacility. More...

Inheritance diagram for artdaq::MsgFacilityMetric:
artdaq::MetricPlugin

List of all members.

Public Member Functions

 MsgFacilityMetric (fhicl::ParameterSet const &config, std::string const &app_name)
 MsgFacilityMetric Constructor.
virtual ~MsgFacilityMetric ()
 MsgFacilityMetric Destructor. Calls stopMetrics().
std::string getLibName () const override
 Return the library name of the MetricPlugin.
void sendMetric_ (const std::string &name, const std::string &value, const std::string &unit) override
 Send a metric to MessageFacilty. Format is: "name: value unit.".
void sendMetric_ (const std::string &name, const int &value, const std::string &unit) override
 Send a metric to MessageFacility. All metrics are converted to strings.
void sendMetric_ (const std::string &name, const double &value, const std::string &unit) override
 Send a metric to MessageFacility. All metrics are converted to strings.
void sendMetric_ (const std::string &name, const float &value, const std::string &unit) override
 Send a metric to MessageFacility. All metrics are converted to strings.
void sendMetric_ (const std::string &name, const unsigned long int &value, const std::string &unit) override
 Send a metric to MessageFacility. All metrics are converted to strings.
void startMetrics_ () override
 Perform startup actions. No-Op.
void stopMetrics_ () override
 Perform shutdown actions. No-Op.

Detailed Description

A MetricPlugin class which sends metric data to MessageFacility.

Definition at line 20 of file msgFacility_metric.cc.


Constructor & Destructor Documentation

artdaq::MsgFacilityMetric::MsgFacilityMetric ( fhicl::ParameterSet const &  config,
std::string const &  app_name 
) [inline, explicit]

MsgFacilityMetric Constructor.

Parameters:
config ParameterSet used to configure MsgFacilityMetric
app_name Name of the application sending metrics
		  MsgFacilityMetric accepts the following Parameters:
		  "output_message_category_name" (Default: "ARTDAQ Metric"): Name of the "category" (for filtering) in MessageFacility
		  "output_message_severity" (Default: 0): Severity which messages should be sent with. This parameter may also be specified using
		  the string name of the severity.
		  0: Info, 1: Debug, 2: Warning, 3: Error
		

Definition at line 39 of file msgFacility_metric.cc.


Member Function Documentation

std::string artdaq::MsgFacilityMetric::getLibName (  )  const [inline, override, virtual]

Return the library name of the MetricPlugin.

Returns:
The library name of MsgFacilityMetric: "msgFacility"

Reimplemented from artdaq::MetricPlugin.

Definition at line 79 of file msgFacility_metric.cc.

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

Send a metric to MessageFacility. All metrics are converted to strings.

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

Definition at line 148 of file msgFacility_metric.cc.

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

Send a metric to MessageFacility. All metrics are converted to strings.

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

Implements artdaq::MetricPlugin.

Definition at line 137 of file msgFacility_metric.cc.

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

Send a metric to MessageFacility. All metrics are converted to strings.

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

Implements artdaq::MetricPlugin.

Definition at line 126 of file msgFacility_metric.cc.

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

Send a metric to MessageFacility. All metrics are converted to strings.

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

Implements artdaq::MetricPlugin.

Definition at line 115 of file msgFacility_metric.cc.

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

Send a metric to MessageFacilty. Format is: "name: value unit.".

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

Implements artdaq::MetricPlugin.

Definition at line 87 of file msgFacility_metric.cc.


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

Generated on 25 Sep 2018 for artdaq_utilities by  doxygen 1.6.1