sdk::metrics::MetricCollector Class Reference

Detailed Description

An internal opaque interface that the MetricReader receives as MetricProducer.

It acts as the storage key to the internal metric stream state for each MetricReader.

Definition at line 41 of file includes/opentelemetry/sdk/metrics/state/metric_collector.h.

Inheritance diagram for sdk::metrics::MetricCollector:

Collaboration diagram for sdk::metrics::MetricCollector:

Public Types
enum	Status {   Status::kSuccess,   Status::kFailure,   Status::kTimeout,   Status::kSuccess,   Status::kFailure,   Status::kTimeout }
enum	Status {   Status::kSuccess,   Status::kFailure,   Status::kTimeout,   Status::kSuccess,   Status::kFailure,   Status::kTimeout }

Public Member Functions
	MetricCollector (MeterContext *context, std::shared_ptr< MetricReader > metric_reader, std::unique_ptr< MetricFilter > metric_filter=nullptr)
	~MetricCollector () override=default
AggregationTemporality	GetAggregationTemporality (InstrumentType instrument_type) noexcept override
Result	Produce () noexcept override
	The callback to be called for each metric exporter. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	MetricCollector (MeterContext *context, std::shared_ptr< MetricReader > metric_reader, std::unique_ptr< MetricFilter > metric_filter=nullptr)
	~MetricCollector () override=default
AggregationTemporality	GetAggregationTemporality (InstrumentType instrument_type) noexcept override
Result	Produce () noexcept override
	The callback to be called for each metric exporter. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept

Member Enumeration Documentation

Status [1/2]

enum sdk::metrics::MetricProducer::Status

stronginherited

Enumerator
kSuccess
kFailure
kTimeout
kSuccess
kFailure
kTimeout

Definition at line 91 of file includes/opentelemetry/sdk/metrics/export/metric_producer.h.

Status [2/2]

enum sdk::metrics::MetricProducer::Status

stronginherited

Enumerator
kSuccess
kFailure
kTimeout
kSuccess
kFailure
kTimeout

Definition at line 91 of file 9.2/includes/opentelemetry/sdk/metrics/export/metric_producer.h.

Constructor & Destructor Documentation

MetricCollector() [1/2]

sdk::metrics::MetricCollector::MetricCollector	(	MeterContext *	context,
		std::shared_ptr< MetricReader >	metric_reader,
		std::unique_ptr< MetricFilter >	metric_filter = nullptr
	)

~MetricCollector() [1/2]

sdk::metrics::MetricCollector::~MetricCollector ( )

overridedefault

MetricCollector() [2/2]

sdk::metrics::MetricCollector::MetricCollector	(	MeterContext *	context,
		std::shared_ptr< MetricReader >	metric_reader,
		std::unique_ptr< MetricFilter >	metric_filter = nullptr
	)

~MetricCollector() [2/2]

sdk::metrics::MetricCollector::~MetricCollector ( )

overridedefault

Member Function Documentation

ForceFlush() [1/2]

bool sdk::metrics::MetricCollector::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

ForceFlush() [2/2]

bool sdk::metrics::MetricCollector::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

GetAggregationTemporality() [1/2]

AggregationTemporality sdk::metrics::MetricCollector::GetAggregationTemporality ( InstrumentType  instrument_type )

overridevirtualnoexcept

Implements sdk::metrics::CollectorHandle.

GetAggregationTemporality() [2/2]

AggregationTemporality sdk::metrics::MetricCollector::GetAggregationTemporality ( InstrumentType  instrument_type )

overridevirtualnoexcept

Implements sdk::metrics::CollectorHandle.

Produce() [1/2]

Result sdk::metrics::MetricCollector::Produce ( )

overridevirtualnoexcept

The callback to be called for each metric exporter.

This will only be those metrics that have been produced since the last time this method was called.

Returns

a status of completion of method.

Implements sdk::metrics::MetricProducer.

Produce() [2/2]

Result sdk::metrics::MetricCollector::Produce ( )

overridevirtualnoexcept

The callback to be called for each metric exporter.

This will only be those metrics that have been produced since the last time this method was called.

Returns

a status of completion of method.

Implements sdk::metrics::MetricProducer.

Shutdown() [1/2]

bool sdk::metrics::MetricCollector::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

Shutdown() [2/2]

bool sdk::metrics::MetricCollector::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

noexcept

---

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

• includes/opentelemetry/sdk/metrics/state/metric_collector.h