Class SemanticAttributes
- java.lang.Object
-
- io.opentelemetry.api.trace.attributes.SemanticAttributes
-
public final class SemanticAttributes extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SemanticAttributes.CloudProviderValues
static class
SemanticAttributes.DbSystemValues
static class
SemanticAttributes.FaasDocumentOperationValues
static class
SemanticAttributes.FaasInvokedProviderValues
static class
SemanticAttributes.FaasTriggerValues
static class
SemanticAttributes.HttpFlavorValues
static class
SemanticAttributes.MessagingDestinationKindValues
static class
SemanticAttributes.MessagingOperationValues
static class
SemanticAttributes.NetTransportValues
static class
SemanticAttributes.OsTypeValues
static class
SemanticAttributes.TelemetrySdkLanguageValues
-
Field Summary
Fields Modifier and Type Field Description static AttributeKey<String>
CLOUD_ACCOUNT_ID
The cloud account ID used to identify different entities.static AttributeKey<String>
CLOUD_PROVIDER
Name of the cloud provider.static AttributeKey<String>
CLOUD_REGION
A specific geographical location where different entities can run.static AttributeKey<String>
CLOUD_ZONE
Zones are a sub set of the region connected through low-latency links.static AttributeKey<String>
CONTAINER_ID
Container id.static AttributeKey<String>
CONTAINER_IMAGE_NAME
Name of the image the container was built on.static AttributeKey<String>
CONTAINER_IMAGE_TAG
Container image tag.static AttributeKey<String>
CONTAINER_NAME
Container name.static AttributeKey<String>
DB_CASSANDRA_KEYSPACE
The name of the keyspace being accessed.static AttributeKey<String>
DB_CONNECTION_STRING
The connection string used to connect to the database.static AttributeKey<String>
DB_HBASE_NAMESPACE
The [HBase namespace](https://hbase.apache.org/book.html#_namespace) being accessed.static AttributeKey<String>
DB_JDBC_DRIVER_CLASSNAME
The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect.static AttributeKey<String>
DB_MONGODB_COLLECTION
The collection being accessed within the database stated in `db.name`.static AttributeKey<String>
DB_MSSQL_INSTANCE_NAME
The Microsoft SQL Server [instance name](https://docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to.static AttributeKey<String>
DB_NAME
If no [tech-specific attribute](#call-level-attributes-for-specific-technologies) is defined, this attribute is used to report the name of the database being accessed.static AttributeKey<String>
DB_OPERATION
The name of the operation being executed, e.g.static AttributeKey<Long>
DB_REDIS_DATABASE_INDEX
The index of the database being accessed as used in the [`SELECT` command](https://redis.io/commands/select), provided as an integer.static AttributeKey<String>
DB_STATEMENT
The database statement being executed.static AttributeKey<String>
DB_SYSTEM
An identifier for the database management system (DBMS) product being used.static AttributeKey<String>
DB_USER
Username for accessing the database.static AttributeKey<String>
DEPLOYMENT_ENVIRONMENT
Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier).static AttributeKey<String>
ENDUSER_ID
Username or client_id extracted from the access token or [Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) header in the inbound request from outside the system.static AttributeKey<String>
ENDUSER_ROLE
Actual/assumed role the client is making the request under extracted from token or application security context.static AttributeKey<String>
ENDUSER_SCOPE
Scopes or granted authorities the client currently possesses extracted from token or application security context.static AttributeKey<Boolean>
EXCEPTION_ESCAPED
SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.static String
EXCEPTION_EVENT_NAME
The name of an event describing an exception.static AttributeKey<String>
EXCEPTION_MESSAGE
The exception message.static AttributeKey<String>
EXCEPTION_STACKTRACE
A stacktrace as a string in the natural representation for the language runtime.static AttributeKey<String>
EXCEPTION_TYPE
The type of the exception (its fully-qualified class name, if applicable).static AttributeKey<Boolean>
FAAS_COLDSTART
A boolean that is true if the serverless function is executed for the first time (aka cold-start).static AttributeKey<String>
FAAS_CRON
A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).static AttributeKey<String>
FAAS_DOCUMENT_COLLECTION
The name of the source on which the triggering operation was performed.static AttributeKey<String>
FAAS_DOCUMENT_NAME
The document name/table subjected to the operation.static AttributeKey<String>
FAAS_DOCUMENT_OPERATION
Describes the type of the operation that was performed on the data.static AttributeKey<String>
FAAS_DOCUMENT_TIME
A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).static AttributeKey<String>
FAAS_EXECUTION
The execution ID of the current function execution.static AttributeKey<String>
FAAS_ID
The unique ID of the function being executed.static AttributeKey<String>
FAAS_INSTANCE
The execution environment ID as a string.static AttributeKey<String>
FAAS_INVOKED_NAME
The name of the invoked function.static AttributeKey<String>
FAAS_INVOKED_PROVIDER
The cloud provider of the invoked function.static AttributeKey<String>
FAAS_INVOKED_REGION
The cloud region of the invoked function.static AttributeKey<String>
FAAS_NAME
The name of the function being executed.static AttributeKey<String>
FAAS_TIME
A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).static AttributeKey<String>
FAAS_TRIGGER
Type of the trigger on which the function is executed.static AttributeKey<String>
FAAS_VERSION
The version string of the function being executed as defined in [Version Attributes](https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions#version-attributes).static AttributeKey<String>
HOST_ID
Unique host ID.static AttributeKey<String>
HOST_IMAGE_ID
VM image ID.static AttributeKey<String>
HOST_IMAGE_NAME
Name of the VM image or OS install the host was instantiated from.static AttributeKey<String>
HOST_IMAGE_VERSION
The version string of the VM image as defined in [Version Attributes](https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions#version-attributes).static AttributeKey<String>
HOST_NAME
Name of the host.static AttributeKey<String>
HOST_TYPE
Type of host.static AttributeKey<String>
HTTP_CLIENT_IP
The IP address of the original client behind all proxies, if known (e.g.static AttributeKey<String>
HTTP_FLAVOR
Kind of HTTP protocol used.static AttributeKey<String>
HTTP_HOST
The value of the [HTTP host header](https://tools.ietf.org/html/rfc7230#section-5.4).static AttributeKey<String>
HTTP_METHOD
HTTP request method.static AttributeKey<Long>
HTTP_REQUEST_CONTENT_LENGTH
The size of the request payload body in bytes.static AttributeKey<Long>
HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
The size of the uncompressed request payload body after transport decoding.static AttributeKey<Long>
HTTP_RESPONSE_CONTENT_LENGTH
The size of the response payload body in bytes.static AttributeKey<Long>
HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
The size of the uncompressed response payload body after transport decoding.static AttributeKey<String>
HTTP_ROUTE
The matched route (path template).static AttributeKey<String>
HTTP_SCHEME
The URI scheme identifying the used protocol.static AttributeKey<String>
HTTP_SERVER_NAME
The primary server name of the matched virtual host.static AttributeKey<Long>
HTTP_STATUS_CODE
[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).static AttributeKey<String>
HTTP_TARGET
The full request target as passed in a HTTP request line or equivalent.static AttributeKey<String>
HTTP_URL
Full HTTP request URL in the form `scheme://host[:port]/path?query[#fragment]`.static AttributeKey<String>
HTTP_USER_AGENT
Value of the [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3) header sent by the client.static AttributeKey<String>
K8S_CLUSTER_NAME
The name of the cluster.static AttributeKey<String>
K8S_CONTAINER_NAME
The name of the Container in a Pod template.static AttributeKey<String>
K8S_CRONJOB_NAME
The name of the CronJob.static AttributeKey<String>
K8S_CRONJOB_UID
The UID of the CronJob.static AttributeKey<String>
K8S_DAEMONSET_NAME
The name of the DaemonSet.static AttributeKey<String>
K8S_DAEMONSET_UID
The UID of the DaemonSet.static AttributeKey<String>
K8S_DEPLOYMENT_NAME
The name of the Deployment.static AttributeKey<String>
K8S_DEPLOYMENT_UID
The UID of the Deployment.static AttributeKey<String>
K8S_JOB_NAME
The name of the Job.static AttributeKey<String>
K8S_JOB_UID
The UID of the Job.static AttributeKey<String>
K8S_NAMESPACE_NAME
The name of the namespace that the pod is running in.static AttributeKey<String>
K8S_POD_NAME
The name of the Pod.static AttributeKey<String>
K8S_POD_UID
The UID of the Pod.static AttributeKey<String>
K8S_REPLICASET_NAME
The name of the ReplicaSet.static AttributeKey<String>
K8S_REPLICASET_UID
The UID of the ReplicaSet.static AttributeKey<String>
K8S_STATEFULSET_NAME
The name of the StatefulSet.static AttributeKey<String>
K8S_STATEFULSET_UID
The UID of the StatefulSet.static AttributeKey<String>
MESSAGING_CONVERSATION_ID
The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string.static AttributeKey<String>
MESSAGING_DESTINATION
The message destination name.static AttributeKey<String>
MESSAGING_DESTINATION_KIND
The kind of message destination.static AttributeKey<String>
MESSAGING_KAFKA_CLIENT_ID
Client Id for the Consumer or Producer that is handling the message.static AttributeKey<String>
MESSAGING_KAFKA_CONSUMER_GROUP
Name of the Kafka Consumer Group that is handling the message.static AttributeKey<String>
MESSAGING_KAFKA_MESSAGE_KEY
Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition.static AttributeKey<Long>
MESSAGING_KAFKA_PARTITION
Partition the message is sent to.static AttributeKey<Boolean>
MESSAGING_KAFKA_TOMBSTONE
A boolean that is true if the message is a tombstone.static AttributeKey<String>
MESSAGING_MESSAGE_ID
A value used by the messaging system as an identifier for the message, represented as a string.static AttributeKey<Long>
MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES
The compressed size of the message payload in bytes.static AttributeKey<Long>
MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES
The (uncompressed) size of the message payload in bytes.static AttributeKey<String>
MESSAGING_OPERATION
A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above.static AttributeKey<String>
MESSAGING_PROTOCOL
The name of the transport protocol.static AttributeKey<String>
MESSAGING_PROTOCOL_VERSION
The version of the transport protocol.static AttributeKey<String>
MESSAGING_SYSTEM
A string identifying the messaging system.static AttributeKey<Boolean>
MESSAGING_TEMP_DESTINATION
A boolean that is true if the message destination is temporary.static AttributeKey<String>
MESSAGING_URL
Connection string.static AttributeKey<String>
NET_HOST_IP
Like `net.peer.ip` but for the host IP.static AttributeKey<String>
NET_HOST_NAME
Local hostname or similar, see note below.static AttributeKey<Long>
NET_HOST_PORT
Like `net.peer.port` but for the host port.static AttributeKey<String>
NET_PEER_IP
Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6).static AttributeKey<String>
NET_PEER_NAME
Remote hostname or similar, see note below.static AttributeKey<Long>
NET_PEER_PORT
Remote port number.static AttributeKey<String>
NET_TRANSPORT
Transport protocol used.static AttributeKey<String>
OS_DESCRIPTION
Human readable (not intended to be parsed) OS version information, like e.g.static AttributeKey<String>
OS_TYPE
The operating system type.static AttributeKey<String>
PEER_SERVICE
The [`service.name`](../../resource/semantic_conventions/README.md#service) of the remote service.static AttributeKey<String>
RPC_METHOD
The name of the method being called, must be equal to the $method part in the span name.static AttributeKey<String>
RPC_SERVICE
The full name of the service being called, including its package name, if applicable.static AttributeKey<String>
RPC_SYSTEM
A string identifying the remoting system.static AttributeKey<String>
SERVICE_INSTANCE_ID
The string ID of the service instance.static AttributeKey<String>
SERVICE_NAME
Logical name of the service.static AttributeKey<String>
SERVICE_NAMESPACE
A namespace for `service.name`.static AttributeKey<String>
SERVICE_VERSION
The version string of the service API or implementation.static AttributeKey<String>
TELEMETRY_AUTO_VERSION
The version string of the auto instrumentation agent, if used.static AttributeKey<String>
TELEMETRY_SDK_LANGUAGE
The language of the telemetry SDK.static AttributeKey<String>
TELEMETRY_SDK_NAME
The name of the telemetry SDK as defined above.static AttributeKey<String>
TELEMETRY_SDK_VERSION
The version string of the telemetry SDK.
-
-
-
Field Detail
-
CLOUD_PROVIDER
public static final AttributeKey<String> CLOUD_PROVIDER
Name of the cloud provider.
-
CLOUD_ACCOUNT_ID
public static final AttributeKey<String> CLOUD_ACCOUNT_ID
The cloud account ID used to identify different entities.
-
CLOUD_REGION
public static final AttributeKey<String> CLOUD_REGION
A specific geographical location where different entities can run.
-
CLOUD_ZONE
public static final AttributeKey<String> CLOUD_ZONE
Zones are a sub set of the region connected through low-latency links.Note: In AWS, this is called availability-zone.
-
CONTAINER_NAME
public static final AttributeKey<String> CONTAINER_NAME
Container name.
-
CONTAINER_ID
public static final AttributeKey<String> CONTAINER_ID
Container id. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/reference/run/#container-identification). The UUID might be abbreviated.
-
CONTAINER_IMAGE_NAME
public static final AttributeKey<String> CONTAINER_IMAGE_NAME
Name of the image the container was built on.
-
CONTAINER_IMAGE_TAG
public static final AttributeKey<String> CONTAINER_IMAGE_TAG
Container image tag.
-
DEPLOYMENT_ENVIRONMENT
public static final AttributeKey<String> DEPLOYMENT_ENVIRONMENT
Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier).
-
FAAS_NAME
public static final AttributeKey<String> FAAS_NAME
The name of the function being executed.
-
FAAS_ID
public static final AttributeKey<String> FAAS_ID
The unique ID of the function being executed.Note: For example, in AWS Lambda this field corresponds to the [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) value, in GCP to the URI of the resource, and in Azure to the [FunctionDirectory](https://github.com/Azure/azure-functions-host/wiki/Retrieving-information-about-the-currently-running-function) field.
-
FAAS_VERSION
public static final AttributeKey<String> FAAS_VERSION
The version string of the function being executed as defined in [Version Attributes](https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions#version-attributes).
-
FAAS_INSTANCE
public static final AttributeKey<String> FAAS_INSTANCE
The execution environment ID as a string.
-
HOST_ID
public static final AttributeKey<String> HOST_ID
Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider.
-
HOST_NAME
public static final AttributeKey<String> HOST_NAME
Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user.
-
HOST_TYPE
public static final AttributeKey<String> HOST_TYPE
Type of host. For Cloud, this must be the machine type.
-
HOST_IMAGE_NAME
public static final AttributeKey<String> HOST_IMAGE_NAME
Name of the VM image or OS install the host was instantiated from.
-
HOST_IMAGE_ID
public static final AttributeKey<String> HOST_IMAGE_ID
VM image ID. For Cloud, this value is from the provider.
-
HOST_IMAGE_VERSION
public static final AttributeKey<String> HOST_IMAGE_VERSION
The version string of the VM image as defined in [Version Attributes](https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions#version-attributes).
-
K8S_CLUSTER_NAME
public static final AttributeKey<String> K8S_CLUSTER_NAME
The name of the cluster.
-
K8S_NAMESPACE_NAME
public static final AttributeKey<String> K8S_NAMESPACE_NAME
The name of the namespace that the pod is running in.
-
K8S_POD_UID
public static final AttributeKey<String> K8S_POD_UID
The UID of the Pod.
-
K8S_POD_NAME
public static final AttributeKey<String> K8S_POD_NAME
The name of the Pod.
-
K8S_CONTAINER_NAME
public static final AttributeKey<String> K8S_CONTAINER_NAME
The name of the Container in a Pod template.
-
K8S_REPLICASET_UID
public static final AttributeKey<String> K8S_REPLICASET_UID
The UID of the ReplicaSet.
-
K8S_REPLICASET_NAME
public static final AttributeKey<String> K8S_REPLICASET_NAME
The name of the ReplicaSet.
-
K8S_DEPLOYMENT_UID
public static final AttributeKey<String> K8S_DEPLOYMENT_UID
The UID of the Deployment.
-
K8S_DEPLOYMENT_NAME
public static final AttributeKey<String> K8S_DEPLOYMENT_NAME
The name of the Deployment.
-
K8S_STATEFULSET_UID
public static final AttributeKey<String> K8S_STATEFULSET_UID
The UID of the StatefulSet.
-
K8S_STATEFULSET_NAME
public static final AttributeKey<String> K8S_STATEFULSET_NAME
The name of the StatefulSet.
-
K8S_DAEMONSET_UID
public static final AttributeKey<String> K8S_DAEMONSET_UID
The UID of the DaemonSet.
-
K8S_DAEMONSET_NAME
public static final AttributeKey<String> K8S_DAEMONSET_NAME
The name of the DaemonSet.
-
K8S_JOB_UID
public static final AttributeKey<String> K8S_JOB_UID
The UID of the Job.
-
K8S_JOB_NAME
public static final AttributeKey<String> K8S_JOB_NAME
The name of the Job.
-
K8S_CRONJOB_UID
public static final AttributeKey<String> K8S_CRONJOB_UID
The UID of the CronJob.
-
K8S_CRONJOB_NAME
public static final AttributeKey<String> K8S_CRONJOB_NAME
The name of the CronJob.
-
OS_TYPE
public static final AttributeKey<String> OS_TYPE
The operating system type.
-
OS_DESCRIPTION
public static final AttributeKey<String> OS_DESCRIPTION
Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands.
-
SERVICE_NAME
public static final AttributeKey<String> SERVICE_NAME
Logical name of the service.Note: MUST be the same for all instances of horizontally scaled services.
-
SERVICE_NAMESPACE
public static final AttributeKey<String> SERVICE_NAMESPACE
A namespace for `service.name`.Note: A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
-
SERVICE_INSTANCE_ID
public static final AttributeKey<String> SERVICE_INSTANCE_ID
The string ID of the service instance.Note: MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words `service.namespace,service.name,service.id` triplet MUST be globally unique). The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this attribute it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations).
-
SERVICE_VERSION
public static final AttributeKey<String> SERVICE_VERSION
The version string of the service API or implementation.
-
TELEMETRY_SDK_NAME
public static final AttributeKey<String> TELEMETRY_SDK_NAME
The name of the telemetry SDK as defined above.
-
TELEMETRY_SDK_LANGUAGE
public static final AttributeKey<String> TELEMETRY_SDK_LANGUAGE
The language of the telemetry SDK.
-
TELEMETRY_SDK_VERSION
public static final AttributeKey<String> TELEMETRY_SDK_VERSION
The version string of the telemetry SDK.
-
TELEMETRY_AUTO_VERSION
public static final AttributeKey<String> TELEMETRY_AUTO_VERSION
The version string of the auto instrumentation agent, if used.
-
DB_SYSTEM
public static final AttributeKey<String> DB_SYSTEM
An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.
-
DB_CONNECTION_STRING
public static final AttributeKey<String> DB_CONNECTION_STRING
The connection string used to connect to the database. It is recommended to remove embedded credentials.
-
DB_USER
public static final AttributeKey<String> DB_USER
Username for accessing the database.
-
DB_JDBC_DRIVER_CLASSNAME
public static final AttributeKey<String> DB_JDBC_DRIVER_CLASSNAME
The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect.
-
DB_NAME
public static final AttributeKey<String> DB_NAME
If no [tech-specific attribute](#call-level-attributes-for-specific-technologies) is defined, this attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails).Note: In some SQL databases, the database name to be used is called "schema name".
-
DB_STATEMENT
public static final AttributeKey<String> DB_STATEMENT
The database statement being executed.Note: The value may be sanitized to exclude sensitive information.
-
DB_OPERATION
public static final AttributeKey<String> DB_OPERATION
The name of the operation being executed, e.g. the [MongoDB command name](https://docs.mongodb.com/manual/reference/command/#database-operations) such as `findAndModify`.Note: While it would semantically make sense to set this, e.g., to a SQL keyword like `SELECT` or `INSERT`, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property (the back end can do that if required).
-
NET_PEER_NAME
public static final AttributeKey<String> NET_PEER_NAME
Remote hostname or similar, see note below.
-
NET_PEER_IP
public static final AttributeKey<String> NET_PEER_IP
Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6).
-
NET_PEER_PORT
public static final AttributeKey<Long> NET_PEER_PORT
Remote port number.
-
NET_TRANSPORT
public static final AttributeKey<String> NET_TRANSPORT
Transport protocol used. See note below.
-
DB_MSSQL_INSTANCE_NAME
public static final AttributeKey<String> DB_MSSQL_INSTANCE_NAME
The Microsoft SQL Server [instance name](https://docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to. This name is used to determine the port of a named instance.Note: If setting a `db.mssql.instance_name`, `net.peer.port` is no longer required (but still recommended if non-standard).
-
DB_CASSANDRA_KEYSPACE
public static final AttributeKey<String> DB_CASSANDRA_KEYSPACE
The name of the keyspace being accessed. To be used instead of the generic `db.name` attribute.
-
DB_HBASE_NAMESPACE
public static final AttributeKey<String> DB_HBASE_NAMESPACE
The [HBase namespace](https://hbase.apache.org/book.html#_namespace) being accessed. To be used instead of the generic `db.name` attribute.
-
DB_REDIS_DATABASE_INDEX
public static final AttributeKey<Long> DB_REDIS_DATABASE_INDEX
The index of the database being accessed as used in the [`SELECT` command](https://redis.io/commands/select), provided as an integer. To be used instead of the generic `db.name` attribute.
-
DB_MONGODB_COLLECTION
public static final AttributeKey<String> DB_MONGODB_COLLECTION
The collection being accessed within the database stated in `db.name`.
-
EXCEPTION_TYPE
public static final AttributeKey<String> EXCEPTION_TYPE
The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it.
-
EXCEPTION_MESSAGE
public static final AttributeKey<String> EXCEPTION_MESSAGE
The exception message.
-
EXCEPTION_STACKTRACE
public static final AttributeKey<String> EXCEPTION_STACKTRACE
A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG.
-
EXCEPTION_ESCAPED
public static final AttributeKey<Boolean> EXCEPTION_ESCAPED
SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.Note: An exception is considered to have escaped (or left) the scope of a span, if that span is ended while the exception is still logically "in flight". This may be actually "in flight" in some languages (e.g. if the exception is passed to a Context manager's `__exit__` method in Python) but will usually be caught at the point of recording the exception in most languages.
It is usually not possible to determine at the point where an exception is thrown whether it will escape the scope of a span. However, it is trivial to know that an exception will escape, if one checks for an active exception just before ending the span, as done in the [example above](#exception-end-example).
It follows that an exception may still escape the scope of the span even if the `exception.escaped` attribute was not set or set to false, since the event might have been recorded at a time where it was not clear whether the exception will escape.
-
FAAS_TRIGGER
public static final AttributeKey<String> FAAS_TRIGGER
Type of the trigger on which the function is executed.
-
FAAS_EXECUTION
public static final AttributeKey<String> FAAS_EXECUTION
The execution ID of the current function execution.
-
FAAS_DOCUMENT_COLLECTION
public static final AttributeKey<String> FAAS_DOCUMENT_COLLECTION
The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name.
-
FAAS_DOCUMENT_OPERATION
public static final AttributeKey<String> FAAS_DOCUMENT_OPERATION
Describes the type of the operation that was performed on the data.
-
FAAS_DOCUMENT_TIME
public static final AttributeKey<String> FAAS_DOCUMENT_TIME
A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
-
FAAS_DOCUMENT_NAME
public static final AttributeKey<String> FAAS_DOCUMENT_NAME
The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name.
-
HTTP_METHOD
public static final AttributeKey<String> HTTP_METHOD
HTTP request method.
-
HTTP_URL
public static final AttributeKey<String> HTTP_URL
Full HTTP request URL in the form `scheme://host[:port]/path?query[#fragment]`. Usually the fragment is not transmitted over HTTP, but if it is known, it should be included nevertheless.
-
HTTP_TARGET
public static final AttributeKey<String> HTTP_TARGET
The full request target as passed in a HTTP request line or equivalent.
-
HTTP_HOST
public static final AttributeKey<String> HTTP_HOST
The value of the [HTTP host header](https://tools.ietf.org/html/rfc7230#section-5.4). When the header is empty or not present, this attribute should be the same.
-
HTTP_SCHEME
public static final AttributeKey<String> HTTP_SCHEME
The URI scheme identifying the used protocol.
-
HTTP_STATUS_CODE
public static final AttributeKey<Long> HTTP_STATUS_CODE
[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).
-
HTTP_FLAVOR
public static final AttributeKey<String> HTTP_FLAVOR
Kind of HTTP protocol used.Note: If `net.transport` is not specified, it can be assumed to be `IP.TCP` except if `http.flavor` is `QUIC`, in which case `IP.UDP` is assumed.
-
HTTP_USER_AGENT
public static final AttributeKey<String> HTTP_USER_AGENT
Value of the [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3) header sent by the client.
-
HTTP_REQUEST_CONTENT_LENGTH
public static final AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH
The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2) header. For requests using transport encoding, this should be the compressed size.
-
HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
public static final AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used.
-
HTTP_RESPONSE_CONTENT_LENGTH
public static final AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH
The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2) header. For requests using transport encoding, this should be the compressed size.
-
HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
public static final AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
The size of the uncompressed response payload body after transport decoding. Not set if transport encoding not used.
-
HTTP_SERVER_NAME
public static final AttributeKey<String> HTTP_SERVER_NAME
The primary server name of the matched virtual host. This should be obtained via configuration. If no such configuration can be obtained, this attribute MUST NOT be set ( `net.host.name` should be used instead).Note: `http.url` is usually not readily available on the server side but would have to be assembled in a cumbersome and sometimes lossy process from other information (see e.g. open-telemetry/opentelemetry-python/pull/148). It is thus preferred to supply the raw data that is available.
-
HTTP_ROUTE
public static final AttributeKey<String> HTTP_ROUTE
The matched route (path template).
-
HTTP_CLIENT_IP
public static final AttributeKey<String> HTTP_CLIENT_IP
The IP address of the original client behind all proxies, if known (e.g. from [X-Forwarded-For](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For)).Note: This is not necessarily the same as `net.peer.ip`, which would identify the network-level peer, which may be a proxy.
-
NET_HOST_IP
public static final AttributeKey<String> NET_HOST_IP
Like `net.peer.ip` but for the host IP. Useful in case of a multi-IP host.
-
NET_HOST_PORT
public static final AttributeKey<Long> NET_HOST_PORT
Like `net.peer.port` but for the host port.
-
NET_HOST_NAME
public static final AttributeKey<String> NET_HOST_NAME
Local hostname or similar, see note below.
-
MESSAGING_SYSTEM
public static final AttributeKey<String> MESSAGING_SYSTEM
A string identifying the messaging system.
-
MESSAGING_DESTINATION
public static final AttributeKey<String> MESSAGING_DESTINATION
The message destination name. This might be equal to the span name but is required nevertheless.
-
MESSAGING_DESTINATION_KIND
public static final AttributeKey<String> MESSAGING_DESTINATION_KIND
The kind of message destination.
-
MESSAGING_TEMP_DESTINATION
public static final AttributeKey<Boolean> MESSAGING_TEMP_DESTINATION
A boolean that is true if the message destination is temporary.
-
MESSAGING_PROTOCOL
public static final AttributeKey<String> MESSAGING_PROTOCOL
The name of the transport protocol.
-
MESSAGING_PROTOCOL_VERSION
public static final AttributeKey<String> MESSAGING_PROTOCOL_VERSION
The version of the transport protocol.
-
MESSAGING_URL
public static final AttributeKey<String> MESSAGING_URL
Connection string.
-
MESSAGING_MESSAGE_ID
public static final AttributeKey<String> MESSAGING_MESSAGE_ID
A value used by the messaging system as an identifier for the message, represented as a string.
-
MESSAGING_CONVERSATION_ID
public static final AttributeKey<String> MESSAGING_CONVERSATION_ID
The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".
-
MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES
public static final AttributeKey<Long> MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES
The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported.
-
MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES
public static final AttributeKey<Long> MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES
The compressed size of the message payload in bytes.
-
FAAS_TIME
public static final AttributeKey<String> FAAS_TIME
A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
-
FAAS_CRON
public static final AttributeKey<String> FAAS_CRON
A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
-
FAAS_COLDSTART
public static final AttributeKey<Boolean> FAAS_COLDSTART
A boolean that is true if the serverless function is executed for the first time (aka cold-start).
-
FAAS_INVOKED_NAME
public static final AttributeKey<String> FAAS_INVOKED_NAME
The name of the invoked function.Note: SHOULD be equal to the `faas.name` resource attribute of the invoked function.
-
FAAS_INVOKED_PROVIDER
public static final AttributeKey<String> FAAS_INVOKED_PROVIDER
The cloud provider of the invoked function.Note: SHOULD be equal to the `cloud.provider` resource attribute of the invoked function.
-
FAAS_INVOKED_REGION
public static final AttributeKey<String> FAAS_INVOKED_REGION
The cloud region of the invoked function.Note: SHOULD be equal to the `cloud.region` resource attribute of the invoked function.
-
PEER_SERVICE
public static final AttributeKey<String> PEER_SERVICE
The [`service.name`](../../resource/semantic_conventions/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any.
-
ENDUSER_ID
public static final AttributeKey<String> ENDUSER_ID
Username or client_id extracted from the access token or [Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) header in the inbound request from outside the system.
-
ENDUSER_ROLE
public static final AttributeKey<String> ENDUSER_ROLE
Actual/assumed role the client is making the request under extracted from token or application security context.
-
ENDUSER_SCOPE
public static final AttributeKey<String> ENDUSER_SCOPE
Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an [OAuth 2.0 Access Token](https://tools.ietf.org/html/rfc6749#section-3.3) or an attribute value in a [SAML 2.0 Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html).
-
MESSAGING_OPERATION
public static final AttributeKey<String> MESSAGING_OPERATION
A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above. If the operation is "send", this attribute MUST NOT be set, since the operation can be inferred from the span kind in that case.
-
MESSAGING_KAFKA_MESSAGE_KEY
public static final AttributeKey<String> MESSAGING_KAFKA_MESSAGE_KEY
Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from `messaging.message_id` in that they're not unique. If the key is `null`, the attribute MUST NOT be set.Note: If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value.
-
MESSAGING_KAFKA_CONSUMER_GROUP
public static final AttributeKey<String> MESSAGING_KAFKA_CONSUMER_GROUP
Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers.
-
MESSAGING_KAFKA_CLIENT_ID
public static final AttributeKey<String> MESSAGING_KAFKA_CLIENT_ID
Client Id for the Consumer or Producer that is handling the message.
-
MESSAGING_KAFKA_PARTITION
public static final AttributeKey<Long> MESSAGING_KAFKA_PARTITION
Partition the message is sent to.
-
MESSAGING_KAFKA_TOMBSTONE
public static final AttributeKey<Boolean> MESSAGING_KAFKA_TOMBSTONE
A boolean that is true if the message is a tombstone.
-
RPC_SYSTEM
public static final AttributeKey<String> RPC_SYSTEM
A string identifying the remoting system.
-
RPC_SERVICE
public static final AttributeKey<String> RPC_SERVICE
The full name of the service being called, including its package name, if applicable.
-
RPC_METHOD
public static final AttributeKey<String> RPC_METHOD
The name of the method being called, must be equal to the $method part in the span name.
-
EXCEPTION_EVENT_NAME
public static final String EXCEPTION_EVENT_NAME
The name of an event describing an exception.Typically an event with that name should not be manually created. Instead
Span.recordException(Throwable)
should be used.- See Also:
- Constant Field Values
-
-