replay(feature): Adding OkHttp Request/Response bodies for sentry-java #4796

43jay · 2025-10-09T21:27:58Z

📜 Description

Introduce new utility/data classes (io.sentry.util.network pkg), following format in the javascript SDK.

Initalise DefaultReplayBreadcrumbConverter as the SDK-wide BeforeBreadcrumbCallback. It is responsible for delegating to a user-provided BeforeBreadcrumb.

In BeforeBreadcrumb, NetworkDetailCaptureUtils extracts "Network Details" data objects (NetworkRequestData, ReplayNetworkRequestOrResponse) and inserts back into the breadcrumb Hint (only sentry-okhttp for now).

When converting Breadcrumb to RRWebSpanEvent, extract NetworkRequestData data from Hint (name="replay:networkDetails") and insert into the replay performanceSpan when creating the replay segment.

TODOs

Feedback:

acceptable acceptance criteria for landing? Given so many diff types of request bodies ->
Current impl handles JSON, UrlFormEncoded, skips these binary content types, and falls back to raw String as possible
Decide on keeping changes to sentry-samples-android
I am planning to add more http request body "types" to the sample app (e.g. xml bodies,... see below). Think this could be useful / reusable. @romtsn wdyt?

Implementation:

Restrict size of breadcrumbsMap entries after data has been added to replay
Respect networkDetail* SDK Options flags
- Will handle in a Future PR
handle case where SentryOkHttpEventListener handles http request instrumentation
- Will handle in a Future PR
Additional Testing
- Add More http request body types triggered via sample app:
  - x-www-form-urlencoded request bodies
  - xml request bodies
  - "weird bodies" (?)
- Unit tests

Pre-Land:

Go through commits and remove any testing-oriented ones
- Remove FAKE_OPTIONS in SentryOkHttpInterceptor before landing // there for testing
Remove remaining unnecessary debug log statements

💡 Motivation and Context

Part of [Mobile Replay] Capture Network request/response bodies

Initially, we were trying to keep SDK changes simple and re-use the existing OKHTTP_REQUEST|RESPONSE hint data.
However, the :sentry-android-replay gradle module doesn't compile against any of the http libs (makes sense).

Because these okhttp3.Request, etc types don't exist in :sentry-android-replay, replay accesses the NetworkDetails data via Hint data ("replay:networkDetails") on the Breadcrumb, when the SDKOptions constraints have been met.

💚 How did you test it?

See recording segment data of entire replay payload

session replay captured from sentry-samples test app

https://sentry-sdks.sentry.io/explore/replays/f89535ea0e79499ca8d75e34e6270925

1. Request / Response headers respect networkDetail[Request|Response]Headers
ref

2. Request body formatted as JSON key/values
ref

3. Response body formatted as JSON key/values
ref

https://sentry-sdks.sentry.io/settings/projects/sentry-android/keys/

…dcrumbCallback to extract NetworkRequestData from Hint -> NetworkRequestData is landing on DefaultReplayBreadcrumbConverter via Hint.get(replay:networkDetails)

linear · 2025-10-09T21:28:02Z

MOBILE-935 [Mobile Replay] Capture Network request/response bodies

...ry-android-replay/src/main/java/io/sentry/android/replay/DefaultReplayBreadcrumbConverter.kt

seer-by-sentry · 2025-10-09T21:33:48Z

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

+      options.setBeforeBreadcrumb(
+        replayBreadcrumbConverter
+      );


Potential bug: A user-configured BeforeBreadcrumbCallback overwrites the SDK's replay converter during initialization, silently disabling network capture for replays.

Description: During SentryAndroid.init(), the DefaultReplayBreadcrumbConverter is set as the BeforeBreadcrumbCallback before the user's configuration callback is executed. If a user provides their own BeforeBreadcrumbCallback in the configuration, it replaces the SDK's converter. This breaks the replay feature's ability to capture network request data, as the logic in DefaultReplayBreadcrumbConverter is never called. The feature fails silently for any user following the common practice of setting a breadcrumb callback.

