Interface MetricsAPI

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

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

Index

Methods

disable getMeter getMeterProvider setGlobalMeterProvider

Methods

disable

disable(): void
Remove the global meter provider

Returns void
- Defined in api/build/src/api/metrics.d.ts:26

getMeter

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

getMeterProvider

getMeterProvider(): @opentelemetry/api.MeterProvider
Returns the global meter provider.

Returns @opentelemetry/api.MeterProvider
- Defined in api/build/src/api/metrics.d.ts:20

setGlobalMeterProvider

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