Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description to OkHttp spans #3320

Merged
merged 5 commits into from Apr 9, 2024
Merged

Conversation

stefanosiano
Copy link
Member

馃摐 Description

added description to OkHttp sub-spans

馃挕 Motivation and Context

Fixes #3262

馃挌 How did you test it?

Unit tests

馃摑 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

馃敭 Next steps

@stefanosiano stefanosiano marked this pull request as ready for review April 4, 2024 13:12
@stefanosiano stefanosiano marked this pull request as draft April 4, 2024 13:17
Copy link
Contributor

github-actions bot commented Apr 4, 2024

Performance metrics 馃殌

Plain With Sentry Diff
Startup time 387.78 ms 454.65 ms 66.87 ms
Size 1.70 MiB 2.28 MiB 592.12 KiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
99a51e2 405.11 ms 479.65 ms 74.54 ms
baaf637 375.71 ms 441.58 ms 65.87 ms
95a98b5 379.14 ms 420.80 ms 41.66 ms
8ff8fd0 432.77 ms 495.18 ms 62.41 ms
937879e 400.98 ms 482.84 ms 81.86 ms
4e29063 376.38 ms 390.98 ms 14.60 ms
28c9a83 366.20 ms 433.88 ms 67.67 ms
0bd723b 412.52 ms 496.65 ms 84.13 ms
93a76ca 377.96 ms 447.52 ms 69.56 ms
a537f8a 457.14 ms 514.19 ms 57.05 ms

App size

Revision Plain With Sentry Diff
99a51e2 1.72 MiB 2.29 MiB 576.34 KiB
baaf637 1.72 MiB 2.27 MiB 558.42 KiB
95a98b5 1.70 MiB 2.27 MiB 586.31 KiB
8ff8fd0 1.72 MiB 2.27 MiB 558.15 KiB
937879e 1.72 MiB 2.27 MiB 558.42 KiB
4e29063 1.72 MiB 2.29 MiB 578.38 KiB
28c9a83 1.70 MiB 2.28 MiB 592.00 KiB
0bd723b 1.72 MiB 2.29 MiB 578.09 KiB
93a76ca 1.72 MiB 2.29 MiB 576.75 KiB
a537f8a 1.70 MiB 2.27 MiB 584.74 KiB

Previous results on branch: enh/okhttp-span-description

Startup times

Revision Plain With Sentry Diff
6760912 396.46 ms 440.64 ms 44.18 ms
1360372 384.06 ms 493.88 ms 109.81 ms
d00b75d 337.35 ms 381.36 ms 44.01 ms

App size

Revision Plain With Sentry Diff
6760912 1.70 MiB 2.28 MiB 592.00 KiB
1360372 1.70 MiB 2.28 MiB 592.01 KiB
d00b75d 1.70 MiB 2.28 MiB 592.01 KiB

@stefanosiano stefanosiano marked this pull request as ready for review April 4, 2024 13:33
Copy link
Member

@markushi markushi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, left one comment.

@@ -113,7 +115,7 @@ internal class SentryOkHttpEvent(private val hub: IHub, private val request: Req
fun startSpan(event: String) {
// Find the parent of the span being created. E.g. secureConnect is child of connect
val parentSpan = findParentSpan(event)
val span = parentSpan?.startChild("http.client.$event") ?: return
val span = parentSpan?.startChild("http.client.$event", "$method $url") ?: return
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I'm wondering if we need to do anything to make PII scrubbing work here? (I don't think so).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright I just did a quick manual check. The span description definitely is processed and e.g. query params do get removed. All good!
image

@stefanosiano stefanosiano merged commit 0d65ef7 into main Apr 9, 2024
24 checks passed
@stefanosiano stefanosiano deleted the enh/okhttp-span-description branch April 9, 2024 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add span descriptions for OkHttp child spans
2 participants