Add gRPC attributes for ASP.NET Core

OpenTelemetry.sln

@@ -129,7 +129,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{D2E73927-5
 		test\Directory.Build.targets = test\Directory.Build.targets
 	EndProjectSection
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.GrpcClient.Tests", "test\OpenTelemetry.Instrumentation.GrpcClient.Tests\OpenTelemetry.Instrumentation.GrpcClient.Tests.csproj", "{305E9DFD-E73B-4A28-8769-795C25551020}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.Grpc.Tests", "test\OpenTelemetry.Instrumentation.Grpc.Tests\OpenTelemetry.Instrumentation.Grpc.Tests.csproj", "{305E9DFD-E73B-4A28-8769-795C25551020}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TestApp.AspNetCore.2.1", "test\TestApp.AspNetCore.2.1\TestApp.AspNetCore.2.1.csproj", "{7CDA3F85-EA6F-45C4-B432-2559303355D4}"
 EndProject

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs

@@ -22,6 +22,7 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Features;
 using OpenTelemetry.Context.Propagation;
+using OpenTelemetry.Instrumentation.Grpc;
 using OpenTelemetry.Trace;
 
 namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation
@@ -131,8 +132,15 @@ public override void OnStopActivity(Activity activity, object payload)
                 var response = context.Response;
                 activity.SetTag(SemanticConventions.AttributeHttpStatusCode, response.StatusCode.ToString());
 
-                Status status = SpanHelper.ResolveSpanStatusForHttpStatusCode(response.StatusCode);
-                activity.SetStatus(status.WithDescription(response.HttpContext.Features.Get<IHttpResponseFeature>()?.ReasonPhrase));
+                if (this.TryGetGrpcMethod(activity, out var grpcMethod))
+                {
+                    this.AddGrpcAttributes(activity, grpcMethod, context);
+                }
+                else
+                {
+                    Status status = SpanHelper.ResolveSpanStatusForHttpStatusCode(response.StatusCode);
+                    activity.SetStatus(status.WithDescription(response.HttpContext.Features.Get<IHttpResponseFeature>()?.ReasonPhrase));
+                }
             }
 
             if (activity.OperationName.Equals(ActivityNameByHttpInListener))
@@ -219,5 +227,30 @@ private static string GetUri(HttpRequest request)
 
             return builder.ToString();
         }
+
+        private bool TryGetGrpcMethod(Activity activity, out string grpcMethod)
+        {
+            grpcMethod = GrpcTagHelper.GetGrpcMethodFromActivity(activity);
+            return !string.IsNullOrEmpty(grpcMethod);
+        }
+
+        private void AddGrpcAttributes(Activity activity, string grpcMethod, HttpContext context)
+        {
+            // TODO: Should the leading slash be trimmed? Spec seems to suggest no leading slash: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/rpc.md#span-name
+            // Client instrumentation is trimming the leading slash. Whatever we decide here, should we apply the same to the client side?
+            // activity.DisplayName = grpcMethod?.Trim('/');
+
+            activity.AddTag(SemanticConventions.AttributeRpcSystem, GrpcTagHelper.RpcSystemGrpc);
+
+            if (GrpcTagHelper.TryParseRpcServiceAndRpcMethod(grpcMethod, out var rpcService, out var rpcMethod))
+            {
+                activity.AddTag(SemanticConventions.AttributeRpcService, rpcService);
+                activity.AddTag(SemanticConventions.AttributeRpcMethod, rpcMethod);
+            }
+
+            activity.AddTag(SemanticConventions.AttributeNetPeerIp, context.Connection.RemoteIpAddress.ToString());
+            activity.AddTag(SemanticConventions.AttributeNetPeerPort, context.Connection.RemotePort.ToString());
+            activity.SetStatus(GrpcTagHelper.GetGrpcStatusCodeFromActivity(activity));
+        }
     }
 }

src/OpenTelemetry.Instrumentation.AspNetCore/OpenTelemetry.Instrumentation.AspNetCore.csproj

@@ -7,6 +7,7 @@
 
   <ItemGroup>
     <Compile Include="..\OpenTelemetry.Api\Trace\SemanticConventions.cs" />
+    <Compile Include="..\OpenTelemetry.Instrumentation.Grpc\GrpcTagHelper.cs" />
   </ItemGroup>
 
   <ItemGroup>

src/OpenTelemetry.Instrumentation.Grpc/AssemblyInfo.cs

@@ -17,7 +17,7 @@
 using System.Runtime.CompilerServices;
 
 #if SIGNED
