Class Meter
Defined in File meter.h
Inheritance Relationships
Derived Types
public opentelemetry::metrics::NoopMeter
(Class NoopMeter)public opentelemetry::sdk::metrics::Meter
(Class Meter)
Class Documentation
-
class Meter
Handles instrument creation and provides a facility for batch recording.
This class provides methods to create new metric instruments, record a batch of values to a specified set of instruments, and collect measurements from all instruments.
Subclassed by opentelemetry::metrics::NoopMeter, opentelemetry::sdk::metrics::Meter
Public Functions
-
virtual ~Meter() = default
-
virtual nostd::unique_ptr<Counter<uint64_t>> CreateUInt64Counter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
Creates a Counter with the passed characteristics and returns a unique_ptr to that Counter.
- Parameters:
name – the name of the new Counter.
description – a brief description of what the Counter is used for.
unit – the unit of metric values following https://unitsofmeasure.org/ucum.html.
- Returns:
a shared pointer to the created Counter.
-
virtual nostd::unique_ptr<Counter<double>> CreateDoubleCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
-
virtual nostd::shared_ptr<ObservableInstrument> CreateInt64ObservableCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
Creates a Asynchronous (Observable) counter with the passed characteristics and returns a shared_ptr to that Observable Counter
- Parameters:
name – the name of the new Observable Counter.
description – a brief description of what the Observable Counter is used for.
unit – the unit of metric values following https://unitsofmeasure.org/ucum.html.
-
virtual nostd::shared_ptr<ObservableInstrument> CreateDoubleObservableCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
-
virtual nostd::unique_ptr<Histogram<uint64_t>> CreateUInt64Histogram(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
Creates a Histogram with the passed characteristics and returns a unique_ptr to that Histogram.
- Parameters:
name – the name of the new Histogram.
description – a brief description of what the Histogram is used for.
unit – the unit of metric values following https://unitsofmeasure.org/ucum.html.
- Returns:
a shared pointer to the created Histogram.
-
virtual nostd::unique_ptr<Histogram<double>> CreateDoubleHistogram(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
-
virtual nostd::shared_ptr<ObservableInstrument> CreateInt64ObservableGauge(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
Creates a Asynchronous (Observable) Gauge with the passed characteristics and returns a shared_ptr to that Observable Gauge
- Parameters:
name – the name of the new Observable Gauge.
description – a brief description of what the Observable Gauge is used for.
unit – the unit of metric values following https://unitsofmeasure.org/ucum.html.
-
virtual nostd::shared_ptr<ObservableInstrument> CreateDoubleObservableGauge(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
-
virtual nostd::unique_ptr<UpDownCounter<int64_t>> CreateInt64UpDownCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
Creates an UpDownCounter with the passed characteristics and returns a unique_ptr to that UpDownCounter.
- Parameters:
name – the name of the new UpDownCounter.
description – a brief description of what the UpDownCounter is used for.
unit – the unit of metric values following https://unitsofmeasure.org/ucum.html.
- Returns:
a shared pointer to the created UpDownCounter.
-
virtual nostd::unique_ptr<UpDownCounter<double>> CreateDoubleUpDownCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
-
virtual nostd::shared_ptr<ObservableInstrument> CreateInt64ObservableUpDownCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
Creates a Asynchronous (Observable) UpDownCounter with the passed characteristics and returns a shared_ptr to that Observable UpDownCounter
- Parameters:
name – the name of the new Observable UpDownCounter.
description – a brief description of what the Observable UpDownCounter is used for.
unit – the unit of metric values following https://unitsofmeasure.org/ucum.html.
-
virtual nostd::shared_ptr<ObservableInstrument> CreateDoubleObservableUpDownCounter(nostd::string_view name, nostd::string_view description = "", nostd::string_view unit = "") noexcept = 0
-
virtual ~Meter() = default