Class MeterProvider

This class implements the MeterProvider interface.

Hierarchy

MeterProvider

Implements

MeterProvider

Index

Constructors

constructor

Methods

Constructors

constructor

new MeterProvider(options?: MeterProviderOptions): MeterProvider

- Defined in packages/sdk-metrics/src/MeterProvider.ts:69
Parameters
- Optional options: MeterProviderOptions
Returns MeterProvider

Methods

addMetricReader

addMetricReader(metricReader: MetricReader): void

- Defined in packages/sdk-metrics/src/MeterProvider.ts:118
Register a MetricReader to the meter provider. After the registration, the MetricReader can start metrics collection.

NOTE: MetricReader instances MUST be added before creating any instruments. A MetricReader instance registered later may receive no or incomplete metric data.
deprecated
This method will be removed in SDK 2.0. Please use MeterProviderOptions.readers via the MeterProvider constructor instead

Parameters
- metricReader: MetricReader
  
  the metric reader to be registered.
Returns void

forceFlush

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

- Defined in packages/sdk-metrics/src/MeterProvider.ts:150
Notifies all registered MetricReaders to flush any buffered data.

Returns a promise which is resolved when all flushes are complete.

Parameters
- Optional options: CommonReaderOptions
Returns Promise<void>

getMeter

getMeter(name: string, version?: string, options?: MeterOptions): Meter

Implementation of MeterProvider.getMeter
- Defined in packages/sdk-metrics/src/MeterProvider.ts:92
Get a meter with the configuration of the MeterProvider.

Parameters
- name: string
- version: string = ''
- options: MeterOptions = {}
Returns Meter

shutdown

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

- Defined in packages/sdk-metrics/src/MeterProvider.ts:130
Shut down the MeterProvider and all registered MetricReaders.

Returns a promise which is resolved when all flushes are complete.

Parameters
- Optional options: CommonReaderOptions
Returns Promise<void>

Generated using TypeDoc