1 #ifndef artdaq_DAQrate_MetricManager_hh
2 #define artdaq_DAQrate_MetricManager_hh
12 #include "artdaq-utilities/Plugins/MetricPlugin.hh"
13 #include "artdaq-utilities/Plugins/MetricData.hh"
14 #include "fhiclcpp/fwd.h"
15 #include "fhiclcpp/types/OptionalTable.h"
16 #include "messagefacility/MessageLogger/MessageLogger.h"
20 #include <condition_variable>
22 #include <boost/thread.hpp>
39 fhicl::Atom<size_t> metric_queue_size{ fhicl::Name{
"metric_queue_size"}, fhicl::Comment{
"The maximum number of metric entries which can be stored in the metric queue."}, 1000 };
40 fhicl::Atom<size_t> metric_queue_notify_size{ 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 };
41 fhicl::Atom<int> metric_send_maximum_delay_ms{ 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 };
42 fhicl::OptionalTable<artdaq::MetricPlugin::Config> metricConfig{ fhicl::Name{
"metricConfig"} };
44 #if MESSAGEFACILITY_HEX_VERSION >= 0x20103
45 using Parameters = fhicl::WrappedTable<Config>;
83 void initialize(fhicl::ParameterSet const& pset, std::
string prefix = "");
112 void reinitialize(fhicl::ParameterSet const& pset, std::
string prefix = "");
132 void sendMetric(std::
string const& name, std::
string const& value, std::
string const& unit,
int level,
MetricMode mode, std::
string const& metricPrefix = "",
bool useNameOverride = false);
147 void sendMetric(std::
string const& name,
int const& value, std::
string const& unit,
int level,
MetricMode mode, std::
string const& metricPrefix = "",
bool useNameOverride = false);
162 void sendMetric(std::
string const& name,
double const& value, std::
string const& unit,
int level,
MetricMode mode, std::
string const& metricPrefix = "",
bool useNameOverride = false);
177 void sendMetric(std::
string const& name,
float const& value, std::
string const& unit,
int level,
MetricMode mode, std::
string const& metricPrefix = "",
bool useNameOverride = false);
192 void sendMetric(std::
string const& name,
long unsigned int const& value, std::
string const& unit,
int level,
MetricMode mode, std::
string const& metricPrefix = "",
bool useNameOverride = false);
198 void setPrefix(std::
string prefix) { prefix_ = prefix; }
232 void sendMetricLoop_();
234 void startMetricLoop_();
236 std::vector<std::unique_ptr<artdaq::MetricPlugin>> metric_plugins_;
237 boost::thread metric_sending_thread_;
238 std::mutex metric_mutex_;
239 std::condition_variable metric_cv_;
240 int metric_send_interval_ms_;
249 typedef std::unique_ptr<MetricData> metric_data_ptr;
250 typedef std::pair<size_t, std::list<metric_data_ptr>> queue_entry;
252 std::unordered_map<std::string, queue_entry> metric_queue_;
253 std::mutex metric_queue_mutex_;
254 std::atomic<size_t> missed_metric_calls_;
255 size_t metric_queue_max_size_;
256 size_t metric_queue_notify_size_;
void reinitialize(fhicl::ParameterSet const &pset, std::string prefix="")
Reinitialize all MetricPlugin Instances.
void shutdown()
Call the destructors for all configured MetricPlugin instances.
void initialize(fhicl::ParameterSet const &pset, std::string prefix="")
Initialize the MetricPlugin instances.
bool Initialized()
Returns whether the MetricManager has been initialized (configured)
void sendMetric(std::string const &name, std::string const &value, std::string const &unit, int level, MetricMode mode, std::string const &metricPrefix="", bool useNameOverride=false)
Send a metric with the given parameters to any MetricPlugins with a threshold level >= to level...
MetricMode
The Mode of the metric indicates how multiple metric values should be combined within a reporting int...
size_t metricQueueSize(std::string name="")
Return the size of the named metric queue
MetricManager()
Construct an instance of the MetricManager class.
void do_start()
Perform startup actions for each configured MetricPlugin.
bool Running()
Returns whether the MetricManager is running (accepting metric calls)
void do_stop()
Stop sending metrics to the MetricPlugin instances.
virtual ~MetricManager() noexcept
MetricManager destructor.
The MetricManager class handles loading metric plugins and asynchronously sending metric data to them...
void setPrefix(std::string prefix)
Sets the prefix prepended to all metrics without useNameOverride set.
bool Active()
Returns whether any Metric Plugins are defined and configured
void do_resume()
Resume metric sending. Currently a No-Op.
bool metricQueueEmpty()
Returns whether the metric queue is completely empty
void do_pause()
Pause metric sending. Currently a No-Op.