Package io.opentelemetry.semconv.incubating

Class UserAgentIncubatingAttributes

java.lang.Object

io.opentelemetry.semconv.incubating.UserAgentIncubatingAttributes

public final class UserAgentIncubatingAttributes
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserAgentIncubatingAttributes.UserAgentSyntheticTypeIncubatingValues	Values for USER_AGENT_SYNTHETIC_TYPE.

Field Summary

Fields

Modifier and Type	Field	Description
static final io.opentelemetry.api.common.AttributeKey<String>	USER_AGENT_NAME	Name of the user-agent extracted from original.
static final io.opentelemetry.api.common.AttributeKey<String>	USER_AGENT_ORIGINAL	Deprecated. deprecated in favor of stable UserAgentAttributes.USER_AGENT_ORIGINAL attribute.
static final io.opentelemetry.api.common.AttributeKey<String>	USER_AGENT_SYNTHETIC_TYPE	Specifies the category of synthetic traffic, such as tests or bots.
static final io.opentelemetry.api.common.AttributeKey<String>	USER_AGENT_VERSION	Version of the user-agent extracted from original.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

USER_AGENT_NAME

public static final io.opentelemetry.api.common.AttributeKey<String> USER_AGENT_NAME

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

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

USER_AGENT_ORIGINAL

@Deprecated
public static final io.opentelemetry.api.common.AttributeKey<String> USER_AGENT_ORIGINAL

Deprecated.

deprecated in favor of stable UserAgentAttributes.USER_AGENT_ORIGINAL attribute.

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

USER_AGENT_SYNTHETIC_TYPE

public static final io.opentelemetry.api.common.AttributeKey<String> USER_AGENT_SYNTHETIC_TYPE

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

Notes:

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_VERSION

public static final io.opentelemetry.api.common.AttributeKey<String> USER_AGENT_VERSION

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

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