Revert "make severity an enum only"

This reverts commit 7108229. Also, move PSR-3 mapping into the Severity enum.
open-telemetry · Apr 30, 2024 · fdff961 · fdff961
1 parent 9b20ddb
commit fdff961
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 29 deletions.
diff --git a/examples/logs/logger_builder.php b/examples/logs/logger_builder.php
@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use OpenTelemetry\API\Logs\LogRecord;
-use OpenTelemetry\API\Logs\Severity;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
 use OpenTelemetry\SDK\Logs\Exporter\ConsoleExporterFactory;
 use OpenTelemetry\SDK\Logs\LoggerProvider;
@@ -25,7 +24,7 @@
 
 $record = (new LogRecord(['foo' => 'bar', 'baz' => 'bat', 'msg' => 'hello world']))
     ->setSeverityText('INFO')
-    ->setSeverityNumber(Severity::INFO);
+    ->setSeverityNumber(9);
 
 /**
  * Note that Loggers should only be used directly by a log appender.

diff --git a/src/API/Logs/EventLoggerInterface.php b/src/API/Logs/EventLoggerInterface.php
@@ -16,7 +16,7 @@ public function emit(
         mixed $payload = null,
         ?int $timestamp = null,
         ?ContextInterface $context = null,
-        ?Severity $severityNumber = null,
+        Severity|int|null $severityNumber = null,
         array $attributes = [],
     ): void;
 }
diff --git a/src/API/Logs/LogRecord.php b/src/API/Logs/LogRecord.php
@@ -42,9 +42,9 @@ public function setContext(?ContextInterface $context = null): self
     /**
      * @see https://opentelemetry.io/docs/reference/specification/logs/data-model/#field-severitynumber
      */
-    public function setSeverityNumber(Severity $severityNumber): self
+    public function setSeverityNumber(Severity|int $severityNumber): self
     {
-        $this->severityNumber = $severityNumber->value;
+        $this->severityNumber = ($severityNumber instanceof Severity) ? $severityNumber->value : $severityNumber;
 
         return $this;
     }

diff --git a/src/API/Logs/Map/Psr3.php b/src/API/Logs/Map/Psr3.php
@@ -4,30 +4,17 @@
 
 namespace OpenTelemetry\API\Logs\Map;
 
-use InvalidArgumentException;
 use OpenTelemetry\API\Logs\Severity;
-use Psr\Log\LogLevel;
 
 class Psr3
 {
     /**
      * Maps PSR-3 severity level (string) to the appropriate opentelemetry severity
      *
-     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model-appendix.md#appendix-b-severitynumber-example-mappings
-     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-severitynumber
+     * @deprecated Use Severity::fromPsr3
      */
     public static function severityNumber(string $level): Severity
     {
-        return match (strtolower($level)) {
-            LogLevel::DEBUG => Severity::DEBUG,
-            LogLevel::INFO => Severity::INFO,
-            LogLevel::NOTICE => Severity::INFO2,
-            LogLevel::WARNING => Severity::WARN,
-            LogLevel::ERROR => Severity::ERROR,
-            LogLevel::CRITICAL => Severity::ERROR2,
-            LogLevel::ALERT => Severity::ERROR3,
-            LogLevel::EMERGENCY => Severity::FATAL,
-            default => throw new InvalidArgumentException('Unknown severity: ' . $level),
-        };
+        return Severity::fromPsr3($level);
     }
 }
diff --git a/src/API/Logs/Severity.php b/src/API/Logs/Severity.php
@@ -4,6 +4,9 @@
 
 namespace OpenTelemetry\API\Logs;
 
