artdaq_utilities  v1_05_09
artdaq::MetricManager::Config Struct Reference

The Config struct defines the accepted configuration parameters for this class. More...

#include <artdaq-utilities/Plugins/MetricManager.hh>

Public Attributes

fhicl::Atom< size_t > metric_queue_size
 
fhicl::Atom< size_t > metric_queue_notify_size
 
fhicl::Atom< int > metric_send_maximum_delay_ms
 
fhicl::Atom< bool > send_system_metrics {fhicl::Name{"send_system_metrics"}, fhicl::Comment{"Whether to collect and send system metrics such as CPU usage, Memory usage and network activity."}, false}
 "send_system_metrics": (Default: false): Whether to collect and send system metrics such as CPU usage, Memory usage and network activity.
 
fhicl::Atom< bool > send_process_metrics {fhicl::Name{"send_process_metrics"}, fhicl::Comment{"Whether to collect and send process CPU usage and Memory usage"}, false}
 "send_process_metrics" (Default: false): Whether to collect and send process CPU usage and Memory usage
 
fhicl::OptionalTable
< artdaq::MetricPlugin::Config
metricConfig {fhicl::Name{"metricConfig"}}
 Example MetricPlugin Configuration.
 

Detailed Description

The Config struct defines the accepted configuration parameters for this class.

Definition at line 40 of file MetricManager.hh.

Member Data Documentation

fhicl::Atom<size_t> artdaq::MetricManager::Config::metric_queue_notify_size
Initial value:
{
fhicl::Name{"metric_queue_notify_size"},
fhicl::Comment{
"The number of metric entries in the list which will cause reports of the queue size to be printed."},
10}

"metric_queue_notify_size": (Default: 10): The number of metric entries in the list which will cause reports of the queue size to be printed.

Definition at line 49 of file MetricManager.hh.

fhicl::Atom<size_t> artdaq::MetricManager::Config::metric_queue_size
Initial value:
{
fhicl::Name{"metric_queue_size"},
fhicl::Comment{"The maximum number of metric entries which can be stored in the metric queue."}, 1000}

"metric_queue_size": (Default: 1000): The maximum number of metric entries which can be stored in the metric queue.

Definition at line 44 of file MetricManager.hh.

fhicl::Atom<int> artdaq::MetricManager::Config::metric_send_maximum_delay_ms
Initial value:
{
fhicl::Name{"metric_send_maximum_delay_ms"},
fhicl::Comment{"The maximum amount of time between metric send calls (will send 0s for metrics which have not "
"reported in this interval)"},
15000}

"metric_send_maximum_delay_ms": (Default: 15000): The maximum amount of time between metric send calls (will send 0s for metrics which have not reported in this interval)

Definition at line 56 of file MetricManager.hh.


The documentation for this struct was generated from the following file: