apply logging spec updates

examples/logs/features/monolog-otel-integration.php

@@ -45,7 +45,7 @@ public function __construct(string $level, bool $bubble = true, ?LoggerProviderI
 
     protected function write(array $record): void
     {
-        $this->logger->logRecord($this->convert($record));
+        $this->logger->emit($this->convert($record));
     }
 
     private function convert(array $record): LogRecord

src/API/Common/Instrumentation/CachedInstrumentation.php

@@ -88,10 +88,9 @@ public function logger(): LoggerInterface
         $loggerProvider = Globals::loggerProvider();
 
         if ($this->loggers === null) {
-            //@todo configurable includeTraceContext?
-            return $loggerProvider->getLogger($this->name, $this->version, $this->schemaUrl, true, $this->attributes);
+            return $loggerProvider->getLogger($this->name, $this->version, $this->schemaUrl, $this->attributes);
         }
 
-        return $this->loggers[$loggerProvider] ??= $loggerProvider->getLogger($this->name, $this->version, $this->schemaUrl, true, $this->attributes);
+        return $this->loggers[$loggerProvider] ??= $loggerProvider->getLogger($this->name, $this->version, $this->schemaUrl, $this->attributes);
     }
 }

src/API/Logs/EventLogger.php

@@ -21,6 +21,6 @@ public function logEvent(string $eventName, LogRecord $logRecord): void
             'event.name' => $eventName,
             'event.domain' => $this->domain,
         ]);
-        $this->logger->logRecord($logRecord);
+        $this->logger->emit($logRecord);
     }
 }

src/API/Logs/LoggerInterface.php

@@ -6,5 +6,5 @@
 
 interface LoggerInterface
 {
-    public function logRecord(LogRecord $logRecord): void;
+    public function emit(LogRecord $logRecord): void;
 }

src/API/Logs/LoggerProviderInterface.php

@@ -13,7 +13,6 @@ public function getLogger(
         string $name,
         ?string $version = null,
         ?string $schemaUrl = null,
-        bool $includeTraceContext = true,
         iterable $attributes = [] //instrumentation scope attributes
     ): LoggerInterface;
 }

src/API/Logs/NoopLogger.php

@@ -20,7 +20,7 @@ public static function getInstance(): self
     /**
      * @codeCoverageIgnore
      */
-    public function logRecord(LogRecord $logRecord): void
+    public function emit(LogRecord $logRecord): void
     {
     }
 

src/API/Logs/NoopLoggerProvider.php

@@ -13,7 +13,7 @@ public static function getInstance(): self
         return $instance ??= new self();
     }
 
-    public function getLogger(string $name, ?string $version = null, ?string $schemaUrl = null, bool $includeTraceContext = true, iterable $attributes = []): LoggerInterface
+    public function getLogger(string $name, ?string $version = null, ?string $schemaUrl = null, iterable $attributes = []): LoggerInterface
     {
         return NoopLogger::getInstance();
     }

src/SDK/Logs/Logger.php

