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.

Sign up for GitHub

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

Add isRemote check for context propagation #3329

Merged
merged 13 commits into from
Jun 6, 2022
Merged

Add isRemote check for context propagation #3329

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f9d423b
Add isRemote chekc for context propagation
Jun 2, 2022
de0573f
update changelog
Jun 2, 2022
ea48192
Merge branch 'main' into vibankwa/3315
Jun 2, 2022
523decb
Merge branch 'main' into vibankwa/3315
vishweshbankwar Jun 2, 2022
95c59d1
resolve pr comments
Jun 2, 2022
196ad18
Merge branch 'vibankwa/3315' of https://github.com/vishweshbankwar/op…
Jun 2, 2022
43f8de6
reword chagelog
Jun 2, 2022
c7b7161
Merge branch 'main' into vibankwa/3315
vishweshbankwar Jun 2, 2022
3194863
Merge branch 'main' into vibankwa/3315
Jun 3, 2022
594bf0d
Merge branch 'vibankwa/3315' of https://github.com/vishweshbankwar/op…
Jun 3, 2022
3615b7b
Merge branch 'main' into vibankwa/3315
Jun 4, 2022
c9880cc
refactor for minor perf
Jun 6, 2022
fb2d5a6
minor
Jun 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/OpenTelemetry/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

* Included `isRemote` check in `PropagateOrIgnoreData` in `TracerProviderSDK` to
Copy link
Member

Choose a reason for hiding this comment

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

TracerProvider modified to create activity irrespective of SamplingResult, for spans with Remote Parent, to maintain context propagation.

^ or similar wording.

ensure context propagation in case of a remote parent.
([#3329](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3329))

## 1.3.0-rc.2

Released 2022-June-1
Expand Down
8 changes: 4 additions & 4 deletions src/OpenTelemetry/Trace/TracerProviderSdk.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ internal TracerProviderSdk(
else if (sampler is AlwaysOffSampler)
{
listener.Sample = (ref ActivityCreationOptions<ActivityContext> options) =>
!Sdk.SuppressInstrumentation ? PropagateOrIgnoreData(options.Parent.TraceId) : ActivitySamplingResult.None;
!Sdk.SuppressInstrumentation ? PropagateOrIgnoreData(options.Parent.TraceId, options.Parent.IsRemote) : ActivitySamplingResult.None;
this.getRequestedDataAction = this.RunGetRequestedDataAlwaysOffSampler;
}
else
Expand Down Expand Up @@ -393,13 +393,13 @@ private static ActivitySamplingResult ComputeActivitySamplingResult(
return activitySamplingResult;
}

return PropagateOrIgnoreData(options.Parent.TraceId);
return PropagateOrIgnoreData(options.Parent.TraceId, options.Parent.IsRemote);
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static ActivitySamplingResult PropagateOrIgnoreData(ActivityTraceId traceId)
private static ActivitySamplingResult PropagateOrIgnoreData(ActivityTraceId traceId, bool isParentRemote)
Copy link
Contributor

Choose a reason for hiding this comment

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

We could probably explore updating the method signature here to something like this:
private static ActivitySamplingResult PropagateOrIgnoreData(in ActivityContext parentContext) and pass in options.Parent to this method. ActivityContext is a readonly struct so using the in modifier might give some minor perf gains.

Copy link
Member Author

Choose a reason for hiding this comment

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

Minor:

Method Mean Error StdDev
WithoutInParam 716.8 ns 12.69 ns 11.87 ns
WithInparam 676.5 ns 7.27 ns 6.44 ns

I have updated the method signature

{
var isRootSpan = traceId == default;
var isRootSpan = traceId == default || isParentRemote;
Copy link
Member

Choose a reason for hiding this comment

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

This is semantically buggy, I guess?

Maybe:

var isRootSpan = traceId == default;

return isRootSpan || isParentRemote
    ? ...


// If it is the root span select PropagationData so the trace ID is preserved
// even if no activity of the trace is recorded (sampled per OpenTelemetry parlance).
Expand Down
2 changes: 1 addition & 1 deletion test/OpenTelemetry.Tests/Trace/TracerProviderSdkTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ public void TracerProviderSdkSamplerAttributesAreAppliedToActivity(SamplingDecis
}
}

[Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/3315")]
[Fact]
public void TracerSdkSetsActivitySamplingResultAsPropagationWhenParentIsRemote()
{
var testSampler = new TestSampler();
Expand Down