interface Instrument
Hierarchy
- interface \OpenTelemetry\API\Metrics\Instrument
Expanded class hierarchy of Instrument
All classes that implement Instrument
File
-
vendor/
open-telemetry/ api/ Metrics/ Instrument.php, line 7
Namespace
OpenTelemetry\API\MetricsView source
interface Instrument {
/**
* Determine if the instrument is enabled. Instrumentation authors SHOULD call this API each time they record a measurement.
*
* MUST return false if:
* - The MeterConfig of the Meter used to create the instrument has parameter disabled=true
* - All resolved views for the instrument are configured with the Drop Aggregation
* @experimental
* @see https://opentelemetry.io/docs/specs/otel/metrics/sdk/#instrument-enabled
*/
public function isEnabled() : bool;
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
Instrument::isEnabled | public | function | Determine if the instrument is enabled. Instrumentation authors SHOULD call this API each time they record a measurement. |