event logger spec compliance

examples/logs/exporters/otlp_grpc.php

@@ -34,7 +34,7 @@
 
 $eventLogger->emit(
     name: 'foo',
-    payload: ['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world'],
+    body: ['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world'],
     severityNumber: Severity::INFO
 );
 

examples/logs/exporters/otlp_http.php

@@ -32,7 +32,7 @@
 
 $eventLogger->emit(
     name: 'foo',
-    payload: ['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world'],
+    body: ['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world'],
     timestamp: (new \DateTime())->getTimestamp() * LogRecord::NANOS_PER_SECOND,
     severityNumber: Severity::INFO,
 );

examples/logs/features/batch_exporting.php

@@ -30,9 +30,9 @@
 
 $payload = ['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world'];
 
-$eventLoggerOne->emit(name: 'foo', payload: $payload, severityNumber: Severity::INFO);
+$eventLoggerOne->emit(name: 'foo', body: $payload, severityNumber: Severity::INFO);
 $eventLoggerOne->emit('bar', 'hello world');
-$eventLoggerTwo->emit(name: 'foo', payload: $payload, severityNumber: Severity::INFO);
+$eventLoggerTwo->emit(name: 'foo', body: $payload, severityNumber: Severity::INFO);
 
 //shut down logger provider
 $loggerProvider->shutdown();

examples/logs/getting_started.php

@@ -41,7 +41,7 @@
 $eventLogger = $eventLoggerProvider->getEventLogger('demo', '1.0', 'http://schema.url', ['foo' => 'bar']);
 $payload = ['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world'];
 
-$eventLogger->emit(name: 'foo', payload: $payload, severityNumber: Severity::INFO);
+$eventLogger->emit(name: 'foo', body: $payload, severityNumber: Severity::INFO);
 
 //end span
 $span->end();

src/API/Logs/EventLoggerInterface.php

@@ -13,7 +13,7 @@ interface EventLoggerInterface
 {
     public function emit(
         string $name,
-        mixed $payload = null,
+        mixed $body = null,
         ?int $timestamp = null,
         ?ContextInterface $context = null,
         Severity $severityNumber = null,

src/API/Logs/NoopEventLogger.php

@@ -16,7 +16,7 @@ public static function instance(): self
         return $instance;
     }
 
-    public function emit(string $name, mixed $payload = null, ?int $timestamp = null, ?ContextInterface $context = null, Severity|int|null $severityNumber = null, iterable $attributes = []): void
+    public function emit(string $name, mixed $body = null, ?int $timestamp = null, ?ContextInterface $context = null, Severity|int|null $severityNumber = null, iterable $attributes = []): void
     {
     }
 }

src/SDK/Logs/EventLogger.php

