Class MetricCollector

An internal opaque interface that the MetricReader receives as MetricProducer. It acts as the storage key to the internal metric stream state for each MetricReader.

Hierarchy

MetricCollector

Implements

MetricProducer

Index

Constructors

constructor

Methods

Constructors

constructor

new MetricCollector(_sharedState: MeterProviderSharedState, _metricReader: MetricReader): MetricCollector

- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:32
Parameters
- _sharedState: MeterProviderSharedState
- _metricReader: MetricReader
Returns MetricCollector

Methods

collect

collect(options?: MetricCollectOptions): Promise<CollectionResult>

Implementation of MetricProducer.collect
- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:37
Collects the metrics from the SDK. If there are asynchronous Instruments involved, their callback functions will be triggered.

Parameters
- Optional options: MetricCollectOptions
Returns Promise<CollectionResult>

forceFlush

forceFlush(options?: CommonReaderOptions): Promise<void>

- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:75
Delegates for MetricReader.forceFlush.

Parameters
- Optional options: CommonReaderOptions
Returns Promise<void>

selectAggregation

selectAggregation(instrumentType: InstrumentType): Aggregation

- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:90
Parameters
- instrumentType: InstrumentType
Returns Aggregation

selectAggregationTemporality

selectAggregationTemporality(instrumentType: InstrumentType): AggregationTemporality

- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:86
Parameters
- instrumentType: InstrumentType
Returns AggregationTemporality

selectCardinalityLimit

selectCardinalityLimit(instrumentType: InstrumentType): number

- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:98
Select the cardinality limit for the given InstrumentType for this collector.

Parameters
- instrumentType: InstrumentType
Returns number

shutdown

shutdown(options?: CommonReaderOptions): Promise<void>

- Defined in packages/sdk-metrics/src/state/MetricCollector.ts:82
Delegates for MetricReader.shutdown.

Parameters
- Optional options: CommonReaderOptions
Returns Promise<void>

Generated using TypeDoc