prom 0.1.0
Client-independent C++23 Prometheus/OpenMetrics metric abstraction
Loading...
Searching...
No Matches
Public Member Functions | List of all members
prom::StateSet Class Reference

A state set: each declared state is a boolean, exposed as one series per state with value 0 or 1. More...

#include <stateset.hpp>

Inheritance diagram for prom::StateSet:
Inheritance graph
[legend]
Collaboration diagram for prom::StateSet:
Collaboration graph
[legend]

Public Member Functions

 StateSet (const std::string_view name, const std::string_view help)
 
 StateSet (const StateSetSpec &spec)
 
 StateSet (std::shared_ptr< MetricCore > core)
 
void set (const std::string_view state, const bool active) const noexcept
 Set the boolean value of one state.
 
StateSet labels (const Labels &dynamic) const noexcept
 
- Public Member Functions inherited from prom::MetricBase< StateSet >
std::string_view name () const noexcept
 The metric's fully-qualified name.
 
MetricType type () const noexcept
 The metric kind.
 

Additional Inherited Members

- Protected Member Functions inherited from prom::MetricBase< StateSet >
 MetricBase (const MetricType type, const std::string_view name, const std::string_view help)
 Standalone, unbound construction from a name and help string.
 
 MetricBase (std::shared_ptr< MetricCore > core)
 Adopt an already-populated core (registered metrics and children).
 
 MetricBase (const MetricBase &)=default
 
 MetricBase (MetricBase &&)=default
 
MetricBaseoperator= (const MetricBase &)=default
 
MetricBaseoperator= (MetricBase &&)=default
 
 ~MetricBase ()=default
 
Binding bind () const noexcept
 Resolve the adapter and backend handle this metric should record against.
 
const std::shared_ptr< MetricCore > & core () const noexcept
 
StateSet make_child (const Labels &dynamic) const noexcept
 Resolve a labeled child of the same metric type.
 
bool reconcile_unit (const Unit &observed, Adapter &adapter) const noexcept
 Reconcile an observed unit against the family's known unit.
 
bool check_finite (const double value, std::string_view op) const noexcept
 Drop-and-log guard for a non-finite sample.
 
- Static Protected Member Functions inherited from prom::MetricBase< StateSet >
static spdlog::logger * logger () noexcept
 The shared per-process metrics logger.
 
- Protected Attributes inherited from prom::MetricBase< StateSet >
std::shared_ptr< MetricCorecore_
 

Detailed Description

A state set: each declared state is a boolean, exposed as one series per state with value 0 or 1.

Constructor & Destructor Documentation

◆ StateSet() [1/3]

prom::StateSet::StateSet ( const std::string_view  name,
const std::string_view  help 
)
inline

◆ StateSet() [2/3]

prom::StateSet::StateSet ( const StateSetSpec spec)
inlineexplicit

◆ StateSet() [3/3]

prom::StateSet::StateSet ( std::shared_ptr< MetricCore core)
inlineexplicit

Member Function Documentation

◆ labels()

StateSet prom::StateSet::labels ( const Labels dynamic) const
inlinenoexcept

◆ set()

void prom::StateSet::set ( const std::string_view  state,
const bool  active 
) const
inlinenoexcept

Set the boolean value of one state.


The documentation for this class was generated from the following file: