[Logs 7] Add System tests for Logs

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/java/io/sentry/samples/spring/boot/jakarta/PersonController.java

@@ -33,6 +33,9 @@ public PersonController(PersonService personService, Tracer tracer) {
   Person person(@PathVariable Long id) {
     Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
+      Sentry.logger().warn("warn Sentry logging");
+      Sentry.logger().error("error Sentry logging");
+      Sentry.logger().info("hello %s %s", "there", "world!");
       ISpan currentSpan = Sentry.getSpan();
       ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
       try {

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties

@@ -15,6 +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
 in-app-includes="io.sentry.samples"
 
 # Uncomment and set to true to enable aot compatibility

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -25,6 +25,14 @@ class PersonSystemTest {
             testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughOtelApi") &&
                 testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughSentryApi")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry/src/main/java/io/sentry/samples/spring/boot/jakarta/PersonController.java

@@ -31,6 +31,9 @@ public PersonController(PersonService personService, Tracer tracer) {
   Person person(@PathVariable Long id) {
     Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
+      Sentry.logger().warn("warn Sentry logging");
+      Sentry.logger().error("error Sentry logging");
+      Sentry.logger().info("hello %s %s", "there", "world!");
       ISpan currentSpan = Sentry.getSpan();
       ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
       try {

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry/src/main/resources/application.properties

@@ -15,6 +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
 in-app-includes="io.sentry.samples"
 
 # Uncomment and set to true to enable aot compatibility

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -25,6 +25,14 @@ class PersonSystemTest {
             testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughOtelApi") &&
                 testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughSentryApi")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot-jakarta/src/main/java/io/sentry/samples/spring/boot/jakarta/PersonController.java

@@ -26,6 +26,9 @@ Person person(@PathVariable Long id) {
     ISpan currentSpan = Sentry.getSpan();
     ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
     try {
+      Sentry.logger().warn("warn Sentry logging");
+      Sentry.logger().error("error Sentry logging");
+      Sentry.logger().info("hello %s %s", "there", "world!");
       LOGGER.error("Trying person with id={}", id, new RuntimeException("error while loading"));
       throw new IllegalArgumentException("Something went wrong [id=" + id + "]");
     } finally {

sentry-samples/sentry-samples-spring-boot-jakarta/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -24,6 +24,14 @@ class PersonSystemTest {
         testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
             testHelper.doesTransactionHaveOp(transaction, "http.server")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/java/io/sentry/samples/spring/boot/PersonController.java

@@ -33,6 +33,9 @@ public PersonController(PersonService personService, Tracer tracer) {
   Person person(@PathVariable Long id) {
     Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
+      Sentry.logger().warn("warn Sentry logging");
+      Sentry.logger().error("error Sentry logging");
+      Sentry.logger().info("hello %s %s", "there", "world!");
       ISpan currentSpan = Sentry.getSpan();
       ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
       try {

sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties

@@ -14,6 +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
 in-app-includes="io.sentry.samples"
 
 # Database configuration

sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -25,6 +25,14 @@ class PersonSystemTest {
             testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughOtelApi") &&
                 testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughSentryApi")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot-opentelemetry/src/main/java/io/sentry/samples/spring/boot/PersonController.java

@@ -31,6 +31,9 @@ public PersonController(PersonService personService, Tracer tracer) {
   Person person(@PathVariable Long id) {
     Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
+      Sentry.logger().warn("warn Sentry logging");
+      Sentry.logger().error("error Sentry logging");
+      Sentry.logger().info("hello %s %s", "there", "world!");
       ISpan currentSpan = Sentry.getSpan();
       ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
       try {

sentry-samples/sentry-samples-spring-boot-opentelemetry/src/main/resources/application.properties

@@ -14,6 +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
 in-app-includes="io.sentry.samples"
 
 # Database configuration

sentry-samples/sentry-samples-spring-boot-opentelemetry/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -25,6 +25,14 @@ class PersonSystemTest {
             testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughOtelApi") &&
                 testHelper.doesTransactionContainSpanWithOp(transaction, "spanCreatedThroughSentryApi")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot-webflux-jakarta/src/main/java/io/sentry/samples/spring/boot/jakarta/PersonController.java

@@ -1,5 +1,6 @@
 package io.sentry.samples.spring.boot.jakarta;
 
+import io.sentry.Sentry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -22,6 +23,9 @@ public PersonController(PersonService personService) {
 
   @GetMapping("{id}")
   Person person(@PathVariable Long id) {
+    Sentry.logger().warn("warn Sentry logging");
+    Sentry.logger().error("error Sentry logging");
+    Sentry.logger().info("hello %s %s", "there", "world!");
     LOGGER.info("Loading person with id={}", id);
     throw new IllegalArgumentException("Something went wrong [id=" + id + "]");
   }

sentry-samples/sentry-samples-spring-boot-webflux-jakarta/src/main/resources/application.properties

@@ -10,4 +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.enable-spotlight=true

sentry-samples/sentry-samples-spring-boot-webflux-jakarta/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -24,6 +24,14 @@ class PersonSystemTest {
         testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
             testHelper.doesTransactionHaveOp(transaction, "http.server")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot-webflux/src/main/java/io/sentry/samples/spring/boot/PersonController.java

@@ -1,5 +1,6 @@
 package io.sentry.samples.spring.boot;
 
+import io.sentry.Sentry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -22,6 +23,9 @@ public PersonController(PersonService personService) {
 
   @GetMapping("{id}")
   Person person(@PathVariable Long id) {
+    Sentry.logger().warn("warn Sentry logging");
+    Sentry.logger().error("error Sentry logging");
+    Sentry.logger().info("hello %s %s", "there", "world!");
     LOGGER.info("Loading person with id={}", id);
     throw new IllegalArgumentException("Something went wrong [id=" + id + "]");
   }

sentry-samples/sentry-samples-spring-boot-webflux/src/main/resources/application.properties

@@ -12,4 +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.enable-spotlight=true

sentry-samples/sentry-samples-spring-boot-webflux/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -24,6 +24,14 @@ class PersonSystemTest {
         testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
             testHelper.doesTransactionHaveOp(transaction, "http.server")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-boot/src/main/java/io/sentry/samples/spring/boot/PersonController.java

@@ -1,5 +1,6 @@
 package io.sentry.samples.spring.boot;
 
+import io.sentry.Sentry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -21,6 +22,9 @@ public PersonController(PersonService personService) {
 
   @GetMapping("{id}")
   Person person(@PathVariable Long id) {
+    Sentry.logger().warn("warn Sentry logging");
+    Sentry.logger().error("error Sentry logging");
+    Sentry.logger().info("hello %s %s", "there", "world!");
     LOGGER.info("Loading person with id={}", id);
     throw new IllegalArgumentException("Something went wrong [id=" + id + "]");
   }

sentry-samples/sentry-samples-spring-boot/src/main/resources/application.properties

@@ -14,6 +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
 in-app-includes="io.sentry.samples"
 
 # Database configuration

sentry-samples/sentry-samples-spring-boot/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -24,6 +24,14 @@ class PersonSystemTest {
         testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
             testHelper.doesTransactionHaveOp(transaction, "http.server")
         }
+
+        Thread.sleep(10000)
+
+        testHelper.ensureLogsReceived { logs, envelopeHeader ->
+            testHelper.doesContainLogWithBody(logs, "warn Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "error Sentry logging") &&
+                testHelper.doesContainLogWithBody(logs, "hello there world!")
+        }
     }
 
     @Test

sentry-samples/sentry-samples-spring-jakarta/src/main/java/io/sentry/samples/spring/jakarta/web/PersonController.java

@@ -1,5 +1,6 @@
 package io.sentry.samples.spring.jakarta.web;
 
+import io.sentry.Sentry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -22,6 +23,9 @@ public PersonController(PersonService personService) {
 
   @GetMapping("{id}")
   Person person(@PathVariable Long id) {
+    Sentry.logger().warn("warn Sentry logging");
+    Sentry.logger().error("error Sentry logging");
+    Sentry.logger().info("hello %s %s", "there", "world!");
     LOGGER.info("Loading person with id={}", id);
     if (id > 10L) {
       throw new IllegalArgumentException("Something went wrong [id=" + id + "]");

sentry-samples/sentry-samples-spring/src/main/java/io/sentry/samples/spring/web/PersonController.java

@@ -1,5 +1,6 @@
 package io.sentry.samples.spring.web;
 
+import io.sentry.Sentry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -22,6 +23,9 @@ public PersonController(PersonService personService) {
 
   @GetMapping("{id}")
   Person person(@PathVariable Long id) {
+    Sentry.logger().warn("warn Sentry logging");
+    Sentry.logger().error("error Sentry logging");
+    Sentry.logger().info("hello %s %s", "there", "world!");
     LOGGER.info("Loading person with id={}", id);
     if (id > 10L) {
       throw new IllegalArgumentException("Something went wrong [id=" + id + "]");

sentry-system-test-support/api/sentry-system-test-support.api

@@ -551,6 +551,7 @@ public final class io/sentry/systemtest/util/SentryMockServerClient : io/sentry/
 
 public final class io/sentry/systemtest/util/TestHelper {
 	public fun <init> (Ljava/lang/String;)V
+	public final fun doesContainLogWithBody (Lio/sentry/SentryLogEvents;Ljava/lang/String;)Z
 	public final fun doesTransactionContainSpanWithDescription (Lio/sentry/protocol/SentryTransaction;Ljava/lang/String;)Z
 	public final fun doesTransactionContainSpanWithOp (Lio/sentry/protocol/SentryTransaction;Ljava/lang/String;)Z
 	public final fun doesTransactionHaveOp (Lio/sentry/protocol/SentryTransaction;Ljava/lang/String;)Z
@@ -559,6 +560,7 @@ public final class io/sentry/systemtest/util/TestHelper {
 	public final fun ensureEnvelopeReceived (Lkotlin/jvm/functions/Function1;)V
 	public final fun ensureErrorCount (Lcom/apollographql/apollo3/api/ApolloResponse;I)V
 	public final fun ensureErrorReceived (Lkotlin/jvm/functions/Function1;)V
+	public final fun ensureLogsReceived (Lkotlin/jvm/functions/Function2;)V
 	public final fun ensureNoEnvelopeReceived (Lkotlin/jvm/functions/Function1;)V
 	public final fun ensureNoErrors (Lcom/apollographql/apollo3/api/ApolloResponse;)V
 	public final fun ensureNoTransactionReceived (Lkotlin/jvm/functions/Function2;)V

sentry-system-test-support/src/main/kotlin/io/sentry/systemtest/util/TestHelper.kt

@@ -6,6 +6,7 @@ import io.sentry.JsonSerializer
 import io.sentry.SentryEnvelopeHeader
 import io.sentry.SentryEvent
 import io.sentry.SentryItemType
+import io.sentry.SentryLogEvents
 import io.sentry.SentryOptions
 import io.sentry.protocol.SentrySpan
 import io.sentry.protocol.SentryTransaction
@@ -83,6 +84,46 @@ class TestHelper(backendUrl: String) {
         }
     }
 
+    fun ensureLogsReceived(callback: ((SentryLogEvents, SentryEnvelopeHeader) -> Boolean)) {
+        ensureEnvelopeReceived { envelopeString ->
+            checkIfLogsMatch(envelopeString, callback)
+        }
+    }
+
+    private fun checkIfLogsMatch(envelopeString: String, callback: ((SentryLogEvents, SentryEnvelopeHeader) -> Boolean)): Boolean {
+        val deserializeEnvelope =
+            jsonSerializer.deserializeEnvelope(envelopeString.byteInputStream())
+        if (deserializeEnvelope == null) {
+            return false
+        }
+
+        val envelopeHeader = deserializeEnvelope.header
+
+        val logsItem =
+            deserializeEnvelope.items.firstOrNull { it.header.type == SentryItemType.Log }
+        if (logsItem == null) {
+            return false
+        }
+
+        val logs = logsItem.getLogs(jsonSerializer)
+        if (logs == null) {
+            return false
+        }
+
+        return callback(logs, envelopeHeader)
+    }
+
+    fun doesContainLogWithBody(logs: SentryLogEvents, body: String): Boolean {
+        val logItem = logs.items.firstOrNull { logItem -> logItem.body == body }
+        if (logItem == null) {
+            println("Unable to find log item with body $body in logs:")
+            logObject(logs)
+            return false
+        }
+
+        return true
+    }
+
     private fun checkIfTransactionMatches(envelopeString: String, callback: ((SentryTransaction, SentryEnvelopeHeader) -> Boolean)): Boolean {
         val deserializeEnvelope =
             jsonSerializer.deserializeEnvelope(envelopeString.byteInputStream())

sentry/api/sentry.api

@@ -2833,6 +2833,7 @@ public final class io/sentry/SentryEnvelopeItem {
 	public fun getData ()[B
 	public fun getEvent (Lio/sentry/ISerializer;)Lio/sentry/SentryEvent;
 	public fun getHeader ()Lio/sentry/SentryEnvelopeItemHeader;
+	public fun getLogs (Lio/sentry/ISerializer;)Lio/sentry/SentryLogEvents;
 	public fun getTransaction (Lio/sentry/ISerializer;)Lio/sentry/protocol/SentryTransaction;
 }
 

sentry/src/main/java/io/sentry/ExternalOptions.java

@@ -152,8 +152,9 @@ public final class ExternalOptions {
     options.setCaptureOpenTelemetryEvents(
         propertiesProvider.getBooleanProperty("capture-open-telemetry-events"));
 
-    options.setEnableLogs(propertiesProvider.getBooleanProperty("logs.enabled"));
-    options.setLogsSampleRate(propertiesProvider.getDoubleProperty("logs.sample-rate"));
+    options.setEnableLogs(propertiesProvider.getBooleanProperty("experimental.logs.enabled"));
+    options.setLogsSampleRate(
+        propertiesProvider.getDoubleProperty("experimental.logs.sample-rate"));
 
     for (final String ignoredExceptionType :
         propertiesProvider.getList("ignored-exceptions-for-type")) {