Add sample rate to baggage as well as trace in envelope header and flatten user #2135

adinauer · 2022-06-24T09:58:38Z

📜 Description

Add sample rate to baggage header as well as trace in envelope header.
Flatten user into user_id and user_segment for trace in envelope header.

💡 Motivation and Context

To allow for dynamic sampling and align with docs / other SDKs: getsentry/develop#613

💚 How did you test it?

📝 Checklist

I reviewed the submitted code
I added tests to verify the changes
I updated the docs if needed
No breaking changes

🔮 Next steps

adinauer · 2022-06-24T10:03:57Z

@AbhiPrasad @lforst @Lms24 can any of you please leave a review, once you feel the docs are ready to make sure this aligns?

codecov-commenter · 2022-06-24T10:11:21Z

Codecov Report

Merging #2135 (1170cc7) into main (413862e) will decrease coverage by 0.01%.
The diff coverage is 85.80%.

@@             Coverage Diff              @@
##               main    #2135      +/-   ##
============================================
- Coverage     80.95%   80.94%   -0.02%     
- Complexity     3257     3290      +33     
============================================
  Files           231      233       +2     
  Lines         11964    12044      +80     
  Branches       1589     1594       +5     
============================================
+ Hits           9686     9749      +63     
- Misses         1698     1712      +14     
- Partials        580      583       +3

Impacted Files	Coverage Δ
...entry/src/main/java/io/sentry/NoOpTransaction.java	`25.00% <0.00%> (-0.81%)`	⬇️
sentry/src/main/java/io/sentry/OutboxSender.java	`65.64% <64.70%> (-0.74%)`	⬇️
...ry/src/main/java/io/sentry/TransactionContext.java	`85.71% <71.42%> (-14.29%)`	⬇️
...ain/java/io/sentry/protocol/SentryTransaction.java	`88.97% <75.00%> (-0.28%)`	⬇️
sentry/src/main/java/io/sentry/SpanContext.java	`83.94% <76.92%> (-0.68%)`	⬇️
...y/src/main/java/io/sentry/util/SampleRateUtil.java	`88.88% <88.88%> (ø)`
sentry/src/main/java/io/sentry/TraceContext.java	`86.74% <90.90%> (-0.01%)`	⬇️
sentry/src/main/java/io/sentry/Baggage.java	`89.41% <100.00%> (+0.25%)`	⬆️
sentry/src/main/java/io/sentry/Hub.java	`76.41% <100.00%> (ø)`
sentry/src/main/java/io/sentry/SentryOptions.java	`82.03% <100.00%> (ø)`
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 413862e...1170cc7. Read the comment docs.

Lms24 · 2022-06-24T10:21:13Z

sentry/src/main/java/io/sentry/Baggage.java

@@ -180,6 +180,10 @@ public void setTransaction(final @Nullable String transaction) {
    set("sentry-transaction", transaction);
  }

