artdaq_utilities
v1_04_02
|
A MetricPlugin which writes a long unsigned int metric with a given name to a given pipe. More...
Public Member Functions | |
ProcFileMetric (fhicl::ParameterSet config) | |
ProcFileMetric Constructor. More... | |
~ProcFileMetric () | |
ProcFileMetric Destructor. | |
std::string | getLibName () const override |
Get the "library name" of this Metric. More... | |
void | sendMetric_ (const std::string &name, const std::string &value, const std::string &) override |
Set the value to be written to the pipe when it is opened by a reader. More... | |
void | sendMetric_ (const std::string &name, const int &value, const std::string &unit) override |
Set the value to be written to the pipe when it is opened by a reader. More... | |
void | sendMetric_ (const std::string &name, const double &value, const std::string &unit) override |
Set the value to be written to the pipe when it is opened by a reader. More... | |
void | sendMetric_ (const std::string &name, const float &value, const std::string &unit) override |
Set the value to be written to the pipe when it is opened by a reader. More... | |
void | sendMetric_ (const std::string &name, const unsigned long int &value, const std::string &unit) override |
Set the value to be written to the pipe when it is opened by a reader. More... | |
void | startMetrics_ () override |
Start the metric-sending thread. | |
void | stopMetrics_ () override |
Open the pipe for reading to allow the metric-sending thread to end gracefully. | |
void | writePipe () |
Wait for the pipe to be opened and then write the current value to 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. | |
A MetricPlugin which writes a long unsigned int metric with a given name to a given pipe.
This MetricPlugin emulates the function of the /proc file system, where the kernel provides access to various counters and parameters.
Definition at line 24 of file procFile_metric.cc.
|
inlineexplicit |
ProcFileMetric Constructor.
config | FHiCL ParameterSet used to configure the ProcFileMetric |
* ProcFileMetric accepts the following Parameters (in addition to those accepted by MetricPlugin): * "pipe": Name of pipe virtual file to write to * "name": Name of the metric to write to pipe *
Definition at line 42 of file procFile_metric.cc.
|
inlineoverridevirtual |
Get the "library name" of this Metric.
Reimplemented from artdaq::MetricPlugin.
Definition at line 72 of file procFile_metric.cc.
|
inlineoverridevirtual |
Set the value to be written to the pipe when it is opened by a reader.
name | Name of the metric. Must match configred name for value to be updated (This MetricPlugin should be used with the useNameOverride parameter!) |
value | Value of the metric. |
Implements artdaq::MetricPlugin.
Definition at line 79 of file procFile_metric.cc.
|
inlineoverridevirtual |
Set the value to be written to the pipe when it is opened by a reader.
name | Name of the metric. Must match configred name for value to be updated (This MetricPlugin should be used with the useNameOverride parameter!) |
value | Value of the metric. |
unit | Units of the metric. |
Implements artdaq::MetricPlugin.
Definition at line 92 of file procFile_metric.cc.
|
inlineoverridevirtual |
Set the value to be written to the pipe when it is opened by a reader.
name | Name of the metric. Must match configred name for value to be updated (This MetricPlugin should be used with the useNameOverride parameter!) |
value | Value of the metric. |
unit | Units of the metric. |
Implements artdaq::MetricPlugin.
Definition at line 102 of file procFile_metric.cc.
|
inlineoverridevirtual |
Set the value to be written to the pipe when it is opened by a reader.
name | Name of the metric. Must match configred name for value to be updated (This MetricPlugin should be used with the useNameOverride parameter!) |
value | Value of the metric. |
unit | Units of the metric. |
Implements artdaq::MetricPlugin.
Definition at line 112 of file procFile_metric.cc.
|
inlineoverride |
Set the value to be written to the pipe when it is opened by a reader.
name | Name of the metric. Must match configred name for value to be updated (This MetricPlugin should be used with the useNameOverride parameter!) |
value | Value of the metric. |
unit | Units of the metric. |
Definition at line 122 of file procFile_metric.cc.