feat: Associate replays with errors and traces on Android #4133
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,15 +20,15 @@ internal class DynamicSamplingContext | |
| /// </summary> | ||
| public static readonly DynamicSamplingContext Empty = new(new Dictionary<string, string>().AsReadOnly()); | ||
|
|
||
| private DynamicSamplingContext(SentryId traceId, | ||
| string publicKey, | ||
| bool? sampled, | ||
| double? sampleRate = null, | ||
| double? sampleRand = null, | ||
| string? release = null, | ||
| string? environment = null, | ||
| string? transactionName = null, | ||
| IReplaySession? replaySession = null) | ||
| { | ||
| // Validate and set required values | ||
| if (traceId == SentryId.Empty) | ||
|
|
@@ -51,7 +51,7 @@ private DynamicSamplingContext( | |
| throw new ArgumentOutOfRangeException(nameof(sampleRand), "Arg invalid if < 0.0 or >= 1.0"); | ||
| } | ||
|
|
||
| var items = new Dictionary<string, string>(capacity: 9) | ||
| { | ||
| ["trace_id"] = traceId.ToString(), | ||
| ["public_key"] = publicKey, | ||
|
|
@@ -88,12 +88,29 @@ private DynamicSamplingContext( | |
| items.Add("transaction", transactionName); | ||
| } | ||
|
|
||
| if (replaySession?.ActiveReplayId is { } replayId && replayId != SentryId.Empty) | ||
| { | ||
| items.Add("replay_id", replayId.ToString()); | ||
| } | ||
|
|
||
| Items = items; | ||
| } | ||
|
|
||
| public BaggageHeader ToBaggageHeader() => BaggageHeader.Create(Items, useSentryPrefix: true); | ||
|
|
||
| public DynamicSamplingContext WithReplayId(IReplaySession? replaySession) | ||
| { | ||
| if (replaySession?.ActiveReplayId is not { } replayId || replayId == SentryId.Empty) | ||
| { | ||
| return this; | ||
| } | ||
|
|
||
| var items = Items.ToDictionary(kvp => kvp.Key, kvp => kvp.Value); | ||
| items["replay_id"] = replayId.ToString(); | ||
| return new DynamicSamplingContext(items); | ||
| } | ||
|
|
||
| public static DynamicSamplingContext? CreateFromBaggageHeader(BaggageHeader baggage, IReplaySession? replaySession) | ||
| { | ||
| var items = baggage.GetSentryMembers(); | ||
|
|
||
|
|
@@ -144,10 +161,19 @@ private DynamicSamplingContext( | |
| } | ||
| items.Add("sample_rand", rand.ToString("N4", CultureInfo.InvariantCulture)); | ||
| } | ||
|
|
||
| if (replaySession?.ActiveReplayId is { } replayId) | ||
| { | ||
| // Any upstream replay_id will be propagated only if the current process hasn't started it's own replay session. | ||
| // Otherwise we have to overwrite this as it's the only way to communicate the replayId to Sentry Relay. | ||
| // In Mobile apps this should never be a problem. | ||
| items["replay_id"] = replayId.ToString(); | ||
| } | ||
|
|
||
| return new DynamicSamplingContext(items); | ||
| } | ||
|
|
||
| public static DynamicSamplingContext CreateFromTransaction(TransactionTracer transaction, SentryOptions options, IReplaySession? replaySession) | ||
| { | ||
| // These should already be set on the transaction. | ||
| var publicKey = options.ParsedDsn.PublicKey; | ||
|
|
@@ -161,18 +187,18 @@ public static DynamicSamplingContext CreateFromTransaction(TransactionTracer tra | |
| var release = options.SettingLocator.GetRelease(); | ||
| var environment = options.SettingLocator.GetEnvironment(); | ||
|
|
||
| return new DynamicSamplingContext(traceId, | ||
| publicKey, | ||
| sampled, | ||
| sampleRate, | ||
| sampleRand, | ||
| release, | ||
| environment, | ||
| transactionName, | ||
| replaySession); | ||
| } | ||
|
|
||
| public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagationContext propagationContext, SentryOptions options, IReplaySession? replaySession) | ||
| { | ||
| var traceId = propagationContext.TraceId; | ||
| var publicKey = options.ParsedDsn.PublicKey; | ||
|
|
@@ -184,18 +210,20 @@ public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagat | |
| publicKey, | ||
| null, | ||
| release: release, | ||
| environment: environment, | ||
| replaySession: replaySession | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| internal static class DynamicSamplingContextExtensions | ||
| { | ||
| public static DynamicSamplingContext? CreateDynamicSamplingContext(this BaggageHeader baggage, IReplaySession? replaySession = null) | ||
| => DynamicSamplingContext.CreateFromBaggageHeader(baggage, replaySession); | ||
|
|
||
| public static DynamicSamplingContext CreateDynamicSamplingContext(this TransactionTracer transaction, SentryOptions options, IReplaySession? replaySession) | ||
| => DynamicSamplingContext.CreateFromTransaction(transaction, options, replaySession); | ||
|
|
||
| public static DynamicSamplingContext CreateDynamicSamplingContext(this SentryPropagationContext propagationContext, SentryOptions options, IReplaySession? replaySession) | ||
| => DynamicSamplingContext.CreateFromPropagationContext(propagationContext, options, replaySession); | ||
|
Comment on lines
+221
to
+228
There was a problem hiding this comment. Instead of adding replay to all the factories, how about we use just the There was a problem hiding this comment. for reference/example, in dart, updating from scope is done like this: https://github.com/getsentry/sentry-dart/blob/e401af3bfe7268f6ad94bbf592fc81525eda264b/dart/lib/src/sentry_baggage.dart#L96-L113 There was a problem hiding this comment. I'd rather avoid The other option would be to change All of this stuff is internal, so we can easily refactor in a separate PR whenever we like, if we want to go with a different coding style. |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| #if __ANDROID__ | ||
| using Sentry.Android.Extensions; | ||
| #endif | ||
|
|
||
| namespace Sentry.Internal; | ||
|
|
||
| internal interface IReplaySession | ||
Flash0ver marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| public SentryId? ActiveReplayId { get; } | ||
| } | ||
|
|
||
| internal class ReplaySession : IReplaySession | ||
| { | ||
| public static readonly IReplaySession Instance = new ReplaySession(); | ||
|
|
||
| private ReplaySession() | ||
| { | ||
| } | ||
|
|
||
| public SentryId? ActiveReplayId | ||
| { | ||
| get | ||
| { | ||
| #if __ANDROID__ | ||
| // Check to see if a Replay ID is available | ||
| var replayId = JavaSdk.ScopesAdapter.Instance?.Options?.ReplayController?.ReplayId?.ToSentryId(); | ||
| return (replayId is { } id && id != SentryId.Empty) ? id : null; | ||
| #else | ||
| return null; | ||
|
There was a problem hiding this comment. Is the idea to add iOS here later? potentially Web for example if we were brave enough? There was a problem hiding this comment. Yeah, I was planning for at least iOS... |
||
| #endif | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.