Attach MDC properties to logs as attributes

Author: lcian

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ### Features
 
+- Add contextTags support for logging integrations ([#4783](https://github.com/getsentry/sentry-java/pull/4783))
+  - MDC/ThreadContext contextTags are now extracted and attached as attributes to Sentry logs for Logback, Log4j2, and JUL integrations
+  - Works with the existing `contextTags` option (e.g., `options.addContextTag("userId")`)
+  - Centralizes contextTags processing logic in new `ContextTagsUtil` class
 - Add session replay id to Sentry Logs ([#4740](https://github.com/getsentry/sentry-java/pull/4740))
 - Add support for continuous profiling of JVM applications on macOS and Linux ([#4556](https://github.com/getsentry/sentry-java/pull/4556))
   - [Sentry continuous profiling](https://docs.sentry.io/product/explore/profiling/) on the JVM is using async-profiler under the hood.

sentry-jul/src/main/java/io/sentry/jul/SentryHandler.java

@@ -22,6 +22,7 @@
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.util.CollectionUtils;
+import io.sentry.util.ContextTagsUtil;
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Date;
@@ -160,6 +161,11 @@ protected void captureLog(@NotNull LogRecord loggingEvent) {
       attributes.add(SentryAttribute.stringAttribute("sentry.message.template", message));
     }
 
+    final Map<String, String> mdcProperties = MDC.getMDCAdapter().getCopyOfContextMap();
+    if (mdcProperties != null) {
+      ContextTagsUtil.applyContextTagsToLogAttributes(attributes, mdcProperties);
+    }
+
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
     params.setOrigin("auto.log.jul");
 
@@ -312,16 +318,7 @@ SentryEvent createEvent(final @NotNull LogRecord record) {
         // get tags from ScopesAdapter options to allow getting the correct tags if Sentry has been
         // initialized somewhere else
         final List<String> contextTags = ScopesAdapter.getInstance().getOptions().getContextTags();
-        if (!contextTags.isEmpty()) {
-          for (final String contextTag : contextTags) {
-            // if mdc tag is listed in SentryOptions, apply as event tag
-            if (mdcProperties.containsKey(contextTag)) {
-              event.setTag(contextTag, mdcProperties.get(contextTag));
-              // remove from all tags applied to logging event
-              mdcProperties.remove(contextTag);
-            }
-          }
-        }
+        ContextTagsUtil.applyContextTagsToEvent(event, contextTags, mdcProperties);
         // put the rest of mdc tags in contexts
         if (!mdcProperties.isEmpty()) {
           event.getContexts().put("MDC", mdcProperties);

sentry-jul/src/test/kotlin/io/sentry/jul/SentryHandlerTest.kt

@@ -555,4 +555,29 @@ class SentryHandlerTest {
         }
       )
   }
+
+  @Test
+  fun `sets contextTags from MDC as attributes on logs`() {
+    fixture = Fixture(minimumLevel = Level.INFO, contextTags = listOf("sessionId", "operationId"))
+
+    MDC.put("sessionId", "session-123")
+    MDC.put("operationId", "op-456")
+    MDC.put("otherTag", "otherValue") // Should not be included in attributes
+    fixture.logger.info("testing context tags in logs")
+
+    Sentry.flush(1000)
+
+    verify(fixture.transport)
+      .send(
+        checkLogs { logs ->
+          val log = logs.items.first()
+          assertEquals("testing context tags in logs", log.body)
+          val attributes = log.attributes!!
+          assertEquals("session-123", attributes["sessionId"]?.value)
+          assertEquals("op-456", attributes["operationId"]?.value)
+          assertNull(attributes["otherTag"]) // Should not be included as it's not in contextTags
+          assertEquals("auto.log.jul", attributes["sentry.origin"]?.value)
+        }
+      )
+  }
 }

sentry-log4j2/src/main/java/io/sentry/log4j2/SentryAppender.java

@@ -25,13 +25,16 @@
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.util.CollectionUtils;
+import io.sentry.util.ContextTagsUtil;
+
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.stream.Collectors;
+
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.core.Filter;
 import org.apache.logging.log4j.core.LogEvent;
@@ -44,7 +47,9 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-/** Appender for Log4j2 in charge of sending the logged events to a Sentry server. */
+/**
+ * Appender for Log4j2 in charge of sending the logged events to a Sentry server.
+ */
 @Plugin(name = "Sentry", category = "Core", elementType = "appender", printObject = true)
 @Open
 public class SentryAppender extends AbstractAppender {
@@ -61,49 +66,49 @@ public class SentryAppender extends AbstractAppender {
 
   static {
     SentryIntegrationPackageStorage.getInstance()
-        .addPackage("maven:io.sentry:sentry-log4j2", BuildConfig.VERSION_NAME);
+      .addPackage("maven:io.sentry:sentry-log4j2", BuildConfig.VERSION_NAME);
   }
 
   /**
    * @deprecated This constructor is deprecated. Please use {@link #SentryAppender(String, Filter,
-   *     String, Level, Level, Level, Boolean, ITransportFactory, IScopes, String[])} instead.
+   * String, Level, Level, Level, Boolean, ITransportFactory, IScopes, String[])} instead.
    */
   @Deprecated
   @SuppressWarnings("InlineMeSuggester")
   public SentryAppender(
-      final @NotNull String name,
-      final @Nullable Filter filter,
-      final @Nullable String dsn,
-      final @Nullable Level minimumBreadcrumbLevel,
-      final @Nullable Level minimumEventLevel,
-      final @Nullable Boolean debug,
-      final @Nullable ITransportFactory transportFactory,
-      final @NotNull IScopes scopes,
-      final @Nullable String[] contextTags) {
+    final @NotNull String name,
+    final @Nullable Filter filter,
+    final @Nullable String dsn,
+    final @Nullable Level minimumBreadcrumbLevel,
+    final @Nullable Level minimumEventLevel,
+    final @Nullable Boolean debug,
+    final @Nullable ITransportFactory transportFactory,
+    final @NotNull IScopes scopes,
+    final @Nullable String[] contextTags) {
     this(
-        name,
-        filter,
-        dsn,
-        minimumBreadcrumbLevel,
-        minimumEventLevel,
-        null,
-        debug,
-        transportFactory,
-        scopes,
-        contextTags);
+      name,
+      filter,
+      dsn,
+      minimumBreadcrumbLevel,
+      minimumEventLevel,
+      null,
+      debug,
+      transportFactory,
+      scopes,
+      contextTags);
   }
 
   public SentryAppender(
-      final @NotNull String name,
-      final @Nullable Filter filter,
-      final @Nullable String dsn,
-      final @Nullable Level minimumBreadcrumbLevel,
-      final @Nullable Level minimumEventLevel,
-      final @Nullable Level minimumLevel,
-      final @Nullable Boolean debug,
-      final @Nullable ITransportFactory transportFactory,
-      final @NotNull IScopes scopes,
-      final @Nullable String[] contextTags) {
+    final @NotNull String name,
+    final @Nullable Filter filter,
+    final @Nullable String dsn,
+    final @Nullable Level minimumBreadcrumbLevel,
+    final @Nullable Level minimumEventLevel,
+    final @Nullable Level minimumLevel,
+    final @Nullable Boolean debug,
+    final @Nullable ITransportFactory transportFactory,
+    final @NotNull IScopes scopes,
+    final @Nullable String[] contextTags) {
     super(name, filter, null, true, null);
     this.dsn = dsn;
     if (minimumBreadcrumbLevel != null) {
@@ -124,64 +129,64 @@ public SentryAppender(
   /**
    * Create a Sentry Appender.
    *
-   * @param name The name of the Appender.
+   * @param name                   The name of the Appender.
    * @param minimumBreadcrumbLevel The min. level of the breadcrumb.
-   * @param minimumEventLevel The min. level of the event.
-   * @param minimumLevel The min. level of the log event.
-   * @param dsn the Sentry DSN.
-   * @param debug if Sentry debug mode should be on
-   * @param filter The filter, if any, to use.
+   * @param minimumEventLevel      The min. level of the event.
+   * @param minimumLevel           The min. level of the log event.
+   * @param dsn                    the Sentry DSN.
+   * @param debug                  if Sentry debug mode should be on
+   * @param filter                 The filter, if any, to use.
    * @return The SentryAppender.
    */
   @PluginFactory
   public static @Nullable SentryAppender createAppender(
-      @Nullable @PluginAttribute("name") final String name,
-      @Nullable @PluginAttribute("minimumBreadcrumbLevel") final Level minimumBreadcrumbLevel,
-      @Nullable @PluginAttribute("minimumEventLevel") final Level minimumEventLevel,
-      @Nullable @PluginAttribute("minimumLevel") final Level minimumLevel,
-      @Nullable @PluginAttribute("dsn") final String dsn,
-      @Nullable @PluginAttribute("debug") final Boolean debug,
-      @Nullable @PluginElement("filter") final Filter filter,
-      @Nullable @PluginAttribute("contextTags") final String contextTags) {
+    @Nullable @PluginAttribute("name") final String name,
+    @Nullable @PluginAttribute("minimumBreadcrumbLevel") final Level minimumBreadcrumbLevel,
+    @Nullable @PluginAttribute("minimumEventLevel") final Level minimumEventLevel,
+    @Nullable @PluginAttribute("minimumLevel") final Level minimumLevel,
+    @Nullable @PluginAttribute("dsn") final String dsn,
+    @Nullable @PluginAttribute("debug") final Boolean debug,
+    @Nullable @PluginElement("filter") final Filter filter,
+    @Nullable @PluginAttribute("contextTags") final String contextTags) {
 
     if (name == null) {
       LOGGER.error("No name provided for SentryAppender");
       return null;
     }
     return new SentryAppender(
-        name,
-        filter,
-        dsn,
-        minimumBreadcrumbLevel,
-        minimumEventLevel,
-        minimumLevel,
-        debug,
-        null,
-        ScopesAdapter.getInstance(),
-        contextTags != null ? contextTags.split(",") : null);
+      name,
+      filter,
+      dsn,
+      minimumBreadcrumbLevel,
+      minimumEventLevel,
+      minimumLevel,
+      debug,
+      null,
+      ScopesAdapter.getInstance(),
+      contextTags != null ? contextTags.split(",") : null);
   }
 
   @Override
   public void start() {
     try {
       Sentry.init(
-          options -> {
-            options.setEnableExternalConfiguration(true);
-            options.setInitPriority(InitPriority.LOWEST);
-            options.setDsn(dsn);
-            if (debug != null) {
-              options.setDebug(debug);
-            }
-            options.setSentryClientName(
-                BuildConfig.SENTRY_LOG4J2_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
-            options.setSdkVersion(createSdkVersion(options));
-            if (contextTags != null) {
-              for (final String contextTag : contextTags) {
-                options.addContextTag(contextTag);
-              }
+        options -> {
+          options.setEnableExternalConfiguration(true);
+          options.setInitPriority(InitPriority.LOWEST);
+          options.setDsn(dsn);
+          if (debug != null) {
+            options.setDebug(debug);
+          }
+          options.setSentryClientName(
+            BuildConfig.SENTRY_LOG4J2_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
+          options.setSdkVersion(createSdkVersion(options));
+          if (contextTags != null) {
+            for (final String contextTag : contextTags) {
+              options.addContextTag(contextTag);
             }
-            Optional.ofNullable(transportFactory).ifPresent(options::setTransportFactory);
-          });
+          }
+          Optional.ofNullable(transportFactory).ifPresent(options::setTransportFactory);
+        });
     } catch (IllegalArgumentException e) {
       LOGGER.warn("Failed to init Sentry during appender initialization: " + e.getMessage());
     }
@@ -192,7 +197,7 @@ public void start() {
   @Override
   public void append(final @NotNull LogEvent eventObject) {
     if (scopes.getOptions().getLogs().isEnabled()
-        && eventObject.getLevel().isMoreSpecificThan(minimumLevel)) {
+      && eventObject.getLevel().isMoreSpecificThan(minimumLevel)) {
       captureLog(eventObject);
     }
     if (eventObject.getLevel().isMoreSpecificThan(minimumEventLevel)) {
@@ -227,7 +232,12 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
 
     if (nonFormattedMessage != null && !formattedMessage.equals(nonFormattedMessage)) {
       attributes.add(
-          SentryAttribute.stringAttribute("sentry.message.template", nonFormattedMessage));
+        SentryAttribute.stringAttribute("sentry.message.template", nonFormattedMessage));
+    }
+
+    final Map<String, String> contextData = loggingEvent.getContextData().toMap();
+    if (contextData != null) {
+      ContextTagsUtil.applyContextTagsToLogAttributes(attributes, contextData);
     }
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
@@ -259,8 +269,8 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
       final Mechanism mechanism = new Mechanism();
       mechanism.setType(MECHANISM_TYPE);
       final Throwable mechanismException =
-          new ExceptionMechanismException(
-              mechanism, throwableInformation.getThrowable(), Thread.currentThread());
+        new ExceptionMechanismException(
+          mechanism, throwableInformation.getThrowable(), Thread.currentThread());
       event.setThrowable(mechanismException);
     }
 
@@ -273,21 +283,14 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
     }
 
     final Map<String, String> contextData =
-        CollectionUtils.filterMapEntries(
-            loggingEvent.getContextData().toMap(), entry -> entry.getValue() != null);
+      CollectionUtils.filterMapEntries(
+        loggingEvent.getContextData().toMap(), entry -> entry.getValue() != null);
     if (!contextData.isEmpty()) {
       // get tags from ScopesAdapter options to allow getting the correct tags if Sentry has been
       // initialized somewhere else
       final List<String> contextTags = scopes.getOptions().getContextTags();
-      if (contextTags != null && !contextTags.isEmpty()) {
-        for (final String contextTag : contextTags) {
-          // if mdc tag is listed in SentryOptions, apply as event tag
-          if (contextData.containsKey(contextTag)) {
-            event.setTag(contextTag, contextData.get(contextTag));
-            // remove from all tags applied to logging event
-            contextData.remove(contextTag);
-          }
-        }
+      if (contextTags != null) {
+        ContextTagsUtil.applyContextTagsToEvent(event, contextTags, contextData);
       }
       // put the rest of mdc tags in contexts
       if (!contextData.isEmpty()) {
@@ -301,9 +304,9 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
   private @NotNull List<String> toParams(final @Nullable Object[] arguments) {
     if (arguments != null) {
       return Arrays.stream(arguments)
-          .filter(Objects::nonNull)
-          .map(Object::toString)
-          .collect(Collectors.toList());
+        .filter(Objects::nonNull)
+        .map(Object::toString)
+        .collect(Collectors.toList());
     } else {
       return Collections.emptyList();
     }

sentry-log4j2/src/test/kotlin/io/sentry/log4j2/SentryAppenderTest.kt

@@ -591,4 +591,31 @@ class SentryAppenderTest {
         }
       )
   }
+
+  @Test
+  fun `sets contextTags from ThreadContext as attributes on logs`() {
+    val logger =
+      fixture.getSut(minimumLevel = Level.INFO, contextTags = listOf("traceId", "spanId"))
+    ScopesAdapter.getInstance().options.logs.isEnabled = true
+
+    ThreadContext.put("traceId", "trace-123")
+    ThreadContext.put("spanId", "span-456")
+    ThreadContext.put("otherTag", "otherValue") // Should not be included in attributes
+    logger.info("testing context tags in logs")
+
+    Sentry.flush(1000)
+
+    verify(fixture.transport)
+      .send(
+        checkLogs { logs ->
+          val log = logs.items.first()
+          assertEquals("testing context tags in logs", log.body)
+          val attributes = log.attributes!!
+          assertEquals("trace-123", attributes["traceId"]?.value)
+          assertEquals("span-456", attributes["spanId"]?.value)
+          assertNull(attributes["otherTag"]) // Should not be included as it's not in contextTags
+          assertEquals("auto.log.log4j2", attributes["sentry.origin"]?.value)
+        }
+      )
+  }
 }