artdaq_utilities  v1_04_01
artdaq Namespace Reference

The artdaq namespace. More...

Classes

class  FileMetric
 FileMetric writes metric data to a file on disk. More...
 
class  GraphiteMetric
 Send a metric to Graphite. More...
 
struct  MetricData
 Small structure used to hold a metric data point before sending to the metric plugins More...
 
class  MetricManager
 The MetricManager class handles loading metric plugins and asynchronously sending metric data to them. It is designed to be a "black hole" for metrics, taking as little time as possible so that metrics do not impact the data-taking performance. More...
 
class  MetricPlugin
 The MetricPlugin class defines the interface that MetricManager uses to send metric data to the various metric plugins. More...
 
class  MsgFacilityMetric
 A MetricPlugin class which sends metric data to MessageFacility. More...
 
class  ProcFileMetric
 A MetricPlugin which writes a long unsigned int metric with a given name to a given pipe. More...
 

Typedefs

typedef std::unique_ptr
< artdaq::MetricPlugin
makeFunc_t (fhicl::ParameterSet const &ps)
 Make a MetricPlugin instance, loading the plugin if necessary. More...
 

Enumerations

enum  MetricType {
  MetricType::InvalidMetric, MetricType::StringMetric, MetricType::IntMetric, MetricType::DoubleMetric,
  MetricType::FloatMetric, MetricType::UnsignedMetric
}
 This enumeration is used to identify the type of the metric instance (which value should be extraced from the union) More...
 
enum  MetricMode { MetricMode::LastPoint, MetricMode::Accumulate, MetricMode::Average }
 The Mode of the metric indicates how multiple metric values should be combined within a reporting interval More...
 

Functions

std::unique_ptr< MetricPluginmakeMetricPlugin (std::string const &generator_plugin_spec, fhicl::ParameterSet const &ps)
 Load a given MetricPlugin and return a pointer to it. More...
 

Detailed Description

The artdaq namespace.

Typedef Documentation

typedef std::unique_ptr<artdaq::MetricPlugin> artdaq::makeFunc_t(fhicl::ParameterSet const &ps)

Make a MetricPlugin instance, loading the plugin if necessary.

Parameters
psParameterSet used to configure the MetricPlugin instance
Returns
A std::unique_ptr<artdaq::MetricPlugin> to the new instance

Definition at line 16 of file MetricMacros.hh.

Enumeration Type Documentation

enum artdaq::MetricMode
strong

The Mode of the metric indicates how multiple metric values should be combined within a reporting interval

Enumerator
LastPoint 

Report only the last value recorded. Useful for event counters, run numbers, etc.

Accumulate 

Report the sum of all values. Use for counters to report accurate results.

Average 

Report the average of all values. Use for rates to report accurate results.

Definition at line 31 of file MetricData.hh.

enum artdaq::MetricType
strong

This enumeration is used to identify the type of the metric instance (which value should be extraced from the union)

Enumerator
InvalidMetric 

Default, invalid value.

StringMetric 

Metric is a std::string (not in union)

IntMetric 

Metric is an int.

DoubleMetric 

Metric is a double.

FloatMetric 

Metric is a float.

UnsignedMetric 

Metric is a long unsigned int.

Definition at line 18 of file MetricData.hh.

Function Documentation

std::unique_ptr< artdaq::MetricPlugin > artdaq::makeMetricPlugin ( std::string const &  generator_plugin_spec,
fhicl::ParameterSet const &  ps 
)

Load a given MetricPlugin and return a pointer to it.

Parameters
generator_plugin_specName of the MetricPlugin
psParameterSet with which to configure the MetricPlugin
Returns
std::unique_ptr to the new MetricPlugin instance

Definition at line 8 of file makeMetricPlugin.cc.