Interface Observable<AttributesTypes>

Since

1.3.0

interface Observable<
    AttributesTypes extends
        @opentelemetry/api.MetricAttributes = @opentelemetry/api.MetricAttributes,
> {
    addCallback(
        callback: @opentelemetry/api.ObservableCallback<AttributesTypes>,
    ): void;
    removeCallback(
        callback: @opentelemetry/api.ObservableCallback<AttributesTypes>,
    ): void;
}

Type Parameters

AttributesTypes extends @opentelemetry/api.MetricAttributes = @opentelemetry/api.MetricAttributes

Index

Methods

addCallback removeCallback

Methods

addCallback

addCallback(
callback: @opentelemetry/api.ObservableCallback<AttributesTypes>,
): void
Sets up a function that will be called whenever a metric collection is initiated.

If the function is already in the list of callbacks for this Observable, the function is not added a second time.
Parameters
- callback: @opentelemetry/api.ObservableCallback<AttributesTypes>
Returns void
- Defined in api/build/src/metrics/Metric.d.ts:165

removeCallback

removeCallback(
callback: @opentelemetry/api.ObservableCallback<AttributesTypes>,
): void
Removes a callback previously registered with Observable.addCallback.
Parameters
- callback: @opentelemetry/api.ObservableCallback<AttributesTypes>
Returns void
- Defined in api/build/src/metrics/Metric.d.ts:169