A registered reader of metrics that, when linked to a MetricProducer, offers global control over metrics.

Hierarchy (View Summary)

Implements

Constructors

Methods

  • Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

    NOTE: this operation MAY continue even after the promise rejects due to a timeout.

    Parameters

    • Optionaloptions: CommonReaderOptions

      options with timeout.

    Returns Promise<void>

  • Protected

    Handle a force flush signal by the SDK.

    In all scenarios metrics should be collected via ().

    For push exporters, this should collect and report metrics.

    Returns Promise<void>

  • Handle once the SDK has initialized this MetricReader Overriding this method is optional.

    Returns void

  • Protected

    Handle a shutdown signal by the SDK.

    For push exporters, this should shut down any intervals and close any open connections.

    Returns Promise<void>

  • Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

    NOTE: this operation MAY continue even after the promise rejects due to a timeout.

    Parameters

    • Optionaloptions: CommonReaderOptions

      options with timeout.

    Returns Promise<void>