Class MetricsAPI

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

Index

Methods

disable getMeter getMeterProvider setGlobalMeterProvider getInstance

Methods

disable

disable(): void
Remove the global meter provider

Returns void
- Defined in api/metrics.ts:74

getMeter

getMeter(name: string, version?: string, options?: MeterOptions): Meter
Returns a meter from the global meter provider.
Parameters
- name: string
- Optionalversion: string
- Optionaloptions: MeterOptions
Returns Meter
- Defined in api/metrics.ts:65

getMeterProvider

getMeterProvider(): MeterProvider
Returns the global meter provider.

Returns MeterProvider
- Defined in api/metrics.ts:58

setGlobalMeterProvider

setGlobalMeterProvider(provider: MeterProvider): boolean
Set the current global meter provider. Returns true if the meter provider was successfully registered, else false.
Parameters
- provider: MeterProvider
Returns boolean
- Defined in api/metrics.ts:51

`Static`getInstance

getInstance(): MetricsAPI
Get the singleton instance of the Metrics API

Returns MetricsAPI
- Defined in api/metrics.ts:39