-[assembly: InternalsVisibleTo("OpenTelemetry.Instrumentation.GrpcClient.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010051c1562a090fb0c9f391012a32198b5e5d9a60e9b80fa2d7b434c9e5ccb7259bd606e66f9660676afc6692b8cdc6793d190904551d2103b7b22fa636dcbb8208839785ba402ea08fc00c8f1500ccef28bbf599aa64ffb1e1d5dc1bf3420a3777badfe697856e9d52070a50c3ea5821c80bef17ca3acffa28f89dd413f096f898")]
+[assembly: InternalsVisibleTo("OpenTelemetry.Instrumentation.Grpc.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010051c1562a090fb0c9f391012a32198b5e5d9a60e9b80fa2d7b434c9e5ccb7259bd606e66f9660676afc6692b8cdc6793d190904551d2103b7b22fa636dcbb8208839785ba402ea08fc00c8f1500ccef28bbf599aa64ffb1e1d5dc1bf3420a3777badfe697856e9d52070a50c3ea5821c80bef17ca3acffa28f89dd413f096f898")]
 #else
-[assembly: InternalsVisibleTo("OpenTelemetry.Instrumentation.GrpcClient.Tests")]
+[assembly: InternalsVisibleTo("OpenTelemetry.Instrumentation.Grpc.Tests")]
 #endif

src/OpenTelemetry.Instrumentation.Grpc/GrpcTagHelper.cs

