Module: OpenTelemetry::SemConv::Incubating::USER_AGENT

Defined in:

lib/opentelemetry/semconv/incubating/user_agent/attributes.rb

Attribute Names

USER_AGENT_NAME =

Note:

Stability Level: development

Name of the user-agent extracted from original. Usually refers to the browser’s 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

Examples:

Sample Values

Safari
YourApp

'user_agent.name'

USER_AGENT_ORIGINAL =

Deprecated.

Now available in the stable namespace at USER_AGENT::USER_AGENT_ORIGINAL.

Note:

Stability Level: stable

Value of the HTTP User-Agent header sent by the client.

Examples:

Sample Values

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
YourApp/1.0.0 grpc-java-okhttp/1.27.2

'user_agent.original'

USER_AGENT_OS_NAME =

Note:

Stability Level: development

Human readable operating system name.

For mapping user agent strings to OS names, libraries such as ua-parser can be utilized.

Examples:

Sample Values

iOS
Android
Ubuntu

'user_agent.os.name'

USER_AGENT_OS_VERSION =

Note:

Stability Level: development

The version string of the operating system as defined in Version Attributes.

For mapping user agent strings to OS versions, libraries such as ua-parser can be utilized.

Examples:

Sample Values

14.2.1
18.04.1

'user_agent.os.version'

USER_AGENT_SYNTHETIC_TYPE =

Note:

Stability Level: development

Specifies the category of synthetic traffic, such as tests or bots.

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.

'user_agent.synthetic.type'

USER_AGENT_VERSION =

Note:

Stability Level: development

Version of the user-agent extracted from original. Usually refers to the browser’s 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

Examples:

Sample Values

14.1.2
1.0.0

'user_agent.version'