Suggested fix: Modify the initialization logic to chain the callbacks instead of overwriting. The DefaultReplayBreadcrumbConverter should be initialized with the user's callback, which is retrieved after the user's configuration has run. The converter would then execute the user's callback before its own logic.
_{severity: 0.7, confidence: 0.99}

_{Did we get this right? 👍 / 👎 to inform future reviews.}

this is legit, so we probably have to move setting the beforeBreadcrumb callback over to initializeIntegrationsAndProcessors which is called after the user config. You can access the converter via options.getReplayController().getBreadcrumbConverter later on

nice one 🙈 thanks

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt

romtsn · 2025-10-13T09:58:42Z

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt

+      val networkData = createNetworkRequestData(request, response, requestBodySize, responseBodySize)
+      it.set("replay:networkDetails", networkData)
+
+//      it.set(OKHTTP_REQUEST, request)


we should probably still keep these because some of our customer may rely on them being present in the hint

romtsn · 2025-10-13T10:07:46Z

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt

+
+  /**
+   * Extracts body metadata from OkHttp RequestBody or ResponseBody
+   * Note: We don't consume the actual body stream to avoid interfering with the request/response


hm, is it not possible to consume/copy it? I think would be great if we could do that, given that the JS sdk does that too. Otherwise, it's probably not very helpful to just have the headers and some metadata

fixed, but need to do some more testing

romtsn · 2025-10-13T10:08:57Z

...ry-android-replay/src/main/java/io/sentry/android/replay/DefaultReplayBreadcrumbConverter.kt

+    // First try to get the structured network data from the hint
+    val networkDetails = breadcrumbHint.get("replay:networkDetails") as? NetworkRequestData
+    if (networkDetails != null) {
+      Log.d("SentryNetwork", "SentryNetwork: Found structured NetworkRequestData in hint: $networkDetails")


I guess you're gonna clean these up, but if you wanna keep some logs please use options.logger as it will no-op in production builds

cleaned up most, left in the rest to help with debugging. will remove / clean-up before landing (added to TODOs)

These get set on the breadcrumb Hint, and then hang around in DefaultReplayBreadcrumbConverter until the replay segment has been sent off See https://github.com/getsentry/sentry-javascript/blob/632f0b953d99050c11b0edafb9f80b5f3ba88045/packages/replay-internal/src/types/performance.ts#L133-L140 https://github.com/getsentry/sentry-javascript/blob/develop/packages/replay-internal/src/types/request.ts#L12

Manually set networkDetailHasUrls to pass this check https://github.com/getsentry/sentry-javascript/blob/d1646c8a281dd8795c5a6a3b8e18f2e7069e7fa9/packages/replay-internal/src/util/handleRecordingEmit.ts#L134 https://github.com/getsentry/sentry/blob/master/static/app/views/replays/detail/network/details/getOutputType.tsx#L33 https://github.com/getsentry/sentry/blob/master/static/app/views/replays/detail/network/details/content.tsx#L55-L56

added some unit tests: ./gradlew :sentry-android-replay:testDebugUnitTest --tests="*DefaultReplayBreadcrumbConverterTest*"

Breadcrumb.java has several timestamp fields: `timestamp: Date`, `timestampMs: Long`, `nanos: Long` `hashcode` was relying solely on `timestamp`, which can be null depending on which constructor was used. => Change to use getTimestamp as 1. this is what equals does (consistency) 2. getTimestamp initialises timestamp if null.

sentry/src/main/java/io/sentry/rrweb/RRWebOptionsEvent.java

seer-by-sentry · 2025-10-24T15:53:09Z

...ry-android-replay/src/main/java/io/sentry/android/replay/DefaultReplayBreadcrumbConverter.kt

+  private val httpNetworkDetails =
+    Collections.synchronizedMap(
+      object : LinkedHashMap<Breadcrumb, NetworkRequestData>() {
+        override fun removeEldestEntry(
+          eldest: MutableMap.MutableEntry<Breadcrumb, NetworkRequestData>?
+        ): Boolean {
+          return size > MAX_HTTP_NETWORK_DETAILS
+        }
+      }
+    )


Bug: Breadcrumb.equals() omits data map, causing HashMap key collisions for concurrent requests, leading to incorrect network data attribution.
_{Severity: CRITICAL | Confidence: 1.00}

🔍 Detailed Analysis

The Breadcrumb.equals() method omits the data map from its comparison. This allows distinct Breadcrumb objects, particularly those generated by HTTP requests occurring within the same millisecond but having different URLs or other data map contents, to be considered equal. When these Breadcrumb objects are used as keys in the httpNetworkDetails LinkedHashMap, one entry can unintentionally overwrite another, causing network details from one request to be incorrectly associated with a different request during session replay processing.

💡 Suggested Fix

Modify Breadcrumb.equals() to include the data map in its comparison, or use a different key for httpNetworkDetails that uniquely identifies each network request, such as a UUID or a composite key including relevant data fields.

🤖 Prompt for AI Agent

Fix this bug. In sentry-android-replay/src/main/java/io/sentry/android/replay/DefaultReplayBreadcrumbConverter.kt at lines 33-42: The `Breadcrumb.equals()` method omits the `data` map from its comparison. This allows distinct `Breadcrumb` objects, particularly those generated by HTTP requests occurring within the same millisecond but having different URLs or other `data` map contents, to be considered equal. When these `Breadcrumb` objects are used as keys in the `httpNetworkDetails` `LinkedHashMap`, one entry can unintentionally overwrite another, causing network details from one request to be incorrectly associated with a different request during session replay processing.

_{Did we get this right? 👍 / 👎 to inform future reviews.}

@romtsn is there any issue with updating Breadcrumb#equals and Breadcrumb#hashmap to include data in the comparison?

I left it out in my commit cuz assumed we want Breadcrumbs to be equal if they have different data (e.g. it's the same breadcrumb if some more data gets added by a different caller at some point later)

43jay · 2025-10-24T16:00:04Z

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

      options.setCompositePerformanceCollector(new DefaultCompositePerformanceCollector(options));
    }

+    if (options.getReplayController() != null) { // TODO: Triple-check this should be a null check


@roman can you be my triple-check? the code above uses instanceof , but afaict the NoOpReplayController always gets overridden so i put a null check here

...ry-android-replay/src/main/java/io/sentry/android/replay/DefaultReplayBreadcrumbConverter.kt

Entrypoint is NetworkDetailCaptureUtils (initializeForUrl) called from SentryOkHttpInterceptor - common logic to handle checking sdk options. - Accept data from http client via NetworkBodyExtractor, NetworkHeaderExtractor interfaces that can be reused in future (if needed) Placeholder impl for req/resp bodies. From https://docs.sentry.io/platforms/javascript/session-replay/configuration/ - networkDetailAllowUrls, networkDetailDenyUrls, - networkCaptureBodies - networkRequestHeaders, networkResponseHeaders These SDKOptions don't exist yet => impl acts as if they do, but have not been enabled.

to revert

…entries Removes entry when creating RRWebSpanEvent Uses syncrhonized LinkedHashMap with impl to cap size of map (avoid memory bloat)

Replaces previous placeholder logic. Now NetworkBodyParser uses io.sentry.JsonObjectReader to extract body into JSONObject, JSONArray, with fallback to plain-text String (or nothing)

Linter / formatting / tests / comments

43jay · 2025-10-24T21:20:21Z

seeing something i want to test more (safely copying out the request body for one-shot okhttp request bodies), moved back to draft for now

cursor · 2025-10-24T21:23:18Z

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

+      options.setBeforeBreadcrumb(
+        replayBreadcrumbConverter
+      );
+    }


Bug: Null Handling Error in Breadcrumb Conversion

A NullPointerException can occur if options.getReplayController().getBreadcrumbConverter() returns null, as the code attempts to call setUserBeforeBreadcrumbCallback on the resulting replayBreadcrumbConverter without a null check.

43jay added 5 commits October 7, 2025 14:33

Update dsn for testing

b8555e2

Enable replay verbose logging

ca28040

Point dsn to sentry-android project

5397e9d

https://sentry-sdks.sentry.io/settings/projects/sentry-android/keys/

Add HTTP Request Trigger to sentry-samples-android app

71ed70e

[replay] Make DefaultReplayBreadcrumbConverter the default BeforeBrea…

f2ce22e

…dcrumbCallback to extract NetworkRequestData from Hint -> NetworkRequestData is landing on DefaultReplayBreadcrumbConverter via Hint.get(replay:networkDetails)

43jay requested review from adinauer, lcian, markushi, romtsn and stefanosiano as code owners October 9, 2025 21:27

43jay marked this pull request as draft October 9, 2025 21:28

This comment was marked as outdated.

Sign in to view

seer-by-sentry bot reviewed Oct 9, 2025

View reviewed changes

romtsn reviewed Oct 13, 2025

View reviewed changes

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt Show resolved Hide resolved

romtsn reviewed Oct 13, 2025

View reviewed changes

43jay added 4 commits October 13, 2025 10:52

Move BeforeBreadcrumbCallback initialization to after user config

2d08e7b

added some unit tests: ./gradlew :sentry-android-replay:testDebugUnitTest --tests="*DefaultReplayBreadcrumbConverterTest*"

43jay changed the title ~~RFF(replay): Adding OkHttp Request/Response bodies for sentry-java~~ replay(feature): Adding OkHttp Request/Response bodies for sentry-java Oct 24, 2025

43jay commented Oct 24, 2025

View reviewed changes

sentry/src/main/java/io/sentry/rrweb/RRWebOptionsEvent.java Outdated Show resolved Hide resolved

43jay marked this pull request as ready for review October 24, 2025 15:50

seer-by-sentry bot reviewed Oct 24, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

43jay commented Oct 24, 2025

View reviewed changes

...ry-android-replay/src/main/java/io/sentry/android/replay/DefaultReplayBreadcrumbConverter.kt Outdated Show resolved Hide resolved

43jay force-pushed the 43jay/MOBILE-935 branch from 9a4852b to 82404ff Compare October 24, 2025 18:28

43jay added 5 commits October 24, 2025 15:38

Add FAKE_OPTIONS for testing

6964a53

to revert

DefaultReplayBreadcrumbConverter properly manages NetworkRequestData …

25c42c7

…entries Removes entry when creating RRWebSpanEvent Uses syncrhonized LinkedHashMap with impl to cap size of map (avoid memory bloat)

Extract bodies of okhttp requests/responses

308072b

Replaces previous placeholder logic. Now NetworkBodyParser uses io.sentry.JsonObjectReader to extract body into JSONObject, JSONArray, with fallback to plain-text String (or nothing)

Check-in sentry-android-replay.api

5836ef1

Cleanup

d9f8254

Linter / formatting / tests / comments

43jay force-pushed the 43jay/MOBILE-935 branch from 82404ff to d9f8254 Compare October 24, 2025 21:15

43jay marked this pull request as draft October 24, 2025 21:19

cursor bot reviewed Oct 24, 2025

View reviewed changes

Uh oh!

replay(feature): Adding OkHttp Request/Response bodies for sentry-java #4796

Are you sure you want to change the base?

replay(feature): Adding OkHttp Request/Response bodies for sentry-java #4796

Uh oh!

Conversation

43jay commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

TODOs

💡 Motivation and Context

💚 How did you test it?

Uh oh!

linear bot commented Oct 9, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

seer-by-sentry bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

romtsn Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

43jay Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

seer-by-sentry bot Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

43jay commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor bot Oct 24, 2025

Choose a reason for hiding this comment

Bug: Null Handling Error in Breadcrumb Conversion

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

43jay commented Oct 9, 2025 •

edited

Loading

romtsn Oct 13, 2025 •

edited

Loading

43jay Oct 24, 2025 •

edited

Loading

43jay commented Oct 24, 2025 •

edited

Loading