artdaq_utilities
v1_05_00
|
Public Member Functions | |
MetricPluginTestAdapter (fhicl::ParameterSet ps) | |
virtual void | sendMetric_ (const std::string &, const std::string &, const std::string &) override |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.) More... | |
virtual void | sendMetric_ (const std::string &, const int &, const std::string &) override |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.) More... | |
virtual void | sendMetric_ (const std::string &, const double &, const std::string &) override |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.) More... | |
virtual void | sendMetric_ (const std::string &, const float &, const std::string &) override |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.) More... | |
virtual void | sendMetric_ (const std::string &, const long unsigned int &, const std::string &) override |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.) More... | |
virtual void | startMetrics_ () override |
Perform any start-up actions necessary for the metric plugin. More... | |
virtual void | stopMetrics_ () override |
Perform any shutdown actions necessary for the metric plugin. More... | |
fhicl::ParameterSet | get_pset () |
double | get_accumulationTime_ () |
std::string | get_app_name_ () |
bool | get_inhibit_ () |
std::bitset< 64 > | get_level_mask_ () |
![]() | |
MetricPlugin (fhicl::ParameterSet const &ps, std::string const &app_name) | |
MetricPlugin Constructor. More... | |
virtual | ~MetricPlugin ()=default |
Default virtual Desctructor. | |
virtual std::string | getLibName () const |
Return the name of the current MetricPlugin instance. | |
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 | |
![]() | |
using | Parameters = fhicl::WrappedTable< Config > |
Used for ParameterSet validation (if desired) | |
![]() | |
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. | |
Definition at line 12 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.)
name | Name of the metric |
value | Value of the metric |
unit | Units for the metric |
Note this is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 26 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.)
name | Name of the metric |
value | Value of the metric |
unit | Units for the metric |
Note this is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 27 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.)
name | Name of the metric |
value | Value of the metric |
unit | Units for the metric |
Note this is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 28 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.)
name | Name of the metric |
value | Value of the metric |
unit | Units for the metric |
Note this is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 29 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.)
name | Name of the metric |
value | Value of the metric |
unit | Units for the metric |
Note this is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 30 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Perform any start-up actions necessary for the metric plugin.
This is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 32 of file MetricPlugin_t.cc.
|
inlineoverridevirtual |
Perform any shutdown actions necessary for the metric plugin.
This is a pure virtual function, it should be overridden by implementation plugins
Implements artdaq::MetricPlugin.
Definition at line 33 of file MetricPlugin_t.cc.