adapter.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <prom/fwd.hpp>
#include <prom/labels.hpp>
#include <prom/unit.hpp>
 
#include <commons/display_info.hpp>
 
#include <cstdint>
#include <span>
#include <string_view>
 
namespace prom {
 
struct MetricMeta {
    MetricType type{};                      
    std::string_view name{};                
    std::string_view help{};                
    Unit unit{};                            
    Labels const_labels{};                  
    comms::DisplayInfo display{};           
    std::span<const double> buckets{};      
    std::span<const double> quantiles{};    
    std::span<const std::string> states{};  
};
 
class MetricState {
public:
    MetricState() = default;
    MetricState(const MetricState&) = default;
    MetricState& operator=(const MetricState&) = default;
    MetricState(MetricState&&) = default;
    MetricState& operator=(MetricState&&) = default;
    virtual ~MetricState() = default;
};
 
class Adapter {
public:
    Adapter() = default;
    Adapter(const Adapter&) = delete;
    Adapter& operator=(const Adapter&) = delete;
    Adapter(Adapter&&) = delete;
    Adapter& operator=(Adapter&&) = delete;
    virtual ~Adapter() = default;
 
    [[nodiscard]] virtual std::string_view backend_name() const noexcept = 0;
 
    [[nodiscard]] virtual MetricHandle register_metric(const MetricMeta& meta) noexcept = 0;
 
    [[nodiscard]] virtual MetricHandle resolve(const MetricHandle& family,
                                               const Labels& dynamic) noexcept = 0;
 
    virtual void inc(const MetricHandle& handle, double amount) noexcept = 0;
    virtual void dec(const MetricHandle& handle, double amount) noexcept = 0;
    virtual void set(const MetricHandle& handle, double value) noexcept = 0;
    virtual void observe(const MetricHandle& handle, double value) noexcept = 0;
 
    virtual void set_info(const MetricHandle& handle, std::span<const Label> labels) noexcept = 0;
    virtual void
    set_state(const MetricHandle& handle, std::string_view state, bool active) noexcept = 0;
 
    virtual void set_unit(const MetricHandle& /*handle*/, const Unit& /*unit*/) noexcept {}
};
 
class AdapterSource {
public:
    AdapterSource() = default;
    AdapterSource(const AdapterSource&) = delete;
    AdapterSource& operator=(const AdapterSource&) = delete;
    AdapterSource(AdapterSource&&) = delete;
    AdapterSource& operator=(AdapterSource&&) = delete;
    virtual ~AdapterSource() = default;
 
    [[nodiscard]] virtual std::uint64_t version() const noexcept = 0;
 
    [[nodiscard]] virtual AdapterPtr adapter() const = 0;
};
 
}  // namespace prom