UserAgentIncubatingAttributes
in
Semantic attributes and corresponding values for user_agent.
Tags
Table of Contents
Constants
- USER_AGENT_NAME = 'user_agent.name'
- Name of the user-agent extracted from original. Usually refers to the browser's name.
- USER_AGENT_ORIGINAL = 'user_agent.original'
- Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
- USER_AGENT_OS_NAME = 'user_agent.os.name'
- Human readable operating system name.
- USER_AGENT_OS_VERSION = 'user_agent.os.version'
- The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes).
- USER_AGENT_SYNTHETIC_TYPE = 'user_agent.synthetic.type'
- Specifies the category of synthetic traffic, such as tests or bots.
- USER_AGENT_SYNTHETIC_TYPE_VALUE_BOT = 'bot'
- Bot source.
- USER_AGENT_SYNTHETIC_TYPE_VALUE_TEST = 'test'
- Synthetic test source.
- USER_AGENT_VERSION = 'user_agent.version'
- Version of the user-agent extracted from original. Usually refers to the browser's version
Constants
USER_AGENT_NAME
Name of the user-agent extracted from original. Usually refers to the browser's name.
public
mixed
USER_AGENT_NAME
= 'user_agent.name'
Example 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
Tags
USER_AGENT_ORIGINAL
Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
public
mixed
USER_AGENT_ORIGINAL
= 'user_agent.original'
Tags
USER_AGENT_OS_NAME
Human readable operating system name.
public
mixed
USER_AGENT_OS_NAME
= 'user_agent.os.name'
For mapping user agent strings to OS names, libraries such as ua-parser can be utilized.
Tags
USER_AGENT_OS_VERSION
The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes).
public
mixed
USER_AGENT_OS_VERSION
= 'user_agent.os.version'
For mapping user agent strings to OS versions, libraries such as ua-parser can be utilized.
Tags
USER_AGENT_SYNTHETIC_TYPE
Specifies the category of synthetic traffic, such as tests or bots.
public
mixed
USER_AGENT_SYNTHETIC_TYPE
= 'user_agent.synthetic.type'
This attribute MAY be derived from the contents of the user_agent.original attribute. Components that populate the attribute are responsible for determining what they consider to be synthetic bot or test traffic. This attribute can either be set for self-identification purposes, or on telemetry detected to be generated as a result of a synthetic request. This attribute is useful for distinguishing between genuine client traffic and synthetic traffic generated by bots or tests.
Tags
USER_AGENT_SYNTHETIC_TYPE_VALUE_BOT
Bot source.
public
mixed
USER_AGENT_SYNTHETIC_TYPE_VALUE_BOT
= 'bot'
Tags
USER_AGENT_SYNTHETIC_TYPE_VALUE_TEST
Synthetic test source.
public
mixed
USER_AGENT_SYNTHETIC_TYPE_VALUE_TEST
= 'test'
Tags
USER_AGENT_VERSION
Version of the user-agent extracted from original. Usually refers to the browser's version
public
mixed
USER_AGENT_VERSION
= 'user_agent.version'
Example 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