improve

Author: lcian

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

@@ -22,7 +22,7 @@
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.util.CollectionUtils;
-import io.sentry.util.ContextTagsUtil;
+import io.sentry.util.LoggerPropertiesUtil;
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Date;
@@ -163,7 +163,7 @@ protected void captureLog(@NotNull LogRecord loggingEvent) {
 
     final Map<String, String> mdcProperties = MDC.getMDCAdapter().getCopyOfContextMap();
     if (mdcProperties != null) {
-      ContextTagsUtil.applyContextTagsToLogAttributes(attributes, mdcProperties);
+      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, mdcProperties);
     }
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
@@ -318,7 +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();
-        ContextTagsUtil.applyContextTagsToEvent(event, contextTags, mdcProperties);
+        LoggerPropertiesUtil.applyPropertiesToEvent(event, contextTags, mdcProperties);
         // put the rest of mdc tags in contexts
         if (!mdcProperties.isEmpty()) {
           event.getContexts().put("MDC", mdcProperties);

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

@@ -25,7 +25,7 @@
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.util.CollectionUtils;
-import io.sentry.util.ContextTagsUtil;
+import io.sentry.util.LoggerPropertiesUtil;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -233,7 +233,7 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
 
     final Map<String, String> contextData = loggingEvent.getContextData().toMap();
     if (contextData != null) {
-      ContextTagsUtil.applyContextTagsToLogAttributes(attributes, contextData);
+      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, contextData);
     }
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
@@ -286,7 +286,7 @@ protected void captureLog(@NotNull LogEvent loggingEvent) {
       // initialized somewhere else
       final List<String> contextTags = scopes.getOptions().getContextTags();
       if (contextTags != null) {
-        ContextTagsUtil.applyContextTagsToEvent(event, contextTags, contextData);
+        LoggerPropertiesUtil.applyPropertiesToEvent(event, contextTags, contextData);
       }
       // put the rest of mdc tags in contexts
       if (!contextData.isEmpty()) {

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

@@ -29,7 +29,7 @@
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.util.CollectionUtils;
-import io.sentry.util.ContextTagsUtil;
+import io.sentry.util.LoggerPropertiesUtil;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Collections;
@@ -153,7 +153,7 @@ protected void append(@NotNull ILoggingEvent eventObject) {
       // 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();
-      ContextTagsUtil.applyContextTagsToEvent(event, contextTags, mdcProperties);
+      LoggerPropertiesUtil.applyPropertiesToEvent(event, contextTags, mdcProperties);
       // put the rest of mdc tags in contexts
       if (!mdcProperties.isEmpty()) {
         event.getContexts().put("MDC", mdcProperties);
@@ -189,7 +189,7 @@ protected void captureLog(@NotNull ILoggingEvent loggingEvent) {
 
     final Map<String, String> mdcProperties = loggingEvent.getMDCPropertyMap();
     if (mdcProperties != null) {
-      ContextTagsUtil.applyContextTagsToLogAttributes(attributes, mdcProperties);
+      LoggerPropertiesUtil.applyPropertiesToAttributes(attributes, mdcProperties);
     }
 
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);

sentry/api/sentry.api

@@ -6962,12 +6962,6 @@ public abstract interface class io/sentry/util/CollectionUtils$Predicate {
 	public abstract fun test (Ljava/lang/Object;)Z
 }
 
-public final class io/sentry/util/ContextTagsUtil {
-	public fun <init> ()V
-	public static fun applyContextTagsToEvent (Lio/sentry/SentryEvent;Ljava/util/List;Ljava/util/Map;)V
-	public static fun applyContextTagsToLogAttributes (Lio/sentry/SentryAttributes;Ljava/util/Map;)V
-}
-
 public final class io/sentry/util/DebugMetaPropertiesApplier {
 	public static field DEBUG_META_PROPERTIES_FILENAME Ljava/lang/String;
 	public fun <init> ()V
@@ -7086,6 +7080,12 @@ public final class io/sentry/util/LogUtils {
 	public static fun logNotInstanceOf (Ljava/lang/Class;Ljava/lang/Object;Lio/sentry/ILogger;)V
 }
 
+public final class io/sentry/util/LoggerPropertiesUtil {
+	public fun <init> ()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
+}
+
 public final class io/sentry/util/MapObjectReader : io/sentry/ObjectReader {
 	public fun <init> (Ljava/util/Map;)V
 	public fun beginArray ()V

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

@@ -0,0 +1,55 @@
+package io.sentry.util;
+
+import io.sentry.SentryAttribute;
+import io.sentry.SentryAttributes;
+import io.sentry.SentryEvent;
+import java.util.List;
+import java.util.Map;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+
+/** Utility class for applying logger properties (e.g. MDC) to Sentry events and log attributes. */
+@ApiStatus.Internal
+public final class LoggerPropertiesUtil {
+
+  /**
+   * Applies logger properties from a map to a Sentry event as tags. Only the properties with keys
+   * that are found in `targetKeys` will be applied as tags.
+   *
+   * @param event the Sentry event to add tags to
+   * @param targetKeys the list of property keys to apply as tags
+   * @param properties the properties map (e.g. MDC) - this map will be modified by removing
+   *     properties which were applied as tags
+   */
+  @ApiStatus.Internal
+  public static void applyPropertiesToEvent(
+      final @NotNull SentryEvent event,
+      final @NotNull List<String> targetKeys,
+      final @NotNull Map<String, String> properties) {
+    if (!targetKeys.isEmpty() && !properties.isEmpty()) {
+      for (final String key : targetKeys) {
+        if (properties.containsKey(key)) {
+          event.setTag(key, properties.get(key));
+          properties.remove(key);
+        }
+      }
+    }
+  }
+
+  /**
+   * Applies logger properties from a properties map to SentryAttributes for logs. Properties with
+   * null values are filtered out.
+   *
+   * @param attributes the SentryAttributes to add the properties to
+   * @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()));
+      }
+    }
+  }
+}