Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document query URL redaction #3377

Closed
pellared opened this issue Apr 17, 2024 · 2 comments · Fixed by #3386
Closed

Document query URL redaction #3377

pellared opened this issue Apr 17, 2024 · 2 comments · Fixed by #3386
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@pellared
Copy link
Member

pellared commented Apr 17, 2024

Hotfix for OpenTelemetry.Instrumentation.AspNetCore to 1.8.1
Hotfix for OpenTelemetry.Instrumentation.Http to 1.8.1

I find it bad that hotfixes change the default behavior in a breaking way.
See: open-telemetry/opentelemetry-dotnet#5541

We should add code to set OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION and OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION to true if these are unset.

We miss docs for these env vars.

Our changelog should also be improved to include changes in the emitted telemetry.

Originally posted by @pellared in #3372 (comment)

@pellared pellared added this to the 1.5.1 milestone Apr 17, 2024
@pellared
Copy link
Member Author

I find it bad that hotfixes change the default behavior in a breaking way.
See: open-telemetry/opentelemetry-dotnet#5541

We confirmed with our Product Manager that this breaking change this is not acceptable for us.
We decided to not rush and discuss the mentioned issue further.
We plan to join the OTel SemConv SIG meeting next Monday to discuss the impact of this change.
We are not planning to make a release of OTel .NET Automatic Instrumentation before that.

CC @MikeGoldsmith @lmolkova @akubik-splunk @mtwo

@pellared
Copy link
Member Author

pellared commented Apr 23, 2024

According to OTel Specification such change is allowed. More: open-telemetry/opentelemetry-dotnet#5541 (comment)

From my perspective we should only document the new env vars and mention in the changelog the changed behavior (and new env vars).

@pellared pellared changed the title Do not retract query URL by default Document query URL redaction Apr 23, 2024
@pellared pellared added the documentation Improvements or additions to documentation label Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant