remove ancestor safeguard to match logback, as the user defines which loggers to attach to

Author: lbloder

sentry-samples/sentry-samples-spring-boot-4/build.gradle.kts

@@ -57,6 +57,19 @@ dependencies {
   implementation(projects.sentryQuartz)
   implementation(projects.sentryAsyncProfiler)
 
+  implementation(projects.sentryLog4j2)
+  implementation(libs.log4j.api)
+  implementation(libs.log4j.core)
+
+  // Enable Log4j2 in Spring Boot
+  //  implementation("org.springframework.boot:spring-boot-starter-log4j2")
+  //  modules {
+  //    module("org.springframework.boot:spring-boot-starter-logging") {
+  //      replacedBy("org.springframework.boot:spring-boot-starter-log4j2", "Use Log4j2 instead of
+  // Logback")
+  //    }
+  //  }
+
   // cache tracing
   implementation(libs.springboot4.starter.cache)
   implementation(libs.caffeine)

sentry-spring-boot-4/src/main/java/io/sentry/spring/boot4/SentryLog4j2Initializer.java

@@ -54,18 +54,11 @@ public void onApplicationEvent(final @NotNull ApplicationEvent event) {
     final LoggerContext loggerContext = (LoggerContext) context;
     final Configuration configuration = loggerContext.getConfiguration();
 
-    final Set<String> loggerNames = normalizeLoggerNames(loggers);
     boolean changed = false;
-    for (final String loggerName : loggerNames) {
-      if (isCoveredByAncestorLogger(configuration, loggerName, loggerNames)
-          || hasSentryAppenderRegisteredOnAncestor(configuration, loggerName)) {
-        continue;
-      }
-
+    for (final String loggerName : normalizeLoggerNames(loggers)) {
       final LoggerConfig loggerConfig = getOrCreateLoggerConfig(configuration, loggerName);
       if (!isSentryAppenderRegistered(loggerConfig)) {
-        final SentryAppender sentryAppender = getSentryAppender(configuration);
-        loggerConfig.addAppender(sentryAppender, null, null);
+        loggerConfig.addAppender(getSentryAppender(configuration), null, null);
         changed = true;
       }
     }
@@ -113,78 +106,14 @@ public void onApplicationEvent(final @NotNull ApplicationEvent event) {
   }
 
   private @NotNull Set<String> normalizeLoggerNames(final @NotNull List<String> loggerNames) {
-    final Set<String> normalizedLoggerNames = new LinkedHashSet<>();
+    final Set<String> normalized = new LinkedHashSet<>();
     for (final String loggerName : loggerNames) {
       if (loggerName == null || loggerName.trim().isEmpty()) {
         continue;
       }
-      normalizedLoggerNames.add(normalizeLoggerName(loggerName.trim()));
-    }
-    return normalizedLoggerNames;
-  }
-
-  private boolean isCoveredByAncestorLogger(
-      final @NotNull Configuration configuration,
-      final @NotNull String loggerName,
-      final @NotNull Set<String> loggerNames) {
-    return loggerNames.stream()
-        .anyMatch(
-            candidate ->
-                isAncestorLogger(candidate, loggerName)
-                    && isAdditivePathToAncestor(configuration, loggerName, candidate));
-  }
-
-  private boolean hasSentryAppenderRegisteredOnAncestor(
-      final @NotNull Configuration configuration, final @NotNull String loggerName) {
-    if (LogManager.ROOT_LOGGER_NAME.equals(loggerName)) {
-      return false;
-    }
-
-    @Nullable String parentLoggerName = getParentLoggerName(loggerName);
-    while (parentLoggerName != null) {
-      final LoggerConfig parentLoggerConfig = configuration.getLoggerConfig(parentLoggerName);
-      if (parentLoggerName.equals(parentLoggerConfig.getName())
-          && isSentryAppenderRegistered(parentLoggerConfig)
-          && isAdditivePathToAncestor(configuration, loggerName, parentLoggerName)) {
-        return true;
-      }
-      parentLoggerName = getParentLoggerName(parentLoggerName);
-    }
-
-    return isSentryAppenderRegistered(configuration.getRootLogger())
-        && isAdditivePathToAncestor(configuration, loggerName, LogManager.ROOT_LOGGER_NAME);
-  }
-
-  private boolean isAdditivePathToAncestor(
-      final @NotNull Configuration configuration,
-      final @NotNull String loggerName,
-      final @NotNull String ancestorLoggerName) {
-    String currentLoggerName = loggerName;
-    while (!ancestorLoggerName.equals(currentLoggerName)) {
-      final LoggerConfig loggerConfig = configuration.getLoggerConfig(currentLoggerName);
-      if (currentLoggerName.equals(loggerConfig.getName()) && !loggerConfig.isAdditive()) {
-        return false;
-      }
-      currentLoggerName = getParentLoggerName(currentLoggerName);
-      if (currentLoggerName == null) {
-        currentLoggerName = LogManager.ROOT_LOGGER_NAME;
-      }
-    }
-    return true;
-  }
-
-  private @Nullable String getParentLoggerName(final @NotNull String loggerName) {
-    final int separator = loggerName.lastIndexOf('.');
-    return separator > -1 ? loggerName.substring(0, separator) : null;
-  }
-
-  private boolean isAncestorLogger(
-      final @NotNull String candidateLoggerName, final @NotNull String loggerName) {
-    if (candidateLoggerName.equals(loggerName)) {
-      return false;
+      normalized.add(normalizeLoggerName(loggerName.trim()));
     }
-    return LogManager.ROOT_LOGGER_NAME.equals(candidateLoggerName)
-        || loggerName.startsWith(candidateLoggerName + ".");
+    return normalized;
   }
 
   private boolean isSentryAppenderRegistered(final @NotNull LoggerConfig loggerConfig) {

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryLog4j2AppenderAutoConfigurationTest.kt

@@ -117,16 +117,6 @@ class SentryLog4j2AppenderAutoConfigurationTest {
       }
   }
 
-  @Test
-  fun `does not configure SentryAppender for descendant logger covered by ancestor logger`() {
-    dsnEnabledRunner
-      .withPropertyValues("sentry.logging.loggers[0]=ROOT", "sentry.logging.loggers[1]=com.example")
-      .run {
-        assertThat(rootLogger.getAppenders(SentryAppender::class.java)).hasSize(1)
-        assertThat(configuration.loggers).doesNotContainKey("com.example")
-      }
-  }
-
   @Test
   fun `configures SentryAppender for descendant logger with additivity disabled`() {
     val loggerConfig = LoggerConfig("com.example", null, false)