@tigorhutasuhut/telemetry-js - v0.7.3
    Preparing search index...

    Interface Meter

    An interface to allow the recording metrics.

    Metrics are used for recording pre-defined aggregation (Counter), or raw values (Histogram) in which the aggregation and attributes for the exported metric are deferred.

    interface Meter {
        addBatchObservableCallback<
            AttributesTypes extends Attributes = Attributes,
        >(
            callback: BatchObservableCallback<AttributesTypes>,
            observables: Observable<AttributesTypes>[],
        ): void;
        createCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Counter<AttributesTypes>;
        createGauge<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Gauge<AttributesTypes>;
        createHistogram<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): Histogram<AttributesTypes>;
        createObservableCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): ObservableCounter<AttributesTypes>;
        createObservableGauge<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): ObservableGauge<AttributesTypes>;
        createObservableUpDownCounter<
            AttributesTypes extends Attributes = Attributes,
        >(
            name: string,
            options?: MetricOptions,
        ): ObservableUpDownCounter<AttributesTypes>;
        createUpDownCounter<AttributesTypes extends Attributes = Attributes>(
            name: string,
            options?: MetricOptions,
        ): UpDownCounter<AttributesTypes>;
        removeBatchObservableCallback<
            AttributesTypes extends Attributes = Attributes,
        >(
            callback: BatchObservableCallback<AttributesTypes>,
            observables: Observable<AttributesTypes>[],
        ): void;
    }
    Index

    Methods

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

      Only the associated observables can be observed in the callback. Measurements of observables that are not associated observed in the callback are dropped.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • callback: BatchObservableCallback<AttributesTypes>

        the batch observable callback

      • observables: Observable<AttributesTypes>[]

        the observables associated with this batch observable callback

      Returns void

    • Creates a new Counter metric. Generally, this kind of metric when the value is a quantity, the sum is of primary interest, and the event count and value distribution are not of primary interest.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns Counter<AttributesTypes>

    • Creates and returns a new Gauge.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns Gauge<AttributesTypes>

    • Creates and returns a new Histogram.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns Histogram<AttributesTypes>

    • Creates a new ObservableCounter metric.

      The callback SHOULD be safe to be invoked concurrently.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns ObservableCounter<AttributesTypes>

    • Creates a new ObservableGauge metric.

      The callback SHOULD be safe to be invoked concurrently.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns ObservableGauge<AttributesTypes>

    • Creates a new ObservableUpDownCounter metric.

      The callback SHOULD be safe to be invoked concurrently.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns ObservableUpDownCounter<AttributesTypes>

    • Creates a new UpDownCounter metric. UpDownCounter is a synchronous instrument and very similar to Counter except that Add(increment) supports negative increments. It is generally useful for capturing changes in an amount of resources used, or any quantity that rises and falls during a request. Example uses for UpDownCounter:

      1. count the number of active requests.
      2. count memory in use by instrumenting new and delete.
      3. count queue size by instrumenting enqueue and dequeue.
      4. count semaphore up and down operations.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • name: string

        the name of the metric.

      • Optionaloptions: MetricOptions

        the metric options.

      Returns UpDownCounter<AttributesTypes>

    • Removes a callback previously registered with Meter.addBatchObservableCallback.

      The callback to be removed is identified using a combination of the callback itself, and the set of the observables associated with it.

      Type Parameters

      • AttributesTypes extends Attributes = Attributes

      Parameters

      • callback: BatchObservableCallback<AttributesTypes>

        the batch observable callback

      • observables: Observable<AttributesTypes>[]

        the observables associated with this batch observable callback

      Returns void