improve

Author: lcian

CHANGELOG.md

@@ -7,7 +7,8 @@
 - Attach MDC properties to logs as attributes ([#4786](https://github.com/getsentry/sentry-java/pull/4786))
   - MDC properties set using supported logging frameworks (Logback, Log4j2, java.util.Logging) are now attached to structured logs as attributes.
   - This means that you will be able to filter/aggregate logs in the product based on these properties.
-  - All properties are sent. To avoid sending certain properties, use the `beforeSendLog` hook. You can also set up [Advanced Data Scrubbing rules](https://docs.sentry.io/security-legal-pii/scrubbing/advanced-datascrubbing/) to redact sensitive information.
+  - Only properties with keys matching the configured `contextTags` are sent as attributes. This is consistent with how MDC properties are applied as tags to events.
+  - To avoid sending certain properties, use the `beforeSendLog` hook. You can also set up [Advanced Data Scrubbing rules](https://docs.sentry.io/security-legal-pii/scrubbing/advanced-datascrubbing/) to redact sensitive information.
   - Note that keys containing spaces are not supported.
 
 ### Fixes

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

@@ -161,9 +161,10 @@ protected void captureLog(@NotNull LogRecord loggingEvent) {
       attributes.add(SentryAttribute.stringAttribute("sentry.message.template", message));
     }
 
-    final Map<String, String> mdcProperties = MDC.getMDCAdapter().getCopyOfContextMap();
+    final @Nullable Map<String, String> mdcProperties = MDC.getMDCAdapter().getCopyOfContextMap();
     if (mdcProperties != null) {
-      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, mdcProperties);
+      final List<String> contextTags = ScopesAdapter.getInstance().getOptions().getContextTags();
+      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, contextTags, mdcProperties);
     }
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);

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

@@ -573,7 +573,7 @@ class SentryHandlerTest {
           assertEquals("testing MDC properties in logs", log.body)
           val attributes = log.attributes!!
           assertEquals("someValue", attributes["someTag"]?.value)
-          assertEquals("otherValue", attributes["otherTag"]?.value)
+          assertNull(attributes["otherTag"])
         }
       )
   }

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

@@ -231,10 +231,9 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
           SentryAttribute.stringAttribute("sentry.message.template", nonFormattedMessage));
     }
 
-    final Map<String, String> contextData = loggingEvent.getContextData().toMap();
-    if (contextData != null) {
-      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, contextData);
-    }
+    final @NotNull Map<String, String> contextData = loggingEvent.getContextData().toMap();
+    final @NotNull List<String> contextTags = ScopesAdapter.getInstance().getOptions().getContextTags();
+    LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, contextTags, contextData);
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
     params.setOrigin("auto.log.log4j2");
@@ -278,16 +277,12 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
       event.setExtra("marker", loggingEvent.getMarker().toString());
     }
 
-    final Map<String, String> contextData =
-        CollectionUtils.filterMapEntries(
-            loggingEvent.getContextData().toMap(), entry -> entry.getValue() != null);
-    if (!contextData.isEmpty()) {
+    final Map<String, String> contextData = loggingEvent.getContextData().toMap();
+    if (contextData != null) {
       // 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) {
-        LoggerPropertiesUtil.applyPropertiesToEvent(event, contextTags, contextData);
-      }
+      final @NotNull List<String> contextTags = scopes.getOptions().getContextTags();
+      LoggerPropertiesUtil.applyPropertiesToEvent(event, contextTags, contextData);
       // put the rest of mdc tags in contexts
       if (!contextData.isEmpty()) {
         event.getContexts().put("Context Data", contextData);

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

@@ -610,7 +610,7 @@ class SentryAppenderTest {
           assertEquals("testing MDC properties in logs", log.body)
           val attributes = log.attributes!!
           assertEquals("someValue", attributes["someTag"]?.value)
-          assertEquals("otherValue", attributes["otherTag"]?.value)
+          assertNull(attributes["otherTag"])
         }
       )
   }

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

@@ -187,10 +187,9 @@ protected void captureLog(@NotNull ILoggingEvent loggingEvent) {
       arguments = loggingEvent.getArgumentArray();
     }
 
-    final Map<String, String> mdcProperties = loggingEvent.getMDCPropertyMap();
-    if (mdcProperties != null) {
-      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, mdcProperties);
-    }
+    final @NotNull Map<String, String> mdcProperties = loggingEvent.getMDCPropertyMap();
+    final @NotNull List<String> contextTags = ScopesAdapter.getInstance().getOptions().getContextTags();
+    LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, contextTags, mdcProperties);
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
     params.setOrigin("auto.log.logback");

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

@@ -838,7 +838,7 @@ class SentryAppenderTest {
           assertEquals("testing MDC properties in logs", log.body)
           val attributes = log.attributes!!
           assertEquals("someValue", attributes["someTag"]?.value)
-          assertEquals("otherValue", attributes["otherTag"]?.value)
+          assertNull(attributes["otherTag"])
         }
       )
   }

sentry/api/sentry.api

@@ -7082,6 +7082,7 @@ public final class io/sentry/util/LogUtils {
 
 public final class io/sentry/util/LoggerPropertiesUtil {
 	public fun <init> ()V
+	public static fun applyPropertiesToAttributes (Lio/sentry/SentryAttributes;Ljava/util/List;Ljava/util/Map;)V
 	public static fun applyPropertiesToAttributes (Lio/sentry/SentryAttributes;Ljava/util/Map;)V
 	public static fun applyPropertiesToEvent (Lio/sentry/SentryEvent;Ljava/util/List;Ljava/util/Map;)V
 }

sentry/src/main/java/io/sentry/util/LoggerPropertiesUtil.java

@@ -7,6 +7,7 @@
 import java.util.Map;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /** Utility class for applying logger properties (e.g. MDC) to Sentry events and log attributes. */
 @ApiStatus.Internal
@@ -37,18 +38,25 @@ public static void applyPropertiesToEvent(
   }
 
   /**
-   * Applies logger properties from a properties map to SentryAttributes for logs. Properties with
-   * null values are filtered out.
+   * Applies logger properties from a properties map to SentryAttributes for logs. Only the
+   * properties with keys that are found in `targetKeys` will be applied as attributes. Properties
+   * with null values are filtered out.
    *
    * @param attributes the SentryAttributes to add the properties to
+   * @param targetKeys the list of property keys to apply as attributes
    * @param properties the properties map (e.g. MDC)
    */
   @ApiStatus.Internal
   public static void applyPropertiesToAttributes(
-      final @NotNull SentryAttributes attributes, final @NotNull Map<String, String> properties) {
-    for (final Map.Entry<String, String> entry : properties.entrySet()) {
-      if (entry.getValue() != null) {
-        attributes.add(SentryAttribute.stringAttribute(entry.getKey(), entry.getValue()));
+      final @NotNull SentryAttributes attributes,
+      final @NotNull List<String> targetKeys,
+      final @NotNull Map<String, String> properties) {
+    if (!targetKeys.isEmpty() && !properties.isEmpty()) {
+      for (final String key : targetKeys) {
+        final @Nullable String value = properties.get(key);
+        if (value != null) {
+          attributes.add(SentryAttribute.stringAttribute(key, value));
+        }
       }
     }
   }