@@ -18,18 +18,16 @@ class Logger implements LoggerInterface
 {
     private InstrumentationScopeInterface $scope;
     private LoggerSharedState $loggerSharedState;
-    private bool $includeTraceContext;
 
-    public function __construct(LoggerSharedState $loggerSharedState, InstrumentationScopeInterface $scope, bool $includeTraceContext)
+    public function __construct(LoggerSharedState $loggerSharedState, InstrumentationScopeInterface $scope)
     {
         $this->loggerSharedState = $loggerSharedState;
         $this->scope = $scope;
-        $this->includeTraceContext = $includeTraceContext;
     }
 
-    public function logRecord(LogRecord $logRecord): void
+    public function emit(LogRecord $logRecord): void
     {
-        $readWriteLogRecord = new ReadWriteLogRecord($this->scope, $this->loggerSharedState, $logRecord, $this->includeTraceContext);
+        $readWriteLogRecord = new ReadWriteLogRecord($this->scope, $this->loggerSharedState, $logRecord);
         // @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/sdk.md#onemit
         $this->loggerSharedState->getProcessor()->onEmit(
             $readWriteLogRecord,

src/SDK/Logs/LoggerProvider.php

@@ -29,14 +29,14 @@ public function __construct(LogRecordProcessorInterface $processor, Instrumentat
     /**
      * @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/sdk.md#logger-creation
      */
-    public function getLogger(string $name, ?string $version = null, ?string $schemaUrl = null, bool $includeTraceContext = true, iterable $attributes = []): LoggerInterface
+    public function getLogger(string $name, ?string $version = null, ?string $schemaUrl = null, iterable $attributes = []): LoggerInterface
     {
         if ($this->loggerSharedState->hasShutdown()) {
             return NoopLogger::getInstance();
         }
         $scope = $this->instrumentationScopeFactory->create($name, $version, $schemaUrl, $attributes);
 
-        return new Logger($this->loggerSharedState, $scope, $includeTraceContext);
+        return new Logger($this->loggerSharedState, $scope);
     }
 
     public function shutdown(CancellationInterface $cancellation = null): bool

src/SDK/Logs/NoopLoggerProvider.php

@@ -16,7 +16,7 @@ public static function getInstance(): self
         return $instance ??= new self();
     }
 
-    public function getLogger(string $name, ?string $version = null, ?string $schemaUrl = null, bool $includeTraceContext = true, iterable $attributes = []): LoggerInterface
+    public function getLogger(string $name, ?string $version = null, ?string $schemaUrl = null, iterable $attributes = []): LoggerInterface
     {
         return NoopLogger::getInstance();
     }

src/SDK/Logs/ReadableLogRecord.php

@@ -24,19 +24,18 @@ class ReadableLogRecord extends LogRecord
     protected AttributesInterface $convertedAttributes;
     protected SpanContextInterface $spanContext;
 
-    public function __construct(InstrumentationScopeInterface $scope, LoggerSharedState $loggerSharedState, LogRecord $logRecord, bool $includeTraceContext)
+    public function __construct(InstrumentationScopeInterface $scope, LoggerSharedState $loggerSharedState, LogRecord $logRecord)
     {
         $this->scope = $scope;
         $this->loggerSharedState = $loggerSharedState;
 
         parent::__construct($logRecord->body);
         $this->timestamp = $logRecord->timestamp;
-        $this->observedTimestamp = $logRecord->observedTimestamp;
+        $this->observedTimestamp = $logRecord->observedTimestamp
+            ?? (int) (microtime(true) * LogRecord::NANOS_PER_SECOND);
         $this->context = $logRecord->context;
-        if ($includeTraceContext) {
-            $context = $this->context ?? Context::getCurrent();
-            $this->spanContext = Span::fromContext($context)->getContext();
-        };
+        $context = $this->context ?? Context::getCurrent();
+        $this->spanContext = Span::fromContext($context)->getContext();
         $this->severityNumber = $logRecord->severityNumber;
         $this->severityText = $logRecord->severityText;
 

tests/Unit/API/Logs/EventLoggerTest.php

@@ -21,7 +21,7 @@ public function test_log_event(): void
         $logRecord = $this->createMock(LogRecord::class);
         $eventLogger = new EventLogger($logger, $domain);
         $logRecord->expects($this->once())->method('setAttributes');
-        $logger->expects($this->once())->method('logRecord')->with($this->equalTo($logRecord));
+        $logger->expects($this->once())->method('emit')->with($this->equalTo($logRecord));
 
         $eventLogger->logEvent('some.event', $logRecord);
     }

tests/Unit/SDK/Logs/Exporter/ConsoleExporterTest.php

@@ -34,7 +34,6 @@ public function test_export(): void
                 $this->createMock(InstrumentationScopeInterface::class),
                 $this->createMock(LoggerSharedState::class),
                 (new LogRecord('foo')),
-                true,
             )),
         ];
 

tests/Unit/SDK/Logs/LoggerTest.php

@@ -34,7 +34,7 @@ public function setUp(): void
 
     public function test_log_record(): void
     {
-        $logger = new Logger($this->sharedState, $this->scope, true);
+        $logger = new Logger($this->sharedState, $this->scope);
         $record = (new LogRecord())->setContext($this->createMock(ContextInterface::class));
 
         $this->processor->expects($this->once())->method('onEmit')
@@ -43,6 +43,26 @@ public function test_log_record(): void
                 $this->isInstanceOf(ContextInterface::class)
             );
 
-        $logger->logRecord($record);
+        $logger->emit($record);
+    }
+
+    public function test_sets_observed_timestamp_on_emit(): void
+    {
+        $logger = new Logger($this->sharedState, $this->scope);
+        $record = new LogRecord();
+        $time = microtime(true) * LogRecord::NANOS_PER_SECOND;
+
+        $this->processor->expects($this->once())->method('onEmit')
+            ->with(
+                $this->callback(function (ReadWriteLogRecord $record) use ($time) {
+                    $this->assertNotNull($record->getObservedTimestamp());
+                    $this->assertGreaterThan($time, $record->getObservedTimestamp());
+
+                    return true;
+                }),
+                $this->anything(),
+            );
+
+        $logger->emit($record);
     }
 }

tests/Unit/SDK/Logs/ReadableLogRecordTest.php

@@ -37,7 +37,7 @@ public function test_getters(): void
             ->setObservedTimestamp(22)
             ->setAttributes(['foo' => 'bar'])
             ->setContext($context);
-        $record = new ReadableLogRecord($scope, $sharedState, $logRecord, true);
+        $record = new ReadableLogRecord($scope, $sharedState, $logRecord);
 
         $this->assertSame($scope, $record->getInstrumentationScope());
         $this->assertSame($resource, $record->getResource());