Allow runtime changes to tracer/meter/logger config disabled flag

Nevay · Jul 20, 2024 · 08bc772 · 08bc772
1 parent 1250797
commit 08bc772
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 48 deletions.
diff --git a/logs/Internal/Logger.php b/logs/Internal/Logger.php
@@ -3,6 +3,7 @@
 
 use Nevay\OTelSDK\Common\ContextResolver;
 use Nevay\OTelSDK\Common\InstrumentationScope;
+use Nevay\OTelSDK\Logs\LoggerConfig;
 use OpenTelemetry\API\Logs\LoggerInterface;
 use OpenTelemetry\API\Logs\LogRecord;
 use OpenTelemetry\API\Trace\Span;
@@ -15,13 +16,18 @@ final class Logger implements LoggerInterface {
     public function __construct(
         private readonly LoggerState $loggerState,
         private readonly InstrumentationScope $instrumentationScope,
+        private readonly LoggerConfig $loggerConfig,
     ) {}
 
     public function enabled(): bool {
-        return true;
+        return !$this->loggerConfig->disabled;
     }
 
     public function emit(LogRecord $logRecord): void {
+        if ($this->loggerConfig->disabled) {
+            return;
+        }
+
         $context = ContextResolver::resolve(Accessor::getContext($logRecord), $this->loggerState->contextStorage);
 
         $record = new ReadWriteLogRecord(

diff --git a/logs/Internal/LoggerProvider.php b/logs/Internal/LoggerProvider.php
@@ -15,7 +15,6 @@
 use OpenTelemetry\API\Logs\LoggerInterface;
 use OpenTelemetry\API\Logs\LoggerProviderInterface;
 use OpenTelemetry\API\Logs\NoopEventLogger;
-use OpenTelemetry\API\Logs\NoopLogger;
 use OpenTelemetry\Context\ContextStorageInterface;
 use Psr\Log\LoggerInterface as PsrLoggerInterface;
 
@@ -65,13 +64,9 @@ public function getLogger(
 
         $instrumentationScope = new InstrumentationScope($name, $version, $schemaUrl,
             $this->instrumentationScopeAttributesFactory->builder()->addAll($attributes)->build());
+        $loggerConfig = ($this->loggerConfigurator)($instrumentationScope);
 
-        $config = ($this->loggerConfigurator)($instrumentationScope);
-        if ($config->disabled) {
-            return new NoopLogger();
-        }
-
-        return new Logger($this->loggerState, $instrumentationScope);
+        return new Logger($this->loggerState, $instrumentationScope, $loggerConfig);
     }
 
     public function getEventLogger(

diff --git a/logs/LoggerConfig.php b/logs/LoggerConfig.php
@@ -7,6 +7,6 @@
 final class LoggerConfig {
 
     public function __construct(
-        public readonly bool $disabled = false,
+        public bool $disabled = false,
     ) {}
 }
diff --git a/metrics/Internal/Instrument/AsynchronousInstrument.php b/metrics/Internal/Instrument/AsynchronousInstrument.php
@@ -4,6 +4,7 @@
 use Nevay\OTelSDK\Metrics\Instrument;
 use Nevay\OTelSDK\Metrics\Internal\Registry\MetricWriter;
 use Nevay\OTelSDK\Metrics\Internal\StalenessHandler\ReferenceCounter;
+use Nevay\OTelSDK\Metrics\MeterConfig;
 use OpenTelemetry\API\Metrics\ObservableCallbackInterface;
 use OpenTelemetry\API\Metrics\ObserverInterface;
 use WeakMap;
@@ -22,6 +23,7 @@ public function __construct(
         private readonly Instrument $instrument,
         private readonly ReferenceCounter $referenceCounter,
         private readonly WeakMap $destructors,
+        private readonly MeterConfig $meterConfig,
     ) {
         assert($this instanceof InstrumentHandle);
 
@@ -37,7 +39,7 @@ public function getHandle(): Instrument {
     }
 
     public function enabled(): bool {
-        return $this->writer->enabled($this->instrument);
+        return !$this->meterConfig->disabled && $this->writer->enabled($this->instrument);
     }
 
     /**

diff --git a/metrics/Internal/Instrument/SynchronousInstrument.php b/metrics/Internal/Instrument/SynchronousInstrument.php
@@ -4,6 +4,7 @@
 use Nevay\OTelSDK\Metrics\Instrument;
 use Nevay\OTelSDK\Metrics\Internal\Registry\MetricWriter;
 use Nevay\OTelSDK\Metrics\Internal\StalenessHandler\ReferenceCounter;
+use Nevay\OTelSDK\Metrics\MeterConfig;
 use OpenTelemetry\Context\ContextInterface;
 use function assert;
 
@@ -16,6 +17,7 @@ public function __construct(
         private readonly MetricWriter $writer,
         private readonly Instrument $instrument,
         private readonly ReferenceCounter $referenceCounter,
+        private readonly MeterConfig $meterConfig,
     ) {
         assert($this instanceof InstrumentHandle);
 
@@ -31,7 +33,7 @@ public function getHandle(): Instrument {
     }
 
     public function enabled(): bool {
-        return $this->writer->enabled($this->instrument);
+        return !$this->meterConfig->disabled && $this->writer->enabled($this->instrument);
     }
 
     /**
@@ -41,6 +43,10 @@ public function enabled(): bool {
      * @noinspection PhpMissingParamTypeInspection
      */
     public function write($amount, iterable $attributes = [], $context = null): void {
+        if ($this->meterConfig->disabled) {
+            return;
+        }
+
         $this->writer->record($this->instrument, $amount, $attributes, $context);
     }
 }
diff --git a/metrics/Internal/Meter.php b/metrics/Internal/Meter.php
@@ -14,6 +14,7 @@
 use Nevay\OTelSDK\Metrics\Internal\Instrument\ObservableUpDownCounter;
 use Nevay\OTelSDK\Metrics\Internal\Instrument\UpDownCounter;
 use Nevay\OTelSDK\Metrics\Internal\StalenessHandler\MultiReferenceCounter;
+use Nevay\OTelSDK\Metrics\MeterConfig;
 use OpenTelemetry\API\Metrics\AsynchronousInstrument;
 use OpenTelemetry\API\Metrics\CounterInterface;
 use OpenTelemetry\API\Metrics\GaugeInterface;
@@ -35,6 +36,7 @@ final class Meter implements MeterInterface {
     public function __construct(
         private readonly MeterState $meterState,
         private readonly InstrumentationScope $instrumentationScope,
+        private readonly MeterConfig $meterConfig,
     ) {}
 
     private static function dummyInstrument(): Instrument {
@@ -121,9 +123,9 @@ public function createObservableUpDownCounter(string $name, ?string $unit = null
      */
     private function createSynchronousInstrument(string $class, InstrumentType $type, string $name, ?string $unit, ?string $description, array $advisory): InstrumentHandle {
         [$instrument, $referenceCounter] = $this->meterState->createSynchronousInstrument(new Instrument(
-            $type, $name, $unit, $description, $advisory), $this->instrumentationScope);
+            $type, $name, $unit, $description, $advisory), $this->instrumentationScope, $this->meterConfig);
 
-        return new $class($this->meterState->registry, $instrument, $referenceCounter);
+        return new $class($this->meterState->registry, $instrument, $referenceCounter, $this->meterConfig);
     }
 
     /**
@@ -138,13 +140,13 @@ private function createAsynchronousInstrument(string $class, InstrumentType $typ
             $advisory = [];
         }
         [$instrument, $referenceCounter] = $this->meterState->createAsynchronousInstrument(new Instrument(
-            $type, $name, $unit, $description, $advisory), $this->instrumentationScope);
+            $type, $name, $unit, $description, $advisory), $this->instrumentationScope, $this->meterConfig);
 
         foreach ($callbacks as $callback) {
             $this->meterState->registry->registerCallback(closure($callback), $instrument);
             $referenceCounter->acquire(true);
         }
 
-        return new $class($this->meterState->registry, $instrument, $referenceCounter, $this->meterState->destructors);
+        return new $class($this->meterState->registry, $instrument, $referenceCounter, $this->meterState->destructors, $this->meterConfig);
     }
 }
diff --git a/metrics/Internal/MeterMetricProducer.php b/metrics/Internal/MeterMetricProducer.php
@@ -7,6 +7,7 @@
 use Nevay\OTelSDK\Metrics\MetricFilter;
 use Nevay\OTelSDK\Metrics\MetricFilterResult;
 use Nevay\OTelSDK\Metrics\MetricProducer;
+use Traversable;
 use function array_keys;
 use function count;
 use const COUNT_RECURSIVE;
@@ -42,16 +43,15 @@ public function registerMetricSource(int $streamId, MetricStreamSource $streamSo
     }
 
     public function produce(?MetricFilter $metricFilter = null, ?Cancellation $cancellation = null): iterable {
-        $sources = $metricFilter
-            ? $this->applyMetricFilter($this->sources, $metricFilter)
-            : $this->sources;
+        $sources = $this->applyMetricFilter($this->sources, $metricFilter);
         $streamIds = count($sources) === count($this->sources)
             ? $this->streamIds ??= array_keys($this->sources)
             : array_keys($sources);
+        $collector = $this->collector;
 
         return new SizedTraversable(
-            (function() use ($sources, $streamIds, $cancellation) {
-                $this->collector->collectAndPush($streamIds, $cancellation);
+            (static function() use ($collector, $sources, $streamIds, $cancellation): Traversable {
+                $collector->collectAndPush($streamIds, $cancellation);
                 unset($streamIds, $cancellation);
 
                 foreach ($sources as $streamSources) {
@@ -71,15 +71,10 @@ public function produce(?MetricFilter $metricFilter = null, ?Cancellation $cance
      * @param array<int, list<MetricStreamSource>> $sources
      * @return array<int, array<int, MetricStreamSource>>
      */
-    private function applyMetricFilter(array $sources, MetricFilter $filter): array {
+    private function applyMetricFilter(array $sources, ?MetricFilter $filter): array {
         foreach ($sources as $streamId => $streamSources) {
             foreach ($streamSources as $sourceId => $source) {
-                $result = $filter->testMetric(
-                    $source->descriptor->instrumentationScope,
-                    $source->descriptor->name,
-                    $source->descriptor->instrumentType,
-                    $source->descriptor->unit,
-                );
+                $result = self::testMetric($source, $filter);
 
                 if ($result === MetricFilterResult::Accept) {
                     // no-op
@@ -89,6 +84,7 @@ private function applyMetricFilter(array $sources, MetricFilter $filter): array
                         $source->descriptor,
                         new FilteredMetricStream($source->descriptor, $source->stream, $filter),
                         $source->reader,
+                        $source->meterConfig,
                     );
                 }
                 if ($result === MetricFilterResult::Drop) {
@@ -103,4 +99,17 @@ private function applyMetricFilter(array $sources, MetricFilter $filter): array
 
         return $sources;
     }
+
+    private static function testMetric(MetricStreamSource $source, ?MetricFilter $filter): MetricFilterResult {
+        if ($source->meterConfig->disabled) {
+            return MetricFilterResult::Drop;
+        }
+
+        return $filter?->testMetric(
+            $source->descriptor->instrumentationScope,
+            $source->descriptor->name,
+            $source->descriptor->instrumentType,
+            $source->descriptor->unit,
+        ) ?? MetricFilterResult::Accept;
+    }
 }
diff --git a/metrics/Internal/MeterProvider.php b/metrics/Internal/MeterProvider.php
@@ -19,7 +19,6 @@
 use Nevay\OTelSDK\Metrics\MetricReader;
 use OpenTelemetry\API\Metrics\MeterInterface;
 use OpenTelemetry\API\Metrics\MeterProviderInterface;
-use OpenTelemetry\API\Metrics\Noop\NoopMeter;
 use OpenTelemetry\Context\ContextStorageInterface;
 use Psr\Log\LoggerInterface;
 use WeakMap;
@@ -90,13 +89,9 @@ public function getMeter(
 
         $instrumentationScope = new InstrumentationScope($name, $version, $schemaUrl,
             $this->instrumentationScopeAttributesFactory->builder()->addAll($attributes)->build());
+        $meterConfig = ($this->meterConfigurator)($instrumentationScope);
 
-        $config = ($this->meterConfigurator)($instrumentationScope);
-        if ($config->disabled) {
-            return new NoopMeter();
-        }
-
-        return new Meter($this->meterState, $instrumentationScope);
+        return new Meter($this->meterState, $instrumentationScope, $meterConfig);
     }
 
     public function shutdown(?Cancellation $cancellation = null): bool {

diff --git a/metrics/Internal/MeterState.php b/metrics/Internal/MeterState.php
@@ -24,6 +24,7 @@
 use Nevay\OTelSDK\Metrics\Internal\Stream\SynchronousMetricStream;
 use Nevay\OTelSDK\Metrics\Internal\View\ResolvedView;
 use Nevay\OTelSDK\Metrics\Internal\View\ViewRegistry;
+use Nevay\OTelSDK\Metrics\MeterConfig;
 use Nevay\OTelSDK\Metrics\MetricReader;
 use Nevay\OTelSDK\Metrics\View;
 use Psr\Log\LoggerInterface;
@@ -89,7 +90,7 @@ public function getAsynchronousInstrument(Instrument $instrument, Instrumentatio
     /**
      * @return array{Instrument, ReferenceCounter}
      */
-    public function createSynchronousInstrument(Instrument $instrument, InstrumentationScope $instrumentationScope): array {
+    public function createSynchronousInstrument(Instrument $instrument, InstrumentationScope $instrumentationScope, MeterConfig $meterConfig): array {
         $instrumentationScopeId = self::instrumentationScopeId($instrumentationScope);
         $instrumentId = self::instrumentId($instrument);
 
@@ -125,7 +126,7 @@ public function createSynchronousInstrument(Instrument $instrument, Instrumentat
                 $dedup[$dedupId] = $streamId;
             }
             $stream = $streams[$streamId];
-            $source = new MetricStreamSource($view->descriptor, $stream, $stream->register($view->temporality));
+            $source = new MetricStreamSource($view->descriptor, $stream, $stream->register($view->temporality), $meterConfig);
             $view->metricProducer->registerMetricSource($streamId, $source);
         }
 
@@ -148,7 +149,7 @@ public function createSynchronousInstrument(Instrument $instrument, Instrumentat
     /**
      * @return array{Instrument, ReferenceCounter}
      */
-    public function createAsynchronousInstrument(Instrument $instrument, InstrumentationScope $instrumentationScope): array {
+    public function createAsynchronousInstrument(Instrument $instrument, InstrumentationScope $instrumentationScope, MeterConfig $meterConfig): array {
         $instrumentationScopeId = self::instrumentationScopeId($instrumentationScope);
         $instrumentId = self::instrumentId($instrument);
 
@@ -182,7 +183,7 @@ public function createAsynchronousInstrument(Instrument $instrument, Instrumenta
                 $dedup[$dedupId] = $streamId;
             }
             $stream = $streams[$streamId];
-            $source = new MetricStreamSource($view->descriptor, $stream, $stream->register($view->temporality));
+            $source = new MetricStreamSource($view->descriptor, $stream, $stream->register($view->temporality), $meterConfig);
             $view->metricProducer->registerMetricSource($streamId, $source);
         }
 

diff --git a/metrics/Internal/MetricStreamSource.php b/metrics/Internal/MetricStreamSource.php
@@ -3,6 +3,7 @@
 
 use Nevay\OTelSDK\Metrics\Data\Descriptor;
 use Nevay\OTelSDK\Metrics\Internal\Stream\MetricStream;
+use Nevay\OTelSDK\Metrics\MeterConfig;
 
 /**
  * @internal
@@ -13,5 +14,6 @@ public function __construct(
         public readonly Descriptor $descriptor,
         public readonly MetricStream $stream,
         public readonly int $reader,
+        public readonly MeterConfig $meterConfig,
     ) {}
 }
diff --git a/metrics/MeterConfig.php b/metrics/MeterConfig.php
@@ -7,6 +7,6 @@
 final class MeterConfig {
 
     public function __construct(
-        public readonly bool $disabled = false,
+        public bool $disabled = false,
     ) {}
 }
diff --git a/trace/Internal/Tracer.php b/trace/Internal/Tracer.php
@@ -2,6 +2,8 @@
 namespace Nevay\OTelSDK\Trace\Internal;
 
 use Nevay\OTelSDK\Common\InstrumentationScope;
+use Nevay\OTelSDK\Trace\TracerConfig;
+use OpenTelemetry\API\Trace\NoopSpanBuilder;
 use OpenTelemetry\API\Trace\SpanBuilderInterface;
 use OpenTelemetry\API\Trace\TracerInterface;
 
@@ -13,13 +15,18 @@ final class Tracer implements TracerInterface {
     public function __construct(
         private readonly TracerState $tracerState,
         private readonly InstrumentationScope $instrumentationScope,
+        private readonly TracerConfig $tracerConfig,
     ) {}
 
     public function enabled(): bool {
-        return true;
+        return !$this->tracerConfig->disabled;
     }
 
     public function spanBuilder(string $spanName): SpanBuilderInterface {
+        if ($this->tracerConfig->disabled) {
+            return new NoopSpanBuilder($this->tracerState->contextStorage);
+        }
+
         return new SpanBuilder($this->tracerState, $this->instrumentationScope, $spanName);
     }
 }
diff --git a/trace/Internal/TracerProvider.php b/trace/Internal/TracerProvider.php
@@ -13,7 +13,6 @@
 use Nevay\OTelSDK\Trace\Sampler;
 use Nevay\OTelSDK\Trace\SpanProcessor;
 use Nevay\OTelSDK\Trace\TracerConfig;
-use OpenTelemetry\API\Trace\NoopTracer;
 use OpenTelemetry\API\Trace\TracerInterface;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
 use OpenTelemetry\Context\ContextStorageInterface;
@@ -79,13 +78,9 @@ public function getTracer(
 
         $instrumentationScope = new InstrumentationScope($name, $version, $schemaUrl,
             $this->instrumentationScopeAttributesFactory->builder()->addAll($attributes)->build());
+        $tracerConfig = ($this->tracerConfigurator)($instrumentationScope);
 
-        $config = ($this->tracerConfigurator)($instrumentationScope);
-        if ($config->disabled) {
-            return new NoopTracer();
-        }
-
-        return new Tracer($this->tracerState, $instrumentationScope);
+        return new Tracer($this->tracerState, $instrumentationScope, $tracerConfig);
     }
 
     public function shutdown(?Cancellation $cancellation = null): bool {

diff --git a/trace/TracerConfig.php b/trace/TracerConfig.php
@@ -7,6 +7,6 @@
 final class TracerConfig {
 
     public function __construct(
-        public readonly bool $disabled = false,
+        public bool $disabled = false,
     ) {}
 }