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>
This commit is contained in:
Alan West 2020-08-21 21:35:19 -07:00 committed by GitHub
parent 6377d6bd87
commit 0f618d001d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 63 additions and 53 deletions

View File

@ -144,7 +144,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentati
EndProject EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.Http", "src\OpenTelemetry.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj", "{412C64D1-43D6-4E4C-8AD8-E20E63B415BD}" Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.Http", "src\OpenTelemetry.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj", "{412C64D1-43D6-4E4C-8AD8-E20E63B415BD}"
EndProject 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 EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{7C87CAF9-79D7-4C26-9FFB-F3F1FB6911F1}" Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{7C87CAF9-79D7-4C26-9FFB-F3F1FB6911F1}"
EndProject EndProject

View File

@ -31,7 +31,7 @@ libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/ma
* [ASP.NET](./src/OpenTelemetry.Instrumentation.AspNet/README.md) * [ASP.NET](./src/OpenTelemetry.Instrumentation.AspNet/README.md)
* [ASP.NET Core](./src/OpenTelemetry.Instrumentation.AspNetCore/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) * [HTTP](./src/OpenTelemetry.Instrumentation.Http/README.md)
* [Redis client](./src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md) * [Redis client](./src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md)
* [SQL client](./src/OpenTelemetry.Instrumentation.SqlClient/README.md) * [SQL client](./src/OpenTelemetry.Instrumentation.SqlClient/README.md)

View File

@ -22,7 +22,7 @@ using System.Text;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Features; using Microsoft.AspNetCore.Http.Features;
using OpenTelemetry.Context.Propagation; using OpenTelemetry.Context.Propagation;
using OpenTelemetry.Instrumentation.Grpc; using OpenTelemetry.Instrumentation.GrpcNetClient;
using OpenTelemetry.Trace; using OpenTelemetry.Trace;
namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation

View File

@ -7,7 +7,7 @@
<ItemGroup> <ItemGroup>
<Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Trace\SemanticConventions.cs" /> <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>
<ItemGroup> <ItemGroup>

View File

@ -5,6 +5,8 @@
Automatically instruments the incoming requests to [ASP.NET Automatically instruments the incoming requests to [ASP.NET
Core](https://docs.microsoft.com/en-us/aspnet/core). 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 ## Installation

View File

@ -1,20 +0,0 @@
# Changelog
## Unreleased
* Grpc 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

View File

@ -1,15 +0,0 @@
# OpenTelemetry.Instrumentation.Grpc
[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.Instrumentation.Grpc.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Grpc)
[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Instrumentation.Grpc.svg)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Grpc)
## Installation
```shell
dotnet add package OpenTelemetry.Instrumentation.Grpc
```
## References
* [gRPC for .NET](https://github.com/grpc/grpc-dotnet)
* [OpenTelemetry Project](https://opentelemetry.io/)

View File

@ -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

View File

@ -14,10 +14,10 @@
// limitations under the License. // limitations under the License.
// </copyright> // </copyright>
using System; using System;
using OpenTelemetry.Instrumentation.Grpc.Implementation; using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
using OpenTelemetry.Trace; using OpenTelemetry.Trace;
namespace OpenTelemetry.Instrumentation.Grpc namespace OpenTelemetry.Instrumentation.GrpcNetClient
{ {
/// <summary> /// <summary>
/// GrpcClient instrumentation. /// GrpcClient instrumentation.

View File

@ -18,7 +18,7 @@ using System.Linq;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
using OpenTelemetry.Trace; using OpenTelemetry.Trace;
namespace OpenTelemetry.Instrumentation.Grpc namespace OpenTelemetry.Instrumentation.GrpcNetClient
{ {
internal static class GrpcTagHelper internal static class GrpcTagHelper
{ {

View File

@ -18,7 +18,7 @@ using System.Diagnostics;
using System.Net.Http; using System.Net.Http;
using OpenTelemetry.Trace; using OpenTelemetry.Trace;
namespace OpenTelemetry.Instrumentation.Grpc.Implementation namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
{ {
internal class GrpcClientDiagnosticListener : ListenerHandler internal class GrpcClientDiagnosticListener : ListenerHandler
{ {

View File

@ -16,7 +16,7 @@
using System.Diagnostics.Tracing; using System.Diagnostics.Tracing;
namespace OpenTelemetry.Instrumentation.Grpc.Implementation namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
{ {
/// <summary> /// <summary>
/// EventSource events emitted from the project. /// EventSource events emitted from the project.

View File

@ -17,7 +17,7 @@ using System;
using System.Linq; using System.Linq;
using System.Reflection; using System.Reflection;
namespace OpenTelemetry.Instrumentation.Grpc.Implementation namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
{ {
internal class PropertyFetcher internal class PropertyFetcher
{ {

View File

@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFrameworks>netstandard2.1</TargetFrameworks> <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> <PackageTags>$(PackageTags);distributed-tracing</PackageTags>
</PropertyGroup> </PropertyGroup>

View File

@ -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/)

View File

@ -15,7 +15,7 @@
// </copyright> // </copyright>
using System; using System;
using OpenTelemetry.Instrumentation.Grpc; using OpenTelemetry.Instrumentation.GrpcNetClient;
namespace OpenTelemetry.Trace namespace OpenTelemetry.Trace
{ {

View File

@ -14,7 +14,7 @@
// limitations under the License. // limitations under the License.
// </copyright> // </copyright>
using OpenTelemetry.Instrumentation.Grpc.Implementation; using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
using OpenTelemetry.Tests; using OpenTelemetry.Tests;
using Xunit; using Xunit;

View File

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

View File

@ -20,8 +20,8 @@ using System.Net.Http;
using Greet; using Greet;
using Grpc.Net.Client; using Grpc.Net.Client;
using Moq; using Moq;
using OpenTelemetry.Instrumentation.Grpc.Implementation;
using OpenTelemetry.Instrumentation.Grpc.Tests.Services; using OpenTelemetry.Instrumentation.Grpc.Tests.Services;
using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
using OpenTelemetry.Trace; using OpenTelemetry.Trace;
using Xunit; using Xunit;

View File

@ -1,6 +1,6 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <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> <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
</PropertyGroup> </PropertyGroup>
@ -26,7 +26,7 @@
<ItemGroup> <ItemGroup>
<ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.AspNetCore\OpenTelemetry.Instrumentation.AspNetCore.csproj" /> <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.Instrumentation.Http\OpenTelemetry.Instrumentation.Http.csproj" />
<ProjectReference Include="$(RepoRoot)\src\OpenTelemetry\OpenTelemetry.csproj" /> <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry\OpenTelemetry.csproj" />
<Compile Include="$(RepoRoot)\test\OpenTelemetry.Tests\Shared\EventSourceTestHelper.cs" Link="EventSourceTestHelper.cs" /> <Compile Include="$(RepoRoot)\test\OpenTelemetry.Tests\Shared\EventSourceTestHelper.cs" Link="EventSourceTestHelper.cs" />