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

Remove userAgent tag from HttpClient activity #5110

Merged

Conversation

vishweshbankwar
Copy link
Member

@vishweshbankwar vishweshbankwar commented Dec 1, 2023

Fixes #
Design discussion issue #

Changes

User Agent is an opt-in tag so removing it https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client and it was also a bug to use older http.user_agent tag instead of user_agent.original

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
  • Unit tests added/updated
  • Appropriate CHANGELOG.md files updated for non-trivial changes
  • Changes in public API reviewed (if applicable)

Copy link

codecov bot commented Dec 1, 2023

Codecov Report

Merging #5110 (ddd8c92) into main (61c6c74) will increase coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5110      +/-   ##
==========================================
+ Coverage   83.13%   83.15%   +0.01%     
==========================================
  Files         296      296              
  Lines       12318    12314       -4     
==========================================
- Hits        10241    10240       -1     
+ Misses       2077     2074       -3     
Flag Coverage Δ
unittests 83.15% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...tp/Implementation/HttpHandlerDiagnosticListener.cs 70.86% <ø> (-0.89%) ⬇️

... and 8 files with indirect coverage changes

@cijothomas
Copy link
Member

Do we plan to provide an option to opt-in as well? Or just removal for now, and asking to use Enrich to get user-agent?

@vishweshbankwar
Copy link
Member Author

Do we plan to provide an option to opt-in as well? Or just removal for now, and asking to use Enrich to get user-agent?

Would suggest Enrich for any additional attributes.

@cijothomas
Copy link
Member

Do we plan to provide an option to opt-in as well? Or just removal for now, and asking to use Enrich to get user-agent?

Would suggest Enrich for any additional attributes.

That would be reasonable approach, as long we know dotnet/runtime#93019 is committed for .NET 9. Otherwise, its better to expose APIs for opt-in fields.
For unblocking stable release, its okay to do just-the-removal, but with a clear documentation on how users can self-mitigate.

@vishweshbankwar vishweshbankwar marked this pull request as ready for review December 1, 2023 19:42
@vishweshbankwar vishweshbankwar requested a review from a team as a code owner December 1, 2023 19:42
@utpilla utpilla merged commit 94c20c6 into open-telemetry:main Dec 1, 2023
78 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants