forked from open-telemetry/semantic-conventions
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactoring: move browser to the registry (open-telemetry#605)
Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
- Loading branch information
Showing
5 changed files
with
80 additions
and
44 deletions.
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
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,24 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| # Browser | ||
|
|
||
| ## Browser Attributes | ||
|
|
||
| <!-- semconv registry.browser(omit_requirement_level) --> | ||
| | Attribute | Type | Description | Examples | | ||
| |---|---|---|---| | ||
| | `browser.brands` | string[] | Array of brand name and version separated by a space [1] | `[ Not A;Brand 99, Chromium 99, Chrome 99]` | | ||
| | `browser.language` | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` | | ||
| | `browser.mobile` | boolean | A boolean that is true if the browser is running on a mobile device [3] | | | ||
| | `browser.platform` | string | The platform on which the browser is running [4] | `Windows`; `macOS`; `Android` | | ||
|
|
||
| **[1]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`). | ||
|
|
||
| **[2]:** This value is intended to be taken from the Navigator API `navigator.language`. | ||
|
|
||
| **[3]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset. | ||
|
|
||
| **[4]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.platform`). If unavailable, the legacy `navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. | ||
| The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides. | ||
| <!-- endsemconv --> |
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 |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| groups: | ||
| - id: registry.browser | ||
| prefix: browser | ||
| type: resource | ||
| brief: > | ||
| The web browser attributes | ||
| attributes: | ||
| - id: brands | ||
| type: string[] | ||
| brief: 'Array of brand name and version separated by a space' | ||
| note: > | ||
| This value is intended to be taken from the | ||
| [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) | ||
| (`navigator.userAgentData.brands`). | ||
| examples: [ " Not A;Brand 99", "Chromium 99", "Chrome 99" ] | ||
| - id: platform | ||
| type: string | ||
| brief: 'The platform on which the browser is running' | ||
| note: > | ||
| This value is intended to be taken from the | ||
| [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) | ||
| (`navigator.userAgentData.platform`). If unavailable, the legacy | ||
| `navigator.platform` API SHOULD NOT be used instead and this attribute | ||
| SHOULD be left unset in order for the values to be consistent. | ||
| The list of possible values is defined in the | ||
| [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). | ||
| Note that some (but not all) of these values can overlap with values | ||
| in the [`os.type` and `os.name` attributes](./os.md). | ||
| However, for consistency, the values in the `browser.platform` attribute | ||
| should capture the exact value that the user agent provides. | ||
| examples: ['Windows', 'macOS', 'Android'] | ||
| - id: mobile | ||
| type: boolean | ||
| brief: 'A boolean that is true if the browser is running on a mobile device' | ||
| note: > | ||
| This value is intended to be taken from the | ||
| [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) | ||
| (`navigator.userAgentData.mobile`). If unavailable, this attribute | ||
| SHOULD be left unset. | ||
| - id: language | ||
| type: string | ||
| brief: 'Preferred language of the user using the browser' | ||
| note: > | ||
| This value is intended to be taken from the Navigator API | ||
| `navigator.language`. | ||
| examples: ["en", "en-US", "fr", "fr-FR"] |
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