Class MetricsAPI

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

Constructors

constructor

Properties

_instance?

Methods

disable getMeter getMeterProvider setGlobalMeterProvider getInstance

Constructors

Private constructor

  • new MetricsAPI(): MetricsAPI

  • Empty private constructor prevents end users from constructing a new instance of the API

    Returns MetricsAPI

Properties

Static Private Optional _instance

_instance?: any

Methods

disable

  • disable(): void

  • Remove the global meter provider

    Returns void

getMeter

  • getMeter(name, version?, options?): Meter

  • Returns a meter from the global meter provider.

    Parameters

    • name: string
    • Optional version: string
    • Optional options: MeterOptions

    Returns Meter

getMeterProvider

  • getMeterProvider(): MeterProvider

  • Returns the global meter provider.

    Returns MeterProvider

setGlobalMeterProvider

  • setGlobalMeterProvider(provider): boolean

  • Set the current global meter provider. Returns true if the meter provider was successfully registered, else false.

    Parameters

    Returns boolean

Static getInstance

  • getInstance(): MetricsAPI

  • Get the singleton instance of the Metrics API

    Returns MetricsAPI

Settings

Member Visibility

Theme

On This Page

constructor_instancedisablegetMetergetMeterProvidersetGlobalMeterProvidergetInstance