Merge branch 'main' into feat/poc-capture-otel-events

Author: adinauer

CHANGELOG.md

@@ -1,19 +1,37 @@
 # Changelog
 
-## Unreleased
+## 8.3.0
 
 ### Features
 
+- Add HTTP server request headers from OpenTelemetry span attributes to sentry `request` in payload ([#4102](https://github.com/getsentry/sentry-java/pull/4102))
+  - You have to explicitly enable each header by adding it to the [OpenTelemetry config](https://opentelemetry.io/docs/zero-code/java/agent/instrumentation/http/#capturing-http-request-and-response-headers)
+  - Please only enable headers you actually want to send to Sentry. Some may contain sensitive data like PII, cookies, tokens etc.
+  - We are no longer adding request/response headers to `contexts/otel/attributes` of the event.
 - The `ignoredErrors` option is now configurable via the manifest property `io.sentry.traces.ignored-errors` ([#4178](https://github.com/getsentry/sentry-java/pull/4178))
 - A list of active Spring profiles is attached to payloads sent to Sentry (errors, traces, etc.) and displayed in the UI when using our Spring or Spring Boot integrations ([#4147](https://github.com/getsentry/sentry-java/pull/4147))
   - This consists of an empty list when only the default profile is active
 - Added `enableTraceIdGeneration` to the AndroidOptions. This allows Hybrid SDKs to "freeze" and control the trace and connect errors on different layers of the application ([4188](https://github.com/getsentry/sentry-java/pull/4188))
 - Move to a single NetworkCallback listener to reduce number of IPC calls on Android ([#4164](https://github.com/getsentry/sentry-java/pull/4164))
 - Add GraphQL Apollo Kotlin 4 integration ([#4166](https://github.com/getsentry/sentry-java/pull/4166))
+- Add support for async dispatch requests to Spring Boot 2 and 3 ([#3983](https://github.com/getsentry/sentry-java/pull/3983))
+  - To enable it, please set `sentry.keep-transactions-open-for-async-responses=true` in `application.properties` or `sentry.keepTransactionsOpenForAsyncResponses: true` in `application.yml`
+- Add constructor to JUL `SentryHandler` for disabling external config ([#4208](https://github.com/getsentry/sentry-java/pull/4208))
 
 ### Fixes
 
+- Filter strings that cannot be parsed as Regex no longer cause an SDK crash ([#4213](https://github.com/getsentry/sentry-java/pull/4213))
+  - This was the case e.g. for `ignoredErrors`, `ignoredTransactions` and `ignoredCheckIns`
+  - We now simply don't use such strings for Regex matching and only use them for String comparison
 - `SentryOptions.setTracePropagationTargets` is no longer marked internal ([#4170](https://github.com/getsentry/sentry-java/pull/4170))
+- Session Replay: Fix crash when a navigation breadcrumb does not have "to" destination ([#4185](https://github.com/getsentry/sentry-java/pull/4185))
+- Session Replay: Cap video segment duration to maximum 5 minutes to prevent endless video encoding in background ([#4185](https://github.com/getsentry/sentry-java/pull/4185))
+- Check `tracePropagationTargets` in OpenTelemetry propagator ([#4191](https://github.com/getsentry/sentry-java/pull/4191))
+  - If a URL can be retrieved from OpenTelemetry span attributes, we check it against `tracePropagationTargets` before attaching `sentry-trace` and `baggage` headers to outgoing requests
+  - If no URL can be retrieved we always attach the headers
+- Fix `ignoredErrors`, `ignoredTransactions` and `ignoredCheckIns` being unset by external options like `sentry.properties` or ENV vars ([#4207](https://github.com/getsentry/sentry-java/pull/4207))
+  - Whenever parsing of external options was enabled (`enableExternalConfiguration`), which is the default for many integrations, the values set on `SentryOptions` passed to `Sentry.init` would be lost
+  - Even if the value was not set in any external configuration it would still be set to an empty list
 
 ### Behavioural Changes
 

gradle.properties

@@ -14,7 +14,7 @@ org.gradle.workers.max=2
 android.useAndroidX=true
 
 # Release information
-versionName=8.2.0
+versionName=8.3.0
 
 # Override the SDK name on native crashes on Android
 sentryAndroidSdkName=sentry.native.android

sentry-android-replay/src/main/java/io/sentry/android/replay/capture/CaptureStrategy.kt

@@ -58,6 +58,10 @@ internal interface CaptureStrategy {
     companion object {
         private const val BREADCRUMB_START_OFFSET = 100L
 
+        // 5 minutes, otherwise relay will just drop it. Can prevent the case where the device
+        // time is wrong and the segment is too long.
+        private const val MAX_SEGMENT_DURATION = 1000L * 60 * 5
+
         fun createSegment(
             scopes: IScopes?,
             options: SentryOptions,
@@ -76,7 +80,7 @@ internal interface CaptureStrategy {
             events: Deque<RRWebEvent>
         ): ReplaySegment {
             val generatedVideo = cache?.createVideoOf(
-                duration,
+                minOf(duration, MAX_SEGMENT_DURATION),
                 currentSegmentTimestamp.time,
                 segmentId,
                 height,
@@ -179,7 +183,9 @@ internal interface CaptureStrategy {
                         recordingPayload += rrwebEvent
 
                         // fill in the urls array from navigation breadcrumbs
-                        if ((rrwebEvent as? RRWebBreadcrumbEvent)?.category == "navigation") {
+                        if ((rrwebEvent as? RRWebBreadcrumbEvent)?.category == "navigation" &&
+                            rrwebEvent.data?.getOrElse("to", { null }) is String
+                        ) {
                             urls.add(rrwebEvent.data!!["to"] as String)
                         }
                     }

sentry-android-replay/src/test/java/io/sentry/android/replay/capture/SessionCaptureStrategyTest.kt

@@ -336,6 +336,30 @@ class SessionCaptureStrategyTest {
         )
     }
 
+    @Test
+    fun `does not throw when navigation destination is not a String`() {
+        val now =
+            System.currentTimeMillis() + (fixture.options.sessionReplay.sessionSegmentDuration * 5)
+        val strategy = fixture.getSut(dateProvider = { now })
+        strategy.start(fixture.recorderConfig)
+
+        fixture.scope.addBreadcrumb(Breadcrumb().apply { category = "navigation" })
+
+        strategy.onScreenshotRecorded(mock<Bitmap>()) {}
+
+        verify(fixture.scopes).captureReplay(
+            check {
+                assertNull(it.urls?.firstOrNull())
+            },
+            check {
+                val breadcrumbEvents =
+                    it.replayRecording?.payload?.filterIsInstance<RRWebBreadcrumbEvent>()
+                assertEquals("navigation", breadcrumbEvents?.first()?.category)
+                assertNull(breadcrumbEvents?.first()?.data?.get("to"))
+            }
+        )
+    }
+
     @Test
     fun `sets screen from scope as replay url`() {
         fixture.scope.screen = "MainActivity"

sentry-jul/api/sentry-jul.api

@@ -8,6 +8,7 @@ public class io/sentry/jul/SentryHandler : java/util/logging/Handler {
 	public static final field THREAD_ID Ljava/lang/String;
 	public fun <init> ()V
 	public fun <init> (Lio/sentry/SentryOptions;)V
+	public fun <init> (Lio/sentry/SentryOptions;Z)V
 	public fun close ()V
 	public fun flush ()V
 	public fun getMinimumBreadcrumbLevel ()Ljava/util/logging/Level;

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

@@ -51,7 +51,7 @@ public class SentryHandler extends Handler {
 
   /** Creates an instance of SentryHandler. */
   public SentryHandler() {
-    this(new SentryOptions(), true);
+    this(new SentryOptions());
   }
 
   /**
@@ -60,17 +60,32 @@ public SentryHandler() {
    * @param options the SentryOptions
    */
   public SentryHandler(final @NotNull SentryOptions options) {
-    this(options, true);
+    this(options, true, true);
+  }
+
+  /**
+   * Creates an instance of SentryHandler.
+   *
+   * @param options the SentryOptions
+   * @param enableExternalConfiguration whether external options like sentry.properties and ENV vars
+   *     should be parsed
+   */
+  public SentryHandler(
+      final @NotNull SentryOptions options, final boolean enableExternalConfiguration) {
+    this(options, true, enableExternalConfiguration);
   }
 
   /** Creates an instance of SentryHandler. */
   @TestOnly
-  SentryHandler(final @NotNull SentryOptions options, final boolean configureFromLogManager) {
+  SentryHandler(
+      final @NotNull SentryOptions options,
+      final boolean configureFromLogManager,
+      final boolean enableExternalConfiguration) {
     setFilter(new DropSentryFilter());
     if (configureFromLogManager) {
       retrieveProperties();
     }
-    options.setEnableExternalConfiguration(true);
+    options.setEnableExternalConfiguration(enableExternalConfiguration);
     options.setInitPriority(InitPriority.LOWEST);
     options.setSdkVersion(createSdkVersion(options));
     Sentry.init(options);

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

@@ -36,7 +36,7 @@ class SentryHandlerTest {
             options.setTransportFactory { _, _ -> transport }
             contextTags?.forEach { options.addContextTag(it) }
             logger = Logger.getLogger("jul.SentryHandlerTest")
-            handler = SentryHandler(options, configureWithLogManager)
+            handler = SentryHandler(options, configureWithLogManager, true)
             handler.setMinimumBreadcrumbLevel(minimumBreadcrumbLevel)
             handler.setMinimumEventLevel(minimumEventLevel)
             handler.level = Level.ALL

sentry-opentelemetry/sentry-opentelemetry-bootstrap/api/sentry-opentelemetry-bootstrap.api

@@ -1,6 +1,7 @@
 public abstract interface class io/sentry/opentelemetry/IOtelSpanWrapper : io/sentry/ISpan {
 	public abstract fun getData ()Ljava/util/Map;
 	public abstract fun getMeasurements ()Ljava/util/Map;
+	public abstract fun getOpenTelemetrySpanAttributes ()Lio/opentelemetry/api/common/Attributes;
 	public abstract fun getScopes ()Lio/sentry/IScopes;
 	public abstract fun getTags ()Ljava/util/Map;
 	public abstract fun getTraceId ()Lio/sentry/protocol/SentryId;
@@ -51,6 +52,7 @@ public final class io/sentry/opentelemetry/OtelStrongRefSpanWrapper : io/sentry/
 	public fun getDescription ()Ljava/lang/String;
 	public fun getFinishDate ()Lio/sentry/SentryDate;
 	public fun getMeasurements ()Ljava/util/Map;
+	public fun getOpenTelemetrySpanAttributes ()Lio/opentelemetry/api/common/Attributes;
 	public fun getOperation ()Ljava/lang/String;
 	public fun getSamplingDecision ()Lio/sentry/TracesSamplingDecision;
 	public fun getScopes ()Lio/sentry/IScopes;
@@ -177,6 +179,7 @@ public final class io/sentry/opentelemetry/SentryOtelThreadLocalStorage : io/ope
 }
 
 public final class io/sentry/opentelemetry/SentryWeakSpanStorage {
+	public fun clear ()V
 	public static fun getInstance ()Lio/sentry/opentelemetry/SentryWeakSpanStorage;
 	public fun getSentrySpan (Lio/opentelemetry/api/trace/SpanContext;)Lio/sentry/opentelemetry/IOtelSpanWrapper;
 	public fun storeSentrySpan (Lio/opentelemetry/api/trace/SpanContext;Lio/sentry/opentelemetry/IOtelSpanWrapper;)V

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/IOtelSpanWrapper.java

@@ -1,5 +1,6 @@
 package io.sentry.opentelemetry;
 
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.context.Context;
 import io.sentry.IScopes;
 import io.sentry.ISpan;
@@ -47,4 +48,8 @@ public interface IOtelSpanWrapper extends ISpan {
 
   @NotNull
   Context storeInContext(Context context);
+
+  @ApiStatus.Internal
+  @Nullable
+  Attributes getOpenTelemetrySpanAttributes();
 }

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/OtelStrongRefSpanWrapper.java

@@ -1,5 +1,6 @@
 package io.sentry.opentelemetry;
 
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.context.Context;
 import io.sentry.BaggageHeader;
@@ -303,4 +304,10 @@ public void setContext(@NotNull String key, @NotNull Object context) {
   public @NotNull ISentryLifecycleToken makeCurrent() {
     return delegate.makeCurrent();
   }
+
+  @ApiStatus.Internal
+  @Override
+  public @Nullable Attributes getOpenTelemetrySpanAttributes() {
+    return delegate.getOpenTelemetrySpanAttributes();
+  }
 }