-
Notifications
You must be signed in to change notification settings - Fork 179
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
add User-agent OS attributes #1434
Open
rogercoll
wants to merge
8
commits into
open-telemetry:main
Choose a base branch
from
rogercoll:user_agent_os
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
98e4d6e
add User-agent OS attributes
rogercoll f2dae59
Merge branch 'main' into user_agent_os
rogercoll b13e037
chore: add changelog file
rogercoll 4b22978
Merge branch 'main' into user_agent_os
rogercoll bed9f11
Merge branch 'main' into user_agent_os
rogercoll e4ad5bb
fix: table generation
rogercoll 1b46946
remove unused description and build_id attributes
rogercoll 4f5afee
Merge branch 'main' into user_agent_os
rogercoll File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: 'enhancement' | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: user-agent | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add user-agent OS attributes | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [1433] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please describe the use-case for these attributes? is there any instrumentation or semantic convention that's supposed to populate it?
We usually add attributes along with the convention (span/metric/resource/event) that uses them - this usually results in more specific attribute definition and more clarity for those who want to populate the attribute on other conventions.
So, could we define such convention and/or document the use-case in some other way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For example, to understand which are the source OSes that are making requests to your system. This could be used from a Nginx Ingress Controller log, which records all requests UserAgent's.
There is an ongoing PR in the collector: open-telemetry/opentelemetry-collector-contrib#35458
From the collector point of view, these attributes are agnostic to its location, they will be extracted from any defined context (span/metric/resource/event). I would like to use it to populate a Nginx Ingress Controller event, but it is not defined in Semconv yet (#982). Would it make sense to add a Nginx log example and explain how these attributes could be extracted?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lmolkova How could we proceed with this PR? In which section could I add the use-case? brief field?
If a proof of concept is needed beforehand, we could unblock open-telemetry/opentelemetry-collector-contrib#35886 (comment) by just referencing this PR for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the (Event) Log SIG may be far enough along that we can start looking into #982, I've left a couple of initial comments there, and added it to next week's Log SIG meeting because I think it's another good example for us to use when considering #1651
Another option for use case besides access log could be to add these attributes as opt-in on HTTP spans / metrics which would enable breaking down HTTP telemetry by Android/iOS or by Windows/Mac.
It would be helpful to understand how the attributes in this PR (
os.type/os.name/os.version) map to a common user-agent parser e.g. https://github.com/ua-parser