+use Psr\Log\LogLevel;
+use ValueError;
+
 enum Severity: int
 {
     case TRACE = 1;
@@ -30,4 +33,25 @@ enum Severity: int
     case FATAL2 = 22;
     case FATAL3 = 23;
     case FATAL4 = 24;
+
+    /**
+     * Maps PSR-3 severity level (string) to the appropriate opentelemetry severity
+     *
+     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model-appendix.md#appendix-b-severitynumber-example-mappings
+     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-severitynumber
+     */
+    public static function fromPsr3(string $level): self
+    {
+        return match (strtolower($level)) {
+            LogLevel::DEBUG => Severity::DEBUG,
+            LogLevel::INFO => Severity::INFO,
+            LogLevel::NOTICE => Severity::INFO2,
+            LogLevel::WARNING => Severity::WARN,
+            LogLevel::ERROR => Severity::ERROR,
+            LogLevel::CRITICAL => Severity::ERROR2,
+            LogLevel::ALERT => Severity::ERROR3,
+            LogLevel::EMERGENCY => Severity::FATAL,
+            default => throw new ValueError('Unknown severity: ' . $level),
+        };
+    }
 }
diff --git a/src/SDK/Logs/EventLogger.php b/src/SDK/Logs/EventLogger.php
@@ -31,7 +31,7 @@ public function emit(
         mixed $payload = null,
         ?int $timestamp = null,
         ?ContextInterface $context = null,
-        ?Severity $severityNumber = null,
+        Severity|int|null $severityNumber = null,
         array $attributes = [],
     ): void {
         $logRecord = new LogRecord();

diff --git a/tests/Unit/API/Logs/LogRecordTest.php b/tests/Unit/API/Logs/LogRecordTest.php
@@ -33,6 +33,7 @@ public static function settersProvider(): array
         return [
             ['setBody', 'body', 'foo'],
             ['setAttributes', 'attributes', ['foo' => 'bar']],
+            ['setSeverityNumber', 'severityNumber', 5],
             ['setSeverityNumber', 'severityNumber', Severity::ERROR, Severity::ERROR->value],
             ['setSeverityText', 'severityText', 'info'],
             ['setObservedTimestamp', 'observedTimestamp', 999],

diff --git a/tests/Unit/API/Logs/Map/Psr3Test.php b/tests/Unit/API/Logs/Map/Psr3Test.php
@@ -34,10 +34,4 @@ public static function levelProvider(): array
             [LogLevel::DEBUG],
         ];
     }
-
-    public function test_unknown_value_error(): void
-    {
-        $this->expectException(\InvalidArgumentException::class);
-        Psr3::severityNumber('unknown');
-    }
 }
diff --git a/tests/Unit/API/Logs/SeverityTest.php b/tests/Unit/API/Logs/SeverityTest.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Tests\Unit\API\Logs;
+
+use OpenTelemetry\API\Logs\Severity;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LogLevel;
+use ValueError;
+
+/**
+ * @covers \OpenTelemetry\API\Logs\Severity
+ */
+class SeverityTest extends TestCase
+{
+    public function test_value_error(): void
+    {
+        $this->expectException(ValueError::class);
+        Severity::fromPsr3('unknown');
+    }
+
+    /**
+     * @dataProvider levelProvider
+     */
+    public function test_severity_number(string $level): void
+    {
+        $this->assertNotNull(Severity::fromPsr3($level));
+    }
+
+    public static function levelProvider(): array
+    {
+        return [
+            [LogLevel::EMERGENCY],
+            [LogLevel::ALERT],
+            [LogLevel::CRITICAL],
+            [LogLevel::ERROR],
+            [LogLevel::WARNING],
+            [LogLevel::NOTICE],
+            [LogLevel::INFO],
+            [LogLevel::DEBUG],
+        ];
+    }
+}
diff --git a/tests/Unit/SDK/Logs/ReadableLogRecordTest.php b/tests/Unit/SDK/Logs/ReadableLogRecordTest.php
@@ -5,7 +5,6 @@
 namespace OpenTelemetry\Tests\Unit\SDK\Logs;
 
 use OpenTelemetry\API\Logs\LogRecord;
-use OpenTelemetry\API\Logs\Severity;
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\SDK\Common\Attribute\AttributesFactory;
 use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeInterface;
@@ -40,7 +39,7 @@ public function setUp(): void
     public function test_getters(): void
     {
         $logRecord = (new LogRecord('body'))
-            ->setSeverityNumber(Severity::DEBUG)
+            ->setSeverityNumber(5)
             ->setSeverityText('info')
             ->setTimestamp(11)
             ->setObservedTimestamp(22)