interface GaugeInterface

A synchronous instrument which can be used to record non-additive values.

@experimental

Hierarchy

  • interface \OpenTelemetry\API\Metrics\Instrument
    • interface \OpenTelemetry\API\Metrics\SynchronousInstrument extends \OpenTelemetry\API\Metrics\Instrument
      • interface \OpenTelemetry\API\Metrics\GaugeInterface extends \OpenTelemetry\API\Metrics\SynchronousInstrument

Expanded class hierarchy of GaugeInterface

All classes that implement GaugeInterface

See also

https://opentelemetry.io/docs/specs/otel/metrics/api/#gauge

4 files declare their use of GaugeInterface
Gauge.php in vendor/open-telemetry/sdk/Metrics/Gauge.php
Meter.php in vendor/open-telemetry/sdk/Metrics/Meter.php
NoopGauge.php in vendor/open-telemetry/api/Metrics/Noop/NoopGauge.php
NoopMeter.php in vendor/open-telemetry/api/Metrics/Noop/NoopMeter.php

File

vendor/open-telemetry/api/Metrics/GaugeInterface.php, line 16

Namespace

OpenTelemetry\API\Metrics
View source 
interface GaugeInterface extends SynchronousInstrument {
    
    /**
     * @param float|int $amount current absolute value
     * @param iterable<non-empty-string, string|bool|float|int|array|null> $attributes
     *        attributes of the data point
     * @param ContextInterface|false|null $context execution context
     *
     * @see https://opentelemetry.io/docs/specs/otel/metrics/api/#record-1
     */
    public function record(float|int $amount, iterable $attributes = [], ContextInterface|false|null $context = null) : void;

}

Members

Title Modifiers Object type Summary Overrides
GaugeInterface::record public function 1