artdaq_utilities
v1_04_01
|
Send a metric to Graphite. More...
Public Member Functions | |
GraphiteMetric (fhicl::ParameterSet config) | |
GraphiteMetric Constructor. More... | |
virtual | ~GraphiteMetric () |
GraphiteMetric Destructor. Calls stopMetrics() | |
std::string | getLibName () const override |
Get the library name for the Graphite metric. More... | |
void | sendMetric_ (const std::string &name, const std::string &value, const std::string &) override |
Send a metric to Graphite. More... | |
void | sendMetric_ (const std::string &name, const int &value, const std::string &unit) override |
Send a metric to Graphite. More... | |
void | sendMetric_ (const std::string &name, const double &value, const std::string &unit) override |
Send a metric to Graphite. More... | |
void | sendMetric_ (const std::string &name, const float &value, const std::string &unit) override |
Send a metric to Graphite. More... | |
void | sendMetric_ (const std::string &name, const unsigned long int &value, const std::string &unit) override |
Send a metric to Graphite. More... | |
void | startMetrics_ () override |
Perform startup actions. For Graphite, this means reconnecting the socket. | |
void | stopMetrics_ () override |
Perform shutdown actions. This shuts down the socket and closes it. | |
![]() | |
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. | |
Send a metric to Graphite.
Graphite accepts metrics in a tree hiereachy, using '.' as a delimiter. Therefore, the metric artdaq.BoardReader.Fragment_Rate will appear in Graphite as: artdaq/ BoardReader/ Fragment_Rate
This plugin sends TCP messages with the following content: [name] [value] [timestamp], units are discarded
Definition at line 32 of file graphite_metric.cc.
|
inlineexplicit |
GraphiteMetric Constructor.
config | ParameterSet used to configure GraphiteMetric |
* GraphiteMetric accepts the following Parameters: * "host" (Default: "localhost"): Destination host * "port" (Default: 2003): Destination port * "namespace" (Default: "artdaq."): Directory name to prepend to all metrics. Should include the trailing '.' *
Definition at line 55 of file graphite_metric.cc.
|
inlineoverridevirtual |
Get the library name for the Graphite metric.
Reimplemented from artdaq::MetricPlugin.
Definition at line 76 of file graphite_metric.cc.
|
inlineoverridevirtual |
Send a metric to Graphite.
name | Name of the metric. Will have the namespace prepended |
value | Value of the metric |
Implements artdaq::MetricPlugin.
Definition at line 83 of file graphite_metric.cc.
|
inlineoverridevirtual |
Send a metric to Graphite.
name | Name of the metric. Will have the namespace prepended |
value | Value of the metric |
unit | Units of the metric (Not used) |
Implements artdaq::MetricPlugin.
Definition at line 112 of file graphite_metric.cc.
|
inlineoverridevirtual |
Send a metric to Graphite.
name | Name of the metric. Will have the namespace prepended |
value | Value of the metric |
unit | Units of the metric (Not used) |
Implements artdaq::MetricPlugin.
Definition at line 123 of file graphite_metric.cc.
|
inlineoverridevirtual |
Send a metric to Graphite.
name | Name of the metric. Will have the namespace prepended |
value | Value of the metric |
unit | Units of the metric (Not used) |
Implements artdaq::MetricPlugin.
Definition at line 134 of file graphite_metric.cc.
|
inlineoverride |
Send a metric to Graphite.
name | Name of the metric. Will have the namespace prepended |
value | Value of the metric |
unit | Units of the metric (Not used) |
Definition at line 145 of file graphite_metric.cc.