adding LogRecordProcessor.enabled (#1637)

brettmc · web-flow · commit 8d27d732241e · 2025-06-27T15:38:30.000+10:00
* adding LogRecordProcessor.enabled

* apply review feedback
diff --git a/examples/src/_register.php b/examples/src/_register.php
@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 use Nevay\SPI\ServiceLoader;
-use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
 use OpenTelemetry\API\Configuration\Config\ComponentProvider;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
 use OpenTelemetry\Example\ExampleConfigProvider;
 use OpenTelemetry\Example\ExampleInstrumentation;
 use OpenTelemetry\Example\TestResourceDetectorFactory;
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -51,10 +51,6 @@ parameters:
             message: "#.*return with type T is not subtype.*#"
             paths:
                 - src/SDK/Common/InstrumentationScope
-        -
-            message: "#.*assertCount\\(\\) expects Countable\\|iterable.*#"
-            paths:
-                - tests/Unit/Contrib/Otlp/
         -
             message: "#.*expects Google\\\\Protobuf\\\\RepeatedField.*#"
             paths:
diff --git a/src/Config/SDK/ComponentProvider/Propagator/TextMapPropagatorCloudTrace.php b/src/Config/SDK/ComponentProvider/Propagator/TextMapPropagatorCloudTrace.php
@@ -5,9 +5,9 @@
 namespace OpenTelemetry\Config\SDK\ComponentProvider\Propagator;
 
 use Nevay\SPI\ServiceProviderDependency\PackageDependency;
-use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
-use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
-use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\API\Configuration\Config\ComponentProvider;
+use OpenTelemetry\API\Configuration\Config\ComponentProviderRegistry;
+use OpenTelemetry\API\Configuration\Context;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use OpenTelemetry\Extension\Propagator\CloudTrace\CloudTracePropagator;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
diff --git a/src/Config/SDK/_register.php b/src/Config/SDK/_register.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Nevay\SPI\ServiceLoader;
+use OpenTelemetry\API\Configuration\Config\ComponentProvider;
 use OpenTelemetry\Config\SDK\ComponentProvider\Instrumentation\General\HttpConfigProvider;
 use OpenTelemetry\Config\SDK\ComponentProvider\Instrumentation\General\PeerConfigProvider;
 use OpenTelemetry\Config\SDK\ComponentProvider\Logs\LogRecordExporterConsole;
@@ -35,7 +36,6 @@
 use OpenTelemetry\Config\SDK\ComponentProvider\Trace\SpanExporterZipkin;
 use OpenTelemetry\Config\SDK\ComponentProvider\Trace\SpanProcessorBatch;
 use OpenTelemetry\Config\SDK\ComponentProvider\Trace\SpanProcessorSimple;
-use OpenTelemetry\API\Configuration\Config\ComponentProvider;
 
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorB3::class);
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorB3Multi::class);
diff --git a/src/SDK/Logs/LogRecordProcessorInterface.php b/src/SDK/Logs/LogRecordProcessorInterface.php
@@ -6,13 +6,16 @@
 
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Future\CancellationInterface;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 
-/**
- * @todo implement (optional) isEnabled: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.45.0/specification/logs/sdk.md#enabled-1
- */
 interface LogRecordProcessorInterface
 {
     public function onEmit(ReadWriteLogRecord $record, ?ContextInterface $context = null): void;
     public function shutdown(?CancellationInterface $cancellation = null): bool;
     public function forceFlush(?CancellationInterface $cancellation = null): bool;
+
+    /**
+     * @experimental
+     */
+    public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool;
 }
diff --git a/src/SDK/Logs/Logger.php b/src/SDK/Logs/Logger.php
@@ -7,6 +7,7 @@
 use OpenTelemetry\API\Behavior\LogsMessagesTrait;
 use OpenTelemetry\API\Logs\LoggerInterface;
 use OpenTelemetry\API\Logs\LogRecord;
