artdaq_utilities
v1_04_02
|
A MetricPlugin class which sends metric data to MessageFacility. More...
Public Member Functions | |
MsgFacilityMetric (fhicl::ParameterSet config) | |
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. | |
![]() | |
MetricPlugin (fhicl::ParameterSet const &ps) | |
MetricPlugin Constructor. More... | |
virtual | ~MetricPlugin ()=default |
Default virtual Desctructor. | |
void | addMetricData (MetricData data) |
Send a metric value to the MetricPlugin. More... | |
void | sendMetrics (bool forceSend=false) |
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. | |
void | setRunLevel (int level) |
Set the threshold for sending metrics to the underlying storage. More... | |
int | getRunLevel () const |
Get the threshold for sending metrics to the underlying storage. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
int | runLevel_ |
The threshold for sending metrics to the underlying storage. Metrics with level <= to runLevel_ will be sent. | |
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. | |
bool | inhibit_ |
Whether to inhibit all metric sending. | |
A MetricPlugin class which sends metric data to MessageFacility.
Definition at line 20 of file msgFacility_metric.cc.
|
inlineexplicit |
MsgFacilityMetric Constructor.
config | ParameterSet used to configure MsgFacilityMetric |
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 38 of file msgFacility_metric.cc.
|
inlineoverridevirtual |
Return the library name of the MetricPlugin.
Reimplemented from artdaq::MetricPlugin.
Definition at line 78 of file msgFacility_metric.cc.
|
inlineoverridevirtual |
Send a metric to MessageFacilty. Format is: "name: value unit.".
name | Name of the metric |
value | Value of the metric |
unit | Units for the metric |
Implements artdaq::MetricPlugin.
Definition at line 86 of file msgFacility_metric.cc.
|
inlineoverridevirtual |
Send a metric to MessageFacility. All metrics are converted to strings.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 114 of file msgFacility_metric.cc.
|
inlineoverridevirtual |
Send a metric to MessageFacility. All metrics are converted to strings.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 125 of file msgFacility_metric.cc.
|
inlineoverridevirtual |
Send a metric to MessageFacility. All metrics are converted to strings.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 136 of file msgFacility_metric.cc.
|
inlineoverride |
Send a metric to MessageFacility. All metrics are converted to strings.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Definition at line 147 of file msgFacility_metric.cc.