-
-
Notifications
You must be signed in to change notification settings - Fork 464
SentryAndroidOptions to enable NetworkDetails extraction #4900
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Performance metrics 🚀
|
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| ee747ae | 357.79 ms | 421.84 ms | 64.05 ms |
| ae7fed0 | 293.84 ms | 380.22 ms | 86.38 ms |
| 9fbb112 | 404.51 ms | 475.65 ms | 71.14 ms |
| 27d7cf8 | 397.90 ms | 498.65 ms | 100.75 ms |
| a416a65 | 333.78 ms | 410.37 ms | 76.59 ms |
| d217708 | 411.22 ms | 430.86 ms | 19.63 ms |
| 539ca63 | 313.51 ms | 355.43 ms | 41.92 ms |
| 23d6b12 | 354.10 ms | 408.38 ms | 54.28 ms |
| 14ff5ee | 419.75 ms | 495.73 ms | 75.98 ms |
| ce0a49e | 532.00 ms | 609.96 ms | 77.96 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| ee747ae | 1.58 MiB | 2.10 MiB | 530.95 KiB |
| ae7fed0 | 1.58 MiB | 2.12 MiB | 551.77 KiB |
| 9fbb112 | 1.58 MiB | 2.11 MiB | 539.18 KiB |
| 27d7cf8 | 1.58 MiB | 2.12 MiB | 549.42 KiB |
| a416a65 | 1.58 MiB | 2.12 MiB | 555.26 KiB |
| d217708 | 1.58 MiB | 2.10 MiB | 532.97 KiB |
| 539ca63 | 1.58 MiB | 2.12 MiB | 551.41 KiB |
| 23d6b12 | 1.58 MiB | 2.10 MiB | 532.31 KiB |
| 14ff5ee | 1.58 MiB | 2.10 MiB | 535.08 KiB |
| ce0a49e | 1.58 MiB | 2.10 MiB | 532.94 KiB |
Previous results on branch: 43jay/MOBILE-935
Startup times
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 1c4ba0c | 302.22 ms | 367.21 ms | 64.98 ms |
| da92356 | 319.12 ms | 388.73 ms | 69.61 ms |
| 6687052 | 321.98 ms | 383.35 ms | 61.38 ms |
| 1a07f53 | 341.15 ms | 378.86 ms | 37.71 ms |
| 790a163 | 339.64 ms | 436.57 ms | 96.94 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 1c4ba0c | 1.58 MiB | 2.13 MiB | 556.34 KiB |
| da92356 | 1.58 MiB | 2.13 MiB | 556.24 KiB |
| 6687052 | 1.58 MiB | 2.13 MiB | 556.25 KiB |
| 1a07f53 | 1.58 MiB | 2.12 MiB | 553.02 KiB |
| 790a163 | 1.58 MiB | 2.12 MiB | 553.01 KiB |
romtsn
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, nice work!
Determine whether the networkDetail options should be added as "tags"
Yes, I think we should add them to options here.
At some point we'd need to add the changelog entry -- maybe now is a good time? Or maybe after we added this to SentryOkHttpEventListener
| */ | ||
| @ApiStatus.Internal | ||
| public static @NotNull String[] getNetworkDetailsDefaultHeaders() { | ||
| return DEFAULT_HEADERS.clone(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have to clone it actually? I see we convert it using Arrays.asList down there anyway, so not sure if it's necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call-out.
The clone was for a defensive copy to ensure the DEFAULT_HEADERS elements couldn't be mutated by clients.
But it would be simpler as a Collections.unmodifiableList
=> fixed
./gradlew apiDump
enables Network Detail extraction via SDK and removes FAKE_OPTIONS placeholder
Seems more efficient - getNetworkRequestHeaders/getNetworkResponseHeaders is invoked on every http request but setNetwork... is only invoked on start-up
…ayOptions networkDetailHasUrls is a gate that the front-end uses to determine whether there is data to show the end-user https://github.com/getsentry/sentry-javascript/blob/090a3e35a94014aad4dfd06a6ff3c361f0420009/packages/replay-internal/src/util/handleRecordingEmit.ts#L134
getNetworkRequestHeaders / getNetworkResponseHeaders are called on every http request => move the memory operation to the setNetworkRequest|ResponseHeaders path which is called 1x on start-up
554d1f6 to
cf34268
Compare
📜 Description
Continuation of MOBILE-935: [Mobile Replay] Capture Network request/response bodies, for android SDK.
💡 Motivation and Context
Related to #4796, which was the implementation.
https://docs.sentry.io/platforms/javascript/session-replay/configuration/#network-details
This PR adds the ability to enable network details extraction via SentryAndroidOptions API, either via AndroidManifest
<metadata/>or viaSentryAndroid#init💚 How did you test it?
Unit Tests
ManifestMetadataReader
SentryReplayOptions
RRWebOptionsEvent
sentry-samples test app
📝 Checklist
📝
I added tests to verify the changes.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.
I added GH Issue ID & Linear ID
No new PII added or SDK only sends newly added PII if
sendDefaultPIIis enabled.By default network detail extraction is off - user must opt-in by adding a regex to
networkDetailAllowUrls. ThereforesendDefaultPIIdoes not apply. @markushi confirms this matches the JS behaviour.When a url is on deny list the UI shows "no mobile sdk support"
Tracked in MOBILE-1131: [sentry-android][network-details] Sentry dashboard incorrectly shows "no mobile sdk support"
falsethe UI shows "no mobile sdk support"Tracked in MOBILE-1131: [sentry-android][network-details] Sentry dashboard incorrectly shows "no mobile sdk support"
session replay


🔮 Next steps