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

Inheritance diagram for artdaq::MsgFacilityMetric:

Public Member Functions
	MsgFacilityMetric (fhicl::ParameterSet const &config, std::string const &app_name)
	MsgFacilityMetric Constructor. More...

virtual	~MsgFacilityMetric ()
	MsgFacilityMetric Destructor. Calls stopMetrics()

std::string	getLibName () const override
	Return the library name of the MetricPlugin. More...

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.". More...

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. More...

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. More...

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. More...

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. More...

void	startMetrics_ () override
	Perform startup actions. No-Op.

void	stopMetrics_ () override
	Perform shutdown actions. No-Op.

Public Member Functions inherited from artdaq::MetricPlugin
	MetricPlugin (fhicl::ParameterSet const &ps, std::string const &app_name)
	MetricPlugin Constructor. More...

virtual	~MetricPlugin ()=default
	Default virtual Desctructor.

void	addMetricData (std::unique_ptr< MetricData > const &data)
	Send a metric value to the MetricPlugin. More...

void	sendMetrics (bool forceSend=false, std::chrono::steady_clock::time_point interval_end=std::chrono::steady_clock::now())
	For each known metric, determine whether the reporting interval has elapsed, and if so, report a value to the underlying metric storage. More...

void	startMetrics ()
	Perform startup actions. Simply calls the virtual startMetrics_ function.

void	stopMetrics ()
	Perform shutdown actions. Zeroes out all accumulators, and sends zeros for each metric. Calls stopMetrics_() for any plugin-defined shutdown actions.

bool	IsLevelEnabled (int level)
	Determine if the given level is enabled for this MetricPlugin instance. More...

Additional Inherited Members
Public Types inherited from artdaq::MetricPlugin
using	Parameters = fhicl::WrappedTable< Config >
	Used for ParameterSet validation (if desired)

Protected Member Functions inherited from artdaq::MetricPlugin
virtual void	sendMetric_ (const std::string &name, const long unsigned int &value, const std::string &unit)=0
	Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.) More...

Protected Attributes inherited from artdaq::MetricPlugin
fhicl::ParameterSet	pset
	The ParameterSet used to configure the MetricPlugin.

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

std::string	app_name_
	Name of the application which is sending metrics to this plugin.

bool	inhibit_
	Flag to indicate that the MetricPlugin is being stopped, and any metric back-ends which do not have a persistent state (i.e. file) should not report further metrics.

std::bitset< 64 >	level_mask_
	Bitset indicating for each possible metric level, whether this plugin will receive those metrics.

Detailed Description

A MetricPlugin class which sends metric data to MessageFacility.

Definition at line 19 of file msgFacility_metric.cc.

Constructor & Destructor Documentation

artdaq::MsgFacilityMetric::MsgFacilityMetric	(	fhicl::ParameterSet const &	config,
		std::string const &	app_name
	)

inlineexplicit

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

inlineoverridevirtual

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 std::string &	value,
		const std::string &	unit
	)

inlineoverridevirtual

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.

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

inlineoverridevirtual

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 double &	value,
		const std::string &	unit
	)

inlineoverridevirtual

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 float &	value,
		const std::string &	unit
	)

inlineoverridevirtual

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

inlineoverride

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.

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

artdaq_utilities/artdaq-utilities/Plugins/msgFacility_metric.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation