#1739 log 2 separate MDC fields: "traceparent-trace-id" and "tracepar…

…ent-span-id" Signed-off-by: Thomas Jäckle <thomas.jaeckle@beyonnex.io>
eclipse-ditto · Sep 12, 2023 · 592150f · 592150f
1 parent 247ffa5
commit 592150f
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 18 deletions.
diff --git a/connectivity/service/src/main/resources/logback.xml b/connectivity/service/src/main/resources/logback.xml
@@ -16,14 +16,14 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
     </appender>
 
     <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
         <target>System.err</target>
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>

diff --git a/gateway/service/src/main/resources/logback.xml b/gateway/service/src/main/resources/logback.xml
@@ -16,14 +16,14 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
     </appender>
 
     <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
         <target>System.err</target>
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>

diff --git a/...s/akka/src/main/java/org/eclipse/ditto/internal/utils/akka/logging/CommonMdcEntryKey.java b/...s/akka/src/main/java/org/eclipse/ditto/internal/utils/akka/logging/CommonMdcEntryKey.java
@@ -17,6 +17,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.function.Function;
 import java.util.stream.Stream;
 
 import javax.annotation.Nullable;
@@ -34,6 +35,9 @@ public enum CommonMdcEntryKey implements CharSequence {
     DITTO_LOG_TAG("ditto-log-tag"),
     TRACE_PARENT(DittoHeaderDefinition.W3C_TRACEPARENT.getKey());
 
+    private static final String TRACE_ID = TRACE_PARENT.key + "-trace-id";
+    private static final String SPAN_ID = TRACE_PARENT.key + "-span-id";
+
     private final String key;
 
     CommonMdcEntryKey(final String key) {
@@ -90,18 +94,27 @@ public static List<MdcEntry> extractMdcEntriesFromHeaders(@Nullable final Map<St
             return Collections.emptyList();
         }
         return Stream.of(CORRELATION_ID, TRACE_PARENT)
-                .flatMap(mdcEntryKey ->
-                        extractValue(headers, mdcEntryKey)
-                                .map(value -> MdcEntry.of(mdcEntryKey.key, value))
-                                .stream()
-                ).toList();
+                .flatMap(mdcEntryKey -> extractValue(headers, mdcEntryKey))
+                .toList();
     }
 
-    private static Optional<String> extractValue(final Map<String, String> headers,
+    private static Stream<MdcEntry> extractValue(final Map<String, String> headers,
             final CommonMdcEntryKey mdcEntryKey) {
 
-        // accessing a key in a HashMap is super fast
-        return Optional.ofNullable(headers.get(mdcEntryKey.key));
+        if (mdcEntryKey == TRACE_PARENT) {
+            return Optional.ofNullable(headers.get(mdcEntryKey.key))
+                    .filter(traceParent -> traceParent.charAt(2) == '-' && traceParent.length() == 55)
+                    .map(traceParent -> Stream.of(
+                            // positions defined by https://www.w3.org/TR/trace-context/#traceparent-header-field-values to contain the "trace-id"
+                            MdcEntry.of(TRACE_ID, traceParent.substring(3, 35)),
+                            MdcEntry.of(SPAN_ID, traceParent.substring(36, 52))
+                    )).stream()
+                    .flatMap(Function.identity());
+        } else {
+            return Optional.ofNullable(headers.get(mdcEntryKey.key))
+                    .map(value -> MdcEntry.of(mdcEntryKey.key, value))
+                    .stream();
+        }
     }
 
 }
diff --git a/policies/service/src/main/resources/logback.xml b/policies/service/src/main/resources/logback.xml
@@ -16,14 +16,14 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
     </appender>
 
     <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
         <target>System.err</target>
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>

diff --git a/things/service/src/main/resources/logback.xml b/things/service/src/main/resources/logback.xml
@@ -16,14 +16,14 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
     </appender>
 
     <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
         <target>System.err</target>
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>

diff --git a/thingsearch/service/src/main/resources/logback.xml b/thingsearch/service/src/main/resources/logback.xml
@@ -16,14 +16,14 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
     </appender>
 
     <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
         <target>System.err</target>
         <encoder>
-            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent}] %logger{20} %X{akkaSource} - %msg%n</pattern>
+            <pattern>%date{ISO8601} %-5level [%X{correlation-id}][%X{traceparent-trace-id}] %logger{20} %X{akkaSource} - %msg%n</pattern>
         </encoder>
         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>