implement scope configuration

phpstan.neon.dist

@@ -38,3 +38,7 @@ parameters:
             message: "#Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface::.*#"
             paths:
                 - src/Config/SDK
+        -
+            message: "#Cannot call method .* on null#"
+            paths:
+                - tests/Integration/SDK/Trace

src/API/Logs/LoggerInterface.php

@@ -17,5 +17,5 @@ public function emit(LogRecord $logRecord): void;
      * are about to generate a LogRecord, to avoid performing computationally expensive work.
      * @experimental
      */
-    public function enabled(): bool;
+    public function isEnabled(): bool;
 }

src/API/Logs/NoopLogger.php

@@ -31,7 +31,7 @@ public function log($level, $message, array $context = []): void
     {
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Metrics/GaugeInterface.php

@@ -13,7 +13,7 @@
  *
  * @experimental
  */
-interface GaugeInterface
+interface GaugeInterface extends SynchronousInstrument
 {
 
     /**

src/API/Metrics/Instrument.php

@@ -8,7 +8,12 @@ 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 enabled(): bool;
+    public function isEnabled(): bool;
 }

src/API/Metrics/MeterInterface.php

@@ -178,4 +178,6 @@ public function createObservableUpDownCounter(
         array|callable $advisory = [],
         callable ...$callbacks,
     ): ObservableUpDownCounterInterface;
+
+    public function isEnabled(): bool;
 }

src/API/Metrics/Noop/NoopCounter.php

@@ -16,7 +16,7 @@ public function add($amount, iterable $attributes = [], $context = null): void
         // no-op
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Metrics/Noop/NoopGauge.php

@@ -15,4 +15,9 @@ public function record(float|int $amount, iterable $attributes = [], $context =
     {
         // no-op
     }
+
+    public function isEnabled(): bool
+    {
+        return false;
+    }
 }

src/API/Metrics/Noop/NoopHistogram.php

@@ -16,7 +16,7 @@ public function record($amount, iterable $attributes = [], $context = null): voi
         // no-op
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Metrics/Noop/NoopMeter.php

@@ -56,4 +56,9 @@ public function createObservableUpDownCounter(string $name, ?string $unit = null
     {
         return new NoopObservableUpDownCounter();
     }
+
+    public function isEnabled(): bool
+    {
+        return false;
+    }
 }

src/API/Metrics/Noop/NoopObservableCounter.php

@@ -17,7 +17,7 @@ public function observe(callable $callback, bool $weaken = false): ObservableCal
         return new NoopObservableCallback();
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Metrics/Noop/NoopObservableGauge.php

@@ -17,7 +17,7 @@ public function observe(callable $callback, bool $weaken = false): ObservableCal
         return new NoopObservableCallback();
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Metrics/Noop/NoopObservableUpDownCounter.php

@@ -17,7 +17,7 @@ public function observe(callable $callback, bool $weaken = false): ObservableCal
         return new NoopObservableCallback();
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Metrics/Noop/NoopUpDownCounter.php

@@ -16,7 +16,7 @@ public function add($amount, iterable $attributes = [], $context = null): void
         // no-op
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Trace/NoopTracer.php

@@ -24,7 +24,7 @@ public function spanBuilder(string $spanName): SpanBuilderInterface
         return new NoopSpanBuilder(Context::storage());
     }
 
-    public function enabled(): bool
+    public function isEnabled(): bool
     {
         return false;
     }

src/API/Trace/TracerInterface.php

@@ -14,5 +14,5 @@ public function spanBuilder(string $spanName): SpanBuilderInterface;
      * creating a new span.
      * @experimental
      */
-    public function enabled(): bool;
+    public function isEnabled(): bool;
 }

src/SDK/Common/InstrumentationScope/Condition.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
+
+class Condition implements ConditionInterface
+{
+    public function __construct(
+        private readonly Predicate $predicate,
+        private readonly State $state,
+    ) {
+    }
+
+    public function matches(InstrumentationScopeInterface $scope): bool
+    {
+        return $this->predicate->matches($scope);
+    }
+
+    public function state(): State
+    {
+        return $this->state;
+    }
+}

src/SDK/Common/InstrumentationScope/ConditionInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
+
+interface ConditionInterface
+{
+    public function matches(InstrumentationScopeInterface $scope): bool;
+    public function state(): State;
+}

src/SDK/Common/InstrumentationScope/Config.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+/**
+ * @internal
+ */
+class Config
+{
+    public function __construct(private readonly State $state = State::ENABLED)
+    {
+    }
+
+    public function isEnabled(): bool
+    {
+        return $this->state === State::ENABLED;
+    }
+
+    public static function default(): self
+    {
+        return new self();
+    }
+}

src/SDK/Common/InstrumentationScope/Configurable.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+interface Configurable
+{
+    public function updateConfigurator(ScopeConfigurator $configurator): void;
+}

src/SDK/Common/InstrumentationScope/Configurator.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
+
+class Configurator implements ScopeConfigurator
+{
+    /**
+     * @param list<Condition> $conditions
+     */
+    public function __construct(private readonly array $conditions = [])
+    {
+    }
+
+    /**
+     * @internal
+     */
+    public function getConfig(InstrumentationScopeInterface $scope): Config
+    {
+        foreach ($this->conditions as $condition) {
+            if ($condition->matches($scope)) {
+                return new Config($condition->state());
+            }
+        }
+
+        return Config::default();
+    }
+
+    public static function builder(): ConfiguratorBuilder
+    {
+        return new ConfiguratorBuilder();
+    }
+
+    public static function default(): ScopeConfigurator
+    {
+        return new self();
+    }
+}

src/SDK/Common/InstrumentationScope/ConfiguratorBuilder.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+class ConfiguratorBuilder
+{
+    /** @var list<Condition> */
+    private array $conditions = [];
+
+    public function addCondition(Predicate $predicate, State $state): ConfiguratorBuilder
+    {
+        $this->conditions[] = new Condition($predicate, $state);
+
+        return $this;
+    }
+
+    public function build(): Configurator
+    {
+        return new Configurator($this->conditions);
+    }
+}

src/SDK/Common/InstrumentationScope/Predicate.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope;
+
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
+
+interface Predicate
+{
+    public function matches(InstrumentationScopeInterface $scope): bool;
+}

src/SDK/Common/InstrumentationScope/Predicate/Attribute.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope\Predicate;
+
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
+use OpenTelemetry\SDK\Common\InstrumentationScope\Predicate;
+
+/**
+ * Predicate which matches exactly on key+value on an {@link InstrumentationScope} attribute.
+ */
+class Attribute implements Predicate
+{
+    public function __construct(
+        private readonly string $key,
+        private readonly mixed $value,
+    ) {
+    }
+
+    public function matches(InstrumentationScopeInterface $scope): bool
+    {
+        if (!$scope->getAttributes()->has($this->key)) {
+            return false;
+        }
+        $attribute = $scope->getAttributes()->get($this->key);
+
+        return $attribute === $this->value;
+    }
+}

src/SDK/Common/InstrumentationScope/Predicate/AttributeExists.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\InstrumentationScope\Predicate;
+
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
+use OpenTelemetry\SDK\Common\InstrumentationScope\Predicate;
+
+/**
+ * Predicate which matches on the existence of an {@link InstrumentationScope} attribute.
+ */
+class AttributeExists implements Predicate
+{
+    public function __construct(
+        private readonly string $key,
+    ) {
+    }
+
+    public function matches(InstrumentationScopeInterface $scope): bool
+    {
+        return $scope->getAttributes()->has($this->key);
+    }
+}