sdk::metrics::PeriodicExportingMetricReader Class Reference

Detailed Description

Definition at line 28 of file includes/opentelemetry/sdk/metrics/export/periodic_exporting_metric_reader.h.

Inheritance diagram for sdk::metrics::PeriodicExportingMetricReader:

Collaboration diagram for sdk::metrics::PeriodicExportingMetricReader:

Public Member Functions
	PeriodicExportingMetricReader (std::unique_ptr< PushMetricExporter > exporter, const PeriodicExportingMetricReaderOptions &options)
	PeriodicExportingMetricReader (std::unique_ptr< PushMetricExporter > exporter, const PeriodicExportingMetricReaderOptions &options, const PeriodicExportingMetricReaderRuntimeOptions &runtime_options)
AggregationTemporality	GetAggregationTemporality (InstrumentType instrument_type) const noexcept override
	PeriodicExportingMetricReader (std::unique_ptr< PushMetricExporter > exporter, const PeriodicExportingMetricReaderOptions &options)
	PeriodicExportingMetricReader (std::unique_ptr< PushMetricExporter > exporter, const PeriodicExportingMetricReaderOptions &options, const PeriodicExportingMetricReaderRuntimeOptions &runtime_options)
AggregationTemporality	GetAggregationTemporality (InstrumentType instrument_type) const noexcept override
void	SetMetricProducer (MetricProducer *metric_producer)
void	SetMetricProducer (MetricProducer *metric_producer)
bool	Collect (nostd::function_ref< bool(ResourceMetrics &metric_data)> callback) noexcept
	Collect the metrics from SDK. More...
bool	Collect (nostd::function_ref< bool(ResourceMetrics &metric_data)> callback) noexcept
	Collect the metrics from SDK. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the metric reader. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shutdown the metric reader. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the metric read by the reader. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Force flush the metric read by the reader. More...
bool	IsShutdown () const noexcept
	Return the status of Metric reader. More...
bool	IsShutdown () const noexcept
	Return the status of Metric reader. More...

Constructor & Destructor Documentation

PeriodicExportingMetricReader() [1/4]

sdk::metrics::PeriodicExportingMetricReader::PeriodicExportingMetricReader	(	std::unique_ptr< PushMetricExporter >	exporter,
		const PeriodicExportingMetricReaderOptions &	options
	)

PeriodicExportingMetricReader() [2/4]

sdk::metrics::PeriodicExportingMetricReader::PeriodicExportingMetricReader	(	std::unique_ptr< PushMetricExporter >	exporter,
		const PeriodicExportingMetricReaderOptions &	options,
		const PeriodicExportingMetricReaderRuntimeOptions &	runtime_options
	)

PeriodicExportingMetricReader() [3/4]

sdk::metrics::PeriodicExportingMetricReader::PeriodicExportingMetricReader	(	std::unique_ptr< PushMetricExporter >	exporter,
		const PeriodicExportingMetricReaderOptions &	options
	)

PeriodicExportingMetricReader() [4/4]

sdk::metrics::PeriodicExportingMetricReader::PeriodicExportingMetricReader	(	std::unique_ptr< PushMetricExporter >	exporter,
		const PeriodicExportingMetricReaderOptions &	options,
		const PeriodicExportingMetricReaderRuntimeOptions &	runtime_options
	)

Member Function Documentation

Collect() [1/2]

bool sdk::metrics::MetricReader::Collect ( nostd::function_ref< bool(ResourceMetrics &metric_data)>  callback )

noexceptinherited

Collect the metrics from SDK.

Returns

return the status of the operation.

Collect() [2/2]

bool sdk::metrics::MetricReader::Collect ( nostd::function_ref< bool(ResourceMetrics &metric_data)>  callback )

noexceptinherited

Collect the metrics from SDK.

Returns

return the status of the operation.

ForceFlush() [1/2]

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

noexceptinherited

Force flush the metric read by the reader.

ForceFlush() [2/2]

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

noexceptinherited

Force flush the metric read by the reader.

GetAggregationTemporality() [1/2]

AggregationTemporality sdk::metrics::PeriodicExportingMetricReader::GetAggregationTemporality ( InstrumentType  instrument_type ) const

overridevirtualnoexcept

Implements sdk::metrics::MetricReader.

GetAggregationTemporality() [2/2]

AggregationTemporality sdk::metrics::PeriodicExportingMetricReader::GetAggregationTemporality ( InstrumentType  instrument_type ) const

overridevirtualnoexcept

Implements sdk::metrics::MetricReader.

IsShutdown() [1/2]

bool sdk::metrics::MetricReader::IsShutdown ( ) const

noexceptinherited

Return the status of Metric reader.

IsShutdown() [2/2]

bool sdk::metrics::MetricReader::IsShutdown ( ) const

noexceptinherited

Return the status of Metric reader.

SetMetricProducer() [1/2]

void sdk::metrics::MetricReader::SetMetricProducer ( MetricProducer *  metric_producer )

inherited

SetMetricProducer() [2/2]

void sdk::metrics::MetricReader::SetMetricProducer ( MetricProducer *  metric_producer )

inherited

Shutdown() [1/2]

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

noexceptinherited

Shutdown the metric reader.

Shutdown() [2/2]

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

noexceptinherited

Shutdown the metric reader.

---

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

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