add User-agent OS attributes #1434
+126
−4
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,3 +35,83 @@ groups: | |
| using a user-agent for non-browser products, such as microservices with multiple names/versions inside the | ||
| `user_agent.original`, the most significant version SHOULD be selected. In such a scenario it should align | ||
| with `user_agent.name` | ||
|
|
||
| - id: registry.user_agent.os | ||
| type: attribute_group | ||
| display_name: User-agent OS Attributes | ||
| brief: "Describes the OS user-agent attributes." | ||
| attributes: | ||
| - id: user_agent.os.type | ||
| type: | ||
| members: | ||
| - id: windows | ||
| value: 'windows' | ||
| brief: "Microsoft Windows" | ||
| stability: experimental | ||
| - id: linux | ||
| value: 'linux' | ||
| brief: "Linux" | ||
| stability: experimental | ||
| - id: darwin | ||
| value: 'darwin' | ||
| brief: "Apple Darwin" | ||
| stability: experimental | ||
| - id: freebsd | ||
| value: 'freebsd' | ||
| brief: "FreeBSD" | ||
| stability: experimental | ||
| - id: netbsd | ||
| value: 'netbsd' | ||
| brief: "NetBSD" | ||
| stability: experimental | ||
| - id: openbsd | ||
| value: 'openbsd' | ||
| brief: "OpenBSD" | ||
| stability: experimental | ||
| - id: dragonflybsd | ||
| value: 'dragonflybsd' | ||
| brief: "DragonFly BSD" | ||
| stability: experimental | ||
| - id: hpux | ||
| value: 'hpux' | ||
| brief: "HP-UX (Hewlett Packard Unix)" | ||
| stability: experimental | ||
| - id: aix | ||
| value: 'aix' | ||
| brief: "AIX (Advanced Interactive eXecutive)" | ||
| stability: experimental | ||
| - id: solaris | ||
| value: 'solaris' | ||
| brief: "SunOS, Oracle Solaris" | ||
| stability: experimental | ||
| - id: z_os | ||
| value: 'z_os' | ||
| brief: "IBM z/OS" | ||
| stability: experimental | ||
| brief: > | ||
| The operating system type. | ||
| stability: experimental | ||
| - id: user_agent.os.description | ||
|
There was a problem hiding this comment. is this needed? I don't see it in ECS, and I'm not sure what you would populate it with via https://github.com/ua-parser/uap-core There was a problem hiding this comment. I think the equivalent in ECS would be the Given that there is no direct mapping for this field in https://github.com/ua-parser/uap-core/blob/master/docs/specification.md#os_parsers and the collector's use case does not cover this attribute at the moment, it is ok for me to remove it until the use case 1b46946 |
||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| Human readable (not intended to be parsed) OS version information, | ||
| like e.g. reported by `ver` or `lsb_release -a` commands. | ||
| examples: ['Microsoft Windows [Version 10.0.18363.778]', 'Ubuntu 18.04.1 LTS'] | ||
| - id: user_agent.os.name | ||
| type: string | ||
| stability: experimental | ||
| brief: 'Human readable operating system name.' | ||
| examples: ['iOS', 'Android', 'Ubuntu'] | ||
| - id: user_agent.os.version | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The version string of the operating system as defined in | ||
| [Version Attributes](/docs/resource/README.md#version-attributes). | ||
| examples: ['14.2.1', '18.04.1'] | ||
| - id: user_agent.os.build_id | ||
|
There was a problem hiding this comment. same question for this attribute, thanks There was a problem hiding this comment. Removing it until we have a use case 1b46946 wdyt? Thanks for the review! |
||
| type: string | ||
| stability: experimental | ||
| brief: 'Unique identifier for a particular build or compilation of the operating system.' | ||
| examples: ['TQ3C.230805.001.B2', '20E247', '22621'] | ||
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