changed default trace id field name & removed injection with otel logger

keepsuit · Apr 8, 2024 · 8644e8b · 8644e8b
1 parent 19164f8
commit 8644e8b
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 65 deletions.
diff --git a/config/opentelemetry.php b/config/opentelemetry.php
@@ -61,13 +61,16 @@
 
         /**
          * Inject active trace id in log context
+         *
+         * When using the OpenTelemetry logger, the trace id is always injected in the exported log record.
+         * This option allows to inject the trace id in the log context for other loggers.
          */
         'inject_trace_id' => true,
 
         /**
          * Context field name for trace id
          */
-        'trace_id_field' => 'traceId',
+        'trace_id_field' => 'traceid',
     ],
 
     /**

diff --git a/src/Logger.php b/src/Logger.php
@@ -69,25 +69,6 @@ public function log(string $level, string $message, array $context = []): void
             $logRecord->setAttribute($key, $value);
         }
 
-        $this->injectTraceId($logRecord);
-
         $this->logger->emit($logRecord);
     }
-
-    protected function injectTraceId(LogRecord $logRecord): void
-    {
-        if (! config('opentelemetry.logs.inject_trace_id', true)) {
-            return;
-        }
-
-        $traceId = \Keepsuit\LaravelOpenTelemetry\Facades\Tracer::traceId();
-
-        if ($traceId === null) {
-            return;
-        }
-
-        $field = config('opentelemetry.logs.trace_id_field', 'traceId');
-
-        $logRecord->setAttribute($field, $traceId);
-    }
 }
diff --git a/src/Tracer.php b/src/Tracer.php
@@ -77,7 +77,7 @@ public function updateLogContext(): void
             return;
         }
 
-        $field = config('opentelemetry.logs.trace_id_field', 'traceId');
+        $field = config('opentelemetry.logs.trace_id_field', 'traceid');
 
         Log::shareContext([
             $field => $traceId,

diff --git a/tests/Instrumentation/HttpServerInstrumentationTest.php b/tests/Instrumentation/HttpServerInstrumentationTest.php
@@ -49,7 +49,7 @@
         ]);
 
     expect(Log::sharedContext())->toMatchArray([
-        'traceId' => $traceId,
+        'traceid' => $traceId,
     ]);
 });
 

diff --git a/tests/Instrumentation/QueueInstrumentationTest.php b/tests/Instrumentation/QueueInstrumentationTest.php
@@ -54,7 +54,7 @@
         ->get('uuid')->not->toBeNull()
         ->get('traceparentInJob')->toBe(sprintf('00-%s-%s-01', $traceId, $spanId))
         ->get('traceIdInJob')->toBe($traceId)
-        ->get('logContextInJob')->toMatchArray(['traceId' => $traceId]);
+        ->get('logContextInJob')->toMatchArray(['traceid' => $traceId]);
 
     expect($enqueueSpan)
         ->getAttributes()->toMatchArray([
@@ -112,7 +112,7 @@
         ->get('uuid')->not->toBeNull()
         ->get('traceparentInJob')->toBe(sprintf('00-%s-%s-01', $root->getTraceId(), $enqueueSpan->getSpanId()))
         ->get('traceIdInJob')->toBe($root->getTraceId())
-        ->get('logContextInJob')->toMatchArray(['traceId' => $root->getTraceId()]);
+        ->get('logContextInJob')->toMatchArray(['traceid' => $root->getTraceId()]);
 });
 
 it('can trace queue failing jobs', function () {
@@ -139,7 +139,7 @@
         ->get('uuid')->not->toBeNull()
         ->get('traceparentInJob')->toBe(sprintf('00-%s-%s-01', $traceId, $spanId))
         ->get('traceIdInJob')->toBe($traceId)
-        ->get('logContextInJob')->toMatchArray(['traceId' => $traceId]);
+        ->get('logContextInJob')->toMatchArray(['traceid' => $traceId]);
 
     expect($enqueueSpan)
         ->getStatus()->getCode()->toBe(StatusCode::STATUS_UNSET)

diff --git a/tests/Sdk/LoggerTest.php b/tests/Sdk/LoggerTest.php
@@ -2,7 +2,6 @@
 
 use Illuminate\Support\Facades\Log;
 use Keepsuit\LaravelOpenTelemetry\Facades\Logger;
-use Keepsuit\LaravelOpenTelemetry\Facades\Tracer;
 use OpenTelemetry\API\Logs\Map\Psr3;
 use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Logs\ReadableLogRecord;
@@ -62,41 +61,3 @@
     LogLevel::INFO,
     LogLevel::DEBUG,
 ]);
-
-test('trace id is injected without log context sharing', function () {
-    $span = Tracer::newSpan('test')->start();
-    $scope = $span->activate();
-
-    $traceId = Tracer::traceId();
-    expect(\OpenTelemetry\API\Trace\SpanContextValidator::isValidTraceId($traceId))->toBeTrue();
-
-    Logger::info('test');
-
-    $scope->detach();
-    $span->end();
-
-    $log = getRecordedLogs()->first();
-
-    expect($log)
-        ->getBody()->toBe('test')
-        ->getAttributes()->toArray()->toBe([
-            'traceId' => $traceId,
-        ]);
-});
-
-test('trace id is not injected when tracer scope is not valid', function () {
-    $span = Tracer::newSpan('test')->start();
-
-    $traceId = Tracer::traceId();
-    expect($traceId)->toBeNull();
-
-    Logger::info('test');
-
-    $span->end();
-
-    $log = getRecordedLogs()->first();
-
-    expect($log)
-        ->getBody()->toBe('test')
-        ->getAttributes()->toArray()->toBe([]);
-});
diff --git a/tests/TracerTest.php b/tests/TracerTest.php
@@ -239,7 +239,7 @@
 
     expect(Log::sharedContext())
         ->toMatchArray([
-            'traceId' => $span->getContext()->getTraceId(),
+            'traceid' => $span->getContext()->getTraceId(),
         ]);
 
     $scope->detach();