artdaq_utilities  v1_04_08
MetricManager.hh
1 #ifndef artdaq_DAQrate_MetricManager_hh
2 #define artdaq_DAQrate_MetricManager_hh
3 
4 // MetricManager class definition file
5 // Author: Eric Flumerfelt
6 // Last Modified: 11/14/2014
7 //
8 // MetricManager loads a user-specified set of plugins, sends them their configuration,
9 // and sends them data as it is recieved. It also maintains the state of the plugins
10 // relative to the application state.
11 
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"
17 
18 #include <sstream>
19 #include <queue>
20 #include <condition_variable>
21 #include <atomic>
22 #include <boost/thread.hpp>
23 
24 namespace artdaq
25 {
26  class MetricManager;
27 }
28 
35 {
36 public:
40  struct Config
41  {
43  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 };
45  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 };
47  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 };
49  fhicl::OptionalTable<artdaq::MetricPlugin::Config> metricConfig{ fhicl::Name{"metricConfig"} };
50  };
51  using Parameters = fhicl::WrappedTable<Config>;
52 
56  MetricManager();
57 
61  MetricManager(MetricManager const&) = delete;
62 
68  virtual ~MetricManager() noexcept;
69 
74  MetricManager& operator=(MetricManager const&) = delete;
75 
88  void initialize(fhicl::ParameterSet const& pset, std::string const& prefix = "");
89 
93  void do_start();
94 
98  void do_stop();
99 
103  void do_pause();
104 
108  void do_resume();
109 
117  void reinitialize(fhicl::ParameterSet const& pset, std::string const& prefix = "");
118 
122  void shutdown();
123 
137  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);
138 
152  void sendMetric(std::string const& name, int const& value, std::string const& unit, int level, MetricMode mode, std::string const& metricPrefix = "", bool useNameOverride = false);
153 
167  void sendMetric(std::string const& name, double const& value, std::string const& unit, int level, MetricMode mode, std::string const& metricPrefix = "", bool useNameOverride = false);
168 
182  void sendMetric(std::string const& name, float const& value, std::string const& unit, int level, MetricMode mode, std::string const& metricPrefix = "", bool useNameOverride = false);
183 
197  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 
203  void setPrefix(std::string const& prefix) { prefix_ = prefix; }
204 
209  bool Initialized() { return initialized_; }
210 
215  bool Running() { return running_; }
216 
221  bool Active() { return active_; }
222 
227  bool metricQueueEmpty();
228 
234  size_t metricQueueSize(std::string const& name = "");
235 
236 private:
237  void sendMetricLoop_();
238 
239  void startMetricLoop_();
240 
241  std::vector<std::unique_ptr<artdaq::MetricPlugin>> metric_plugins_;
242  boost::thread metric_sending_thread_;
243  std::mutex metric_mutex_;
244  std::condition_variable metric_cv_;
245  int metric_send_interval_ms_;
246 
247  std::atomic<bool> initialized_;
248  std::atomic<bool> running_;
249  std::atomic<bool> active_;
250  std::string prefix_;
251 
252  //https://stackoverflow.com/questions/228908/is-listsize-really-on
253  // e10 does NOT properly have std::list::size as O(1)!!! Keep track of size separately while we still support e10.
254  typedef std::unique_ptr<MetricData> metric_data_ptr;
255  typedef std::pair<std::atomic<size_t>, std::list<metric_data_ptr>> queue_entry;
256 
257  std::unordered_map<std::string, queue_entry> metric_queue_;
258  std::mutex metric_queue_mutex_;
259  std::atomic<size_t> missed_metric_calls_;
260  size_t metric_queue_max_size_;
261  size_t metric_queue_notify_size_;
262 };
263 
264 #endif /* artdaq_DAQrate_MetricManager_hh */
fhicl::Atom< int > metric_send_maximum_delay_ms
&quot;metric_send_maximum_delay_ms&quot;: (Default: 15000): The maximum amount of time between metric send call...
void shutdown()
Call the destructors for all configured MetricPlugin instances.
void initialize(fhicl::ParameterSet const &pset, std::string const &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 &gt;= to level...
size_t metricQueueSize(std::string const &name="")
Return the size of the named metric queue
void reinitialize(fhicl::ParameterSet const &pset, std::string const &prefix="")
Reinitialize all MetricPlugin Instances.
MetricMode
The Mode of the metric indicates how multiple metric values should be combined within a reporting int...
Definition: MetricData.hh:30
MetricManager()
Construct an instance of the MetricManager class.
void do_start()
Perform startup actions for each configured MetricPlugin.
fhicl::Atom< size_t > metric_queue_notify_size
&quot;metric_queue_notify_size&quot;: (Default: 10): The number of metric entries in the list which will cause ...
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.
void setPrefix(std::string const &prefix)
Sets the prefix prepended to all metrics without useNameOverride set.
The MetricManager class handles loading metric plugins and asynchronously sending metric data to them...
The Config struct defines the accepted configuration parameters for this class.
fhicl::OptionalTable< artdaq::MetricPlugin::Config > metricConfig
Example MetricPlugin Configuration.
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.
fhicl::Atom< size_t > metric_queue_size
&quot;metric_queue_size&quot;: (Default: 1000): The maximum number of metric entries which can be stored in the...