@@ -22,6 +22,8 @@ namespace OpenTelemetry.Instrumentation.Grpc
 {
     internal static class GrpcTagHelper
     {
+        public const string RpcSystemGrpc = "grpc";
+
         // The Grpc.Net.Client library adds its own tags to the activity.
         // These tags are used to source the tags added by the OpenTelemetry instrumentation.
         public const string GrpcMethodTagName = "grpc.method";

src/OpenTelemetry.Instrumentation.Grpc/Implementation/GrpcClientDiagnosticListener.cs

@@ -53,7 +53,7 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetTag(SemanticConventions.AttributeRpcSystem, "grpc");
+                activity.SetTag(SemanticConventions.AttributeRpcSystem, GrpcTagHelper.RpcSystemGrpc);
 
                 if (GrpcTagHelper.TryParseRpcServiceAndRpcMethod(grpcMethod, out var rpcService, out var rpcMethod))
                 {

test/OpenTelemetry.Instrumentation.GrpcClient.Tests/GrpcFixture.cs → test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcFixture.cs

@@ -19,8 +19,10 @@
 using Microsoft.AspNetCore.Server.Kestrel.Core;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Moq;
+using OpenTelemetry.Trace;
 
-namespace OpenTelemetry.Instrumentation.GrpcClient.Tests
+namespace OpenTelemetry.Instrumentation.Grpc.Tests
 {
     public class GrpcFixture<TService> : IDisposable
         where TService : class
@@ -29,8 +31,14 @@ public class GrpcFixture<TService> : IDisposable
 
         private readonly IHost host;
 
+        private TracerProvider openTelemetrySdk = null;
+
         public GrpcFixture()
         {
+            // Allows gRPC client to call insecure gRPC services
+            // https://docs.microsoft.com/en-us/aspnet/core/grpc/troubleshoot?view=aspnetcore-3.1#call-insecure-grpc-services-with-net-core-client
+            AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
+
             this.Port = 0;
 
             var retryCount = 5;
@@ -53,10 +61,13 @@ public GrpcFixture()
 
         public int Port { get; }
 
+        public Mock<ActivityProcessor> GrpcServerSpanProcessor { get; } = new Mock<ActivityProcessor>();
+
         public void Dispose()
         {
             this.host.StopAsync(TimeSpan.FromSeconds(5)).GetAwaiter().GetResult();
             this.host.Dispose();
+            this.openTelemetrySdk.Dispose();
         }
 
         private IHost CreateServer()
@@ -70,6 +81,14 @@ private IHost CreateServer()
                             // Setup a HTTP/2 endpoint without TLS.
                             options.ListenLocalhost(this.Port, o => o.Protocols = HttpProtocols.Http2);
                         })
+                        .ConfigureServices(serviceCollection =>
+                        {
+                            this.openTelemetrySdk = Sdk
+                                .CreateTracerProvider(
+                                    (builder) => builder
+                                        .AddAspNetCoreInstrumentation()
+                                        .AddProcessorPipeline(p => p.AddProcessor(n => this.GrpcServerSpanProcessor.Object)));
+                        })
                         .UseStartup<Startup>();
                 });
 

test/OpenTelemetry.Instrumentation.GrpcClient.Tests/GrpcClientTests.cs → test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs

@@ -1,4 +1,4 @@
-// <copyright file="GrpcClientTests.cs" company="OpenTelemetry Authors">
+// <copyright file="GrpcTests.client.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,27 +19,14 @@
 using Greet;
 using Grpc.Net.Client;
 using Moq;
-using OpenTelemetry.Instrumentation.GrpcClient.Tests.Services;
+using OpenTelemetry.Instrumentation.Grpc.Tests.Services;
 using OpenTelemetry.Trace;
 using Xunit;
 
-namespace OpenTelemetry.Instrumentation.GrpcClient.Tests
+namespace OpenTelemetry.Instrumentation.Grpc.Tests
 {
-    public class GrpcClientTests : IClassFixture<GrpcFixture<GreeterService>>
+    public partial class GrpcTests : IClassFixture<GrpcFixture<GreeterService>>
     {
-        private GrpcFixture<GreeterService> fixture;
-
-        public GrpcClientTests(GrpcFixture<GreeterService> fixture)
-        {
-            // Allows gRPC client to call insecure gRPC services
-            // https://docs.microsoft.com/en-us/aspnet/core/grpc/troubleshoot?view=aspnetcore-3.1#call-insecure-grpc-services-with-net-core-client
-            AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
-
-            Activity.DefaultIdFormat = ActivityIdFormat.W3C;
-
-            this.fixture = fixture;
-        }
-
         [Theory]
         [InlineData("http://localhost")]
         [InlineData("http://127.0.0.1")]
@@ -76,23 +63,23 @@ public void GrpcClientCallsAreCollectedSuccessfully(string baseAddress)
 
             Assert.Equal($"greet.Greeter/SayHello", span.DisplayName);
             Assert.Equal("Client", span.Kind.ToString());
-            Assert.Equal("grpc", span.Tags.FirstOrDefault(i => i.Key == "rpc.system").Value);
-            Assert.Equal("greet.Greeter", span.Tags.FirstOrDefault(i => i.Key == "rpc.service").Value);
-            Assert.Equal("SayHello", span.Tags.FirstOrDefault(i => i.Key == "rpc.method").Value);
+            Assert.Equal("grpc", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeRpcSystem).Value);
+            Assert.Equal("greet.Greeter", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeRpcService).Value);
+            Assert.Equal("SayHello", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeRpcMethod).Value);
 
             if (uriHostNameType == UriHostNameType.IPv4 || uriHostNameType == UriHostNameType.IPv6)
             {
-                Assert.Equal(uri.Host, span.Tags.FirstOrDefault(i => i.Key == "net.peer.ip").Value);
-                Assert.Null(span.Tags.FirstOrDefault(i => i.Key == "net.peer.name").Value);
+                Assert.Equal(uri.Host, span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerIp).Value);
+                Assert.Null(span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerName).Value);
             }
             else
             {
-                Assert.Null(span.Tags.FirstOrDefault(i => i.Key == "net.peer.ip").Value);
-                Assert.Equal(uri.Host, span.Tags.FirstOrDefault(i => i.Key == "net.peer.name").Value);
+                Assert.Null(span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerIp).Value);
+                Assert.Equal(uri.Host, span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerName).Value);
             }
 
-            Assert.Equal(uri.Port.ToString(), span.Tags.FirstOrDefault(i => i.Key == "net.peer.port").Value);
-            Assert.Equal("Ok", span.Tags.FirstOrDefault(i => i.Key == SpanAttributeConstants.StatusCodeKey).Value);
+            Assert.Equal(uri.Port.ToString(), span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerPort).Value);
+            Assert.Equal(Status.Ok, span.GetStatus());
             Assert.Equal(expectedResource, span.GetResource());
         }
 

test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.server.cs

