sdk::metrics::PushMetricExporter Class Reference

Detailed Description

PushMetricExporter defines the interface to be used by metrics libraries to push metrics data to the OpenTelemetry exporters.

Definition at line 24 of file includes/opentelemetry/sdk/metrics/push_metric_exporter.h.

Public Member Functions
virtual	~PushMetricExporter ()=default
virtual opentelemetry::sdk::common::ExportResult	Export (const ResourceMetrics &data) noexcept=0
	Exports a batch of metrics data. More...
virtual AggregationTemporality	GetAggregationTemporality (InstrumentType instrument_type) const noexcept=0
	Get the AggregationTemporality for given Instrument Type for this exporter. More...
virtual bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept=0
	Force flush the exporter. More...
virtual bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept=0
	Shut down the metric exporter. More...
virtual	~PushMetricExporter ()=default
virtual opentelemetry::sdk::common::ExportResult	Export (const ResourceMetrics &data) noexcept=0
	Exports a batch of metrics data. More...
virtual AggregationTemporality	GetAggregationTemporality (InstrumentType instrument_type) const noexcept=0
	Get the AggregationTemporality for given Instrument Type for this exporter. More...
virtual bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept=0
	Force flush the exporter. More...
virtual bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept=0
	Shut down the metric exporter. More...

Constructor & Destructor Documentation

~PushMetricExporter() [1/2]

virtual sdk::metrics::PushMetricExporter::~PushMetricExporter ( )

virtualdefault

~PushMetricExporter() [2/2]

virtual sdk::metrics::PushMetricExporter::~PushMetricExporter ( )

virtualdefault

Member Function Documentation

Export() [1/2]

virtual opentelemetry::sdk::common::ExportResult sdk::metrics::PushMetricExporter::Export ( const ResourceMetrics &  data )

pure virtualnoexcept

Exports a batch of metrics data.

This method must not be called concurrently for the same exporter instance.

Parameters

data	metrics data

Export() [2/2]

virtual opentelemetry::sdk::common::ExportResult sdk::metrics::PushMetricExporter::Export ( const ResourceMetrics &  data )

pure virtualnoexcept

Exports a batch of metrics data.

This method must not be called concurrently for the same exporter instance.

Parameters

data	metrics data

ForceFlush() [1/2]

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

pure virtualnoexcept

Force flush the exporter.

ForceFlush() [2/2]

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

pure virtualnoexcept

Force flush the exporter.

GetAggregationTemporality() [1/2]

virtual AggregationTemporality sdk::metrics::PushMetricExporter::GetAggregationTemporality ( InstrumentType  instrument_type ) const

pure virtualnoexcept

Get the AggregationTemporality for given Instrument Type for this exporter.

Returns

AggregationTemporality

GetAggregationTemporality() [2/2]

virtual AggregationTemporality sdk::metrics::PushMetricExporter::GetAggregationTemporality ( InstrumentType  instrument_type ) const

pure virtualnoexcept

Get the AggregationTemporality for given Instrument Type for this exporter.

Returns

AggregationTemporality

Shutdown() [1/2]

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

pure virtualnoexcept

Shut down the metric exporter.

Parameters

timeout

an optional timeout.

Returns

return the status of the operation.

Shutdown() [2/2]

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

pure virtualnoexcept

Shut down the metric exporter.

Parameters

timeout

an optional timeout.

Returns

return the status of the operation.

---

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

• includes/opentelemetry/sdk/metrics/push_metric_exporter.h