Add thread information when a span is created #2998

markushi · 2023-10-19T07:02:32Z

📜 Description

Add thread.id and thread.name to the span context.

💡 Motivation and Context

Fixes #2997

💚 How did you test it?

Add Unit test

📝 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

github-actions · 2023-10-19T07:03:42Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Add thread information when a span is created ([#2998](https://github.com/getsentry/sentry-java/pull/2998))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against ce0469b

github-actions · 2023-10-19T07:19:16Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	399.27 ms	485.84 ms	86.57 ms
Size	1.72 MiB	2.29 MiB	576.75 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`c7e2fbc`	372.00 ms	461.71 ms	89.71 ms
`bc4be3b`	360.40 ms	435.04 ms	74.64 ms
`0bf143e`	368.35 ms	437.47 ms	69.12 ms
`86f0096`	368.63 ms	446.92 ms	78.29 ms
`99a51e2`	405.11 ms	479.65 ms	74.54 ms
`7ca9895`	364.31 ms	460.46 ms	96.15 ms
`c7e2fbc`	393.98 ms	478.24 ms	84.27 ms
`c7e2fbc`	377.85 ms	426.35 ms	48.50 ms
`86f0096`	371.86 ms	439.78 ms	67.92 ms
`4bf95dd`	345.96 ms	414.24 ms	68.28 ms

App size

Revision	Plain	With Sentry	Diff
`c7e2fbc`	1.72 MiB	2.29 MiB	576.40 KiB
`bc4be3b`	1.72 MiB	2.29 MiB	576.53 KiB
`0bf143e`	1.72 MiB	2.29 MiB	576.50 KiB
`86f0096`	1.72 MiB	2.29 MiB	576.50 KiB
`99a51e2`	1.72 MiB	2.29 MiB	576.34 KiB
`7ca9895`	1.72 MiB	2.29 MiB	576.51 KiB
`c7e2fbc`	1.72 MiB	2.29 MiB	576.40 KiB
`c7e2fbc`	1.72 MiB	2.29 MiB	576.40 KiB
`86f0096`	1.72 MiB	2.29 MiB	576.50 KiB
`4bf95dd`	1.72 MiB	2.29 MiB	576.40 KiB

Previous results on branch: feat/starfish-span-mainthread-flag

Startup times

Revision	Plain	With Sentry	Diff
`2f17022`	376.33 ms	463.83 ms	87.50 ms
`f9cd2b8`	382.38 ms	455.80 ms	73.42 ms
`2e5b9df`	373.00 ms	445.30 ms	72.30 ms

App size

Revision	Plain	With Sentry	Diff
`2f17022`	1.72 MiB	2.29 MiB	576.71 KiB
`f9cd2b8`	1.72 MiB	2.29 MiB	576.55 KiB
`2e5b9df`	1.72 MiB	2.29 MiB	576.55 KiB

codecov · 2023-10-19T07:28:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Files	Coverage Δ
sentry/src/main/java/io/sentry/SentryTracer.java	`95.07% <100.00%> (+0.08%)`	⬆️

📢 Thoughts on this report? Let us know!.

romtsn · 2023-10-19T10:22:12Z

sentry/src/main/java/io/sentry/SentryTracer.java

@@ -384,6 +385,8 @@ private ISpan createChild(
              }
            });
    span.setDescription(description);
+    span.setData(


Did we agree to use the same blocked_main_thread key? I'd rather us choose something different, because we don't know for sure if it blocked the main thread, we know that it was just started there? Also, if we pick a different key, the current behavior for File I/O or DB spans will remain the same with blocked_main_thread.

Nope, this wasn't discussed yet - thanks for bringing this up. @shruthilayaj I think Roman has some good points here, would it make sense for you as well to have a separate flag for main thread flagging?

Yes, it makes sense to have these as separate flags!

A bit lengthy, but how about started_on_main_thread? Would also make it clear that the flag is determined on span start.

This rfc https://github.com/getsentry/rfcs/pull/75/files got merged just a couple of days ago, so we probably should adhere to what is defined there. Here's the develop docs PR which adds the the new keys to the span data conventions getsentry/develop#1056, which means we have to send thread.id and thread.name, how does that sounds @shruthilayaj @markushi ?

h: I just wanted to make the same comment ⬆️ . Thanks @romtsn.

👍
just to confirm, sending thread.id and thread.name in addition to started_on_main_thread flag right?

mm, since in the RFC we say it's the thread the span originated from, I think thread.name: main would be the same thing pretty much, so we don't need both flags?

yeah makes sense, and will thread name always be standardized to main if it started on the main thread regardless of the SDK it's coming from? (just so we know if we just look for main or need to maintain some sort of map/allow list for extracting this info in relay)

I'd start with just main, I guess we can expand it later. We can ensure that it's called main from the SDKs side

Tag all spans with main thread flag

1e73b22

markushi requested review from adinauer, romtsn and stefanosiano as code owners October 19, 2023 07:02

Update Changelog

83f7838

romtsn reviewed Oct 19, 2023

View reviewed changes

markushi added 2 commits October 23, 2023 17:22

Merge branch 'main' into feat/starfish-span-mainthread-flag

ea3057a

Attach thread.id and thread.name to spans

fb44d20

romtsn approved these changes Oct 23, 2023

View reviewed changes

Fix tests

f2ba64f

markushi enabled auto-merge (squash) October 23, 2023 20:46

markushi disabled auto-merge October 23, 2023 20:46

markushi added 2 commits October 24, 2023 07:47

Merge branch 'main' into feat/starfish-span-mainthread-flag

28c4130

Fix Changelog

ce0469b

markushi merged commit 93a76ca into main Oct 24, 2023
21 checks passed

markushi deleted the feat/starfish-span-mainthread-flag branch October 24, 2023 06:49

markushi changed the title ~~Tag all spans with main thread flag~~ Add thread information when a span is created Oct 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add thread information when a span is created #2998

Add thread information when a span is created #2998

markushi commented Oct 19, 2023 •

edited

github-actions bot commented Oct 19, 2023 •

edited

github-actions bot commented Oct 19, 2023 •

edited

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/starfish-span-mainthread-flag

Startup times

App size

codecov bot commented Oct 19, 2023 •

edited

romtsn Oct 19, 2023

markushi Oct 19, 2023

shruthilayaj Oct 19, 2023

markushi Oct 20, 2023

romtsn Oct 20, 2023

philipphofmann Oct 20, 2023

shruthilayaj Oct 20, 2023

romtsn Oct 20, 2023

shruthilayaj Oct 23, 2023 •

edited

romtsn Oct 23, 2023

Add thread information when a span is created #2998

Add thread information when a span is created #2998

Conversation

markushi commented Oct 19, 2023 • edited

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Oct 19, 2023 • edited

Instructions and example for changelog

github-actions bot commented Oct 19, 2023 • edited

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/starfish-span-mainthread-flag

Startup times

App size

codecov bot commented Oct 19, 2023 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shruthilayaj Oct 23, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markushi commented Oct 19, 2023 •

edited

github-actions bot commented Oct 19, 2023 •

edited

github-actions bot commented Oct 19, 2023 •

edited

codecov bot commented Oct 19, 2023 •

edited

shruthilayaj Oct 23, 2023 •

edited