artdaq_utilities  v1_05_04
artdaq::MetricPlugin::Config Struct Reference

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

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

Public Attributes

fhicl::Atom< std::string > metricPluginType {fhicl::Name{"metricPluginType"}, fhicl::Comment{"The name of the metric plugin to load (may have additional configuration parameters"}}
 The name of the metric plugin to load (may have additional configuration parameters.
 
fhicl::Atom< size_t > level {fhicl::Name{"level"}, fhicl::Comment{"The verbosity level threshold for this plugin. sendMetric calls with verbosity level greater than this will not be sent to the plugin. OPTIONAL"}, 0}
 "level" (OPTIONAL): The verbosity level threshold for this plugin. sendMetric calls with verbosity level greater than this will not be sent to the plugin.
 
fhicl::Sequence< size_t > metric_levels {fhicl::Name{"metric_levels"}, fhicl::Comment{"A list of levels that should be enabled for this plugin. OPTIONAL"}, std::vector<size_t>()}
 "metric_levels" (OPTIONAL): A list of levels that should be enabled for this plugin.
 
fhicl::Atom< std::string > level_string {fhicl::Name{"level_string"}, fhicl::Comment{"A string containing a comma-separated list of levels to enable. Ranges are supported. Example: \"1,2,4-10,11\" OPTIONAL"}, ""}
 "level_string" (OPTIONAL): A string containing a comma-separated list of levels to enable. Ranges are supported. Example: "1,2,4-10,11"
 
fhicl::Atom< double > reporting_interval {fhicl::Name{"reporting_interval"}, fhicl::Comment{"How often recorded metrics are sent to the underlying metric storage"}, 15.0}
 "reporting_interval" (Default: 15.0): The interval, in seconds, which the metric plugin will accumulate values for.
 
fhicl::Atom< bool > send_zeros {fhicl::Name{"send_zeros"}, fhicl::Comment{"Whether zeros should be sent to the metric back-end when metrics are not reported in an interval and during shutdown"}, true}
 "send_zeros" (Default: true): Whether zeros should be sent to the metric back-end when metrics are not reported in an interval and during shutdown
 

Detailed Description

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

Definition at line 43 of file MetricPlugin.hh.


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