Add concept of run number (#234)

Author: awegrzyn

CMakeLists.txt

@@ -17,7 +17,7 @@ endif()
 
 # Define project
 project(Monitoring
-  VERSION 3.6.0
+  VERSION 3.7.0
   DESCRIPTION "O2 Monitoring library"
   LANGUAGES CXX
 )
@@ -188,6 +188,7 @@ set(EXAMPLES
   examples/6-Increment.cxx
   examples/7-InternalBenchamrk.cxx
   examples/8-DbFiller.cxx
+  examples/9-RunNumber.cxx
   examples/10-Buffering.cxx
 )
 

README.md

@@ -80,6 +80,7 @@ Metric{"name"}.addValue(10, "value")
 ```
 
 #### Tags
+1. Metric tags
 Each metric can be tagged with any number of [predefined tags](include/Monitoring/Tags.h).
 In order to do so use `addTag(tags::Key, tags::Value)` or `addTag(tags::Key, unsigned short)` methods. The latter method allows assigning numeric value to a tag.
 
@@ -89,6 +90,15 @@ Metric{10, "name"}.addTag(tags::Key::Subsystem, tags::Value::QC)
 
 See the example: [examples/2-TaggedMetrics.cxx](examples/2-TaggedMetrics.cxx).
 
+2. Global tags
+Global tags are added to each metric sent eg. `hostname` tag is added by default by the library.
+
+You can add your own global tag by calling `addGlobalTag(std::string_view key, std::string_view value)` or `addGlobalTag(tags::Key, tags::Value)` on Monitoring object.
+
+3. Run number
+Run number is special case of a global tag, its value can be overwritten at any time, therefore it benefits simplified handling: `setRunNumber(uint32_t)`
+
+
 ### Sending metric
 Pass metric object to `send` method as l-value reference:
 ```cpp
@@ -137,11 +147,6 @@ The derived value is generated only from the first value of the metric and it is
 
 See how it works in the example: [examples/4-RateDerivedMetric.cxx](examples/4-RateDerivedMetric.cxx).
 
-### Global tags
-Global tags are added to each metric sent using given monitoring instance. `hostname` is set as global by default.
-
-You can add your own global tag by calling `addGlobalTag(std::string_view key, std::string_view value)` or `addGlobalTag(tags::Key, tags::Value)`.
-
 ### Process monitoring
 
 This feature provides basic performance status of the process. Note that is runs in separate thread (without mutex).

examples/9-RunNumber.cxx

@@ -0,0 +1,22 @@
+///
+/// \file 9-RunNumber.cxx
+/// \author Adam Wegrzynek <[email protected]>
+///
+
+#include "Monitoring/MonitoringFactory.h"
+
+using namespace o2::monitoring;
+
+int main()
+{
+
+  // Configure monitoring
+  // Pass string with list of URLs as parameter
+  auto monitoring = MonitoringFactory::Get("influxdb-stdout://");
+
+  monitoring->send(Metric{10, "myMetric"});
+  monitoring->setRunNumber(1);
+  monitoring->send(Metric{10, "myMetric"});
+  monitoring->setRunNumber(2);
+  monitoring->send(Metric{10, "myMetric"});
+}

include/Monitoring/Backend.h

@@ -35,10 +35,21 @@ class Backend
  private:
   /// Verbosity level
   Verbosity verbosityLevel;
+protected:
+  /// Run number
+  uint32_t mRunNumber;
 
  public:
   /// Default constructor
-  Backend() { verbosityLevel = Verbosity::Info; }
+  Backend() {
+    mRunNumber = 0;
+    verbosityLevel = Verbosity::Info;
+  }
+
+  /// Run number setter
+  void setRunNumber(uint32_t runNumber) {
+    mRunNumber = runNumber;
+  }
 
   /// Default destructor
   virtual ~Backend() = default;

include/Monitoring/Monitoring.h

@@ -88,11 +88,9 @@ class Monitoring
   /// \param value            tag value
   void addGlobalTag(tags::Key key, tags::Value value);
 
-  /// Returns a metric which will be periodically sent to backends
-  /// \param name 		metric name
-  /// \return 		periodically send metric
-  //ComplexMetric& getAutoPushMetric(std::string name, unsigned int interval = 1);
-
+  /// Sets run number
+  /// \param name run  run number
+  void setRunNumber(uint32_t run);
  private:
   /// Sends multiple (not related to each other) metrics
   /// \param metrics  vector of metrics

include/Monitoring/Tags.h

@@ -39,7 +39,6 @@ enum class Key : unsigned short int {
   FLP,
   EPN,
   Unit,
-  Run,
   ID,
   Type,
   CRORC,
@@ -48,7 +47,7 @@ enum class Key : unsigned short int {
 };
 
 /// Tag keys array
-static constexpr std::array<std::string_view, 15> TAG_KEY = {
+static constexpr std::array<std::string_view, 14> TAG_KEY = {
   "hostname"sv,
   "rolenane"sv,
   "name"sv,
@@ -58,7 +57,6 @@ static constexpr std::array<std::string_view, 15> TAG_KEY = {
   "FLP"sv,
   "EPN"sv,
   "unit"sv,
-  "run"sv,
   "id"sv,
   "type"sv,
   "CRORC"sv,

src/Backends/ApMonBackend.cxx

@@ -68,6 +68,7 @@ void ApMonBackend::send(const Metric& metric)
     entity += '=';
     (value > 0) ? entity += tags::GetValue(value) : entity += std::to_string(0 - value);
   }
+  if (mRunNumber != 0) convert << ",run=" << mRunNumber;
 
   int valueSize = metric.getValuesSize();
   char **paramNames, **paramValues;

src/Backends/InfluxDB.cxx

@@ -85,6 +85,7 @@ std::string InfluxDB::toInfluxLineProtocol(const Metric& metric)
     convert << "," << tags::TAG_KEY[key] << "=";
     (value > 0) ? convert << tags::GetValue(value) : convert << (0 - value);
   }
+  if (mRunNumber != 0) convert << ",run=" << mRunNumber;
   convert << ' ';
   for (const auto& [name, value] : metric.getValues()) {
     convert << name << '=';

src/Backends/StdOut.cxx

@@ -84,6 +84,7 @@ void StdOut::send(const Metric& metric)
     convert << ',' << tags::TAG_KEY[key] << "=";
     (value > 0) ? convert << tags::GetValue(value) : convert << (0 - value);
   }
+  if (mRunNumber != 0) convert << ",run=" << mRunNumber;
   convert << '\n';
   std::cout << convert.str();
 }

src/Monitoring.cxx

@@ -110,6 +110,13 @@ void Monitoring::addGlobalTag(tags::Key key, tags::Value value)
   }
 }
 
+void Monitoring::setRunNumber(uint32_t run)
+{
+  for (auto& backend : mBackends) {
+    backend->setRunNumber(run);
+  }
+}
+
 void Monitoring::addBackend(std::unique_ptr<Backend> backend)
 {
   ProcessDetails processDetails{};