Interface MetricsAPI

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

interface MetricsAPI {
    disable(): void;
    getMeter(name: string, version?: string, options?: MeterOptions): Meter;
    getMeterProvider(): MeterProvider;
    setGlobalMeterProvider(provider: MeterProvider): boolean;
}

Index

Methods

disable getMeter getMeterProvider setGlobalMeterProvider

Methods

disable

disable(): void
Remove the global meter provider

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

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:54

getMeterProvider

getMeterProvider(): MeterProvider
Returns the global meter provider.

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

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:40