From e0c120e47b9fce5d6f795a317c766a5d7d31d001 Mon Sep 17 00:00:00 2001 From: Alan West <3676547+alanwest@users.noreply.github.com> Date: Fri, 9 Feb 2024 14:48:20 -0800 Subject: [PATCH] [GrpcNetClient] Clarify impact to SuppressDownstreamInstrumentation --- .../CHANGELOG.md | 10 ++++++---- .../README.md | 5 +++++ 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md index 66390b0daab..0474a13d959 100644 --- a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md +++ b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md @@ -2,13 +2,15 @@ ## Unreleased -* **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 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 index b48a3e8822b..eb6bdd12d92 100644 --- 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