Package io.opentelemetry.semconv

Class SemanticAttributes

java.lang.Object
io.opentelemetry.semconv.SemanticAttributes
public final class SemanticAttributes extends Object

  • Field Details

    • SCHEMA_URL

      public static final String SCHEMA_URL
      The URL of the OpenTelemetry schema for these keys and values.
      See Also:

    • CLIENT_ADDRESS

      public static final io.opentelemetry.api.common.AttributeKey<String> CLIENT_ADDRESS
      Client address - unix domain socket name, IPv4 or IPv6 address.

      Notes:

      • When observed from the server side, and when communicating through an intermediary, client.address SHOULD represent client address behind any intermediaries (e.g. proxies) if it's available.

    • CLIENT_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> CLIENT_PORT
      Client port number

      Notes:

      • When observed from the server side, and when communicating through an intermediary, client.port SHOULD represent client port behind any intermediaries (e.g. proxies) if it's available.

    • CLIENT_SOCKET_ADDRESS

      public static final io.opentelemetry.api.common.AttributeKey<String> CLIENT_SOCKET_ADDRESS
      Immediate client peer address - unix domain socket name, IPv4 or IPv6 address.

    • CLIENT_SOCKET_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> CLIENT_SOCKET_PORT
      Immediate client peer port number

    • HTTP_METHOD

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_METHOD
      Deprecated.
      Deprecated, use `http.request.method` instead.
      Deprecated, use http.request.method instead.

    • HTTP_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_STATUS_CODE
      Deprecated.
      Deprecated, use `http.response.status_code` instead.
      Deprecated, use http.response.status_code instead.

    • HTTP_SCHEME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_SCHEME
      Deprecated.
      Deprecated, use `url.scheme` instead.
      Deprecated, use url.scheme instead.

    • HTTP_URL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_URL
      Deprecated.
      Deprecated, use `url.full` instead.
      Deprecated, use url.full instead.

    • HTTP_TARGET

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_TARGET
      Deprecated.
      Deprecated, use `url.path` and `url.query` instead.
      Deprecated, use url.path and url.query instead.

    • HTTP_REQUEST_CONTENT_LENGTH

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH
      Deprecated.
      Deprecated, use `http.request.body.size` instead.
      Deprecated, use http.request.body.size instead.

    • HTTP_RESPONSE_CONTENT_LENGTH

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH
      Deprecated.
      Deprecated, use `http.response.body.size` instead.
      Deprecated, use http.response.body.size instead.

    • NET_SOCK_PEER_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_PEER_NAME
      Deprecated.
      Deprecated, use `server.socket.domain` on client spans.
      Deprecated, use server.socket.domain on client spans.

    • NET_SOCK_PEER_ADDR

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_PEER_ADDR
      Deprecated.
      Deprecated, use `server.socket.address` on client spans and `client.socket.address` on server spans.
      Deprecated, use server.socket.address on client spans and client.socket.address on server spans.

    • NET_SOCK_PEER_PORT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> NET_SOCK_PEER_PORT
      Deprecated.
      Deprecated, use `server.socket.port` on client spans and `client.socket.port` on server spans.
      Deprecated, use server.socket.port on client spans and client.socket.port on server spans.

    • NET_PEER_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_PEER_NAME
      Deprecated.
      Deprecated, use `server.address` on client spans and `client.address` on server spans.
      Deprecated, use server.address on client spans and client.address on server spans.

    • NET_PEER_PORT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> NET_PEER_PORT
      Deprecated.
      Deprecated, use `server.port` on client spans and `client.port` on server spans.
      Deprecated, use server.port on client spans and client.port on server spans.

    • NET_HOST_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_NAME
      Deprecated.
      Deprecated, use `server.address`.
      Deprecated, use server.address.

    • NET_HOST_PORT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> NET_HOST_PORT
      Deprecated.
      Deprecated, use `server.port`.
      Deprecated, use server.port.

    • NET_SOCK_HOST_ADDR

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_HOST_ADDR
      Deprecated.
      Deprecated, use `server.socket.address`.
      Deprecated, use server.socket.address.

    • NET_SOCK_HOST_PORT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> NET_SOCK_HOST_PORT
      Deprecated.
      Deprecated, use `server.socket.port`.
      Deprecated, use server.socket.port.

    • NET_TRANSPORT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_TRANSPORT
      Deprecated.
      Deprecated, use `network.transport`.
      Deprecated, use network.transport.

    • NET_PROTOCOL_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_PROTOCOL_NAME
      Deprecated.
      Deprecated, use `network.protocol.name`.
      Deprecated, use network.protocol.name.

    • NET_PROTOCOL_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_PROTOCOL_VERSION
      Deprecated.
      Deprecated, use `network.protocol.version`.
      Deprecated, use network.protocol.version.

    • NET_SOCK_FAMILY

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_FAMILY
      Deprecated.
      Deprecated, use `network.transport` and `network.type`.
      Deprecated, use network.transport and network.type.

    • DESTINATION_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> DESTINATION_DOMAIN
      The domain name of the destination system.

      Notes:

      • This value may be a host name, a fully qualified domain name, or another host naming format.

    • DESTINATION_ADDRESS

      public static final io.opentelemetry.api.common.AttributeKey<String> DESTINATION_ADDRESS
      Peer address, for example IP address or UNIX socket name.

    • DESTINATION_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> DESTINATION_PORT
      Peer port number

    • 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.

    • HTTP_REQUEST_METHOD

      public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_REQUEST_METHOD
      HTTP request method.

      Notes:

      • HTTP request method value SHOULD be "known" to the instrumentation. By default, this convention defines "known" methods as the ones listed in RFC9110 and the PATCH method defined in RFC5789.
      • If the HTTP request method is not known to instrumentation, it MUST set the http.request.method attribute to _OTHER and, except if reporting a metric, MUST set the exact method received in the request line as value of the http.request.method_original attribute.
      • If the HTTP instrumentation could end up converting valid HTTP request methods to _OTHER, then it MUST provide a way to override the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).
      • HTTP method names are case-sensitive and http.request.method attribute value MUST match a known HTTP method name exactly. Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. Tracing instrumentations that do so, MUST also set http.request.method_original to the original value.

    • HTTP_RESPONSE_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_STATUS_CODE
      HTTP response status code.

    • HTTP_ROUTE

      public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_ROUTE
      The matched route (path template in the format used by the respective server framework). See note below

      Notes:

      • MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include the application root if there is one.

    • EVENT_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> EVENT_NAME
      The name identifies the event.

    • EVENT_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> EVENT_DOMAIN
      The domain identifies the business context for the events.

      Notes:

      • Events across different domains may have same event.name, yet be unrelated events.

    • LOG_RECORD_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> LOG_RECORD_UID
      A unique identifier for the Log Record.

      Notes:

      • If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. The id MAY be an Universally Unique Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. UUID) may be used as needed.

    • LOG_IOSTREAM

      public static final io.opentelemetry.api.common.AttributeKey<String> LOG_IOSTREAM
      The stream associated with the log. See below for a list of well-known values.

    • LOG_FILE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> LOG_FILE_NAME
      The basename of the file.

    • LOG_FILE_PATH

      public static final io.opentelemetry.api.common.AttributeKey<String> LOG_FILE_PATH
      The full path to the file.

    • LOG_FILE_NAME_RESOLVED

      public static final io.opentelemetry.api.common.AttributeKey<String> LOG_FILE_NAME_RESOLVED
      The basename of the file, with symlinks resolved.

    • LOG_FILE_PATH_RESOLVED

      public static final io.opentelemetry.api.common.AttributeKey<String> LOG_FILE_PATH_RESOLVED
      The full path to the file, with symlinks resolved.

    • TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> TYPE
      The type of memory.

    • POOL

      public static final io.opentelemetry.api.common.AttributeKey<String> POOL
      Name of the memory pool.

      Notes:

    • SERVER_ADDRESS

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVER_ADDRESS
      Logical server hostname, matches server FQDN if available, and IP or socket address if FQDN is not known.

    • SERVER_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> SERVER_PORT
      Logical server port number

    • SERVER_SOCKET_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVER_SOCKET_DOMAIN
      The domain name of an immediate peer.

      Notes:

      • Typically observed from the client side, and represents a proxy or other intermediary domain name.

    • SERVER_SOCKET_ADDRESS

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVER_SOCKET_ADDRESS
      Physical server IP address or Unix socket address. If set from the client, should simply use the socket's peer address, and not attempt to find any actual server IP (i.e., if set from client, this may represent some proxy server instead of the logical server).

    • SERVER_SOCKET_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> SERVER_SOCKET_PORT
      Physical server port.

    • SOURCE_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> SOURCE_DOMAIN
      The domain name of the source system.

      Notes:

      • This value may be a host name, a fully qualified domain name, or another host naming format.

    • SOURCE_ADDRESS

      public static final io.opentelemetry.api.common.AttributeKey<String> SOURCE_ADDRESS
      Source address, for example IP address or Unix socket name.

    • SOURCE_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> SOURCE_PORT
      Source port number

    • AWS_LAMBDA_INVOKED_ARN

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_LAMBDA_INVOKED_ARN
      The full invoked ARN as provided on the Context passed to the function ( Lambda-Runtime-Invoked-Function-Arn header on the /runtime/invocation/next applicable).

      Notes:

      • This may be different from cloud.resource_id if an alias is involved.

    • CLOUDEVENTS_EVENT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUDEVENTS_EVENT_ID
      The event_id uniquely identifies the event.

    • CLOUDEVENTS_EVENT_SOURCE

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUDEVENTS_EVENT_SOURCE
      The source identifies the context in which an event happened.

    • CLOUDEVENTS_EVENT_SPEC_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUDEVENTS_EVENT_SPEC_VERSION
      The version of the CloudEvents specification which the event uses.

    • CLOUDEVENTS_EVENT_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUDEVENTS_EVENT_TYPE
      The event_type contains a value describing the type of event related to the originating occurrence.

    • CLOUDEVENTS_EVENT_SUBJECT

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUDEVENTS_EVENT_SUBJECT
      The subject of the event in the context of the event producer (identified by source).

    • OPENTRACING_REF_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> OPENTRACING_REF_TYPE
      Parent-child Reference type

      Notes:

      • The causal relationship between a child Span and a parent Span.

    • 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) driver used to connect.

    • DB_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_NAME
      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).

      Notes:

      • In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name).

    • DB_STATEMENT

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_STATEMENT
      The database statement being executed.

    • 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 such as findAndModify, or the SQL keyword.

      Notes:

      • 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.

    • DB_MSSQL_INSTANCE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_MSSQL_INSTANCE_NAME
      The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance.

      Notes:

      • If setting a db.mssql.instance_name, server.port is no longer required (but still recommended if non-standard).

    • 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.

    • 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 keyspace name (if applicable).

      Notes:

      • 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_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, 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 database name (if applicable).

      Notes:

      • 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_COSMOSDB_CLIENT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CLIENT_ID
      Unique Cosmos client instance id.

    • DB_COSMOSDB_OPERATION_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_OPERATION_TYPE
      CosmosDB Operation Type.

    • DB_COSMOSDB_CONNECTION_MODE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONNECTION_MODE
      Cosmos client connection mode.

    • DB_COSMOSDB_CONTAINER

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONTAINER
      Cosmos DB container name.

    • DB_COSMOSDB_REQUEST_CONTENT_LENGTH

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_REQUEST_CONTENT_LENGTH
      Request payload size in bytes

    • DB_COSMOSDB_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_STATUS_CODE
      Cosmos DB status code.

    • DB_COSMOSDB_SUB_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_SUB_STATUS_CODE
      Cosmos DB sub status code.

    • DB_COSMOSDB_REQUEST_CHARGE

      public static final io.opentelemetry.api.common.AttributeKey<Double> DB_COSMOSDB_REQUEST_CHARGE
      RU consumed for that operation

    • OTEL_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_STATUS_CODE
      Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET.

    • OTEL_STATUS_DESCRIPTION

      public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_STATUS_DESCRIPTION
      Description of the Status if it has a value, otherwise not set.

    • FAAS_TRIGGER

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_TRIGGER
      Type of the trigger which caused this function invocation.

      Notes:

      • For the server/consumer span on the incoming side, faas.trigger MUST be set.
      • Clients invoking FaaS instances usually cannot set faas.trigger, since they would typically need to look in the payload to determine the event type. If clients set it, it should be the same as the trigger that corresponding incoming would have (i.e., this has nothing to do with the underlying transport used to make the API call to invoke the lambda, which is often HTTP).

    • FAAS_INVOCATION_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INVOCATION_ID
      The invocation ID of the current function invocation.

    • 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 format expressed in UTC.

    • 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.

    • FAAS_TIME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_TIME
      A string containing the function invocation time in the ISO 8601 format expressed in UTC.

    • FAAS_CRON

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_CRON
      A string containing the schedule period as Cron Expression.

    • 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.

      Notes:

      • 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.

      Notes:

      • 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.

      Notes:

      • SHOULD be equal to the cloud.region resource attribute of the invoked function.

    • FEATURE_FLAG_KEY

      public static final io.opentelemetry.api.common.AttributeKey<String> FEATURE_FLAG_KEY
      The unique identifier of the feature flag.

    • FEATURE_FLAG_PROVIDER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> FEATURE_FLAG_PROVIDER_NAME
      The name of the service provider that performs the flag evaluation.

    • FEATURE_FLAG_VARIANT

      public static final io.opentelemetry.api.common.AttributeKey<String> FEATURE_FLAG_VARIANT
      SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used.

      Notes:

      • A semantic identifier, commonly referred to as a variant, provides a means for referring to a value without including the value itself. This can provide additional context for understanding the meaning behind a value. For example, the variant red maybe be used for the value #c05543.
      • A stringified version of the value can be used in situations where a semantic identifier is unavailable. String representation of the value should be determined by the implementer.

    • NETWORK_TRANSPORT

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_TRANSPORT
      OSI Transport Layer or Inter-process Communication method. The value SHOULD be normalized to lowercase.

    • NETWORK_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_TYPE
      OSI Network Layer or non-OSI equivalent. The value SHOULD be normalized to lowercase.

    • NETWORK_PROTOCOL_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_PROTOCOL_NAME
      OSI Application Layer or non-OSI equivalent. The value SHOULD be normalized to lowercase.

    • NETWORK_PROTOCOL_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_PROTOCOL_VERSION
      Version of the application layer protocol used. See note below.

      Notes:

      • network.protocol.version refers to the version of the protocol used and might be different from the protocol client's version. If the HTTP client used has a version of 0.27.2, but sends HTTP version 1.1, this attribute should be set to 1.1.

    • NETWORK_CONNECTION_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_CONNECTION_TYPE
      The internet connection type.

    • NETWORK_CONNECTION_SUBTYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_CONNECTION_SUBTYPE
      This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection.

    • NETWORK_CARRIER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_CARRIER_NAME
      The name of the mobile carrier.

    • NETWORK_CARRIER_MCC

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_CARRIER_MCC
      The mobile carrier country code.

    • NETWORK_CARRIER_MNC

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_CARRIER_MNC
      The mobile carrier network code.

    • NETWORK_CARRIER_ICC

      public static final io.opentelemetry.api.common.AttributeKey<String> NETWORK_CARRIER_ICC
      The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network.

    • PEER_SERVICE

      public static final io.opentelemetry.api.common.AttributeKey<String> PEER_SERVICE
      The service.name 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 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 or an attribute value in a SAML 2.0 Assertion.

    • 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.

    • CODE_COLUMN

      public static final io.opentelemetry.api.common.AttributeKey<Long> CODE_COLUMN
      The column number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function.

    • HTTP_REQUEST_METHOD_ORIGINAL

      public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_REQUEST_METHOD_ORIGINAL
      Original HTTP method sent by the client in the request line.

    • HTTP_REQUEST_BODY_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_BODY_SIZE
      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 header. For requests using transport encoding, this should be the compressed size.

    • HTTP_RESPONSE_BODY_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_BODY_SIZE
      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 header. For requests using transport encoding, this should be the compressed size.

    • HTTP_RESEND_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESEND_COUNT
      The ordinal number of request resending attempt (for any reason, including redirects).

      Notes:

      • The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other).

    • AWS_REQUEST_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_REQUEST_ID
      The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid.

    • AWS_DYNAMODB_TABLE_NAMES

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_TABLE_NAMES
      The keys in the RequestItems object field.

    • AWS_DYNAMODB_CONSUMED_CAPACITY

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_CONSUMED_CAPACITY
      The JSON-serialized value of each item in the ConsumedCapacity response field.

    • AWS_DYNAMODB_ITEM_COLLECTION_METRICS

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_DYNAMODB_ITEM_COLLECTION_METRICS
      The JSON-serialized value of the ItemCollectionMetrics response field.

    • AWS_DYNAMODB_PROVISIONED_READ_CAPACITY

      public static final io.opentelemetry.api.common.AttributeKey<Double> AWS_DYNAMODB_PROVISIONED_READ_CAPACITY
      The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.

    • AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY

      public static final io.opentelemetry.api.common.AttributeKey<Double> AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY
      The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.

    • AWS_DYNAMODB_CONSISTENT_READ

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> AWS_DYNAMODB_CONSISTENT_READ
      The value of the ConsistentRead request parameter.

    • AWS_DYNAMODB_PROJECTION

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_DYNAMODB_PROJECTION
      The value of the ProjectionExpression request parameter.

    • AWS_DYNAMODB_LIMIT

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_DYNAMODB_LIMIT
      The value of the Limit request parameter.

    • AWS_DYNAMODB_ATTRIBUTES_TO_GET

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_ATTRIBUTES_TO_GET
      The value of the AttributesToGet request parameter.

    • AWS_DYNAMODB_INDEX_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_DYNAMODB_INDEX_NAME
      The value of the IndexName request parameter.

    • AWS_DYNAMODB_SELECT

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_DYNAMODB_SELECT
      The value of the Select request parameter.

    • AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES
      The JSON-serialized value of each item of the GlobalSecondaryIndexes request field

    • AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES
      The JSON-serialized value of each item of the LocalSecondaryIndexes request field.

    • AWS_DYNAMODB_EXCLUSIVE_START_TABLE

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_DYNAMODB_EXCLUSIVE_START_TABLE
      The value of the ExclusiveStartTableName request parameter.

    • AWS_DYNAMODB_TABLE_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_DYNAMODB_TABLE_COUNT
      The the number of items in the TableNames response parameter.

    • AWS_DYNAMODB_SCAN_FORWARD

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> AWS_DYNAMODB_SCAN_FORWARD
      The value of the ScanIndexForward request parameter.

    • AWS_DYNAMODB_SEGMENT

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_DYNAMODB_SEGMENT
      The value of the Segment request parameter.

    • AWS_DYNAMODB_TOTAL_SEGMENTS

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_DYNAMODB_TOTAL_SEGMENTS
      The value of the TotalSegments request parameter.

    • AWS_DYNAMODB_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_DYNAMODB_COUNT
      The value of the Count response parameter.

    • AWS_DYNAMODB_SCANNED_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_DYNAMODB_SCANNED_COUNT
      The value of the ScannedCount response parameter.

    • AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS
      The JSON-serialized value of each item in the AttributeDefinitions request field.

    • AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES
      The JSON-serialized value of each item in the the GlobalSecondaryIndexUpdates request field.

    • AWS_S3_BUCKET

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_S3_BUCKET
      The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations.

      Notes:

      • The bucket attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. This applies to almost all S3 operations except list-buckets.

    • AWS_S3_KEY

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_S3_KEY
      The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.

      Notes:

    • AWS_S3_COPY_SOURCE

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_S3_COPY_SOURCE
      The source object (in the form bucket/key) for the copy operation.

      Notes:

    • AWS_S3_UPLOAD_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_S3_UPLOAD_ID
      Upload ID that identifies the multipart upload.

      Notes:

    • AWS_S3_DELETE

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_S3_DELETE
      The delete request container that specifies the objects to be deleted.

      Notes:

    • AWS_S3_PART_NUMBER

      public static final io.opentelemetry.api.common.AttributeKey<Long> AWS_S3_PART_NUMBER
      The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000.

      Notes:

    • GRAPHQL_OPERATION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> GRAPHQL_OPERATION_NAME
      The name of the operation being executed.

    • GRAPHQL_OPERATION_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> GRAPHQL_OPERATION_TYPE
      The type of the operation being executed.

    • GRAPHQL_DOCUMENT

      public static final io.opentelemetry.api.common.AttributeKey<String> GRAPHQL_DOCUMENT
      The GraphQL document being executed.

      Notes:

      • The value may be sanitized to exclude sensitive information.

    • 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_MESSAGE_CONVERSATION_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_MESSAGE_CONVERSATION_ID
      The conversation ID 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.

    • MESSAGING_DESTINATION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_NAME
      The message destination name

      Notes:

      • Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If the broker does not have such notion, the destination name SHOULD uniquely identify the broker.

    • MESSAGING_DESTINATION_TEMPLATE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_TEMPLATE
      Low cardinality representation of the messaging destination name

      Notes:

      • Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.

    • MESSAGING_DESTINATION_TEMPORARY

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_DESTINATION_TEMPORARY
      A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.

    • MESSAGING_DESTINATION_ANONYMOUS

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_DESTINATION_ANONYMOUS
      A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).

    • MESSAGING_SYSTEM

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SYSTEM
      A string identifying the messaging system.

    • MESSAGING_OPERATION

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_OPERATION
      A string identifying the kind of messaging operation as defined in the Operation names section above.

      Notes:

      • If a custom value is used, it MUST be of low cardinality.

    • MESSAGING_BATCH_MESSAGE_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_BATCH_MESSAGE_COUNT
      The number of messages sent, received, or processed in the scope of the batching operation.

      Notes:

      • Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.

    • MESSAGING_CLIENT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_CLIENT_ID
      A unique identifier for the client that consumes or produces a message.

    • MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY
      RabbitMQ message routing key.

    • 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.

      Notes:

      • 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_DESTINATION_PARTITION

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_DESTINATION_PARTITION
      Partition the message is sent to.

    • MESSAGING_KAFKA_MESSAGE_OFFSET

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_MESSAGE_OFFSET
      The offset of a record in the corresponding Kafka partition.

    • MESSAGING_KAFKA_MESSAGE_TOMBSTONE

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_KAFKA_MESSAGE_TOMBSTONE
      A boolean that is true if the message is a tombstone.

    • MESSAGING_ROCKETMQ_NAMESPACE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_NAMESPACE
      Namespace of RocketMQ resources, resources in different namespaces are individual.

    • MESSAGING_ROCKETMQ_CLIENT_GROUP

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_CLIENT_GROUP
      Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind.

    • MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP
      The timestamp in milliseconds that the delay message is expected to be delivered to consumer.

    • MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL
      The delay time level for delay message, which determines the message delay time.

    • MESSAGING_ROCKETMQ_MESSAGE_GROUP

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_GROUP
      It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.

    • MESSAGING_ROCKETMQ_MESSAGE_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_TYPE
      Type of message.

    • MESSAGING_ROCKETMQ_MESSAGE_TAG

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_TAG
      The secondary classifier of message besides topic.

    • MESSAGING_ROCKETMQ_MESSAGE_KEYS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> MESSAGING_ROCKETMQ_MESSAGE_KEYS
      Key(s) of message, another way to mark message besides message id.

    • MESSAGING_ROCKETMQ_CONSUMPTION_MODEL

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_CONSUMPTION_MODEL
      Model of message consumption. This only applies to consumer spans.

    • RPC_SYSTEM

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SYSTEM
      A string identifying the remoting system. See below for a list of well-known identifiers.

    • RPC_SERVICE

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_SERVICE
      The full (logical) name of the service being called, including its package name, if applicable.

      Notes:

      • This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

    • RPC_METHOD

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_METHOD
      The name of the (logical) method being called, must be equal to the $method part in the span name.

      Notes:

      • This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

    • RPC_GRPC_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_GRPC_STATUS_CODE
      The numeric status code of the gRPC request.

    • RPC_JSONRPC_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_VERSION
      Protocol version as in jsonrpc property of request/response. Since JSON-RPC 1.0 does not specify this, the value can be omitted.

    • RPC_JSONRPC_REQUEST_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_REQUEST_ID
      id property of request or response. Since protocol allows id to be int, string, null or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of null value. Omit entirely if this is a notification.

    • RPC_JSONRPC_ERROR_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> RPC_JSONRPC_ERROR_CODE
      error.code property of response if it is an error response.

    • RPC_JSONRPC_ERROR_MESSAGE

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_JSONRPC_ERROR_MESSAGE
      error.message property of response if it is an error response.

    • MESSAGE_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGE_TYPE
      Whether this is a received or sent message.

    • MESSAGE_ID

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGE_ID
      MUST be calculated as two different counters starting from 1 one for sent messages and one for received message.

      Notes:

      • This way we guarantee that the values will be consistent between different implementations.

    • MESSAGE_COMPRESSED_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGE_COMPRESSED_SIZE
      Compressed size of the message in bytes.

    • MESSAGE_UNCOMPRESSED_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGE_UNCOMPRESSED_SIZE
      Uncompressed size of the message in bytes.

    • RPC_CONNECT_RPC_ERROR_CODE

      public static final io.opentelemetry.api.common.AttributeKey<String> RPC_CONNECT_RPC_ERROR_CODE
      The error codes of the Connect request. Error codes are always string values.

    • 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.

      Notes:

      • 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.
      • 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.

    • URL_SCHEME

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_SCHEME
      The URI scheme component identifying the used protocol.

    • URL_FULL

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_FULL
      Absolute URL describing a network resource according to RFC3986

      Notes:

      • For network calls, URL usually has scheme://host[:port][path][?query][#fragment] format, where the fragment is not transmitted over HTTP, but if it is known, it should be included nevertheless. url.full MUST NOT contain credentials passed via URL in form of https://username:password@www.example.com/. In such case username and password should be redacted and attribute's value should be https://REDACTED:REDACTED@www.example.com/. url.full SHOULD capture the absolute URL when it is available (or can be reconstructed) and SHOULD NOT be validated or modified except for sanitizing purposes.

    • URL_PATH

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_PATH
      The URI path component

      Notes:

      • When missing, the value is assumed to be /

    • URL_QUERY

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_QUERY
      The URI query component

      Notes:

      • Sensitive content provided in query string SHOULD be scrubbed when instrumentations can identify it.

    • URL_FRAGMENT

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_FRAGMENT
      The URI fragment component

    • USER_AGENT_ORIGINAL

      public static final io.opentelemetry.api.common.AttributeKey<String> USER_AGENT_ORIGINAL
      Value of the HTTP User-Agent header sent by the client.

    • 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:

    • DB_CASSANDRA_KEYSPACE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_KEYSPACE
      Deprecated.
      this item has been removed as of 1.8.0 of the semantic conventions. Please use DB_NAME instead.
      The name of the keyspace being accessed.

    • DB_HBASE_NAMESPACE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_HBASE_NAMESPACE
      Deprecated.
      this item has been removed as of 1.8.0 of the semantic conventions. Please use DB_NAME instead.
      The HBase namespace being accessed.

    • HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
      Deprecated.
      this item has been removed as of 1.13.0 of the semantic conventions. Please use HTTP_REQUEST_CONTENT_LENGTH instead.
      The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used.

    • HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
      Deprecated.
      This item has been removed as of 1.13.0 of the semantic conventions. Please use HTTP_RESPONSE_CONTENT_LENGTH instead.

    • HTTP_SERVER_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_SERVER_NAME
      Deprecated.
      This item has been removed as of 1.13.0 of the semantic conventions. Please use NET_HOST_NAME instead.

    • HTTP_HOST

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_HOST
      Deprecated.
      This item has been removed as of 1.13.0 of the semantic conventions. Please use NET_HOST_NAME instead.

    • NET_PEER_IP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_PEER_IP
      Deprecated.
      This item has been removed as of 1.13.0 of the semantic conventions. Please use NET_SOCK_PEER_ADDR instead.

    • NET_HOST_IP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_IP
      Deprecated.
      This item has been removed as of 1.13.0 of the semantic conventions. Please use NET_SOCK_HOST_ADDR instead.

    • HTTP_RETRY_COUNT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RETRY_COUNT
      Deprecated.
      This item has been removed as of 1.15.0 of the semantic conventions. Use HTTP_RESEND_COUNT instead.
      The ordinal number of request re-sending attempt.

    • MESSAGING_DESTINATION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_DESTINATION_NAME instead.
      A string identifying the messaging system.

    • MESSAGING_TEMP_DESTINATION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_TEMP_DESTINATION
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_DESTINATION_TEMPORARY instead.
      A boolean that is true if the message destination is temporary.

    • MESSAGING_PROTOCOL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_PROTOCOL
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use NET_PROTOCOL_NAME instead.
      The name of the transport protocol.

    • MESSAGING_PROTOCOL_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_PROTOCOL_VERSION
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use NET_PROTOCOL_VERSION instead.
      The version of the transport protocol.

    • MESSAGING_URL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_URL
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. There is no replacement.
      Connection string.

    • MESSAGING_CONVERSATION_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_CONVERSATION_ID
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_MESSAGE_CONVERSATION_ID instead.
      The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".

    • MESSAGING_RABBITMQ_ROUTING_KEY

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_RABBITMQ_ROUTING_KEY
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY instead.
      RabbitMQ message routing key.

    • MESSAGING_KAFKA_PARTITION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_PARTITION
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_KAFKA_SOURCE_PARTITION instead.
      Partition the message is received from.

    • MESSAGING_KAFKA_TOMBSTONE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_KAFKA_TOMBSTONE
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_KAFKA_MESSAGE_TOMBSTONE instead.
      A boolean that is true if the message is a tombstone.

    • MESSAGING_ROCKETMQ_DELIVERY_TIMESTAMP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_DELIVERY_TIMESTAMP
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP instead.
      The timestamp in milliseconds that the delay message is expected to be delivered to consumer.

    • MESSAGING_ROCKETMQ_DELAY_TIME_LEVEL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_DELAY_TIME_LEVEL
      Deprecated.
      This item has been removed as of 1.17.0 of the semantic conventions. Use MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL instead.
      The delay time level for delay message, which determines the message delay time.

    • OTEL_SCOPE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_SCOPE_NAME
      Deprecated.
      This item has been moved, use ResourceAttributes.OTEL_SCOPE_NAME instead.
      The name of the instrumentation scope - (InstrumentationScope.Name in OTLP).

    • OTEL_SCOPE_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_SCOPE_VERSION
      Deprecated.
      This item has been moved, use ResourceAttributes.OTEL_SCOPE_VERSION instead.
      The version of the instrumentation scope - (InstrumentationScope.Version in OTLP).

    • FAAS_EXECUTION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_EXECUTION
      Deprecated.
      This item has been renamed in 1.19.0 version of the semantic conventions. Use FAAS_INVOCATION_ID instead.
      The execution ID of the current function execution.

    • HTTP_USER_AGENT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_USER_AGENT
      Deprecated.
      This item has been renamed in 1.19.0 version of the semantic conventions. Use USER_AGENT_ORIGINAL instead.
      Value of the HTTP User-Agent header sent by the client.

    • OTEL_LIBRARY_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_NAME
      Deprecated.
      Deprecated, use the ResourceAttributes.OTEL_SCOPE_NAME attribute.
      Deprecated.

    • OTEL_LIBRARY_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_VERSION
      Deprecated.
      Deprecated, use the ResourceAttributes.OTEL_SCOPE_VERSION attribute.
      Deprecated.

    • HTTP_FLAVOR

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_FLAVOR
      Deprecated.
      This item has been removed as of 1.20.0 of the semantic conventions.
      Kind of HTTP protocol used.

    • NET_APP_PROTOCOL_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_APP_PROTOCOL_NAME
      Deprecated.
      This item has been removed as of 1.20.0 of the semantic conventions. Use NET_PROTOCOL_NAME instead.
      Application layer protocol used. The value SHOULD be normalized to lowercase.

    • NET_APP_PROTOCOL_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_APP_PROTOCOL_VERSION
      Deprecated.
      This item has been removed as of 1.20.0 of the semantic conventions. Use NET_PROTOCOL_VERSION instead.
      Version of the application layer protocol used. See note below.

      Notes:

      • net.app.protocol.version refers to the version of the protocol used and might be different from the protocol client's version. If the HTTP client used has a version of 0.27.2, but sends HTTP version 1.1, this attribute should be set to 1.1.

    • MESSAGING_DESTINATION_KIND

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_DESTINATION_KIND
      Deprecated.
      This item has been removed as of 1.20.0 of the semantic conventions.
      The kind of message destination.

    • MESSAGING_SOURCE_KIND

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SOURCE_KIND
      Deprecated.
      This item has been removed as of 1.20.0 of the semantic conventions.
      The kind of message source.

    • NET_HOST_CONNECTION_TYPE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CONNECTION_TYPE
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use NETWORK_CONNECTION_TYPE instead.
      The internet connection type currently being used by the host.

    • NET_HOST_CONNECTION_SUBTYPE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CONNECTION_SUBTYPE
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use NETWORK_CONNECTION_SUBTYPE instead.
      This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection.

    • NET_HOST_CARRIER_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CARRIER_NAME
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use NETWORK_CARRIER_NAME instead.
      The name of the mobile carrier.

    • NET_HOST_CARRIER_MCC

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CARRIER_MCC
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use NETWORK_CARRIER_MCC instead.
      The mobile carrier country code.

    • NET_HOST_CARRIER_MNC

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CARRIER_MNC
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use NETWORK_CARRIER_MNC instead.
      The mobile carrier network code.

    • NET_HOST_CARRIER_ICC

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CARRIER_ICC
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use NETWORK_CARRIER_ICC instead.
      The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network.

    • HTTP_CLIENT_IP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_CLIENT_IP
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. Use CLIENT_ADDRESS instead.
      The IP address of the original client behind all proxies, if known (e.g. from X-Forwarded-For).

      Notes:

      • This is not necessarily the same as net.sock.peer.addr, which would identify the network-level peer, which may be a proxy.
      • This attribute should be set when a source of information different from the one used for net.sock.peer.addr, is available even if that other source just confirms the same value as net.sock.peer.addr. Rationale: For net.sock.peer.addr, one typically does not know if it comes from a proxy, reverse proxy, or the actual client. Setting http.client_ip when it's the same as net.sock.peer.addr means that one is at least somewhat confident that the address is not that of the closest proxy.

    • MESSAGING_SOURCE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SOURCE_NAME
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions.
      The message source name.

      Notes:

      • Source name SHOULD uniquely identify a specific queue, topic, or other entity within the broker. If the broker does not have such notion, the source name SHOULD uniquely identify the broker.

    • MESSAGING_SOURCE_TEMPLATE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_SOURCE_TEMPLATE
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions.
      Low cardinality representation of the messaging source name.

      Notes:

      • Source names could be constructed from templates. An example would be a source name involving a user name or product id. Although the source name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.

    • MESSAGING_SOURCE_TEMPORARY

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_SOURCE_TEMPORARY
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions.
      A boolean that is true if the message source is temporary and might not exist anymore after messages are processed.

    • MESSAGING_SOURCE_ANONYMOUS

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_SOURCE_ANONYMOUS
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions.
      A boolean that is true if the message source is anonymous (could be unnamed or have auto-generated name).

    • MESSAGING_CONSUMER_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_CONSUMER_ID
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. See MESSAGING_CLIENT_ID.
      The identifier for the consumer receiving a message. For Kafka, set it to {messaging.kafka.consumer.group} - {messaging.kafka.client_id}, if both are present, or only messaging.kafka.consumer.group. For brokers, such as RabbitMQ and Artemis, set it to the client_id of the client consuming the message.

    • MESSAGING_KAFKA_CLIENT_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_KAFKA_CLIENT_ID
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. See MESSAGING_CLIENT_ID.
      Client Id for the Consumer or Producer that is handling the message.

    • MESSAGING_KAFKA_SOURCE_PARTITION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_KAFKA_SOURCE_PARTITION
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions.
      Partition the message is received from.

    • MESSAGING_ROCKETMQ_CLIENT_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_CLIENT_ID
      Deprecated.
      This item has been removed in 1.21.0 version of the semantic conventions. See MESSAGING_CLIENT_ID.
      The unique identifier for each client.