OpenTelemetry SDK
    Preparing search index...

    MetricReader which collects metrics based on a user-configurable time interval, and passes the metrics to the configured PushMetricExporter

    Hierarchy (View Summary)

    Index
    • 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>

    • Set the MetricProducer used by this instance. This should only be called once by the SDK and should be considered internal.

      NOTE: implementations MUST throw when called more than once

      Parameters

      Returns 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>