Interface ObservableResult<AttributesTypes>

Interface that is being used in callback function for Observable Metric.

Since

1.3.0

interface ObservableResult<
    AttributesTypes extends
        @opentelemetry/api.MetricAttributes = @opentelemetry/api.MetricAttributes,
> {
    observe(
        this: @opentelemetry/api.ObservableResult<AttributesTypes>,
        value: number,
        attributes?: AttributesTypes,
    ): void;
}

Type Parameters

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

Index

Methods

Methods

observe

observe(
    this: @opentelemetry/api.ObservableResult<AttributesTypes>,
    value: number,
    attributes?: AttributesTypes,
): void
Observe a measurement of the value associated with the given attributes.
Parameters
- this: @opentelemetry/api.ObservableResult<AttributesTypes>
- value: number
  The value to be observed.
- Optionalattributes: AttributesTypes
  The attributes associated with the value. If more than one value is associated with the same attributes values, SDK may pick the last one or simply drop the entire observable result.
Returns void
- Defined in api/build/src/metrics/Metric.d.ts:127