sdk::metrics::MetricReader Class Referenceabstract
Detailed Description
MetricReader defines the interface to collect metrics from SDK.
Definition at line 22 of file includes/opentelemetry/sdk/metrics/metric_reader.h.
Inheritance diagram for sdk::metrics::MetricReader:
Public Member Functions | |
| MetricReader () | |
| void | SetMetricProducer (MetricProducer *metric_producer) |
| bool | Collect (nostd::function_ref< bool(ResourceMetrics &metric_data)> callback) noexcept |
| Collect the metrics from SDK. More... | |
| virtual AggregationTemporality | GetAggregationTemporality (InstrumentType instrument_type) const noexcept=0 |
| Get the AggregationTemporality for given Instrument Type for this 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 | IsShutdown () const noexcept |
| Return the status of Metric reader. More... | |
| virtual | ~MetricReader ()=default |
| MetricReader () | |
| void | SetMetricProducer (MetricProducer *metric_producer) |
| bool | Collect (nostd::function_ref< bool(ResourceMetrics &metric_data)> callback) noexcept |
| Collect the metrics from SDK. More... | |
| virtual AggregationTemporality | GetAggregationTemporality (InstrumentType instrument_type) const noexcept=0 |
| Get the AggregationTemporality for given Instrument Type for this 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 | IsShutdown () const noexcept |
| Return the status of Metric reader. More... | |
| virtual | ~MetricReader ()=default |
Constructor & Destructor Documentation
◆ MetricReader() [1/2]
| sdk::metrics::MetricReader::MetricReader | ( | ) |
◆ ~MetricReader() [1/2]
|
virtualdefault |
◆ MetricReader() [2/2]
| sdk::metrics::MetricReader::MetricReader | ( | ) |
◆ ~MetricReader() [2/2]
|
virtualdefault |
Member Function Documentation
◆ Collect() [1/2]
|
noexcept |
Collect the metrics from SDK.
- Returns
- return the status of the operation.
◆ Collect() [2/2]
|
noexcept |
Collect the metrics from SDK.
- Returns
- return the status of the operation.
◆ ForceFlush() [1/2]
|
noexcept |
Force flush the metric read by the reader.
◆ ForceFlush() [2/2]
|
noexcept |
Force flush the metric read by the reader.
◆ GetAggregationTemporality() [1/2]
|
pure virtualnoexcept |
Get the AggregationTemporality for given Instrument Type for this reader.
- Returns
- AggregationTemporality
Implemented in sdk::metrics::PeriodicExportingMetricReader, and sdk::metrics::PeriodicExportingMetricReader.
◆ GetAggregationTemporality() [2/2]
|
pure virtualnoexcept |
Get the AggregationTemporality for given Instrument Type for this reader.
- Returns
- AggregationTemporality
Implemented in sdk::metrics::PeriodicExportingMetricReader, and sdk::metrics::PeriodicExportingMetricReader.
◆ IsShutdown() [1/2]
|
noexcept |
Return the status of Metric reader.
◆ IsShutdown() [2/2]
|
noexcept |
Return the status of Metric reader.
◆ SetMetricProducer() [1/2]
| void sdk::metrics::MetricReader::SetMetricProducer | ( | MetricProducer * | metric_producer | ) |
◆ SetMetricProducer() [2/2]
| void sdk::metrics::MetricReader::SetMetricProducer | ( | MetricProducer * | metric_producer | ) |
◆ Shutdown() [1/2]
|
noexcept |
Shutdown the metric reader.
◆ Shutdown() [2/2]
|
noexcept |
Shutdown the metric reader.
The documentation for this class was generated from the following file: