counter.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <prom/metric_base.hpp>
 
#include <string_view>
#include <utility>
 
namespace prom {
 
struct CounterSpec {
    std::string_view name{};
    std::string_view help{};
    Labels labels{};
    Unit unit{};
    comms::DisplayInfo display{};
};
 
class Counter : public MetricBase<Counter> {
public:
    Counter(const std::string_view name, const std::string_view help)
        : MetricBase(MetricType::Counter, name, help) {}
 
    explicit Counter(const CounterSpec& spec)
        : MetricBase(MetricType::Counter, spec.name, spec.help) {
        core_->base_labels = spec.labels;
        core_->const_labels = spec.labels;
        core_->base_display = spec.display;
        core_->display = spec.display;
        if (!spec.unit.empty()) {
            core_->has_unit = true;
            core_->unit_from_dimval = spec.unit.from_dimval;
            core_->unit_name = std::string(spec.unit.name);
            core_->unit_kind = std::string(spec.unit.kind);
            core_->unit_symbol = std::string(spec.unit.symbol);
        }
    }
 
    explicit Counter(std::shared_ptr<MetricCore> core) : MetricBase(std::move(core)) {}
 
    void inc() const noexcept {
        record(NormalizedValue{1.0, Unit{}});
    }
 
    template <class T>
        requires std::is_arithmetic_v<T>
    void inc(T amount) noexcept {
        record(normalize(amount));
    }
 
    template <DimensionalValue V>
    void inc(const V& amount) noexcept {
        record(normalize(amount));
    }
 
    [[nodiscard]] Counter labels(const Labels& dynamic) const noexcept {
        return make_child(dynamic);
    }
 
private:
    void record(NormalizedValue nv) const noexcept {
        const auto [adapter, handle] = this->bind();
        if (!check_finite(nv.value, "inc")) {
            return;
        }
        if (nv.value < 0.0) {
            if (auto* lg = logger()) {
                lg->warn("counter '{}' dropping negative increment {}", core_->name, nv.value);
            }
            return;
        }
        if (!reconcile_unit(nv.unit, *adapter)) {
            return;
        }
        adapter->inc(handle, nv.value);
    }
};
 
}  // namespace prom