+use OpenTelemetry\Context\Context;
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 use OpenTelemetry\SDK\Common\InstrumentationScope\Configurator;
@@ -55,7 +56,10 @@ public function emit(LogRecord $logRecord): void
      */
     public function isEnabled(?ContextInterface $context = null, ?int $severityNumber = null, ?string $eventName = null): bool
     {
-        return $this->config->isEnabled();
+        $context ??= Context::getCurrent();
+
+        return $this->loggerSharedState->getProcessor()->isEnabled($context, $this->scope, $severityNumber, $eventName)
+            && $this->config->isEnabled();
     }
 
     /**
diff --git a/src/SDK/Logs/Processor/BatchLogRecordProcessor.php b/src/SDK/Logs/Processor/BatchLogRecordProcessor.php
@@ -12,6 +12,7 @@
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Future\CancellationInterface;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 use OpenTelemetry\SDK\Logs\LogRecordExporterInterface;
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
 use OpenTelemetry\SDK\Logs\ReadWriteLogRecord;
@@ -178,6 +179,11 @@ public function shutdown(?CancellationInterface $cancellation = null): bool
         return $this->flush(__FUNCTION__, $cancellation);
     }
 
+    public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool
+    {
+        return true;
+    }
+
     private function flush(?string $flushMethod = null, ?CancellationInterface $cancellation = null): bool
     {
         if ($flushMethod !== null) {
diff --git a/src/SDK/Logs/Processor/MultiLogRecordProcessor.php b/src/SDK/Logs/Processor/MultiLogRecordProcessor.php
@@ -6,6 +6,7 @@
 
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Future\CancellationInterface;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
 use OpenTelemetry\SDK\Logs\ReadWriteLogRecord;
 
@@ -59,4 +60,15 @@ public function forceFlush(?CancellationInterface $cancellation = null): bool
 
         return $result;
     }
+
+    public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool
+    {
+        foreach ($this->processors as $processor) {
+            if ($processor->isEnabled($context, $scope, $severityNumber, $eventName)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/src/SDK/Logs/Processor/NoopLogRecordProcessor.php b/src/SDK/Logs/Processor/NoopLogRecordProcessor.php
@@ -6,6 +6,7 @@
 
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Future\CancellationInterface;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
 use OpenTelemetry\SDK\Logs\ReadWriteLogRecord;
 
@@ -34,4 +35,9 @@ public function forceFlush(?CancellationInterface $cancellation = null): bool
     {
         return true;
     }
+
+    public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool
+    {
+        return true;
+    }
 }
diff --git a/src/SDK/Logs/Processor/SimpleLogRecordProcessor.php b/src/SDK/Logs/Processor/SimpleLogRecordProcessor.php
@@ -6,6 +6,7 @@
 
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Future\CancellationInterface;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 use OpenTelemetry\SDK\Logs\LogRecordExporterInterface;
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
 use OpenTelemetry\SDK\Logs\ReadWriteLogRecord;
@@ -33,4 +34,9 @@ public function forceFlush(?CancellationInterface $cancellation = null): bool
     {
         return $this->exporter->forceFlush($cancellation);
     }
+
+    public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool
+    {
+        return true;
+    }
 }
diff --git a/tests/Integration/SDK/Logs/LoggerTest.php b/tests/Integration/SDK/Logs/LoggerTest.php
@@ -7,6 +7,7 @@
 use OpenTelemetry\API\Logs\LogRecord;
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Future\CancellationInterface;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
 use OpenTelemetry\SDK\Logs\Exporter\InMemoryExporter;
 use OpenTelemetry\SDK\Logs\LoggerProvider;
 use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;
@@ -50,6 +51,11 @@ public function forceFlush(?CancellationInterface $cancellation = null): bool
             {
                 return true;
             }
+
+            public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool
+            {
+                return true;
+            }
         };
         $multi = new MultiLogRecordProcessor([
             new SimpleLogRecordProcessor($exporter),
diff --git a/tests/Unit/SDK/Logs/LoggerTest.php b/tests/Unit/SDK/Logs/LoggerTest.php
@@ -39,6 +39,7 @@ public function setUp(): void
         $this->sharedState = $this->createMock(LoggerSharedState::class);
         $this->sharedState->method('getLogRecordLimits')->willReturn($limits);
         $this->processor = $this->createMock(LogRecordProcessorInterface::class);
+        $this->processor->method('isEnabled')->willReturn(true);
         $this->sharedState->method('getProcessor')->willReturn($this->processor);
         $this->scope = new InstrumentationScope('foo', '1.0', 'schema.url', Attributes::create([])); //final
 

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use OpenTelemetry\Context\ContextInterface;`
`8`	`8`	`use OpenTelemetry\SDK\Common\Future\CancellationInterface;`
	`9`	`+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;`
`9`	`10`	`use OpenTelemetry\SDK\Logs\LogRecordProcessorInterface;`
`10`	`11`	`use OpenTelemetry\SDK\Logs\ReadWriteLogRecord;`
`11`	`12`
`@@ -34,4 +35,9 @@ public function forceFlush(?CancellationInterface $cancellation = null): bool`
`34`	`35`	`{`
`35`	`36`	`return true;`
`36`	`37`	`}`
	`38`	`+`
	`39`	`+ public function isEnabled(ContextInterface $context, InstrumentationScopeInterface $scope, ?int $severityNumber, ?string $eventName): bool`
	`40`	`+ {`
	`41`	`+ return true;`
	`42`	`+ }`
`37`	`43`	`}`