Class MetricsAPI

Singleton object which represents the entry point to the OpenTelemetry Metrics API

Hierarchy

MetricsAPI

Index

Methods

Methods

disable

disable(): void

- Defined in api/src/api/metrics.ts:74
Remove the global meter provider

Returns void

getMeter

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

- Defined in api/src/api/metrics.ts:65
Returns a meter from the global meter provider.

Parameters
- name: string
- Optional version: string
- Optional options: MeterOptions
Returns Meter

getMeterProvider

getMeterProvider(): MeterProvider

- Defined in api/src/api/metrics.ts:58
Returns the global meter provider.

Returns MeterProvider

setGlobalMeterProvider

setGlobalMeterProvider(provider: MeterProvider): boolean

- Defined in api/src/api/metrics.ts:51
Set the current global meter provider. Returns true if the meter provider was successfully registered, else false.

Parameters
- provider: MeterProvider
Returns boolean

Static getInstance

getInstance(): MetricsAPI

- Defined in api/src/api/metrics.ts:39
Get the singleton instance of the Metrics API

Returns MetricsAPI

Generated using TypeDoc