artdaq_utilities
v1_05_01
|
PeriodicReportMetric writes metric data to a file on disk. More...
Public Member Functions | |
PeriodicReportMetric (fhicl::ParameterSet const &config, std::string const &app_name) | |
PeriodicReportMetric Constructor. More... | |
virtual | ~PeriodicReportMetric () |
PeriodicReportMetric Destructor. Calls stopMetrics and then closes the file. | |
std::string | getLibName () const override |
Get the library name for the PeriodicReport metric. More... | |
void | sendMetric_ (const std::string &name, const std::string &value, const std::string &unit) override |
Write metric data to a file. More... | |
void | sendMetric_ (const std::string &name, const int &value, const std::string &unit) override |
Write metric data to a file. More... | |
void | sendMetric_ (const std::string &name, const double &value, const std::string &unit) override |
Write metric data to a file. More... | |
void | sendMetric_ (const std::string &name, const float &value, const std::string &unit) override |
Write metric data to a file. More... | |
void | sendMetric_ (const std::string &name, const unsigned long int &value, const std::string &unit) override |
Write metric data to a file. More... | |
void | startMetrics_ () override |
Perform startup actions. | |
void | stopMetrics_ () override |
Perform shutdown actions. | |
![]() | |
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... | |
bool | metricsPending () |
Determine if metrics are waiting to be sent. More... | |
Additional Inherited Members | |
![]() | |
using | Parameters = fhicl::WrappedTable< Config > |
Used for ParameterSet validation (if desired) | |
![]() | |
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... | |
![]() | |
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. | |
bool | sendZeros_ |
Whether zeros should be sent to this metric backend when metric instances are missing or at the end of the run. | |
PeriodicReportMetric writes metric data to a file on disk.
Definition at line 23 of file report_metric.cc.
|
inlineexplicit |
PeriodicReportMetric Constructor.
config | ParameterSet used to configure PeriodicReportMetric |
app_name | Name of the application sending metrics |
* PeriodicReportMetric accepts no parameters. *
Definition at line 42 of file report_metric.cc.
|
inlineoverridevirtual |
Get the library name for the PeriodicReport metric.
Reimplemented from artdaq::MetricPlugin.
Definition at line 62 of file report_metric.cc.
|
inlineoverridevirtual |
Write metric data to a file.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 70 of file report_metric.cc.
|
inlineoverridevirtual |
Write metric data to a file.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 85 of file report_metric.cc.
|
inlineoverridevirtual |
Write metric data to a file.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 96 of file report_metric.cc.
|
inlineoverridevirtual |
Write metric data to a file.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Implements artdaq::MetricPlugin.
Definition at line 107 of file report_metric.cc.
|
inlineoverride |
Write metric data to a file.
name | Name of the metric |
value | Value of the metric |
unit | Units of the metric |
Definition at line 118 of file report_metric.cc.