View Source OpenTelemetry.SemConv.Incubating.UserAgentAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for User_Agent attributes.

Summary

Functions

Name of the user-agent extracted from original. Usually refers to the browser's name.

Version of the user-agent extracted from original. Usually refers to the browser's version

Functions

@spec user_agent_name() :: :"user_agent.name"

Name of the user-agent extracted from original. Usually refers to the browser's name.

Value type

Value must be of type atom() | String.t().

Notes

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

["Safari", "YourApp"]
iex> OpenTelemetry.SemConv.Incubating.UserAgentAttributes.user_agent_name()
:"user_agent.name"

See OpenTelemetry.SemConv.UserAgentAttributes.user_agent_original/0.

@spec user_agent_version() :: :"user_agent.version"

Version of the user-agent extracted from original. Usually refers to the browser's version

Value type

Value must be of type atom() | String.t().

Notes

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

["14.1.2", "1.0.0"]
iex> OpenTelemetry.SemConv.Incubating.UserAgentAttributes.user_agent_version()
:"user_agent.version"