Rename HttpClientInstrumentationOptions (#5109)

Author: vishweshbankwar

src/OpenTelemetry.Instrumentation.Http/.publicApi/PublicAPI.Unshipped.txt

@@ -1,24 +1,24 @@
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithException.get -> System.Action<System.Diagnostics.Activity, System.Exception>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithException.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpRequestMessage.get -> System.Action<System.Diagnostics.Activity, System.Net.Http.HttpRequestMessage>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpRequestMessage.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpResponseMessage.get -> System.Action<System.Diagnostics.Activity, System.Net.Http.HttpResponseMessage>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpResponseMessage.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpWebRequest.get -> System.Action<System.Diagnostics.Activity, System.Net.HttpWebRequest>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpWebRequest.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpWebResponse.get -> System.Action<System.Diagnostics.Activity, System.Net.HttpWebResponse>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.EnrichWithHttpWebResponse.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.FilterHttpRequestMessage.get -> System.Func<System.Net.Http.HttpRequestMessage, bool>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.FilterHttpRequestMessage.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.FilterHttpWebRequest.get -> System.Func<System.Net.HttpWebRequest, bool>
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.FilterHttpWebRequest.set -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.HttpClientInstrumentationOptions() -> void
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.RecordException.get -> bool
-OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions.RecordException.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithException.get -> System.Action<System.Diagnostics.Activity, System.Exception>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithException.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpRequestMessage.get -> System.Action<System.Diagnostics.Activity, System.Net.Http.HttpRequestMessage>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpRequestMessage.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpResponseMessage.get -> System.Action<System.Diagnostics.Activity, System.Net.Http.HttpResponseMessage>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpResponseMessage.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpWebRequest.get -> System.Action<System.Diagnostics.Activity, System.Net.HttpWebRequest>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpWebRequest.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpWebResponse.get -> System.Action<System.Diagnostics.Activity, System.Net.HttpWebResponse>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.EnrichWithHttpWebResponse.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.FilterHttpRequestMessage.get -> System.Func<System.Net.Http.HttpRequestMessage, bool>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.FilterHttpRequestMessage.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.FilterHttpWebRequest.get -> System.Func<System.Net.HttpWebRequest, bool>
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.FilterHttpWebRequest.set -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.HttpClientTraceInstrumentationOptions() -> void
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.RecordException.get -> bool
+OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions.RecordException.set -> void
 OpenTelemetry.Metrics.MeterProviderBuilderExtensions
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
 static OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddHttpClientInstrumentation(this OpenTelemetry.Metrics.MeterProviderBuilder builder) -> OpenTelemetry.Metrics.MeterProviderBuilder
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddHttpClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder) -> OpenTelemetry.Trace.TracerProviderBuilder
-static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddHttpClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, string name, System.Action<OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions> configureHttpClientInstrumentationOptions) -> OpenTelemetry.Trace.TracerProviderBuilder
-static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddHttpClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<OpenTelemetry.Instrumentation.Http.HttpClientInstrumentationOptions> configureHttpClientInstrumentationOptions) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddHttpClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, string name, System.Action<OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions> configureHttpClientTraceInstrumentationOptions) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddHttpClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions> configureHttpClientTraceInstrumentationOptions) -> OpenTelemetry.Trace.TracerProviderBuilder

src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md

@@ -19,6 +19,10 @@
   [issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/5092).
   ([#5077](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5077))
 
+* **Breaking Change**: Renamed `HttpClientInstrumentationOptions` to
+  `HttpClientTraceInstrumentationOptions`.
+  ([#5109](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5109))
+
 ## 1.6.0-beta.3
 
 Released 2023-Nov-17

src/OpenTelemetry.Instrumentation.Http/HttpClientInstrumentation.cs

@@ -47,7 +47,7 @@ internal sealed class HttpClientInstrumentation : IDisposable
     /// Initializes a new instance of the <see cref="HttpClientInstrumentation"/> class.
     /// </summary>
     /// <param name="options">Configuration options for HTTP client instrumentation.</param>
-    public HttpClientInstrumentation(HttpClientInstrumentationOptions options)
+    public HttpClientInstrumentation(HttpClientTraceInstrumentationOptions options)
     {
         // For .NET7.0 activity will be created using activitySource.
         // https://github.com/dotnet/runtime/blob/main/src/libraries/System.Net.Http/src/System/Net/Http/DiagnosticsHandler.cs

src/OpenTelemetry.Instrumentation.Http/HttpClientInstrumentationOptions.cs renamed to src/OpenTelemetry.Instrumentation.Http/HttpClientTraceInstrumentationOptions.cs

@@ -1,4 +1,4 @@
-// <copyright file="HttpClientInstrumentationOptions.cs" company="OpenTelemetry Authors">
+// <copyright file="HttpClientTraceInstrumentationOptions.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,7 +27,7 @@ namespace OpenTelemetry.Instrumentation.Http;
 /// <summary>
 /// Options for HttpClient instrumentation.
 /// </summary>
-public class HttpClientInstrumentationOptions
+public class HttpClientTraceInstrumentationOptions
 {
     /// <summary>
     /// Gets or sets a filter function that determines whether or not to

src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs

@@ -47,7 +47,7 @@ internal sealed class HttpHandlerDiagnosticListener : ListenerHandler
     private static readonly PropertyFetcher<HttpResponseMessage> StopResponseFetcher = new("Response");
     private static readonly PropertyFetcher<Exception> StopExceptionFetcher = new("Exception");
     private static readonly PropertyFetcher<TaskStatus> StopRequestStatusFetcher = new("RequestTaskStatus");
-    private readonly HttpClientInstrumentationOptions options;
+    private readonly HttpClientTraceInstrumentationOptions options;
 
     static HttpHandlerDiagnosticListener()
     {
@@ -61,7 +61,7 @@ static HttpHandlerDiagnosticListener()
         }
     }
 
-    public HttpHandlerDiagnosticListener(HttpClientInstrumentationOptions options)
+    public HttpHandlerDiagnosticListener(HttpClientTraceInstrumentationOptions options)
         : base("HttpHandlerDiagnosticListener")
     {
         this.options = options;

src/OpenTelemetry.Instrumentation.Http/Implementation/HttpWebRequestActivitySource.netfx.cs

@@ -50,7 +50,7 @@ internal static class HttpWebRequestActivitySource
     private static readonly Meter WebRequestMeter = new(MeterName, Version);
     private static readonly Histogram<double> HttpClientRequestDuration = WebRequestMeter.CreateHistogram<double>("http.client.request.duration", "s", "Measures the duration of outbound HTTP requests.");
 
-    private static HttpClientInstrumentationOptions tracingOptions;
+    private static HttpClientTraceInstrumentationOptions tracingOptions;
 
     // Fields for reflection
     private static FieldInfo connectionGroupListField;
@@ -87,7 +87,7 @@ static HttpWebRequestActivitySource()
             PrepareReflectionObjects();
             PerformInjection();
 
-            TracingOptions = new HttpClientInstrumentationOptions();
+            TracingOptions = new HttpClientTraceInstrumentationOptions();
         }
         catch (Exception ex)
         {
@@ -96,7 +96,7 @@ static HttpWebRequestActivitySource()
         }
     }
 
-    internal static HttpClientInstrumentationOptions TracingOptions
+    internal static HttpClientTraceInstrumentationOptions TracingOptions
     {
         get => tracingOptions;
         set

src/OpenTelemetry.Instrumentation.Http/README.md

@@ -148,7 +148,7 @@ newer versions.
 ## Advanced configuration
 
 This instrumentation can be configured to change the default behavior by using
-`HttpClientInstrumentationOptions`. It is important to note that there are
+`HttpClientTraceInstrumentationOptions`. It is important to note that there are
 differences between .NET Framework and newer .NET/.NET Core runtimes which
 govern what options are used. On .NET Framework, `HttpClient` uses the
 `HttpWebRequest` API. On .NET & .NET Core, `HttpWebRequest` uses the
@@ -196,7 +196,7 @@ enrich the activity with additional information. These actions are called
 only when `activity.IsAllDataRequested` is `true`. It contains the activity
 itself (which can be enriched) and the actual raw object.
 
-`HttpClientInstrumentationOptions` provides 3 enrich options:
+`HttpClientTraceInstrumentationOptions` provides 3 enrich options:
 `EnrichWithHttpRequestMessage`, `EnrichWithHttpResponseMessage` and
 `EnrichWithException`. These are based on the raw object that is passed in to
 the action to enrich the activity.
@@ -269,7 +269,7 @@ enrich the activity with additional information. These actions are called
 only when `activity.IsAllDataRequested` is `true`. It contains the activity
 itself (which can be enriched) and the actual raw object.
 
-`HttpClientInstrumentationOptions` provides 3 enrich options:
+`HttpClientTraceInstrumentationOptions` provides 3 enrich options:
 `EnrichWithHttpWebRequest`, `EnrichWithHttpWebResponse` and
 `EnrichWithException`. These are based on the raw object that is passed in to
 the action to enrich the activity.

src/OpenTelemetry.Instrumentation.Http/TracerProviderBuilderExtensions.cs

@@ -33,30 +33,30 @@ public static class TracerProviderBuilderExtensions
     /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
     /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
     public static TracerProviderBuilder AddHttpClientInstrumentation(this TracerProviderBuilder builder)
-        => AddHttpClientInstrumentation(builder, name: null, configureHttpClientInstrumentationOptions: null);
+        => AddHttpClientInstrumentation(builder, name: null, configureHttpClientTraceInstrumentationOptions: null);
 
     /// <summary>
     /// Enables HttpClient instrumentation.
     /// </summary>
     /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
-    /// <param name="configureHttpClientInstrumentationOptions">Callback action for configuring <see cref="HttpClientInstrumentationOptions"/>.</param>
+    /// <param name="configureHttpClientTraceInstrumentationOptions">Callback action for configuring <see cref="HttpClientTraceInstrumentationOptions"/>.</param>
     /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
     public static TracerProviderBuilder AddHttpClientInstrumentation(
         this TracerProviderBuilder builder,
-        Action<HttpClientInstrumentationOptions> configureHttpClientInstrumentationOptions)
-        => AddHttpClientInstrumentation(builder, name: null, configureHttpClientInstrumentationOptions);
+        Action<HttpClientTraceInstrumentationOptions> configureHttpClientTraceInstrumentationOptions)
+        => AddHttpClientInstrumentation(builder, name: null, configureHttpClientTraceInstrumentationOptions);
 
     /// <summary>
     /// Enables HttpClient instrumentation.
     /// </summary>
     /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
     /// <param name="name">Name which is used when retrieving options.</param>
-    /// <param name="configureHttpClientInstrumentationOptions">Callback action for configuring <see cref="HttpClientInstrumentationOptions"/>.</param>
+    /// <param name="configureHttpClientTraceInstrumentationOptions">Callback action for configuring <see cref="HttpClientTraceInstrumentationOptions"/>.</param>
     /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
     public static TracerProviderBuilder AddHttpClientInstrumentation(
         this TracerProviderBuilder builder,
         string name,
-        Action<HttpClientInstrumentationOptions> configureHttpClientInstrumentationOptions)
+        Action<HttpClientTraceInstrumentationOptions> configureHttpClientTraceInstrumentationOptions)
     {
         Guard.ThrowIfNull(builder);
 
@@ -68,9 +68,9 @@ public static TracerProviderBuilder AddHttpClientInstrumentation(
 
         builder.ConfigureServices(services =>
         {
-            if (configureHttpClientInstrumentationOptions != null)
+            if (configureHttpClientTraceInstrumentationOptions != null)
             {
-                services.Configure(name, configureHttpClientInstrumentationOptions);
+                services.Configure(name, configureHttpClientTraceInstrumentationOptions);
             }
         });
 
@@ -81,7 +81,7 @@ public static TracerProviderBuilder AddHttpClientInstrumentation(
         {
             deferredTracerProviderBuilder.Configure((sp, builder) =>
             {
-                var options = sp.GetRequiredService<IOptionsMonitor<HttpClientInstrumentationOptions>>().Get(name);
+                var options = sp.GetRequiredService<IOptionsMonitor<HttpClientTraceInstrumentationOptions>>().Get(name);
 
                 HttpWebRequestActivitySource.TracingOptions = options;
             });
@@ -91,7 +91,7 @@ public static TracerProviderBuilder AddHttpClientInstrumentation(
 
         builder.AddInstrumentation(sp =>
         {
-            var options = sp.GetRequiredService<IOptionsMonitor<HttpClientInstrumentationOptions>>().Get(name);
+            var options = sp.GetRequiredService<IOptionsMonitor<HttpClientTraceInstrumentationOptions>>().Get(name);
 
             return new HttpClientInstrumentation(options);
         });

test/OpenTelemetry.Instrumentation.Http.Tests/HttpClientTests.Basic.cs

@@ -96,12 +96,12 @@ public void AddHttpClientInstrumentation_NamedOptions()
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
             .ConfigureServices(services =>
             {
-                services.Configure<HttpClientInstrumentationOptions>(o => defaultExporterOptionsConfigureOptionsInvocations++);
+                services.Configure<HttpClientTraceInstrumentationOptions>(o => defaultExporterOptionsConfigureOptionsInvocations++);
 
-                services.Configure<HttpClientInstrumentationOptions>("Instrumentation2", o => namedExporterOptionsConfigureOptionsInvocations++);
+                services.Configure<HttpClientTraceInstrumentationOptions>("Instrumentation2", o => namedExporterOptionsConfigureOptionsInvocations++);
             })
             .AddHttpClientInstrumentation()
-            .AddHttpClientInstrumentation("Instrumentation2", configureHttpClientInstrumentationOptions: null)
+            .AddHttpClientInstrumentation("Instrumentation2", configureHttpClientTraceInstrumentationOptions: null)
             .Build();
 
         Assert.Equal(1, defaultExporterOptionsConfigureOptionsInvocations);

test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestActivitySourceTests.netfx.cs

@@ -37,7 +37,7 @@ public class HttpWebRequestActivitySourceTests : IDisposable
 
     static HttpWebRequestActivitySourceTests()
     {
-        HttpClientInstrumentationOptions options = new()
+        HttpClientTraceInstrumentationOptions options = new()
         {
             EnrichWithHttpWebRequest = (activity, httpWebRequest) =>
             {

test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestTests.Basic.cs

@@ -312,11 +312,11 @@ public void AddHttpClientInstrumentationUsesOptionsApi(string name)
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
             .ConfigureServices(services =>
             {
-                services.Configure<HttpClientInstrumentationOptions>(name, o => configurationDelegateInvocations++);
+                services.Configure<HttpClientTraceInstrumentationOptions>(name, o => configurationDelegateInvocations++);
             })
             .AddHttpClientInstrumentation(name, options =>
             {
-                Assert.IsType<HttpClientInstrumentationOptions>(options);
+                Assert.IsType<HttpClientTraceInstrumentationOptions>(options);
             })
             .Build();