artdaq_utilities  v1_08_00
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/MetricData.hh"
13 #include "artdaq-utilities/Plugins/MetricPlugin.hh"
14 #include "artdaq-utilities/Plugins/SystemMetricCollector.hh"
15 
16 namespace fhicl { class ParameterSet; }
17 
18 #include "fhiclcpp/types/Atom.h"
19 #include "fhiclcpp/types/Comment.h"
20 #include "fhiclcpp/types/ConfigurationTable.h"
21 #include "fhiclcpp/types/Name.h"
22 #include "fhiclcpp/types/OptionalTable.h"
23 
24 #include <atomic>
25 #include <boost/thread.hpp>
26 #include <condition_variable>
27 #include <queue>
28 #include <sstream>
29 
30 namespace artdaq {
31 class MetricManager;
32 }
33 
40 {
41 public:
45  struct Config
46  {
49  fhicl::Atom<size_t> metric_queue_size{
50  fhicl::Name{"metric_queue_size"},
51  fhicl::Comment{"The maximum number of metric entries which can be stored in the metric queue."}, 1000};
54  fhicl::Atom<size_t> metric_queue_notify_size{
55  fhicl::Name{"metric_queue_notify_size"},
56  fhicl::Comment{
57  "The number of metric entries in the list which will cause reports of the queue size to be printed."},
58  10};
61  fhicl::Atom<int> metric_send_maximum_delay_ms{
62  fhicl::Name{"metric_send_maximum_delay_ms"},
63  fhicl::Comment{"The maximum amount of time between metric send calls (will send 0s for metrics which have not "
64  "reported in this interval)"},
65  15000};
67  fhicl::Atom<bool> send_system_metrics{fhicl::Name{"send_system_metrics"}, fhicl::Comment{"Whether to collect and send system metrics such as CPU usage, Memory usage and network activity."}, false};
69  fhicl::Atom<bool> send_process_metrics{fhicl::Name{"send_process_metrics"}, fhicl::Comment{"Whether to collect and send process CPU usage and Memory usage"}, false};
71  fhicl::OptionalTable<artdaq::MetricPlugin::Config> metricConfig{fhicl::Name{"metricConfig"}};
72  };
74  using Parameters = fhicl::WrappedTable<Config>;
75 
79  MetricManager();
80 
84  MetricManager(MetricManager const&) = delete;
85 
91  virtual ~MetricManager() noexcept;
92 
97  MetricManager& operator=(MetricManager const&) = delete;
98 
102  MetricManager(MetricManager&&) = delete;
107  MetricManager& operator=(MetricManager&&) = delete;
108 
122  void initialize(fhicl::ParameterSet const& pset, std::string const& prefix = "");
123 
127  void do_start();
128 
132  void do_stop();
133 
137  void do_pause();
138 
142  void do_resume();
143 
151  void reinitialize(fhicl::ParameterSet const& pset, std::string const& prefix = "");
152 
156  void shutdown();
157 
171  void sendMetric(std::string const& name, std::string const& value, std::string const& unit, int level,
172  MetricMode mode, std::string const& metricPrefix = "", bool useNameOverride = false);
173 
187  void sendMetric(std::string const& name, int const& value, std::string const& unit, int level, MetricMode mode,
188  std::string const& metricPrefix = "", bool useNameOverride = false);
189 
203  void sendMetric(std::string const& name, double const& value, std::string const& unit, int level, MetricMode mode,
204  std::string const& metricPrefix = "", bool useNameOverride = false);
205 
219  void sendMetric(std::string const& name, float const& value, std::string const& unit, int level, MetricMode mode,
220  std::string const& metricPrefix = "", bool useNameOverride = false);
221 
235  void sendMetric(std::string const& name, uint64_t const& value, std::string const& unit, int level,
236  MetricMode mode, std::string const& metricPrefix = "", bool useNameOverride = false);
237 
242  void setPrefix(std::string const& prefix) { prefix_ = prefix; }
243 
248  bool Initialized() { return initialized_; }
249 
254  bool Running() { return running_; }
255 
260  bool Active() { return active_; }
261 
266  bool metricQueueEmpty();
267 
272  bool metricManagerBusy();
273 
279  size_t metricQueueSize(std::string const& name = "");
280 
281 private:
282  void sendMetricLoop_();
283 
284  void startMetricLoop_();
285 
286  std::vector<std::unique_ptr<artdaq::MetricPlugin>> metric_plugins_;
287  boost::thread metric_sending_thread_;
288  std::mutex metric_mutex_;
289  std::condition_variable metric_cv_;
290  int metric_send_interval_ms_{15000};
291  int metric_holdoff_us_{1000};
292  std::chrono::steady_clock::time_point last_metric_received_;
293  std::unique_ptr<SystemMetricCollector> system_metric_collector_;
294 
295  std::atomic<bool> initialized_;
296  std::atomic<bool> running_;
297  std::atomic<bool> active_;
298  std::atomic<bool> busy_;
299  std::string prefix_;
300 
301  std::unordered_map<std::string, std::unique_ptr<MetricData>> metric_cache_;
302  std::mutex metric_cache_mutex_;
303  std::atomic<size_t> missed_metric_calls_;
304  std::atomic<size_t> metric_calls_;
305  size_t metric_cache_max_size_{1000};
306  size_t metric_cache_notify_size_{10};
307 };
308 
309 #endif /* artdaq_DAQrate_MetricManager_hh */
fhicl::Atom< int > metric_send_maximum_delay_ms
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...
bool metricManagerBusy()
Determine whether the MetricManager or any of its plugins are currently processing metrics...
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.
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
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.
MetricMode
The Mode of the metric indicates how multiple metric values should be combined within a reporting int...
Definition: MetricData.hh:27
fhicl::OptionalTable< artdaq::MetricPlugin::Config > metricConfig
Example MetricPlugin Configuration.
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation (if desired)
bool Active()
Returns whether any Metric Plugins are defined and configured
fhicl::Atom< bool > send_system_metrics
&quot;send_system_metrics&quot;: (Default: false): Whether to collect and send system metrics such as CPU usage...
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
fhicl::Atom< bool > send_process_metrics
&quot;send_process_metrics&quot; (Default: false): Whether to collect and send process CPU usage and Memory usa...