Merge pull request #1907 from atlanhq/APP-8769

Add requestID into MDC as trace for logging

Author: cmgrote

integration-tests/src/test/resources/log4j2.xml

@@ -12,7 +12,7 @@
                 <Route>
                     <File name="appender-${ctx:className}" fileName="${ctx:className:-threads}.log" append="false">
                         <PatternLayout>
-                            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+                            <pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} trace_id: %X{trace_id} span_id: %X{span_id} trace_flags: %X{trace_flags} - %msg%n</pattern>
                         </PatternLayout>
                     </File>
                 </Route>

samples/packages/duplicate-detector/src/test/kotlin/DuplicateDetectorTest.kt

@@ -30,7 +30,7 @@ class DuplicateDetectorTest : PackageTest("dd") {
         runCustomPackage(
             DuplicateDetectorCfg(
                 glossaryName = glossaryName,
-                qnPrefix = "default/snowflake",
+                qnPrefix = "default/mssql",
                 controlConfigStrategy = "default",
                 assetTypes = listOf(Table.TYPE_NAME, View.TYPE_NAME, MaterializedView.TYPE_NAME),
             ),

sdk/src/main/java/com/atlan/net/ApiEventStreamResource.java

@@ -11,7 +11,6 @@
 import java.util.*;
 import lombok.ToString;
 import lombok.extern.slf4j.Slf4j;
-import org.slf4j.MDC;
 
 /**
  * Base class for all event-stream response objects.
@@ -93,13 +92,13 @@ public static <T extends ApiEventStreamResource> T request(
             throws AtlanException {
         // Create a unique ID for every request, and add it to the logging context and header
         String requestId = UUID.randomUUID().toString();
-        MDC.put("X-Atlan-Request-Id", requestId);
+        ApiResource.injectTraceId(requestId);
         log.debug("({}) {} with: {}", method, url, body);
         T response =
                 ApiResource.atlanResponseGetter.requestStream(client, method, url, body, clazz, options, requestId);
         // Ensure we reset the Atlan request ID, so we always have the context from the original
         // request that was made (even if it in turn triggered off other requests)
-        MDC.put("X-Atlan-Request-Id", requestId);
+        ApiResource.injectTraceId(requestId);
         return response;
     }
 }

sdk/src/main/java/com/atlan/net/ApiResource.java

@@ -276,12 +276,12 @@ public static void request(
             throws AtlanException {
         // Create a unique ID for every request, and add it to the logging context and header
         String requestId = UUID.randomUUID().toString();
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         log.debug("({}) {} with: {}", method, url, body);
         ApiResource.atlanResponseGetter.request(client, method, url, body, options, requestId);
         // Ensure we reset the Atlan request ID, so we always have the context from the original
         // request that was made (even if it in turn triggered off other requests)
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         if (log.isDebugEnabled()) {
             log.debug(" ... empty response.");
         }
@@ -360,12 +360,12 @@ public static <T extends ApiResource> T request(
             throws AtlanException {
         // Create a unique ID for every request, and add it to the logging context and header
         String requestId = UUID.randomUUID().toString();
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         log.debug("({}) {} with: {}", method, url, body);
         T response = ApiResource.atlanResponseGetter.request(client, method, url, body, clazz, options, requestId);
         // Ensure we reset the Atlan request ID, so we always have the context from the original
         // request that was made (even if it in turn triggered off other requests)
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         if (log.isDebugEnabled() && (options == null || !options.getSkipLogging())) {
             if (response != null) {
                 if (Atlan.enableTelemetry) {
@@ -404,13 +404,13 @@ public static String requestPlainText(
             throws AtlanException {
         // Create a unique ID for every request, and add it to the logging context and header
         String requestId = UUID.randomUUID().toString();
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         log.debug("({}) {} with: {}", method, url, body);
         String response =
                 ApiResource.atlanResponseGetter.requestPlainText(client, method, url, body, options, requestId);
         // Ensure we reset the Atlan request ID, so we always have the context from the original
         // request that was made (even if it in turn triggered off other requests)
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         if (log.isDebugEnabled()) {
             if (response != null) {
                 log.debug(" ... response: {}", response);
@@ -481,13 +481,13 @@ public static <T extends ApiResource> T request(
         }
         // Create a unique ID for every request, and add it to the logging context and header
         String requestId = UUID.randomUUID().toString();
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         log.debug("({}) {} with: {}", method, url, filename);
         T response = ApiResource.atlanResponseGetter.request(
                 client, method, url, payload, filename, clazz, extras, options, requestId);
         // Ensure we reset the Atlan request ID, so we always have the context from the original
         // request that was made (even if it in turn triggered off other requests)
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         if (log.isDebugEnabled()) {
             if (response != null) {
                 if (Atlan.enableTelemetry) {
@@ -531,11 +531,11 @@ public static <T extends ApiResource> T request(
         }
         // Create a unique ID for every request, and add it to the logging context and header
         String requestId = UUID.randomUUID().toString();
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         T response = ApiResource.atlanResponseGetter.request(client, method, url, map, clazz, options, requestId);
         // Ensure we reset the Atlan request ID, so we always have the context from the original
         // request that was made (even if it in turn triggered off other requests)
-        MDC.put("X-Atlan-Request-Id", requestId);
+        injectTraceId(requestId);
         if (log.isDebugEnabled()) {
             if (response != null) {
                 if (Atlan.enableTelemetry) {
@@ -550,6 +550,10 @@ public static <T extends ApiResource> T request(
         return response;
     }
 
+    public static void injectTraceId(String requestId) {
+        MDC.put("trace_id", requestId);
+    }
+
     /**
      * Invalidate null typed parameters.
      *