Rename gRPC instrumentation project (#1136)

* Rename project OpenTelemetry.Instrumentation.GrpcNetClient * Update GrpcNetClient README * Update AspNetCore instrumentation README with gRPC support * Update changelog and top-level readme * markdownlint * Fix project/file path references * Change namespace to GrpcNetClient Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
open-telemetry · Aug 22, 2020 · 0f618d0 · 0f618d0
1 parent 6377d6b
commit 0f618d0
Show file tree

Hide file tree

Showing 21 changed files with 63 additions and 53 deletions.
diff --git a/OpenTelemetry.sln b/OpenTelemetry.sln
@@ -144,7 +144,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentati
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.Http", "src\OpenTelemetry.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj", "{412C64D1-43D6-4E4C-8AD8-E20E63B415BD}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.Grpc", "src\OpenTelemetry.Instrumentation.Grpc\OpenTelemetry.Instrumentation.Grpc.csproj", "{0246BFC4-8AAF-45E1-A127-DB43D6E345BB}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.GrpcNetClient", "src\OpenTelemetry.Instrumentation.GrpcNetClient\OpenTelemetry.Instrumentation.GrpcNetClient.csproj", "{0246BFC4-8AAF-45E1-A127-DB43D6E345BB}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{7C87CAF9-79D7-4C26-9FFB-F3F1FB6911F1}"
 EndProject

diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/ma
 
 * [ASP.NET](./src/OpenTelemetry.Instrumentation.AspNet/README.md)
 * [ASP.NET Core](./src/OpenTelemetry.Instrumentation.AspNetCore/README.md)
-* [gRPC](./src/OpenTelemetry.Instrumentation.Grpc/README.md)
+* [Grpc.Net.Client](./src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md)
 * [HTTP](./src/OpenTelemetry.Instrumentation.Http/README.md)
 * [Redis client](./src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md)
 * [SQL client](./src/OpenTelemetry.Instrumentation.SqlClient/README.md)

diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs b/src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs
@@ -22,7 +22,7 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Features;
 using OpenTelemetry.Context.Propagation;
-using OpenTelemetry.Instrumentation.Grpc;
+using OpenTelemetry.Instrumentation.GrpcNetClient;
 using OpenTelemetry.Trace;
 
 namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation

diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/OpenTelemetry.Instrumentation.AspNetCore.csproj b/src/OpenTelemetry.Instrumentation.AspNetCore/OpenTelemetry.Instrumentation.AspNetCore.csproj
@@ -7,7 +7,7 @@
 
   <ItemGroup>
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Trace\SemanticConventions.cs" />
-    <Compile Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.Grpc\GrpcTagHelper.cs" />
+    <Compile Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.GrpcNetClient\GrpcTagHelper.cs" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/README.md b/src/OpenTelemetry.Instrumentation.AspNetCore/README.md
@@ -5,6 +5,8 @@
 
 Automatically instruments the incoming requests to [ASP.NET
 Core](https://docs.microsoft.com/en-us/aspnet/core).
+This includes incoming gRPC requests using
+[Grpc.AspNetCore](https://www.nuget.org/packages/Grpc.AspNetCore).
 
 ## Installation
 

diff --git a/src/OpenTelemetry.Instrumentation.Grpc/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.Grpc/CHANGELOG.md
diff --git a/src/OpenTelemetry.Instrumentation.Grpc/README.md b/src/OpenTelemetry.Instrumentation.Grpc/README.md
diff --git a/...etry.Instrumentation.Grpc/AssemblyInfo.cs → ...rumentation.GrpcNetClient/AssemblyInfo.cs b/...etry.Instrumentation.Grpc/AssemblyInfo.cs → ...rumentation.GrpcNetClient/AssemblyInfo.cs
diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md
@@ -0,0 +1,25 @@
+# Changelog
+
+## Unreleased
+
+* NuGet package renamed to OpenTelemetry.Instrumentation.GrpcNetClient to
+  more clearly indicate that this package is specifically for gRPC client
+  instrumentation. The package was previously named
+  OpenTelemetry.Instrumentation.Grpc.
+  ([#1136](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1136))
+* Grpc.Net.Client Instrumentation automatically populates HttpRequest in
+  Activity custom property
+  ([#1099](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1099))
+  ([#1128](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1128))
+
+## 0.4.0-beta.2
+
+Released 2020-07-24
+
+* First beta release
+
+## 0.3.0-beta
+
+Released 2020-07-23
+
+* Initial release
diff --git a/...ntation.Grpc/GrpcClientInstrumentation.cs → ...rpcNetClient/GrpcClientInstrumentation.cs b/...ntation.Grpc/GrpcClientInstrumentation.cs → ...rpcNetClient/GrpcClientInstrumentation.cs
@@ -14,10 +14,10 @@
 // limitations under the License.
 // </copyright>
 using System;
-using OpenTelemetry.Instrumentation.Grpc.Implementation;
+using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
 using OpenTelemetry.Trace;
 
-namespace OpenTelemetry.Instrumentation.Grpc
+namespace OpenTelemetry.Instrumentation.GrpcNetClient
 {
     /// <summary>
     /// GrpcClient instrumentation.

diff --git a/...try.Instrumentation.Grpc/GrpcTagHelper.cs → ...umentation.GrpcNetClient/GrpcTagHelper.cs b/...try.Instrumentation.Grpc/GrpcTagHelper.cs → ...umentation.GrpcNetClient/GrpcTagHelper.cs
@@ -18,7 +18,7 @@
 using System.Text.RegularExpressions;
 using OpenTelemetry.Trace;
 
-namespace OpenTelemetry.Instrumentation.Grpc
+namespace OpenTelemetry.Instrumentation.GrpcNetClient
 {
     internal static class GrpcTagHelper
     {

diff --git a/...mentation/GrpcClientDiagnosticListener.cs → ...mentation/GrpcClientDiagnosticListener.cs b/...mentation/GrpcClientDiagnosticListener.cs → ...mentation/GrpcClientDiagnosticListener.cs
@@ -18,7 +18,7 @@
 using System.Net.Http;
 using OpenTelemetry.Trace;
 
-namespace OpenTelemetry.Instrumentation.Grpc.Implementation
+namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
 {
     internal class GrpcClientDiagnosticListener : ListenerHandler
     {

diff --git a/...ntation/GrpcInstrumentationEventSource.cs → ...ntation/GrpcInstrumentationEventSource.cs b/...ntation/GrpcInstrumentationEventSource.cs → ...ntation/GrpcInstrumentationEventSource.cs
@@ -16,7 +16,7 @@
 
 using System.Diagnostics.Tracing;
 
-namespace OpenTelemetry.Instrumentation.Grpc.Implementation
+namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
 {
     /// <summary>
     /// EventSource events emitted from the project.

diff --git a/...on.Grpc/Implementation/PropertyFetcher.cs → ...tClient/Implementation/PropertyFetcher.cs b/...on.Grpc/Implementation/PropertyFetcher.cs → ...tClient/Implementation/PropertyFetcher.cs
@@ -17,7 +17,7 @@
 using System.Linq;
 using System.Reflection;
 
-namespace OpenTelemetry.Instrumentation.Grpc.Implementation
+namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
 {
     internal class PropertyFetcher
     {

diff --git a/...OpenTelemetry.Instrumentation.Grpc.csproj → ...etry.Instrumentation.GrpcNetClient.csproj b/...OpenTelemetry.Instrumentation.Grpc.csproj → ...etry.Instrumentation.GrpcNetClient.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netstandard2.1</TargetFrameworks>
-    <Description>gRPC client instrumentation for OpenTelemetry .NET</Description>
+    <Description>gRPC for .NET client instrumentation for OpenTelemetry .NET</Description>
     <PackageTags>$(PackageTags);distributed-tracing</PackageTags>
   </PropertyGroup>
 

diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md
@@ -0,0 +1,18 @@
+# OpenTelemetry.Instrumentation.GrpcNetClient
+
+[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.Instrumentation.GrpcNetClient.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.GrpcNetClient)
+[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Instrumentation.GrpcNetClient.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.GrpcNetClient)
+
+Automatically instruments the outgoing requests from
+[Grpc.Net.Client](https://www.nuget.org/packages/Grpc.Net.Client).
+
+## Installation
+
+```shell
+dotnet add package OpenTelemetry.Instrumentation.GrpcNetClient
+```
+
+## References
+
+* [gRPC for .NET](https://github.com/grpc/grpc-dotnet)
+* [OpenTelemetry Project](https://opentelemetry.io/)
diff --git a/...n.Grpc/TracerProviderBuilderExtensions.cs → ...Client/TracerProviderBuilderExtensions.cs b/...n.Grpc/TracerProviderBuilderExtensions.cs → ...Client/TracerProviderBuilderExtensions.cs
@@ -15,7 +15,7 @@
 // </copyright>
 
 using System;
-using OpenTelemetry.Instrumentation.Grpc;
+using OpenTelemetry.Instrumentation.GrpcNetClient;
 
 namespace OpenTelemetry.Trace
 {

diff --git a/test/OpenTelemetry.Instrumentation.Grpc.Tests/EventSourceTest.cs b/test/OpenTelemetry.Instrumentation.Grpc.Tests/EventSourceTest.cs
@@ -14,7 +14,7 @@
 // limitations under the License.
 // </copyright>
 
-using OpenTelemetry.Instrumentation.Grpc.Implementation;
+using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
 using OpenTelemetry.Tests;
 using Xunit;
 

diff --git a/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTagHelperTests.cs b/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTagHelperTests.cs
@@ -14,11 +14,11 @@
 // limitations under the License.
 // </copyright>
 using System.Diagnostics;
-using OpenTelemetry.Instrumentation.Grpc;
+using OpenTelemetry.Instrumentation.GrpcNetClient;
 using OpenTelemetry.Trace;
 using Xunit;
 
-namespace OpenTelemetry.Instrumentation.GrpcClient.Tests
+namespace OpenTelemetry.Instrumentation.Grpc.Tests
 {
     public class GrpcTagHelperTests
     {

diff --git a/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs b/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs
@@ -20,8 +20,8 @@
 using Greet;
 using Grpc.Net.Client;
 using Moq;
-using OpenTelemetry.Instrumentation.Grpc.Implementation;
 using OpenTelemetry.Instrumentation.Grpc.Tests.Services;
+using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
 using OpenTelemetry.Trace;
 using Xunit;
 

diff --git a/.../OpenTelemetry.Instrumentation.Grpc.Tests/OpenTelemetry.Instrumentation.Grpc.Tests.csproj b/.../OpenTelemetry.Instrumentation.Grpc.Tests/OpenTelemetry.Instrumentation.Grpc.Tests.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Description>Unit test project for OpenTelemetry GrpcClient instrumentation</Description>
+    <Description>Unit test project for OpenTelemetry Grpc for .NET instrumentation</Description>
     <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
   </PropertyGroup>
 
@@ -26,7 +26,7 @@
 
   <ItemGroup>
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.AspNetCore\OpenTelemetry.Instrumentation.AspNetCore.csproj" />
-    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.Grpc\OpenTelemetry.Instrumentation.Grpc.csproj" />
+    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.GrpcNetClient\OpenTelemetry.Instrumentation.GrpcNetClient.csproj" />
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj" />
     <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry\OpenTelemetry.csproj" />
     <Compile Include="$(RepoRoot)\test\OpenTelemetry.Tests\Shared\EventSourceTestHelper.cs" Link="EventSourceTestHelper.cs" />