componentMetricsIf.hpp

Go to the documentation of this file.

#ifndef RTCTK_COMPONENTFRAMEWORK_COMPONENTMETRICSIF_HPP
#define RTCTK_COMPONENTFRAMEWORK_COMPONENTMETRICSIF_HPP
#include <iosfwd>
#include <string>
#include <sys/types.h>
 
#include <perfc/perfc.hpp>
 
#include <rtctk/componentFramework/exceptions.hpp>
#include <rtctk/componentFramework/influxTagMap.hpp>
 
namespace rtctk::componentFramework {

class MetricConflictException : public RtctkException {
    using RtctkException::RtctkException;
};

class CounterMetricInfo {
public:
    explicit CounterMetricInfo(std::string id, std::string description) noexcept;

    explicit CounterMetricInfo(std::string id,
                               std::string description,
                               std::string field_name,
                               std::string unit = "") noexcept;

    explicit CounterMetricInfo(std::string id,
                               std::string description,
                               InfluxTagMap tag_map) noexcept;

    explicit CounterMetricInfo(std::string id,
                               std::string description,
                               InfluxTagMap tag_map,
                               std::string field_name,
                               std::string unit = "") noexcept;

    const std::string& GetId() const noexcept {
        return m_id;
    }

    const std::string& GetDescription() const noexcept {
        return m_description;
    }

    const InfluxTagMap& GetTagMap() const noexcept {
        return m_tag_map;
    }

    const std::string& GetFieldName() const noexcept {
        return m_field_name;
    }

    const std::string& GetUnit() const noexcept {
        return m_unit;
    }
 
private:
    std::string m_id;
    std::string m_description;
    InfluxTagMap m_tag_map;
    std::string m_field_name;
    std::string m_unit;
};

class ComponentMetricsIf {
public:
    virtual ~ComponentMetricsIf() noexcept = default;


    virtual void StartMonitoring() = 0;

    virtual void StopMonitoring() noexcept = 0;

    virtual bool IsMonitoring() noexcept = 0;

    virtual void UpdateParams() = 0;


    using CounterTypes =
        perfc::CounterTypes<perfc::CounterDouble, perfc::CounterU64, perfc::CounterI64>;
    using CounterVariant = typename CounterTypes::CounterVariant;

    [[nodiscard]] virtual perfc::ScopedRegistration
    AddCounter(CounterVariant counter, CounterMetricInfo info) = 0;

    virtual bool RemoveCounter(CounterVariant counter) = 0;
};
 
struct Unit {
    inline static constexpr std::string PERCENT = "%";
    inline static constexpr std::string MICRO_SECONDS = "us";
    inline static constexpr std::string HERTZ = "hz";
};
 
}  // namespace rtctk::componentFramework
 
#endif  // RTCTK_COMPONENTFRAMEWORK_COMPONENTMETRICSIF_HPP