add User-agent OS attributes

.chloggen/user_agent_os.yaml

@@ -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:

docs/attributes-registry/user-agent.md

@@ -6,6 +6,9 @@
 
 # User Agent
 
+- [User-agent Attributes](#user-agent-attributes)
+- [User-agent OS Attributes](#user-agent-os-attributes)
+
 ## User-agent Attributes
 
 Describes user-agent attributes.
@@ -19,3 +22,31 @@ Describes user-agent attributes.
 **[1]:** [Example](https://www.whatsmyua.info) of extracting browser's name from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the `user_agent.original`, the most significant name SHOULD be selected. In such a scenario it should align with `user_agent.version`
 
 **[2]:** [Example](https://www.whatsmyua.info) of extracting browser's version from original string. In the case of 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`
+
+## User-agent OS Attributes
+
+Describes the OS user-agent attributes.
+
+| Attribute | Type | Description | Examples | Stability |
+|---|---|---|---|---|
+| <a id="user-agent-os-build-id" href="#user-agent-os-build-id">`user_agent.os.build_id`</a> | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="user-agent-os-description" href="#user-agent-os-description">`user_agent.os.description`</a> | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="user-agent-os-name" href="#user-agent-os-name">`user_agent.os.name`</a> | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="user-agent-os-type" href="#user-agent-os-type">`user_agent.os.type`</a> | string | The operating system type. | `windows`; `linux`; `darwin` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| <a id="user-agent-os-version" href="#user-agent-os-version">`user_agent.os.version`</a> | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+`user_agent.os.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
+
+| Value  | Description | Stability |
+|---|---|---|
+| `aix` | AIX (Advanced Interactive eXecutive) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `darwin` | Apple Darwin | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dragonflybsd` | DragonFly BSD | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `freebsd` | FreeBSD | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `hpux` | HP-UX (Hewlett Packard Unix) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `linux` | Linux | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `netbsd` | NetBSD | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `openbsd` | OpenBSD | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `solaris` | SunOS, Oracle Solaris | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `windows` | Microsoft Windows | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `z_os` | IBM z/OS | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

model/user-agent/registry.yaml

@@ -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
+        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
+        type: string
+        stability: experimental
+        brief: 'Unique identifier for a particular build or compilation of the operating system.'
+        examples: ['TQ3C.230805.001.B2', '20E247', '22621']