sdk::metrics::MetricProducer Class Reference

Detailed Description

MetricProducer defines the interface which bridges to third-party metric sources MUST implement, so they can be plugged into an OpenTelemetry MetricReader as a source of aggregated metric data.

Implementations must be thread-safe, and should accept configuration for the AggregationTemporality of produced metrics.

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

Inheritance diagram for sdk::metrics::MetricProducer:

Data Structures
struct	Result

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
	MetricProducer ()=default
virtual	~MetricProducer ()=default
	MetricProducer (const MetricProducer &)=delete
	MetricProducer (const MetricProducer &&)=delete
virtual Result	Produce () noexcept=0
	Produce returns a batch of Metric Points, with a single instrumentation scope that identifies the MetricProducer. More...
	MetricProducer ()=default
virtual	~MetricProducer ()=default
	MetricProducer (const MetricProducer &)=delete
	MetricProducer (const MetricProducer &&)=delete
virtual Result	Produce () noexcept=0
	Produce returns a batch of Metric Points, with a single instrumentation scope that identifies the MetricProducer. More...

Member Enumeration Documentation

Status [1/2]

enum sdk::metrics::MetricProducer::Status

strong

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

strong

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

MetricProducer() [1/6]

sdk::metrics::MetricProducer::MetricProducer ( )

default

~MetricProducer() [1/2]

virtual sdk::metrics::MetricProducer::~MetricProducer ( )

virtualdefault

MetricProducer() [2/6]

sdk::metrics::MetricProducer::MetricProducer ( const MetricProducer &  )

delete

MetricProducer() [3/6]

sdk::metrics::MetricProducer::MetricProducer ( const MetricProducer &&  )

delete

MetricProducer() [4/6]

sdk::metrics::MetricProducer::MetricProducer ( )

default

~MetricProducer() [2/2]

virtual sdk::metrics::MetricProducer::~MetricProducer ( )

virtualdefault

MetricProducer() [5/6]

sdk::metrics::MetricProducer::MetricProducer ( const MetricProducer &  )

delete

MetricProducer() [6/6]

sdk::metrics::MetricProducer::MetricProducer ( const MetricProducer &&  )

delete

Member Function Documentation

Produce() [1/2]

virtual Result sdk::metrics::MetricProducer::Produce ( )

pure virtualnoexcept

Produce returns a batch of Metric Points, with a single instrumentation scope that identifies the MetricProducer.

Implementations may return successfully collected points even if there is a partial failure.

Implemented in sdk::metrics::MetricCollector, and sdk::metrics::MetricCollector.

Produce() [2/2]

virtual Result sdk::metrics::MetricProducer::Produce ( )

pure virtualnoexcept

Produce returns a batch of Metric Points, with a single instrumentation scope that identifies the MetricProducer.

Implementations may return successfully collected points even if there is a partial failure.

Implemented in sdk::metrics::MetricCollector, and sdk::metrics::MetricCollector.

---

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

• includes/opentelemetry/sdk/metrics/export/metric_producer.h