[Logs 10] Move options for Logs out of experimental namespace (#4390)

adinauer · web-flow · commit 8bbd94e61a4a · 2025-05-13T15:11:48.000Z
* Add Log feature to Java SDK

* Rate limit for log items

* Add options for logs

* Add batch processor for logs

* Use a separate ExecutorService for log batching

* Reduce locking when log event is created

* Add system tests for Logs

* Separate enum for SentryLogLevel

* Remove logsSampleRate option

* Move logs options out of experimental namespace
diff --git a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties
@@ -15,7 +15,7 @@ sentry.graphql.ignored-error-types=SOME_ERROR,ANOTHER_ERROR
 sentry.enable-backpressure-handling=true
 sentry.enable-spotlight=true
 sentry.enablePrettySerializationOutput=false
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 in-app-includes="io.sentry.samples"
 
 # Uncomment and set to true to enable aot compatibility
diff --git a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry/src/main/resources/application.properties
@@ -15,7 +15,7 @@ sentry.graphql.ignored-error-types=SOME_ERROR,ANOTHER_ERROR
 sentry.enable-backpressure-handling=true
 sentry.enable-spotlight=true
 sentry.enablePrettySerializationOutput=false
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 in-app-includes="io.sentry.samples"
 
 # Uncomment and set to true to enable aot compatibility
diff --git a/sentry-samples/sentry-samples-spring-boot-jakarta/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-jakarta/src/main/resources/application.properties
@@ -16,7 +16,7 @@ sentry.enable-backpressure-handling=true
 sentry.enable-spotlight=true
 sentry.enablePrettySerializationOutput=false
 in-app-includes="io.sentry.samples"
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 
 # Uncomment and set to true to enable aot compatibility
 # This flag disables all AOP related features (i.e. @SentryTransaction, @SentrySpan)
diff --git a/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties
@@ -14,7 +14,7 @@ sentry.debug=true
 sentry.graphql.ignored-error-types=SOME_ERROR,ANOTHER_ERROR
 sentry.enable-backpressure-handling=true
 sentry.enable-spotlight=true
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 in-app-includes="io.sentry.samples"
 
 # Database configuration
diff --git a/sentry-samples/sentry-samples-spring-boot-opentelemetry/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-opentelemetry/src/main/resources/application.properties
@@ -14,7 +14,7 @@ sentry.debug=true
 sentry.graphql.ignored-error-types=SOME_ERROR,ANOTHER_ERROR
 sentry.enable-backpressure-handling=true
 sentry.enable-spotlight=true
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 in-app-includes="io.sentry.samples"
 
 # Database configuration
diff --git a/sentry-samples/sentry-samples-spring-boot-webflux-jakarta/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-webflux-jakarta/src/main/resources/application.properties
@@ -10,5 +10,5 @@ sentry.logging.minimum-breadcrumb-level=debug
 sentry.reactive.thread-local-accessor-enabled=true
 sentry.traces-sample-rate=1.0
 sentry.enable-backpressure-handling=true
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 sentry.enable-spotlight=true
diff --git a/sentry-samples/sentry-samples-spring-boot-webflux/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-webflux/src/main/resources/application.properties
@@ -12,5 +12,5 @@ spring.graphql.graphiql.enabled=true
 spring.graphql.websocket.path=/graphql
 spring.graphql.schema.printer.enabled=true
 sentry.enable-backpressure-handling=true
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 sentry.enable-spotlight=true
diff --git a/sentry-samples/sentry-samples-spring-boot/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot/src/main/resources/application.properties
@@ -14,7 +14,7 @@ sentry.debug=true
 sentry.graphql.ignored-error-types=SOME_ERROR,ANOTHER_ERROR
 sentry.enable-backpressure-handling=true
 sentry.enable-spotlight=true
-sentry.experimental.logs.enabled=true
+sentry.logs.enabled=true
 in-app-includes="io.sentry.samples"
 
 # Database configuration
diff --git a/sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt b/sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt
@@ -188,7 +188,7 @@ class SentryAutoConfigurationTest {
             "sentry.cron.default-timezone=America/New_York",
             "sentry.cron.default-failure-issue-threshold=40",
             "sentry.cron.default-recovery-threshold=50",
-            "sentry.experimental.logs.enabled=true"
+            "sentry.logs.enabled=true"
         ).run {
             val options = it.getBean(SentryProperties::class.java)
             assertThat(options.readTimeoutMillis).isEqualTo(10)
@@ -233,7 +233,7 @@ class SentryAutoConfigurationTest {
             assertThat(options.cron!!.defaultTimezone).isEqualTo("America/New_York")
             assertThat(options.cron!!.defaultFailureIssueThreshold).isEqualTo(40L)
             assertThat(options.cron!!.defaultRecoveryThreshold).isEqualTo(50L)
-            assertThat(options.experimental.logs.isEnabled).isEqualTo(true)
+            assertThat(options.logs.isEnabled).isEqualTo(true)
         }
     }
 
diff --git a/sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt b/sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt
@@ -187,7 +187,7 @@ class SentryAutoConfigurationTest {
             "sentry.cron.default-timezone=America/New_York",
             "sentry.cron.default-failure-issue-threshold=40",
             "sentry.cron.default-recovery-threshold=50",
-            "sentry.experimental.logs.enabled=true"
+            "sentry.logs.enabled=true"
         ).run {
             val options = it.getBean(SentryProperties::class.java)
             assertThat(options.readTimeoutMillis).isEqualTo(10)
@@ -232,7 +232,7 @@ class SentryAutoConfigurationTest {
             assertThat(options.cron!!.defaultTimezone).isEqualTo("America/New_York")
             assertThat(options.cron!!.defaultFailureIssueThreshold).isEqualTo(40L)
             assertThat(options.cron!!.defaultRecoveryThreshold).isEqualTo(50L)
-            assertThat(options.experimental.logs.isEnabled).isEqualTo(true)
+            assertThat(options.logs.isEnabled).isEqualTo(true)
         }
     }
 
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -464,8 +464,6 @@ public abstract interface class io/sentry/EventProcessor {
 
 public final class io/sentry/ExperimentalOptions {
 	public fun <init> (ZLio/sentry/protocol/SdkVersion;)V
-	public fun getLogs ()Lio/sentry/SentryOptions$Logs;
-	public fun setLogs (Lio/sentry/SentryOptions$Logs;)V
 }
 
 public final class io/sentry/ExternalOptions {
@@ -3223,6 +3221,7 @@ public class io/sentry/SentryOptions {
 	public fun getIntegrations ()Ljava/util/List;
 	public fun getInternalTracesSampler ()Lio/sentry/TracesSampler;
 	public fun getLogger ()Lio/sentry/ILogger;
+	public fun getLogs ()Lio/sentry/SentryOptions$Logs;
 	public fun getMaxAttachmentSize ()J
 	public fun getMaxBreadcrumbs ()I
 	public fun getMaxCacheItems ()I
@@ -3362,6 +3361,7 @@ public class io/sentry/SentryOptions {
 	public fun setInitPriority (Lio/sentry/InitPriority;)V
 	public fun setInstrumenter (Lio/sentry/Instrumenter;)V
 	public fun setLogger (Lio/sentry/ILogger;)V
+	public fun setLogs (Lio/sentry/SentryOptions$Logs;)V
 	public fun setMaxAttachmentSize (J)V
 	public fun setMaxBreadcrumbs (I)V
 	public fun setMaxCacheItems (I)V
diff --git a/sentry/src/main/java/io/sentry/ExperimentalOptions.java b/sentry/src/main/java/io/sentry/ExperimentalOptions.java
@@ -1,8 +1,6 @@
 package io.sentry;
 
 import io.sentry.protocol.SdkVersion;
-import org.jetbrains.annotations.ApiStatus;
-import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /**
@@ -12,17 +10,6 @@
  * <p>Beware that experimental options can change at any time.
  */
 public final class ExperimentalOptions {
-  private @NotNull SentryOptions.Logs logs = new SentryOptions.Logs();
 
   public ExperimentalOptions(final boolean empty, final @Nullable SdkVersion sdkVersion) {}
-
-  @ApiStatus.Experimental
-  public @NotNull SentryOptions.Logs getLogs() {
-    return logs;
-  }
-
-  @ApiStatus.Experimental
-  public void setLogs(@NotNull SentryOptions.Logs logs) {
-    this.logs = logs;
-  }
 }
diff --git a/sentry/src/main/java/io/sentry/ExternalOptions.java b/sentry/src/main/java/io/sentry/ExternalOptions.java
@@ -151,7 +151,7 @@ public final class ExternalOptions {
     options.setCaptureOpenTelemetryEvents(
         propertiesProvider.getBooleanProperty("capture-open-telemetry-events"));
 
-    options.setEnableLogs(propertiesProvider.getBooleanProperty("experimental.logs.enabled"));
+    options.setEnableLogs(propertiesProvider.getBooleanProperty("logs.enabled"));
 
     for (final String ignoredExceptionType :
         propertiesProvider.getList("ignored-exceptions-for-type")) {
diff --git a/sentry/src/main/java/io/sentry/SentryClient.java b/sentry/src/main/java/io/sentry/SentryClient.java
@@ -59,7 +59,7 @@ public SentryClient(final @NotNull SentryOptions options) {
 
     final RequestDetailsResolver requestDetailsResolver = new RequestDetailsResolver(options);
     transport = transportFactory.create(options, requestDetailsResolver.resolve());
-    if (options.getExperimental().getLogs().isEnabled()) {
+    if (options.getLogs().isEnabled()) {
       loggerBatchProcessor = new LoggerBatchProcessor(options, this);
     } else {
       loggerBatchProcessor = NoOpLoggerBatchProcessor.getInstance();
@@ -1456,7 +1456,7 @@ private void sortBreadcrumbsByDate(
   private @Nullable SentryLogEvent executeBeforeSendLog(
       @NotNull SentryLogEvent event, final @NotNull Hint hint) {
     final SentryOptions.Logs.BeforeSendLogCallback beforeSendLog =
-        options.getExperimental().getLogs().getBeforeSend();
+        options.getLogs().getBeforeSend();
     if (beforeSendLog != null) {
       try {
         event = beforeSendLog.execute(event, hint);
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -572,6 +572,8 @@ public class SentryOptions {
    */
   private boolean startProfilerOnAppStart = false;
 
+  private @NotNull SentryOptions.Logs logs = new SentryOptions.Logs();
+
   private @NotNull ISocketTagger socketTagger = NoOpSocketTagger.getInstance();
 
   /**
@@ -3203,7 +3205,7 @@ public void merge(final @NotNull ExternalOptions options) {
     }
 
     if (options.isEnableLogs() != null) {
-      getExperimental().getLogs().setEnabled(options.isEnableLogs());
+      getLogs().setEnabled(options.isEnableLogs());
     }
   }
 
@@ -3231,6 +3233,16 @@ public void setSpanFactory(final @NotNull ISpanFactory spanFactory) {
     this.spanFactory = spanFactory;
   }
 
+  @ApiStatus.Experimental
+  public @NotNull SentryOptions.Logs getLogs() {
+    return logs;
+  }
+
+  @ApiStatus.Experimental
+  public void setLogs(@NotNull SentryOptions.Logs logs) {
+    this.logs = logs;
+  }
+
   public static final class Proxy {
     private @Nullable String host;
     private @Nullable String port;
diff --git a/sentry/src/main/java/io/sentry/logger/LoggerApi.java b/sentry/src/main/java/io/sentry/logger/LoggerApi.java
@@ -92,7 +92,7 @@ private void captureLog(
         return;
       }
 
-      if (!options.getExperimental().getLogs().isEnabled()) {
+      if (!options.getLogs().isEnabled()) {
         options
             .getLogger()
             .log(SentryLevel.WARNING, "Sentry Log is disabled and this 'logger' call is a no-op.");
diff --git a/sentry/src/test/java/io/sentry/ExternalOptionsTest.kt b/sentry/src/test/java/io/sentry/ExternalOptionsTest.kt
@@ -377,7 +377,7 @@ class ExternalOptionsTest {
 
     @Test
     fun `creates options with enableLogs set to true`() {
-        withPropertiesFile("experimental.logs.enabled=true") { options ->
+        withPropertiesFile("logs.enabled=true") { options ->
             assertTrue(options.isEnableLogs == true)
         }
     }
diff --git a/sentry/src/test/java/io/sentry/SentryOptionsTest.kt b/sentry/src/test/java/io/sentry/SentryOptionsTest.kt
@@ -459,7 +459,7 @@ class SentryOptionsTest {
         assertTrue(options.isEnableSpotlight)
         assertEquals("http://local.sentry.io:1234", options.spotlightConnectionUrl)
         assertTrue(options.isGlobalHubMode!!)
-        assertTrue(options.experimental.logs.isEnabled!!)
+        assertTrue(options.logs.isEnabled!!)
     }
 
     @Test
diff --git a/test/system-test-spring-server-start.sh b/test/system-test-spring-server-start.sh
@@ -15,5 +15,5 @@ fi
 
 echo "$JAVA_AGENT_STRING"
 
-SENTRY_DSN="http://502f25099c204a2fbf4cb16edc5975d1@localhost:8000/0" SENTRY_AUTO_INIT=${JAVA_AGENT_AUTO_INIT} SENTRY_TRACES_SAMPLE_RATE=1.0 OTEL_TRACES_EXPORTER=none OTEL_METRICS_EXPORTER=none OTEL_LOGS_EXPORTER=none SENTRY_EXPERIMENTAL_LOGS_ENABLED=true java ${JAVA_AGENT_STRING} -jar sentry-samples/${SAMPLE_MODULE}/build/libs/${SAMPLE_MODULE}-0.0.1-SNAPSHOT.jar > spring-server.txt 2>&1 &
+SENTRY_DSN="http://502f25099c204a2fbf4cb16edc5975d1@localhost:8000/0" SENTRY_AUTO_INIT=${JAVA_AGENT_AUTO_INIT} SENTRY_TRACES_SAMPLE_RATE=1.0 OTEL_TRACES_EXPORTER=none OTEL_METRICS_EXPORTER=none OTEL_LOGS_EXPORTER=none SENTRY_LOGS_ENABLED=true java ${JAVA_AGENT_STRING} -jar sentry-samples/${SAMPLE_MODULE}/build/libs/${SAMPLE_MODULE}-0.0.1-SNAPSHOT.jar > spring-server.txt 2>&1 &
 echo $! > spring-server.pid
