SemanticAttributes (OpenTelemetry Semantic Conventions)

java.lang.Object
- io.opentelemetry.semconv.trace.attributes.SemanticAttributes

public final class SemanticAttributes
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SemanticAttributes.DbCassandraConsistencyLevelValues`
`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.RpcGrpcStatusCodeValues`

Field Summary

Fields
Modifier and Type	Field	Description
`static io.opentelemetry.api.common.AttributeKey<String>`	`CODE_FILEPATH`	The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
`static io.opentelemetry.api.common.AttributeKey<String>`	`CODE_FUNCTION`	The method or function name, or equivalent (usually rightmost part of the code unit's name).
`static io.opentelemetry.api.common.AttributeKey<Long>`	`CODE_LINENO`	The line number in `code.filepath` best representing the operation.
`static io.opentelemetry.api.common.AttributeKey<String>`	`CODE_NAMESPACE`	The "namespace" within which `code.function` is defined.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_CASSANDRA_CONSISTENCY_LEVEL`	The consistency level of the query.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_CASSANDRA_COORDINATOR_DC`	The data center of the coordinating node for a query.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_CASSANDRA_COORDINATOR_ID`	The ID of the coordinating node for a query.
`static io.opentelemetry.api.common.AttributeKey<Boolean>`	`DB_CASSANDRA_IDEMPOTENCE`	Whether or not the query is idempotent.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_CASSANDRA_KEYSPACE`	The name of the keyspace being accessed.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`DB_CASSANDRA_PAGE_SIZE`	The fetch size used for paging, i.e. how many rows will be returned at once.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT`	The number of times a query was speculatively executed.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_CASSANDRA_TABLE`	The name of the primary table that the operation is acting upon, including the schema name (if applicable).
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_CONNECTION_STRING`	The connection string used to connect to the database.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_HBASE_NAMESPACE`	The [HBase namespace](https://hbase.apache.org/book.html#_namespace) being accessed.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`DB_MONGODB_COLLECTION`	The collection being accessed within the database stated in `db.name`.
`static io.opentelemetry.api.common.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?
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.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`, or the SQL keyword.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`DB_SQL_TABLE`	The name of the primary table that the operation is acting upon, including the schema name (if applicable).
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_STATEMENT`	The database statement being executed.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_SYSTEM`	An identifier for the database management system (DBMS) product being used.
`static io.opentelemetry.api.common.AttributeKey<String>`	`DB_USER`	Username for accessing the database.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`ENDUSER_ROLE`	Actual/assumed role the client is making the request under extracted from token or application security context.
`static io.opentelemetry.api.common.AttributeKey<String>`	`ENDUSER_SCOPE`	Scopes or granted authorities the client currently possesses extracted from token or application security context.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`EXCEPTION_MESSAGE`	The exception message.
`static io.opentelemetry.api.common.AttributeKey<String>`	`EXCEPTION_STACKTRACE`	A stacktrace as a string in the natural representation for the language runtime.
`static io.opentelemetry.api.common.AttributeKey<String>`	`EXCEPTION_TYPE`	The type of the exception (its fully-qualified class name, if applicable).
`static io.opentelemetry.api.common.AttributeKey<Boolean>`	`FAAS_COLDSTART`	A boolean that is true if the serverless function is executed for the first time (aka cold-start).
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_DOCUMENT_COLLECTION`	The name of the source on which the triggering operation was performed.
`static io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_DOCUMENT_NAME`	The document name/table subjected to the operation.
`static io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_DOCUMENT_OPERATION`	Describes the type of the operation that was performed on the data.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_EXECUTION`	The execution ID of the current function execution.
`static io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_INVOKED_NAME`	The name of the invoked function.
`static io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_INVOKED_PROVIDER`	The cloud provider of the invoked function.
`static io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_INVOKED_REGION`	The cloud region of the invoked function.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`FAAS_TRIGGER`	Type of the trigger on which the function is executed.
`static io.opentelemetry.api.common.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)).
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_FLAVOR`	Kind of HTTP protocol used.
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_HOST`	The value of the [HTTP host header](https://tools.ietf.org/html/rfc7230#section-5.4).
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_METHOD`	HTTP request method.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`HTTP_REQUEST_CONTENT_LENGTH`	The size of the request payload body in bytes.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED`	The size of the uncompressed request payload body after transport decoding.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`HTTP_RESPONSE_CONTENT_LENGTH`	The size of the response payload body in bytes.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED`	The size of the uncompressed response payload body after transport decoding.
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_ROUTE`	The matched route (path template).
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_SCHEME`	The URI scheme identifying the used protocol.
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_SERVER_NAME`	The primary server name of the matched virtual host.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`HTTP_STATUS_CODE`	[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_TARGET`	The full request target as passed in a HTTP request line or equivalent.
`static io.opentelemetry.api.common.AttributeKey<String>`	`HTTP_URL`	Full HTTP request URL in the form `scheme://host[:port]/path?
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_CONVERSATION_ID`	The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_DESTINATION`	The message destination name.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_DESTINATION_KIND`	The kind of message destination.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_KAFKA_CLIENT_ID`	Client Id for the Consumer or Producer that is handling the message.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_KAFKA_CONSUMER_GROUP`	Name of the Kafka Consumer Group that is handling the message.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<Long>`	`MESSAGING_KAFKA_PARTITION`	Partition the message is sent to.
`static io.opentelemetry.api.common.AttributeKey<Boolean>`	`MESSAGING_KAFKA_TOMBSTONE`	A boolean that is true if the message is a tombstone.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_MESSAGE_ID`	A value used by the messaging system as an identifier for the message, represented as a string.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES`	The compressed size of the message payload in bytes.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES`	The (uncompressed) size of the message payload in bytes.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_OPERATION`	A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_PROTOCOL`	The name of the transport protocol.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_PROTOCOL_VERSION`	The version of the transport protocol.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_SYSTEM`	A string identifying the messaging system.
`static io.opentelemetry.api.common.AttributeKey<Boolean>`	`MESSAGING_TEMP_DESTINATION`	A boolean that is true if the message destination is temporary.
`static io.opentelemetry.api.common.AttributeKey<String>`	`MESSAGING_URL`	Connection string.
`static io.opentelemetry.api.common.AttributeKey<String>`	`NET_HOST_IP`	Like `net.peer.ip` but for the host IP.
`static io.opentelemetry.api.common.AttributeKey<String>`	`NET_HOST_NAME`	Local hostname or similar, see note below.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`NET_HOST_PORT`	Like `net.peer.port` but for the host port.
`static io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String>`	`NET_PEER_NAME`	Remote hostname or similar, see note below.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`NET_PEER_PORT`	Remote port number.
`static io.opentelemetry.api.common.AttributeKey<String>`	`NET_TRANSPORT`	Transport protocol used.
`static io.opentelemetry.api.common.AttributeKey<String>`	`PEER_SERVICE`	The [`service.name`](../..
`static io.opentelemetry.api.common.AttributeKey<Long>`	`RPC_GRPC_STATUS_CODE`	The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request.
`static io.opentelemetry.api.common.AttributeKey<String>`	`RPC_METHOD`	The name of the method being called, must be equal to the $method part in the span name.
`static io.opentelemetry.api.common.AttributeKey<String>`	`RPC_SERVICE`	The full name of the service being called, including its package name, if applicable.
`static io.opentelemetry.api.common.AttributeKey<String>`	`RPC_SYSTEM`	A string identifying the remoting system.
`static io.opentelemetry.api.common.AttributeKey<Long>`	`THREAD_ID`	Current "managed" thread ID (as opposed to OS thread ID).
`static io.opentelemetry.api.common.AttributeKey<String>`	`THREAD_NAME`	Current thread name.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DB_SYSTEM
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> DB_USER
```
    Username for accessing the database.
  - DB_JDBC_DRIVER_CLASSNAME
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> DB_STATEMENT
```
    The database statement being executed.
    Note: The value may be sanitized to exclude sensitive information.
  - DB_OPERATION
```
public static final io.opentelemetry.api.common.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`, or the SQL keyword.
    Note: When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted.
  - NET_PEER_NAME
```
public static final io.opentelemetry.api.common.AttributeKey<String> NET_PEER_NAME
```
    Remote hostname or similar, see note below.
  - NET_PEER_IP
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<Long> NET_PEER_PORT
```
    Remote port number.
  - NET_TRANSPORT
```
public static final io.opentelemetry.api.common.AttributeKey<String> NET_TRANSPORT
```
    Transport protocol used. See note below.
  - DB_MSSQL_INSTANCE_NAME
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_KEYSPACE
```
    The name of the keyspace being accessed. To be used instead of the generic `db.name` attribute.
  - DB_CASSANDRA_PAGE_SIZE
```
public static final io.opentelemetry.api.common.AttributeKey<Long> DB_CASSANDRA_PAGE_SIZE
```
    The fetch size used for paging, i.e. how many rows will be returned at once.
  - DB_CASSANDRA_CONSISTENCY_LEVEL
```
public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_CONSISTENCY_LEVEL
```
    The consistency level of the query. Based on consistency values from [CQL](https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html).
  - DB_CASSANDRA_TABLE
```
public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_TABLE
```
    The name of the primary table that the operation is acting upon, including the schema name (if applicable).
    Note: This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.
  - DB_CASSANDRA_IDEMPOTENCE
```
public static final io.opentelemetry.api.common.AttributeKey<Boolean> DB_CASSANDRA_IDEMPOTENCE
```
    Whether or not the query is idempotent.
  - DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT
```
public static final io.opentelemetry.api.common.AttributeKey<Long> DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT
```
    The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively.
  - DB_CASSANDRA_COORDINATOR_ID
```
public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_COORDINATOR_ID
```
    The ID of the coordinating node for a query.
  - DB_CASSANDRA_COORDINATOR_DC
```
public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_COORDINATOR_DC
```
    The data center of the coordinating node for a query.
  - DB_HBASE_NAMESPACE
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> DB_MONGODB_COLLECTION
```
    The collection being accessed within the database stated in `db.name`.
  - DB_SQL_TABLE
```
public static final io.opentelemetry.api.common.AttributeKey<String> DB_SQL_TABLE
```
    The name of the primary table that the operation is acting upon, including the schema name (if applicable).
    Note: It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.
  - EXCEPTION_TYPE
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> EXCEPTION_MESSAGE
```
    The exception message.
  - EXCEPTION_STACKTRACE
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> FAAS_TRIGGER
```
    Type of the trigger on which the function is executed.
  - FAAS_EXECUTION
```
public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_EXECUTION
```
    The execution ID of the current function execution.
  - FAAS_DOCUMENT_COLLECTION
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> FAAS_DOCUMENT_OPERATION
```
    Describes the type of the operation that was performed on the data.
  - FAAS_DOCUMENT_TIME
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> HTTP_METHOD
```
    HTTP request method.
  - HTTP_URL
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> HTTP_TARGET
```
    The full request target as passed in a HTTP request line or equivalent.
  - HTTP_HOST
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> HTTP_SCHEME
```
    The URI scheme identifying the used protocol.
  - HTTP_STATUS_CODE
```
public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_STATUS_CODE
```
    [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).
  - HTTP_FLAVOR
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> HTTP_ROUTE
```
    The matched route (path template).
  - HTTP_CLIENT_IP
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<Long> NET_HOST_PORT
```
    Like `net.peer.port` but for the host port.
  - NET_HOST_NAME
```
public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_NAME
```
    Local hostname or similar, see note below.
  - MESSAGING_SYSTEM
```
public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SYSTEM
```
    A string identifying the messaging system.
  - MESSAGING_DESTINATION
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_KIND
```
    The kind of message destination.
  - MESSAGING_TEMP_DESTINATION
```
public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_TEMP_DESTINATION
```
    A boolean that is true if the message destination is temporary.
  - MESSAGING_PROTOCOL
```
public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_PROTOCOL
```
    The name of the transport protocol.
  - MESSAGING_PROTOCOL_VERSION
```
public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_PROTOCOL_VERSION
```
    The version of the transport protocol.
  - MESSAGING_URL
```
public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_URL
```
    Connection string.
  - MESSAGING_MESSAGE_ID
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES
```
    The compressed size of the message payload in bytes.
  - FAAS_TIME
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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).
  - THREAD_ID
```
public static final io.opentelemetry.api.common.AttributeKey<Long> THREAD_ID
```
    Current "managed" thread ID (as opposed to OS thread ID).
  - THREAD_NAME
```
public static final io.opentelemetry.api.common.AttributeKey<String> THREAD_NAME
```
    Current thread name.
  - CODE_FUNCTION
```
public static final io.opentelemetry.api.common.AttributeKey<String> CODE_FUNCTION
```
    The method or function name, or equivalent (usually rightmost part of the code unit's name).
  - CODE_NAMESPACE
```
public static final io.opentelemetry.api.common.AttributeKey<String> CODE_NAMESPACE
```
    The "namespace" within which `code.function` is defined. Usually the qualified class or module name, such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit.
  - CODE_FILEPATH
```
public static final io.opentelemetry.api.common.AttributeKey<String> CODE_FILEPATH
```
    The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
  - CODE_LINENO
```
public static final io.opentelemetry.api.common.AttributeKey<Long> CODE_LINENO
```
    The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
  - MESSAGING_OPERATION
```
public static final io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.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 io.opentelemetry.api.common.AttributeKey<String> MESSAGING_KAFKA_CLIENT_ID
```
    Client Id for the Consumer or Producer that is handling the message.
  - MESSAGING_KAFKA_PARTITION
```
public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_PARTITION
```
    Partition the message is sent to.
  - MESSAGING_KAFKA_TOMBSTONE
```
public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_KAFKA_TOMBSTONE
```
    A boolean that is true if the message is a tombstone.
  - RPC_SYSTEM
```
public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SYSTEM
```
    A string identifying the remoting system.
  - RPC_SERVICE
```
public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SERVICE
```
    The full name of the service being called, including its package name, if applicable.
  - RPC_METHOD
```
public static final io.opentelemetry.api.common.AttributeKey<String> RPC_METHOD
```
    The name of the method being called, must be equal to the $method part in the span name.
  - RPC_GRPC_STATUS_CODE
```
public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_GRPC_STATUS_CODE
```
    The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request.
  - 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

Class SemanticAttributes

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DB_SYSTEM

DB_CONNECTION_STRING

DB_USER

DB_JDBC_DRIVER_CLASSNAME

DB_NAME

DB_STATEMENT

DB_OPERATION

NET_PEER_NAME

NET_PEER_IP

NET_PEER_PORT

NET_TRANSPORT

DB_MSSQL_INSTANCE_NAME

DB_CASSANDRA_KEYSPACE

DB_CASSANDRA_PAGE_SIZE

DB_CASSANDRA_CONSISTENCY_LEVEL

DB_CASSANDRA_TABLE

DB_CASSANDRA_IDEMPOTENCE

DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT

DB_CASSANDRA_COORDINATOR_ID

DB_CASSANDRA_COORDINATOR_DC

DB_HBASE_NAMESPACE

DB_REDIS_DATABASE_INDEX

DB_MONGODB_COLLECTION

DB_SQL_TABLE

EXCEPTION_TYPE

EXCEPTION_MESSAGE

EXCEPTION_STACKTRACE

EXCEPTION_ESCAPED

FAAS_TRIGGER

FAAS_EXECUTION

FAAS_DOCUMENT_COLLECTION

FAAS_DOCUMENT_OPERATION

FAAS_DOCUMENT_TIME

FAAS_DOCUMENT_NAME

HTTP_METHOD

HTTP_URL

HTTP_TARGET

HTTP_HOST

HTTP_SCHEME

HTTP_STATUS_CODE

HTTP_FLAVOR

HTTP_USER_AGENT

HTTP_REQUEST_CONTENT_LENGTH

HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED

HTTP_RESPONSE_CONTENT_LENGTH

HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED

HTTP_SERVER_NAME

HTTP_ROUTE

HTTP_CLIENT_IP

NET_HOST_IP

NET_HOST_PORT

NET_HOST_NAME

MESSAGING_SYSTEM

MESSAGING_DESTINATION

MESSAGING_DESTINATION_KIND

MESSAGING_TEMP_DESTINATION

MESSAGING_PROTOCOL

MESSAGING_PROTOCOL_VERSION

MESSAGING_URL

MESSAGING_MESSAGE_ID

MESSAGING_CONVERSATION_ID

MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES

MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES

FAAS_TIME

FAAS_CRON

FAAS_COLDSTART

FAAS_INVOKED_NAME

FAAS_INVOKED_PROVIDER

FAAS_INVOKED_REGION

PEER_SERVICE

ENDUSER_ID

ENDUSER_ROLE

ENDUSER_SCOPE

THREAD_ID