move user agent to registry (#418)
This commit is contained in:
Alexandra Konrad
GitHub
parent
8e40255a39
commit
cd047137dd
|
|
@ -30,5 +30,6 @@ Currently, the following namespaces exist:
|
|||
* [HTTP](http.md)
|
||||
* [Network](network.md)
|
||||
* [URL](url.md)
|
||||
* [User agent](user-agent.md)
|
||||
|
||||
[developers recommendations]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/common/attribute-naming.md#recommendations-for-application-developers
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
<!--- Hugo front matter used to generate the website version of this page:
|
||||
--->
|
||||
|
||||
# User agent
|
||||
|
||||
## User agent Attributes
|
||||
|
||||
<!-- semconv registry.user_agent(omit_requirement_level) -->
|
||||
| Attribute | Type | Description | Examples |
|
||||
|---|---|---|---|
|
||||
| `user_agent.original` | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` |
|
||||
<!-- endsemconv -->
|
||||
|
|
@ -28,7 +28,7 @@ Cosmos DB instrumentation includes call-level (public API) surface spans and net
|
|||
| `db.cosmosdb.request_content_length` | int | Request payload size in bytes | | Recommended |
|
||||
| `db.cosmosdb.status_code` | int | Cosmos DB status code. | `200`; `201` | Conditionally Required: if response was received |
|
||||
| `db.cosmosdb.sub_status_code` | int | Cosmos DB sub status code. | `1000`; `1002` | Conditionally Required: [2] |
|
||||
| `user_agent.original` | string | Full user-agent string is generated by Cosmos DB SDK [3] | `cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\|` | Recommended |
|
||||
| [`user_agent.original`](../attributes-registry/user-agent.md) | string | Full user-agent string is generated by Cosmos DB SDK [3] | `cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\|` | Recommended |
|
||||
|
||||
**[1]:** when performing one of the operations in this list
|
||||
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@ sections below.
|
|||
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [6] | `http`; `spdy` | Opt-In |
|
||||
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [7] | `1.0`; `1.1`; `2`; `3` | Recommended |
|
||||
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [8] | `tcp`; `udp` | Opt-In |
|
||||
| `user_agent.original` | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3` | Recommended |
|
||||
| [`user_agent.original`](../attributes-registry/user-agent.md) | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` | Recommended |
|
||||
|
||||
**[1]:** If the request fails with an error before response status code was sent or received,
|
||||
`error.type` SHOULD be set to exception type (its fully-qualified class name, if applicable)
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ All of these attributes can be provided by the user agent itself in the form of
|
|||
| `browser.language` | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` | Recommended |
|
||||
| `browser.mobile` | boolean | A boolean that is true if the browser is running on a mobile device [3] | | Recommended |
|
||||
| `browser.platform` | string | The platform on which the browser is running [4] | `Windows`; `macOS`; `Android` | Recommended |
|
||||
| `user_agent.original` | string | Full user-agent string provided by the browser [5] | `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36` | Recommended |
|
||||
| [`user_agent.original`](../attributes-registry/user-agent.md) | string | Full user-agent string provided by the browser [5] | `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36` | Recommended |
|
||||
|
||||
**[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`).
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
groups:
|
||||
- id: registry.user_agent
|
||||
prefix: user_agent
|
||||
type: attribute_group
|
||||
brief: "Describes user-agent attributes."
|
||||
attributes:
|
||||
- id: original
|
||||
type: string
|
||||
brief: >
|
||||
Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
|
||||
examples: ['CERN-LineMode/2.15 libwww/2.17b3',
|
||||
'Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1']
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
groups:
|
||||
- id: attributes.user_agent
|
||||
type: attribute_group
|
||||
brief: "Describes user-agent attributes."
|
||||
prefix: user_agent
|
||||
attributes:
|
||||
- id: original
|
||||
type: string
|
||||
brief: 'Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.'
|
||||
examples: ['CERN-LineMode/2.15 libwww/2.17b3']
|
||||
Loading…
Reference in New Issue