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

Optimize gRPC client instrumentation for suppress instrumentation #1904

Merged
merged 2 commits into from
Mar 13, 2021
Merged

Optimize gRPC client instrumentation for suppress instrumentation #1904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69ec569
Optimize gRPC client instrumentation for SuppressInstrumentation
utpilla Mar 12, 2021
5495bde
Udated unit tests
utpilla Mar 12, 2021
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
28 changes: 22 additions & 6 deletions ...penTelemetry.Instrumentation.GrpcNetClient/Implementation/GrpcClientDiagnosticListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,22 @@ public GrpcClientDiagnosticListener(GrpcClientInstrumentationOptions options)

public override void OnStartActivity(Activity activity, object payload)
{
// The overall flow of what GrpcClient library does is as below:
// Activity.Start()
// DiagnosticSource.WriteEvent("Start", payload)
// DiagnosticSource.WriteEvent("Stop", payload)
// Activity.Stop()

// This method is in the WriteEvent("Start", payload) path.
// By this time, samplers have already run and
// activity.IsAllDataRequested populated accordingly.

if (Sdk.SuppressInstrumentation)
{
return;
}

// Ensure context propagation irrespective of sampling decision
if (!this.startRequestFetcher.TryFetch(payload, out HttpRequestMessage request) || request == null)
{
GrpcInstrumentationEventSource.Log.NullPayload(nameof(GrpcClientDiagnosticListener), nameof(this.OnStartActivity));
Expand Down Expand Up @@ -78,15 +94,15 @@ public override void OnStartActivity(Activity activity, object payload)
HttpRequestMessageContextPropagation.HeaderValueSetter);
}

var grpcMethod = GrpcTagHelper.GetGrpcMethodFromActivity(activity);
if (activity.IsAllDataRequested)
{
ActivityInstrumentationHelper.SetActivitySourceProperty(activity, ActivitySource);
ActivityInstrumentationHelper.SetKindProperty(activity, ActivityKind.Client);

activity.DisplayName = grpcMethod?.Trim('/');
var grpcMethod = GrpcTagHelper.GetGrpcMethodFromActivity(activity);

ActivityInstrumentationHelper.SetActivitySourceProperty(activity, ActivitySource);
ActivityInstrumentationHelper.SetKindProperty(activity, ActivityKind.Client);
activity.DisplayName = grpcMethod?.Trim('/');

if (activity.IsAllDataRequested)
{
activity.SetTag(SemanticConventions.AttributeRpcSystem, GrpcTagHelper.RpcSystemGrpc);

if (GrpcTagHelper.TryParseRpcServiceAndRpcMethod(grpcMethod, out var rpcService, out var rpcMethod))
Expand Down
6 changes: 6 additions & 0 deletions test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
using Microsoft.AspNetCore.Http;
using Moq;
using OpenTelemetry.Instrumentation.GrpcNetClient;
using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
using OpenTelemetry.Trace;
using Xunit;

Expand Down Expand Up @@ -143,6 +144,7 @@ public void GrpcAndHttpClientInstrumentationIsInvoked(bool shouldEnrich)

ValidateGrpcActivity(grpcSpan);
Assert.Equal($"greet.Greeter/SayHello", grpcSpan.DisplayName);
Assert.Equal(0, grpcSpan.GetTagValue(SemanticConventions.AttributeRpcGrpcStatusCode));
Assert.Equal($"HTTP POST", httpSpan.DisplayName);
Assert.Equal(grpcSpan.SpanId, httpSpan.ParentSpanId);
}
Expand Down Expand Up @@ -274,6 +276,7 @@ public void GrpcPropagatesContextWithSuppressInstrumentation()
Assert.Equal($"greet.Greeter/SayHello", serverActivity.DisplayName);
Assert.Equal(clientActivity.TraceId, serverActivity.TraceId);
Assert.Equal(clientActivity.SpanId, serverActivity.ParentSpanId);
Assert.Equal(0, clientActivity.GetTagValue(SemanticConventions.AttributeRpcGrpcStatusCode));
Assert.Contains("item1=value1", serverActivity.GetCustomProperty("BaggageString") as string);
}

Expand All @@ -286,11 +289,14 @@ public void Grpc_BadArgs()

private static void ValidateGrpcActivity(Activity activityToValidate)
{
Assert.Equal(GrpcClientDiagnosticListener.ActivitySourceName, activityToValidate.Source.Name);
Assert.Equal(GrpcClientDiagnosticListener.Version.ToString(), activityToValidate.Source.Version);
Assert.Equal(ActivityKind.Client, activityToValidate.Kind);
}

private static void ActivityEnrichment(Activity activity, string method, object obj)
{
Assert.True(activity.IsAllDataRequested);
switch (method)
{
case "OnStartActivity":
Expand Down