@@ -28,7 +28,7 @@ public function __construct(
      */
     public function emit(
         string $name,
-        mixed $payload = null,
+        mixed $body = null,
         ?int $timestamp = null,
         ?ContextInterface $context = null,
         Severity $severityNumber = null,
@@ -38,7 +38,7 @@ public function emit(
         $logRecord->setAttribute('event.name', $name);
         $logRecord->setAttributes($attributes);
         $logRecord->setAttribute('event.name', $name);
-        $logRecord->setBody($payload);
+        $logRecord->setBody($body);
         $logRecord->setTimestamp($timestamp ?? $this->clock->now());
         $logRecord->setContext($context ?? Context::getCurrent());
         $logRecord->setSeverityNumber($severityNumber ?? Severity::INFO);

src/SDK/Logs/EventLoggerProvider.php

@@ -6,8 +6,6 @@
 
 use OpenTelemetry\API\Common\Time\Clock;
 use OpenTelemetry\API\Logs\EventLoggerInterface;
-use OpenTelemetry\API\Logs\EventLoggerProviderInterface;
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
 
 class EventLoggerProvider implements EventLoggerProviderInterface
 {
@@ -22,4 +20,9 @@ public function getEventLogger(string $name, ?string $version = null, ?string $s
             Clock::getDefault(),
         );
     }
+
+    public function forceFlush(): bool
+    {
+        return $this->loggerProvider->forceFlush();
+    }
 }

src/SDK/Logs/EventLoggerProviderFactory.php

@@ -4,13 +4,11 @@
 
 namespace OpenTelemetry\SDK\Logs;
 
-use OpenTelemetry\API\Logs\EventLoggerProviderInterface;
-use OpenTelemetry\API\Logs\NoopEventLoggerProvider;
 use OpenTelemetry\SDK\Sdk;
 
 class EventLoggerProviderFactory
 {
-    public function create(\OpenTelemetry\API\Logs\LoggerProviderInterface $loggerProvider): EventLoggerProviderInterface
+    public function create(LoggerProviderInterface $loggerProvider): EventLoggerProviderInterface
     {
         if (Sdk::isDisabled()) {
             return NoopEventLoggerProvider::getInstance();

src/SDK/Logs/EventLoggerProviderInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Logs;
+
+use OpenTelemetry\API\Logs as API;
+
+interface EventLoggerProviderInterface extends API\EventLoggerProviderInterface
+{
+    public function forceFlush(): bool;
+}

src/SDK/Logs/NoopEventLoggerProvider.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Logs;
+
+use OpenTelemetry\API\Logs as API;
+
+class NoopEventLoggerProvider extends API\NoopEventLoggerProvider implements EventLoggerProviderInterface
+{
+    public static function getInstance(): self
+    {
+        static $instance;
+
+        return $instance ??= new self();
+    }
+
+    public function forceFlush(): bool
+    {
+        return true;
+    }
+}

tests/Unit/SDK/Logs/EventLoggerProviderFactoryTest.php

@@ -4,11 +4,11 @@
 
 namespace OpenTelemetry\Tests\Unit\SDK\Logs;
 
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
-use OpenTelemetry\API\Logs\NoopEventLoggerProvider;
 use OpenTelemetry\SDK\Common\Configuration\Variables;
 use OpenTelemetry\SDK\Logs\EventLoggerProvider;
 use OpenTelemetry\SDK\Logs\EventLoggerProviderFactory;
+use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
+use OpenTelemetry\SDK\Logs\NoopEventLoggerProvider;
 use OpenTelemetry\Tests\TestState;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;

tests/Unit/SDK/Logs/EventLoggerProviderTest.php

@@ -5,21 +5,38 @@
 namespace Unit\SDK\Logs;
 
 use OpenTelemetry\API\Logs\LoggerInterface;
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
 use OpenTelemetry\SDK\Logs\EventLoggerProvider;
+use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 #[CoversClass(EventLoggerProvider::class)]
 class EventLoggerProviderTest extends TestCase
 {
+    private EventLoggerProvider $eventLoggerProvider;
+    /** @var LoggerProviderInterface&MockObject $loggerProvider */
+    private LoggerProviderInterface $loggerProvider;
+    private LoggerInterface $logger;
+
+    public function setUp(): void
+    {
+        $this->loggerProvider = $this->createMock(LoggerProviderInterface::class);
+        $this->logger = $this->createMock(LoggerInterface::class);
+        $this->eventLoggerProvider = new EventLoggerProvider($this->loggerProvider);
+    }
+
     public function test_emit(): void
     {
-        $loggerProvider = $this->createMock(LoggerProviderInterface::class);
-        $logger = $this->createMock(LoggerInterface::class);
-        $loggerProvider->expects($this->once())->method('getLogger')->willReturn($logger);
-        $eventLoggerProvider = new EventLoggerProvider($loggerProvider);
+        $this->loggerProvider->expects($this->once())->method('getLogger')->willReturn($this->logger);
+
+        $this->eventLoggerProvider->getEventLogger('event.logger', '1.0', 'https://example.org/schema', ['foo' => 'foo']);
+    }
+
+    public function test_force_flush(): void
+    {
+        $this->loggerProvider->expects($this->once())->method('forceFlush')->willReturn(true);
 
-        $eventLoggerProvider->getEventLogger('event.logger', '1.0', 'https://example.org/schema', ['foo' => 'foo']);
+        $this->eventLoggerProvider->forceFlush();
     }
 }

tests/Unit/SDK/Logs/EventLoggerTest.php

@@ -7,12 +7,12 @@
 use OpenTelemetry\API\Common\Time\Clock;
 use OpenTelemetry\API\Common\Time\TestClock;
 use OpenTelemetry\API\Logs\LoggerInterface;
-use OpenTelemetry\API\Logs\LoggerProviderInterface;
 use OpenTelemetry\API\Logs\LogRecord;
 use OpenTelemetry\API\Logs\Severity;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\SDK\Logs\EventLogger;
 use OpenTelemetry\SDK\Logs\EventLoggerProvider;
+use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;

tests/Unit/SDK/Logs/NoopEventLoggerProviderTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Unit\SDK\Logs;
+
+use OpenTelemetry\SDK\Logs\NoopEventLoggerProvider;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(NoopEventLoggerProvider::class)]
+class NoopEventLoggerProviderTest extends TestCase
+{
+    public function test_get_instance(): void
+    {
+        $this->assertInstanceOf(NoopEventLoggerProvider::class, NoopEventLoggerProvider::getInstance());
+    }
+
+    public function test_force_flush(): void
+    {
+        $this->assertTrue(NoopEventLoggerProvider::getInstance()->forceFlush());
+    }
+}