+  public void setSampleRate(final @Nullable String sampleRate) {
+    set("sentry-samplerate", sampleRate);


We decided to make baggage and envelope header key names identical (except for the sentry- prefix in baggage keys) so that we're able to just dump the DSC data into both transport mechanisms without any mapping. (Linking to the preview here for more details)

Therefore, we should change the snake case keys to underscores (like in the example below)

Suggested change

set("sentry-samplerate", sampleRate);

set("sentry-sample_rate", sampleRate);

Does that also mean

sentry-publickey becomes sentry-public_key

sentry-traceid becomes sentry_trace_id

sentry-userid becomes sentry-user_id

sentry-usersegment becomes sentry-user_segment

Yes, exactly

sentry-traceid becomes sentry_trace_id

It becomes sentry-trace_id, but that probably just was a typo ^^

OK thanks, will update.
Yeah just a typo on the _ there.

marandaneto · 2022-06-29T08:33:18Z

CHANGELOG.md

+## Unreleased
+
+### Features
+
+- Add sample rate to baggage as well as trace in envelope header and flatten user ([#2135](https://github.com/getsentry/sentry-java/pull/2135))


Merge main into the branch to fix the changelog.

marandaneto · 2022-06-29T08:35:11Z

sentry/src/main/java/io/sentry/TraceContext.java

+  private static @Nullable String getSegment(final @NotNull User user) {
+    final Map<String, String> others = user.getOthers();
+    if (others != null) {
+      return others.get("segment");


Should segment be a new field in the User protocol maybe?

JS seems to have it https://github.com/getsentry/sentry-javascript/blob/master/packages/types/src/user.ts while cocoa does not. Didn't check any other SDKs. Not sure what exactly this is used for / if it should be added. Can create a separate issue to track if you want.

Yes, please, but let's be sure that the approach with others works if not now.
Also, in this issue, we should upgrade the protocol https://develop.sentry.dev/sdk/event-payloads/user/ (adding the new field).

Maybe there's a confusion here. Retrieving segment from others is not new behaviour. It's been there before. See

https://github.com/getsentry/sentry-java/pull/2135/files#diff-9049646d5de9245eead3115d46537579192044823590d4e9ef02eb221a9ae43cL118-L125

marandaneto · 2022-06-29T08:37:56Z

sentry/src/main/java/io/sentry/TraceContext.java

+    if (sampleRateAsDouble < 0.0 || sampleRateAsDouble > 1.0) {
+      return null;
+    }


Maybe we extract this logic from SentryOptions#setSampleRate and SentryOptions#setTracesSampleRate and reuse it as an util function.

setSampleRate has sampleRate > 1.0 || sampleRate <= 0.0 while setTracesSampleRate has tracesSampleRate > 1.0 || tracesSampleRate < 0.0. Can add a util but won't reuse in both.

Indeed, tracesSampleRate can be 0.0

Added SampleRateUtil in #2141

marandaneto · 2022-06-29T08:39:34Z

sentry/src/main/java/io/sentry/TraceContext.java

+    DecimalFormat df =
+        new DecimalFormat("#.################", DecimalFormatSymbols.getInstance(Locale.US));
+    return df.format(sampleRateAsDouble);


We should avoid US locale and use Locale.ROOT instead, some custom OS versions might not have the US locale.
Why don't we just transform the Double to String and send it as it is?

Because we don't want exponent formatting. 0.00000021.toString() would become 2.1E-7 which we don't want.
Can replace the locale.

Is the spec defining the number of max digits? because ################ can lead to a different value, not sure if this would round or not.

It would round on the last digit. Yes we're aligning with JS on the max digits here.

Updated the locale usage in #2141

marandaneto · 2022-06-29T08:40:50Z

sentry/src/main/java/io/sentry/TraceContext.java


    return baggage;
  }

-  public static final class TraceContextUser implements JsonUnknown, JsonSerializable {


Would that be a breaking change if people is upgrading SDKs from X to Y? how does the ser/deser behave if you're reading a JSON with the older structure.

Yes, updated the code to parse from legacy JSON in #2141

* Commit tests * Add sample rate from traces sampler to DSC * Do not replace null with true/false * Restore sample rate in OutboxSender * Remove fallback for sampling decision from TraceContext * Remove sample rate fallback from TracesSamplingDecision * Test more envelope header trace fields for OutboxSender * CR changes

…y/sentry-java into feat/add-sample-rate-to-baggage

romtsn

LGTM!

#2147) * Skip sending userId in DSC if send default pii is off * Add changelog * Add test case

adinauer added 2 commits June 24, 2022 11:54

Add sample rate to baggage and trace in envelope header; flatten user

fb4c0c9

Add changelog

135798b

Lms24 reviewed Jun 24, 2022

View reviewed changes

This was referenced Jun 24, 2022

Dynamic Sampling baggage header changes getsentry/sentry-mobile-release-health-app#241

Closed

Dynamic Sampling baggage header changes getsentry/team-mobile#23

Closed

adinauer added 2 commits June 27, 2022 10:28

Use _ for baggage keys

076ba00

Commit tests

96ac28f

adinauer mentioned this pull request Jun 28, 2022

Feat/traces sampler into sample rate #2141

Merged

4 tasks

adinauer marked this pull request as ready for review June 29, 2022 08:25

adinauer requested a review from romtsn as a code owner June 29, 2022 08:25

marandaneto reviewed Jun 29, 2022

View reviewed changes

adinauer and others added 4 commits June 30, 2022 12:16

Merge branch 'feat/add-sample-rate-to-baggage' of github.com:getsentr…

e4d7fb5

…y/sentry-java into feat/add-sample-rate-to-baggage

Merge branch 'main' into feat/add-sample-rate-to-baggage

1a88d77

Fix changelog

685c725

romtsn approved these changes Jul 1, 2022

View reviewed changes

adinauer added 2 commits July 1, 2022 13:40

Only send userid in Dynamic Sampling Context if sendDefaultPii is true (

30e4ed6

#2147) * Skip sending userId in DSC if send default pii is off * Add changelog * Add test case

Merge branch 'main' into feat/add-sample-rate-to-baggage

1170cc7

adinauer merged commit fa3886f into main Jul 1, 2022

adinauer deleted the feat/add-sample-rate-to-baggage branch July 1, 2022 13:47

gslevinkov mentioned this pull request Oct 27, 2022

NO-TICKET - update Sentry version to 6.6.0 p2p-org/key-app-android#924

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sample rate to baggage as well as trace in envelope header and flatten user #2135

Add sample rate to baggage as well as trace in envelope header and flatten user #2135

adinauer commented Jun 24, 2022 •

edited

adinauer commented Jun 24, 2022

codecov-commenter commented Jun 24, 2022 •

edited

Lms24 Jun 24, 2022

adinauer Jun 24, 2022

Lms24 Jun 24, 2022

lforst Jun 24, 2022

adinauer Jun 27, 2022 •

edited

marandaneto Jun 29, 2022

marandaneto Jun 29, 2022

adinauer Jun 29, 2022

marandaneto Jun 29, 2022

adinauer Jun 29, 2022

marandaneto Jun 29, 2022

adinauer Jun 29, 2022

marandaneto Jun 29, 2022

adinauer Jun 29, 2022

marandaneto Jun 29, 2022 •

edited

adinauer Jun 29, 2022

marandaneto Jun 29, 2022

adinauer Jun 29, 2022

adinauer Jun 29, 2022 •

edited

marandaneto Jun 29, 2022

adinauer Jun 29, 2022 •

edited

romtsn left a comment

	set("sentry-samplerate", sampleRate);
	set("sentry-sample_rate", sampleRate);

Add sample rate to baggage as well as trace in envelope header and flatten user #2135

Add sample rate to baggage as well as trace in envelope header and flatten user #2135

Conversation

adinauer commented Jun 24, 2022 • edited

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

adinauer commented Jun 24, 2022

codecov-commenter commented Jun 24, 2022 • 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

adinauer Jun 27, 2022 • edited

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marandaneto Jun 29, 2022 • edited

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

adinauer Jun 29, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adinauer Jun 29, 2022 • edited

Choose a reason for hiding this comment

romtsn left a comment

Choose a reason for hiding this comment

adinauer commented Jun 24, 2022 •

edited

codecov-commenter commented Jun 24, 2022 •

edited

adinauer Jun 27, 2022 •

edited

marandaneto Jun 29, 2022 •

edited

adinauer Jun 29, 2022 •

edited

adinauer Jun 29, 2022 •

edited