@@ -0,0 +1,89 @@
+// <copyright file="GrpcTests.server.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+using System;
+using System.Diagnostics;
+using System.Linq;
+using System.Net;
+using System.Threading;
+using Greet;
+using Grpc.Net.Client;
+using Moq;
+using OpenTelemetry.Instrumentation.Grpc.Tests.Services;
+using OpenTelemetry.Trace;
+using Xunit;
+
+namespace OpenTelemetry.Instrumentation.Grpc.Tests
+{
+    public partial class GrpcTests : IClassFixture<GrpcFixture<GreeterService>>
+    {
+        private GrpcFixture<GreeterService> fixture;
+
+        public GrpcTests(GrpcFixture<GreeterService> fixture)
+        {
+            this.fixture = fixture;
+        }
+
+        [Fact]
+        public void GrpcAspNetCoreInstrumentationAddsCorrectAttributes()
+        {
+            var clientLoopbackAddresses = new[] { IPAddress.Loopback.ToString(), IPAddress.IPv6Loopback.ToString() };
+            var uri = new Uri($"http://localhost:{this.fixture.Port}");
+            var spanProcessor = this.fixture.GrpcServerSpanProcessor;
+
+            var channel = GrpcChannel.ForAddress(uri);
+            var client = new Greeter.GreeterClient(channel);
+            var rs = client.SayHello(new HelloRequest());
+
+            WaitForProcessorInvocations(spanProcessor, 2);
+
+            Assert.Equal(2, spanProcessor.Invocations.Count); // begin and end was called
+            var span = (Activity)spanProcessor.Invocations[1].Arguments[0];
+
+            Assert.Equal(ActivityKind.Server, span.Kind);
+            Assert.Equal("grpc", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeRpcSystem).Value);
+            Assert.Equal("greet.Greeter", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeRpcService).Value);
+            Assert.Equal("SayHello", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeRpcMethod).Value);
+            Assert.Contains(span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerIp).Value, clientLoopbackAddresses);
+            Assert.True(!string.IsNullOrEmpty(span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeNetPeerPort).Value));
+            Assert.Equal(Status.Ok, span.GetStatus());
+
+            // The following are http.* attributes that are also included on the span for the gRPC invocation.
+            Assert.Equal($"localhost:{this.fixture.Port}", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeHttpHost).Value);
+            Assert.Equal("POST", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeHttpMethod).Value);
+            Assert.Equal("/greet.Greeter/SayHello", span.Tags.FirstOrDefault(i => i.Key == SpanAttributeConstants.HttpPathKey).Value);
+            Assert.Equal($"http://localhost:{this.fixture.Port}/greet.Greeter/SayHello", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeHttpUrl).Value);
+            Assert.StartsWith("grpc-dotnet", span.Tags.FirstOrDefault(i => i.Key == SemanticConventions.AttributeHttpUserAgent).Value);
+
+            // This attribute is added by the gRPC for .NET library. There is a discussion of having the OTel instrumentation remove it.
+            // See: https://github.com/open-telemetry/opentelemetry-dotnet/issues/482#issuecomment-655753756
+            Assert.Equal($"0", span.Tags.FirstOrDefault(i => i.Key == "grpc.status_code").Value);
+        }
+
+        private static void WaitForProcessorInvocations(Mock<ActivityProcessor> spanProcessor, int invocationCount)
+        {
+            // We need to let End callback execute as it is executed AFTER response was returned.
+            // In unit tests environment there may be a lot of parallel unit tests executed, so
+            // giving some breezing room for the End callback to complete
+            Assert.True(SpinWait.SpinUntil(
+                () =>
+                {
+                    Thread.Sleep(10);
+                    return spanProcessor.Invocations.Count >= invocationCount;
+                },
+                TimeSpan.FromSeconds(1)));
+        }
+    }
+}

test/OpenTelemetry.Instrumentation.GrpcClient.Tests/OpenTelemetry.Instrumentation.GrpcClient.Tests.csproj → test/OpenTelemetry.Instrumentation.Grpc.Tests/OpenTelemetry.Instrumentation.Grpc.Tests.csproj

@@ -25,6 +25,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\OpenTelemetry.Instrumentation.AspNetCore\OpenTelemetry.Instrumentation.AspNetCore.csproj" />
     <ProjectReference Include="..\..\src\OpenTelemetry.Instrumentation.Grpc\OpenTelemetry.Instrumentation.Grpc.csproj" />
     <ProjectReference Include="..\..\src\OpenTelemetry.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj" />
     <ProjectReference Include="..\..\src\OpenTelemetry\OpenTelemetry.csproj" />

test/OpenTelemetry.Instrumentation.GrpcClient.Tests/Services/GreeterService.cs → test/OpenTelemetry.Instrumentation.Grpc.Tests/Services/GreeterService.cs

@@ -18,7 +18,7 @@
 using Grpc.Core;
 using Microsoft.Extensions.Logging;
 
-namespace OpenTelemetry.Instrumentation.GrpcClient.Tests.Services
+namespace OpenTelemetry.Instrumentation.Grpc.Tests.Services
 {
     public class GreeterService : Greeter.GreeterBase
     {