Merge branch 'main' into feature/prometheus-scope-info

open-telemetry · Nov 29, 2023 · ab9292c · ab9292c
2 parents 4ba86a8 + 4f73d2b
commit ab9292c
Show file tree

Hide file tree

Showing 15 changed files with 95 additions and 157 deletions.
diff --git a/build/Common.props b/build/Common.props
@@ -21,7 +21,7 @@
     <!-- production TFMs -->
     <TargetFrameworksForLibraries>net8.0;net6.0;netstandard2.0;$(NetFrameworkMinimumSupportedVersion)</TargetFrameworksForLibraries>
     <TargetFrameworksForLibrariesExtended>net8.0;net6.0;netstandard2.1;netstandard2.0;$(NetFrameworkMinimumSupportedVersion)</TargetFrameworksForLibrariesExtended>
-    <TargetFrameworksForAspNetCoreInstrumentation>net8.0;net7.0;net6.0;netstandard2.1;netstandard2.0</TargetFrameworksForAspNetCoreInstrumentation>
+    <TargetFrameworksForAspNetCoreInstrumentation>net8.0;net7.0;net6.0;netstandard2.0</TargetFrameworksForAspNetCoreInstrumentation>
     <TargetFrameworksForGrpcNetClientInstrumentation>net8.0;net6.0;netstandard2.1;netstandard2.0</TargetFrameworksForGrpcNetClientInstrumentation>
     <TargetFrameworksForPrometheusAspNetCore>net8.0;net6.0</TargetFrameworksForPrometheusAspNetCore>
 

diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/AspNetCoreInstrumentationOptions.cs b/src/OpenTelemetry.Instrumentation.AspNetCore/AspNetCoreInstrumentationOptions.cs
@@ -77,7 +77,7 @@ public class AspNetCoreInstrumentationOptions
     /// </remarks>
     public bool RecordException { get; set; }
 
-#if NETSTANDARD2_1 || NET6_0_OR_GREATER
+#if NET6_0_OR_GREATER
     /// <summary>
     /// Gets or sets a value indicating whether RPC attributes are added to an Activity when using Grpc.AspNetCore. Default is true.
     /// </summary>

diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md
@@ -8,6 +8,9 @@
   semantic conventions.
   ([#5066](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5066))
 
+* Removed `netstandard2.1` target.
+  ([#5094](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5094))
+
 ## 1.6.0-beta.3
 
 Released 2023-Nov-17

diff --git a/src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs b/src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs
@@ -344,51 +344,6 @@ static bool TryFetchException(object payload, out Exception exc)
             => ExceptionPropertyFetcher.TryFetch(payload, out exc) && exc != null;
     }
 
-    private static string GetUri(HttpRequest request)
-    {
-        // this follows the suggestions from https://github.com/dotnet/aspnetcore/issues/28906
-        var scheme = request.Scheme ?? string.Empty;
-
-        // HTTP 1.0 request with NO host header would result in empty Host.
-        // Use placeholder to avoid incorrect URL like "http:///"
-        var host = request.Host.Value ?? UnknownHostName;
-        var pathBase = request.PathBase.Value ?? string.Empty;
-        var path = request.Path.Value ?? string.Empty;
-        var queryString = request.QueryString.Value ?? string.Empty;
-        var length = scheme.Length + Uri.SchemeDelimiter.Length + host.Length + pathBase.Length
-                     + path.Length + queryString.Length;
-
-#if NETSTANDARD2_1_OR_GREATER || NET6_0_OR_GREATER
-        return string.Create(length, (scheme, host, pathBase, path, queryString), (span, parts) =>
-        {
-            CopyTo(ref span, parts.scheme);
-            CopyTo(ref span, Uri.SchemeDelimiter);
-            CopyTo(ref span, parts.host);
-            CopyTo(ref span, parts.pathBase);
-            CopyTo(ref span, parts.path);
-            CopyTo(ref span, parts.queryString);
-
-            static void CopyTo(ref Span<char> buffer, ReadOnlySpan<char> text)
-            {
-                if (!text.IsEmpty)
-                {
-                    text.CopyTo(buffer);
-                    buffer = buffer.Slice(text.Length);
-                }
-            }
-        });
-#else
-        return new System.Text.StringBuilder(length)
-            .Append(scheme)
-            .Append(Uri.SchemeDelimiter)
-            .Append(host)
-            .Append(pathBase)
-            .Append(path)
-            .Append(queryString)
-            .ToString();
-#endif
-    }
-
 #if !NETSTANDARD2_0
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     private static bool TryGetGrpcMethod(Activity activity, out string grpcMethod)

diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+* **Breaking Change** :
+  [SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation)
+  option will no longer be supported when used with certain versions of
+  `OpenTelemetry.Instrumentation.Http` package. Check out this
+  [issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092)
+  for details and workaround.
+  ([#5077](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5077))
+
 ## 1.6.0-beta.3
 
 Released 2023-Nov-17

diff --git a/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md
@@ -11,6 +11,14 @@
 * Update activity DisplayName as per the specification.
   ([#5078](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5078))
 
+* Removed reference to `OpenTelemetry` package. This is a **breaking change**
+  for users relying on
+  [SuppressDownstreamInstrumentation](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Instrumentation.GrpcNetClient#suppressdownstreaminstrumentation)
+  option in `OpenTelemetry.Instrumentation.GrpcNetClient`. For details, check
+  out this
+  [issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092).
+  ([#5077](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5077))
+
 ## 1.6.0-beta.3
 
 Released 2023-Nov-17

diff --git a/src/OpenTelemetry.Instrumentation.Http/HttpClientInstrumentationOptions.cs b/src/OpenTelemetry.Instrumentation.Http/HttpClientInstrumentationOptions.cs
@@ -20,9 +20,7 @@
 using System.Net.Http;
 #endif
 using System.Runtime.CompilerServices;
-using Microsoft.Extensions.Configuration;
 using OpenTelemetry.Instrumentation.Http.Implementation;
-using static OpenTelemetry.Internal.HttpSemanticConventionHelper;
 
 namespace OpenTelemetry.Instrumentation.Http;
 
@@ -31,23 +29,6 @@ namespace OpenTelemetry.Instrumentation.Http;
 /// </summary>
 public class HttpClientInstrumentationOptions
 {
-    internal readonly HttpSemanticConvention HttpSemanticConvention;
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="HttpClientInstrumentationOptions"/> class.
-    /// </summary>
-    public HttpClientInstrumentationOptions()
-        : this(new ConfigurationBuilder().AddEnvironmentVariables().Build())
-    {
-    }
-
-    internal HttpClientInstrumentationOptions(IConfiguration configuration)
-    {
-        Debug.Assert(configuration != null, "configuration was null");
-
-        this.HttpSemanticConvention = GetSemanticConventionOptIn(configuration);
-    }
-
     /// <summary>
     /// Gets or sets a filter function that determines whether or not to
     /// collect telemetry on a per request basis.

diff --git a/src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs b/src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs
@@ -104,11 +104,6 @@ public void OnStartActivity(Activity activity, object payload)
         // By this time, samplers have already run and
         // activity.IsAllDataRequested populated accordingly.
 
-        if (Sdk.SuppressInstrumentation)
-        {
-            return;
-        }
-
         if (!TryFetchRequest(payload, out HttpRequestMessage request))
         {
             HttpInstrumentationEventSource.Log.NullPayload(nameof(HttpHandlerDiagnosticListener), nameof(this.OnStartActivity));

diff --git a/...OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerMetricsDiagnosticListener.cs b/...OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerMetricsDiagnosticListener.cs
@@ -66,11 +66,6 @@ public override void OnEventWritten(string name, object payload)
 
     public void OnStopEventWritten(Activity activity, object payload)
     {
-        if (Sdk.SuppressInstrumentation)
-        {
-            return;
-        }
-
         if (TryFetchRequest(payload, out HttpRequestMessage request))
         {
             // see the spec https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-metrics.md

diff --git a/src/OpenTelemetry.Instrumentation.Http/OpenTelemetry.Instrumentation.Http.csproj b/src/OpenTelemetry.Instrumentation.Http/OpenTelemetry.Instrumentation.Http.csproj
@@ -12,24 +12,22 @@
 
   <ItemGroup>
     <Compile Include="$(RepoRoot)\src\Shared\Guard.cs" Link="Includes\Guard.cs" />
-    <Compile Include="$(RepoRoot)\src\Shared\EnvironmentVariables\*.cs" Link="Includes\EnvironmentVariables\%(Filename).cs" />
-    <Compile Include="$(RepoRoot)\src\Shared\HttpSemanticConventionHelper.cs" Link="Includes\HttpSemanticConventionHelper.cs" />
-    <Compile Include="$(RepoRoot)\src\Shared\Options\*.cs" Link="Includes\Options\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Shims\NullableAttributes.cs" Link="Includes\Shims\NullableAttributes.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\RequestMethodHelper.cs" Link="Includes\RequestMethodHelper.cs" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(RunningDotNetPack)' != 'true'">
-    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry\OpenTelemetry.csproj" />
+    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Api.ProviderBuilderExtensions\OpenTelemetry.Api.ProviderBuilderExtensions.csproj" />
   </ItemGroup>
 
   <!-- Instrumentation packages when published should take a dependency only on the latest stable version of the API/SDK. -->
   <ItemGroup Condition="'$(RunningDotNetPack)' == 'true'">
-    <PackageReference Include="OpenTelemetry" />
+    <PackageReference Include="OpenTelemetry.Api.ProviderBuilderExtensions" />
   </ItemGroup>
 
   <ItemGroup>
     <Reference Include="System.Net.Http" Condition="'$(TargetFramework)' == '$(NetFrameworkMinimumSupportedVersion)'" />
+    <PackageReference Include="Microsoft.Extensions.Options" />
   </ItemGroup>
 
 </Project>
diff --git a/src/OpenTelemetry.Instrumentation.Http/TracerProviderBuilderExtensions.cs b/src/OpenTelemetry.Instrumentation.Http/TracerProviderBuilderExtensions.cs
@@ -72,8 +72,6 @@ public static TracerProviderBuilder AddHttpClientInstrumentation(this TracerProv
             {
                 services.Configure(name, configureHttpClientInstrumentationOptions);
             }
-
-            services.RegisterOptionsFactory(configuration => new HttpClientInstrumentationOptions(configuration));
         });
 
 #if NETFRAMEWORK

diff --git a/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs b/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs
@@ -390,7 +390,7 @@ public void GrpcAndHttpClientInstrumentationIsInvoked(bool shouldEnrich)
         Assert.Equal(shouldEnrich ? "yes" : "no", grpcSpan.Tags.Where(tag => tag.Key == "enrichedWithHttpResponseMessage").FirstOrDefault().Value);
     }
 
-    [Fact]
+    [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092")]
     public void GrpcAndHttpClientInstrumentationWithSuppressInstrumentation()
     {
         var uri = new Uri($"http://localhost:{this.server.Port}");
@@ -443,7 +443,7 @@ public void GrpcAndHttpClientInstrumentationWithSuppressInstrumentation()
         Assert.Equal(0, grpcSpan4.GetTagValue(SemanticConventions.AttributeRpcGrpcStatusCode));
     }
 
-    [Fact]
+    [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092")]
     public void GrpcPropagatesContextWithSuppressInstrumentationOptionSetToTrue()
     {
         try
@@ -586,7 +586,7 @@ public void GrpcDoesNotPropagateContextWithSuppressInstrumentationOptionSetToFal
         }
     }
 
-    [Fact]
+    [Fact(Skip = "https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092")]
     public void GrpcClientInstrumentationRespectsSdkSuppressInstrumentation()
     {
         try