Class PeriodicExportingMetricReader

MetricReader which collects metrics based on a user-configurable time interval, and passes the metrics to the configured PushMetricExporter

Hierarchy (View Summary)

MetricReader
- PeriodicExportingMetricReader

Index

Constructors

Methods

collect forceFlush onForceFlush onInitialized onShutdown selectAggregation selectAggregationTemporality selectCardinalityLimit setMetricProducer shutdown

Constructors

constructor

new PeriodicExportingMetricReader(
options: PeriodicExportingMetricReaderOptions,
): PeriodicExportingMetricReader
Parameters
- options: PeriodicExportingMetricReaderOptions
Returns PeriodicExportingMetricReader
Overrides MetricReader.constructor
- Defined in packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts:62

Methods

collect

collect(options?: CommonReaderOptions): Promise<CollectionResult>
Collect all metrics from the associated MetricProducer
Parameters
- Optionaloptions: CommonReaderOptions
Returns Promise<CollectionResult>
Inherited from MetricReader.collect
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:209

forceFlush

forceFlush(options?: CommonReaderOptions): Promise<void>
Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

NOTE: this operation MAY continue even after the promise rejects due to a timeout.
Parameters
- Optionaloptions: CommonReaderOptions
  options with timeout.
Returns Promise<void>
Inherited from MetricReader.forceFlush
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:269

`Protected`onForceFlush

onForceFlush(): Promise<void>
Protected
Handle a force flush signal by the SDK.

In all scenarios metrics should be collected via ().
For push exporters, this should collect and report metrics.
Returns Promise<void>
Overrides MetricReader.onForceFlush
- Defined in packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts:159

`Protected`onInitialized

onInitialized(): void
Handle once the SDK has initialized this MetricReader Overriding this method is optional.

Returns void
Overrides MetricReader.onInitialized
- Defined in packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts:150

`Protected`onShutdown

onShutdown(): Promise<void>
Protected
Handle a shutdown signal by the SDK.

For push exporters, this should shut down any intervals and close any open connections.
Returns Promise<void>
Overrides MetricReader.onShutdown
- Defined in packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts:164

selectAggregation

selectAggregation(instrumentType: InstrumentType): AggregationOption
Select the AggregationOption for the given InstrumentType for this reader.

NOTE: implementations MUST be pure
Parameters
- instrumentType: InstrumentType
Returns AggregationOption
Inherited from MetricReader.selectAggregation
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:168

selectAggregationTemporality

selectAggregationTemporality(
instrumentType: InstrumentType,
): AggregationTemporality
Select the AggregationTemporality for the given InstrumentType for this reader.

NOTE: implementations MUST be pure
Parameters
- instrumentType: InstrumentType
Returns AggregationTemporality
Inherited from MetricReader.selectAggregationTemporality
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:172

selectCardinalityLimit

selectCardinalityLimit(instrumentType: InstrumentType): number
Select the cardinality limit for the given InstrumentType for this reader.

NOTE: implementations MUST be pure
Parameters
- instrumentType: InstrumentType
Returns number
Inherited from MetricReader.selectCardinalityLimit
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:178

setMetricProducer

setMetricProducer(metricProducer: MetricProducer): void
Set the MetricProducer used by this instance. This should only be called once by the SDK and should be considered internal.

NOTE: implementations MUST throw when called more than once
Parameters
- metricProducer: MetricProducer
Returns void
Inherited from MetricReader.setMetricProducer
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:158

shutdown

shutdown(options?: CommonReaderOptions): Promise<void>
Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

NOTE: this operation MAY continue even after the promise rejects due to a timeout.
Parameters
- Optionaloptions: CommonReaderOptions
  options with timeout.
Returns Promise<void>
Inherited from MetricReader.shutdown
- Defined in packages/sdk-metrics/src/export/MetricReader.ts:252