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

Generalize the http.user_agent attribute to user_agent.* #3180

Closed
trask opened this issue Feb 6, 2023 · 5 comments · Fixed by #3190
Closed

Generalize the http.user_agent attribute to user_agent.* #3180

trask opened this issue Feb 6, 2023 · 5 comments · Fixed by #3190
Assignees
Labels
area:semantic-conventions Related to semantic conventions semconv:HTTP spec:trace Related to the specification/trace directory

Comments

@trask
Copy link
Member

trask commented Feb 6, 2023

What are you trying to achieve?

Generalize the http.user_agent attribute so it can be used by different semantic conventions.

Related to: #3097 (comment)

Additional context.

ECS already has user_agent.* namespace: https://www.elastic.co/guide/en/ecs/current/ecs-user_agent.html

If we want to follow ECS naming, we could rename http.user_agent to user_agent.original.

UPDATE This proposal is being made independent of ECS alignment.

@trask trask added area:semantic-conventions Related to semantic conventions spec:trace Related to the specification/trace directory semconv:HTTP labels Feb 6, 2023
@trask trask changed the title Generalize the http.user_agent attribute Generalize the http.user_agent attribute Feb 7, 2023
@trask trask assigned trask and unassigned jsuereth Feb 7, 2023
@trask trask changed the title Generalize the http.user_agent attribute Generalize the http.user_agent attribute to user_agent.* Feb 7, 2023
@MSNev
Copy link
Contributor

MSNev commented Feb 7, 2023

This probably makes sense longer term as browsers are freezing the user agent, so the basic meaning of http.user_agent will diminish over time.

@trask
Copy link
Member Author

trask commented Feb 9, 2023

This probably makes sense longer term as browsers are freezing the user agent, so the basic meaning of http.user_agent will diminish over time.

any thoughts if there's a better name than user_agent.original given the upcoming changes? (or maybe original is ok, in the sense it's the original "old" field)

@mateuszrzeszutek
Copy link
Member

Since we're planning to rename http.url to url.full, maybe user_agent.full? In case you want to parse the agent and split out individual properties (like ECS does).

@trask trask changed the title Generalize the http.user_agent attribute to user_agent.* Generalize the http.user_agent attribute to user_agent.* (aligning with ECS) Feb 9, 2023
@trask
Copy link
Member Author

trask commented Feb 13, 2023

Since we're planning to rename http.url to url.full, maybe user_agent.full? In case you want to parse the agent and split out individual properties (like ECS does).

I think we'll only rename http.url to url.full if we are aligning with ECS, in which case we'd go with user_agent.original to also align with ECS

@trask
Copy link
Member Author

trask commented Feb 13, 2023

I think this is a good change regardless of ECS alignment:

  • we've already seen the need for generalizing this
  • user agent string is being deprecated and replace with user agent components, so this will provide a good home for those under user_agent.* in the future
  • breaking (renaming) http.user_agent should be less disruptive compared to making changes to other http.* attributes

@trask trask changed the title Generalize the http.user_agent attribute to user_agent.* (aligning with ECS) Generalize the http.user_agent attribute to user_agent.* Feb 14, 2023
carlosalberto pushed a commit that referenced this issue Mar 2, 2023
Fixes #3180

## Changes

Renames `http.user_agent` to `user_agent.original`.
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 31, 2024
Fixes open-telemetry#3180

## Changes

Renames `http.user_agent` to `user_agent.original`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions semconv:HTTP spec:trace Related to the specification/trace directory
Projects
Development

Successfully merging a pull request may close this issue.

4 participants