[GrpcNetClient] Clarify impact to SuppressDownstreamInstrumentation (#…

…5340) Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>
open-telemetry · Feb 10, 2024 · 8b88f43 · 8b88f43
1 parent a2f85dc
commit 8b88f43
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md
@@ -6,13 +6,15 @@
 
 Released 2024-Feb-09
 
-* **Breaking Change** :
+* **Breaking Change**:
+  Please be advised that the
   [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
+  option no longer works when used in conjunction with the
+  `OpenTelemetry.Instrumentation.Http` package version `1.6.0` or greater.
+  This is not a result of a change in the `OpenTelemetry.Instrumentation.GrpcNetClient`
+  package therefore this also affects versions prior to this release. See 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))
 * Removed support for the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable
   which toggled the use of the new conventions for the
   [server, client, and shared network attributes](https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/general/attributes.md#server-client-and-shared-network-attributes).

diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/README.md
@@ -80,6 +80,11 @@ This instrumentation can be configured to change the default behavior by using
 
 ### SuppressDownstreamInstrumentation
 
+> [!CAUTION]
+> `SuppressDownstreamInstrumentation` no longer works when used in conjunction
+with the `OpenTelemetry.Instrumentation.Http` package version `1.6.0` and greater.
+This option may change or even be removed in a future release.
+
 This option prevents downstream instrumentation from being invoked.
 Grpc.Net.Client is built on top of HttpClient. When instrumentation for both
 libraries is enabled, `SuppressDownstreamInstrumentation` prevents the