Metric.h

Go to the documentation of this file.

#ifndef ALICEO2_MONITORING_CORE_METRIC_H
#define ALICEO2_MONITORING_CORE_METRIC_H

#include <string>
#include <chrono>
#include <map>
#include <regex>
#include <variant>
#include <vector>
#include "Tags.h"

namespace o2
{
namespace monitoring
{

enum class Verbosity : short { Prod,
                               Info,
                               Debug };

enum MetricType { INT = 0,
                  STRING = 1,
                  DOUBLE = 2,
                  UINT64_T = 3 };

class DerivedMetrics;

class Metric
{
 public:
  Metric(int value, const std::string& name, Verbosity verbosity = Metric::DefaultVerbosity);

  Metric(std::string value, const std::string& name, Verbosity verbosity = Metric::DefaultVerbosity);

  Metric(double value, const std::string& name, Verbosity verbosity = Metric::DefaultVerbosity);

  Metric(uint64_t value, const std::string& name, Verbosity verbosity = Metric::DefaultVerbosity);

  Metric(const std::string& name, Verbosity verbosity = Metric::DefaultVerbosity, const std::chrono::time_point<std::chrono::system_clock>& timestamp = Metric::getCurrentTimestamp());

  Metric&& addValue(int value, const std::string& name);

  Metric&& addValue(double value, const std::string& name);

  Metric&& addValue(uint64_t value, const std::string& name);

  Metric&& addValue(std::string value, const std::string& name);

  Metric&& addValue(const std::variant<int, std::string, double, uint64_t>& value, const std::string& name);

  ~Metric() = default;

  const std::string& getName() const;

  std::chrono::time_point<std::chrono::system_clock> getTimestamp() const;

  const std::vector<std::pair<std::string, std::variant<int, std::string, double, uint64_t>>>& getValues() const;

  const std::pair<std::string, std::variant<int, std::string, double, uint64_t>>& getFirstValue() const;

  std::size_t getValuesSize() const noexcept;

  const std::vector<std::pair<int, int>>& getTags() const;

  Metric&& addTag(tags::Key key, tags::Value value);

  Metric&& addTag(tags::Key key, unsigned short int number);

  Verbosity getVerbosity();

  static auto getCurrentTimestamp() -> decltype(std::chrono::system_clock::now());

  static void setDefaultVerbosity(Verbosity verbosity);

  static Verbosity DefaultVerbosity;

  static void setVerbosityPolicy(Verbosity verbosity, const std::regex& regex);

  static bool includeTimestamp;

  int getFirstValueType() const;

 protected:
  friend class o2::monitoring::DerivedMetrics;

  Metric&& setTags(std::vector<std::pair<int, int>>&& tags);

  std::vector<std::pair<std::string, std::variant<int, std::string, double, uint64_t>>> mValues;

  std::string mName;

  std::chrono::time_point<std::chrono::system_clock> mTimestamp;

  std::vector<std::pair<int, int>> mTags;

  Verbosity mVerbosity;

  static std::map<std::underlying_type<Verbosity>::type, std::regex> mRegexPolicy;

  void overwriteVerbosity();

  static constexpr char mDefaultValueName[] = "value";
};

} // namespace monitoring
} // namespace o2

#endif // ALICEO2_MONITORING_CORE_METRIC_H