8 #ifndef __METRIC_INTERFACE__
9 #define __METRIC_INTERFACE__
13 #include <unordered_map>
14 #include "fhiclcpp/ParameterSet.h"
15 #include "fhiclcpp/types/Atom.h"
16 #if MESSAGEFACILITY_HEX_VERSION >= 0x20103
17 # include "fhiclcpp/types/ConfigurationTable.h"
20 #include "artdaq-utilities/Plugins/MetricData.hh"
21 #include "cetlib/compiler_macros.h"
23 #define FALLTHROUGH while(0)
37 fhicl::Atom<std::string> metricPluginType{ fhicl::Name{
"metricPluginType"}, fhicl::Comment{
"The name of the metric plugin to load (may have additional configuration parameters"} };
38 fhicl::Atom<int> level{ fhicl::Name{
"level"}, fhicl::Comment{
"The verbosity level threshold for this plugin. Metrics with verbosity level greater than this will not be sent to the plugin"}, 0 };
39 fhicl::Atom<double> reporting_interval{ fhicl::Name{
"reporting_interval"}, fhicl::Comment{
"How often recorded metrics are sent to the underlying metric storage"}, 15.0 };
41 #if MESSAGEFACILITY_HEX_VERSION >= 0x20103
42 using Parameters = fhicl::WrappedTable<Config>;
58 explicit MetricPlugin(fhicl::ParameterSet
const& ps, std::string
const& app_name) :
pset(ps)
80 virtual std::string
getLibName()
const {
return "ERROR"; }
90 virtual void sendMetric_(
const std::string& name,
const std::string& value,
const std::string& unit) = 0;
100 virtual void sendMetric_(
const std::string& name,
const int& value,
const std::string& unit) = 0;
110 virtual void sendMetric_(
const std::string& name,
const double& value,
const std::string& unit) = 0;
120 virtual void sendMetric_(
const std::string& name,
const float& value,
const std::string& unit) = 0;
130 virtual void sendMetric_(
const std::string& name,
const long unsigned int& value,
const std::string& unit) = 0;
164 if (!metricRegistry_.count(data.
Name))
166 metricRegistry_[data.
Name] = data;
168 metricData_[data.
Name].push_back(data);
177 void sendMetrics(
bool forceSend =
false, std::chrono::steady_clock::time_point interval_end = std::chrono::steady_clock::now())
179 for (
auto metric : metricData_)
181 auto metricName = metric.first;
182 if (readyToSend_(metricName) || forceSend)
184 if (metricData_[metricName].size() == 0 && metricRegistry_.count(metricName))
186 sendZero_(metricRegistry_[metricName]);
188 else if (metricData_[metricName].size() > 0)
190 auto metricMode = metricData_[metricName].back().Mode;
191 auto metricUnits = metricData_[metricName].back().Unit;
192 auto metricType = metricData_[metricName].back().Type;
196 if (metricData_[metricName].size() > 1)
198 metricData_[metricName].erase(metricData_[metricName].begin(), std::prev(metricData_[metricName].end()));
209 for (
auto& mv : metricData_[metricName]) { ds += mv.DoubleValue; }
212 case MetricMode::Average: ds /=
static_cast<double>(metricData_[metricName].size());
break;
213 case MetricMode::Rate: ds /= std::chrono::duration_cast<std::chrono::duration<double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count();
break;
214 case MetricMode::AccumulateAndRate:
sendMetric_(metricName +
" - Rate", ds / std::chrono::duration_cast<std::chrono::duration<
double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count(), metricUnits +
"/s");
break;
225 for (
auto& mv : metricData_[metricName]) { fs += mv.FloatValue; }
230 ds = fs /
static_cast<double>(metricData_[metricName].size());
234 ds = fs / std::chrono::duration_cast<std::chrono::duration<double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count();
238 sendMetric_(metricName +
" - Rate", fs / std::chrono::duration_cast<std::chrono::duration<
double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count(), metricUnits +
"/s");
251 for (
auto& mv : metricData_[metricName]) { is += mv.IntValue; }
256 ds = is /
static_cast<double>(metricData_[metricName].size());
260 ds = is / std::chrono::duration_cast<std::chrono::duration<double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count();
264 sendMetric_(metricName +
" - Rate", is / std::chrono::duration_cast<std::chrono::duration<
double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count(), metricUnits +
"/s");
277 for (
auto& mv : metricData_[metricName]) { us += mv.UnsignedValue; }
282 ds = us /
static_cast<double>(metricData_[metricName].size());
286 ds = us / std::chrono::duration_cast<std::chrono::duration<double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count();
290 sendMetric_(metricName +
" - Rate", us / std::chrono::duration_cast<std::chrono::duration<
double, std::ratio<1>>>(interval_end - interval_start_[metricName]).count(), metricUnits +
"/s");
302 metricData_[metricName].clear();
305 interval_start_[metricName] = interval_end;
323 for (
auto metric : metricRegistry_)
325 sendZero_(metric.second);
350 std::unordered_map<std::string, std::list<MetricData>> metricData_;
351 std::unordered_map<std::string, MetricData> metricRegistry_;
352 std::unordered_map<std::string, std::chrono::steady_clock::time_point> lastSendTime_;
353 std::unordered_map<std::string, std::chrono::steady_clock::time_point> interval_start_;
355 bool readyToSend_(std::string name)
357 auto now = std::chrono::steady_clock::now();
358 if (std::chrono::duration_cast<std::chrono::duration<
double, std::ratio<1>>>(now - lastSendTime_[name]).count() >=
accumulationTime_)
360 lastSendTime_[name] = now;
398 sendMetric_(data.Name, data.DoubleValue, data.Unit);
401 sendMetric_(data.Name, data.FloatValue, data.Unit);
407 sendMetric_(data.Name, data.UnsignedValue, data.Unit);
416 #endif //End ifndef __METRIC_INTERFACE__
virtual void startMetrics_()=0
Perform any start-up actions necessary for the metric plugin.
std::string StringValue
Value of the metric, if it is a MetricType::StringMetric
The MetricPlugin class defines the interface that MetricManager uses to send metric data to the vario...
void startMetrics()
Perform startup actions. Simply calls the virtual startMetrics_ function.
Report the average of all values. Use for rates to report accurate results.
fhicl::ParameterSet pset
The ParameterSet used to configure the MetricPlugin.
virtual void sendMetric_(const std::string &name, const std::string &value, const std::string &unit)=0
Send a metric to the underlying metric storage (file, Graphite, Ganglia, etc.)
std::string Unit
Units of the metric
Metric is a std::string (not in union)
std::string Name
Name of the metric
Reports the sum of all values, divided by the length of the time interval they were accumulated over...
MetricMode Mode
Accumulation mode of the metric
void addMetricData(MetricData data)
Send a metric value to the MetricPlugin.
void stopMetrics()
Perform shutdown actions. Zeroes out all accumulators, and sends zeros for each metric. Calls stopMetrics_() for any plugin-defined shutdown actions.
std::string app_name_
Name of the application which is sending metrics to this plugin.
Metric is a long unsigned int.
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...
int getRunLevel() const
Get the threshold for sending metrics to the underlying storage.
MetricPlugin(fhicl::ParameterSet const &ps, std::string const &app_name)
MetricPlugin Constructor.
virtual std::string getLibName() const
Return the name of the current MetricPlugin instance.
virtual void stopMetrics_()=0
Perform any shutdown actions necessary for the metric plugin.
Sends both the Accumulate mode and Rate mode metric. (Rate mode metric will append "/s" to metric uni...
MetricType Type
Type of the metric
Report the sum of all values. Use for counters to report accurate results.
double accumulationTime_
The amount of time to average metric values; except for accumulate=false metrics, will be the interva...
Small structure used to hold a metric data point before sending to the metric plugins ...
Report only the last value recorded. Useful for event counters, run numbers, etc. ...
virtual ~MetricPlugin()=default
Default virtual Desctructor.
void setRunLevel(int level)
Set the threshold for sending metrics to the underlying storage.
bool inhibit_
Whether to inhibit all metric sending.
int runLevel_
The threshold for sending metrics to the underlying storage. Metrics with level <= to runLevel_ will ...