prometheus::Info Class Reference

Detailed Description

A info metric to represent textual information which should not change during process lifetime.

This class represents the metric type info: https://github.com/OpenObservability/OpenMetrics/blob/98ae26c87b1c3bcf937909a880b32c8be643cc9b/specification/OpenMetrics.md#info Prometheus does not provide this type directly, it is used by emulating a gauge with value 1: https://prometheus.io/docs/concepts/metric_types/#gauge

The value of the info cannot change. Example of infos are:

• the application's version
• revision control commit
• version of the compiler

The class is thread-safe. No concurrent call to any API of this type causes a data race.

Definition at line 26 of file sources/includes/prometheus/info.h.

Public Member Functions
	Info ()=default
	Create a info. More...
ClientMetric	Collect () const
	Get the current value of the info. More...
	Info ()=default
	Create a info. More...
ClientMetric	Collect () const
	Get the current value of the info. More...

Static Public Attributes
static const MetricType	metric_type {MetricType::Info}

Constructor & Destructor Documentation

Info() [1/2]

prometheus::Info::Info ( )

default

Create a info.

Info() [2/2]

prometheus::Info::Info ( )

default

Create a info.

Member Function Documentation

Collect() [1/2]

ClientMetric prometheus::Info::Collect

(

)

const

Get the current value of the info.

Collect is called by the Registry when collecting metrics.

Collect() [2/2]

ClientMetric prometheus::Info::Collect

(

)

const

Get the current value of the info.

Collect is called by the Registry when collecting metrics.

Field Documentation

metric_type

static const MetricType prometheus::Info::metric_type {MetricType::Info}

static

Definition at line 28 of file sources/includes/prometheus/info.h.

---

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

• sources/includes/prometheus/info.h