Package io.opentelemetry.semconv.trace.attributes

Class SemanticAttributes

java.lang.Object
io.opentelemetry.semconv.trace.attributes.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:

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

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

    • OTEL_SCOPE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_SCOPE_NAME
      The name of the instrumentation scope - (InstrumentationScope.Name in OTLP).

    • OTEL_SCOPE_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_SCOPE_VERSION
      The version of the instrumentation scope - (InstrumentationScope.Version in OTLP).

    • OTEL_LIBRARY_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_NAME
      Deprecated.
      Deprecated, use the `otel.scope.name` attribute.
      Deprecated, use the otel.scope.name attribute.

    • OTEL_LIBRARY_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_VERSION
      Deprecated.
      Deprecated, use the `otel.scope.version` attribute.
      Deprecated, use the otel.scope.version attribute.

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

      Notes:

      • 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 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, net.peer.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.

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

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

    • NET_TRANSPORT

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_TRANSPORT
      Transport protocol used. See note below.

    • NET_APP_PROTOCOL_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_APP_PROTOCOL_NAME
      Application layer protocol used. The value SHOULD be normalized to lowercase.

    • NET_APP_PROTOCOL_VERSION

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

    • NET_SOCK_PEER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_PEER_NAME
      Remote socket peer name.

    • NET_SOCK_PEER_ADDR

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_PEER_ADDR
      Remote socket peer address: IPv4 or IPv6 for internet protocols, path for local communication, etc.

    • NET_SOCK_PEER_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> NET_SOCK_PEER_PORT
      Remote socket peer port.

    • NET_SOCK_FAMILY

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_FAMILY
      Protocol address family which is used for communication.

    • NET_PEER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_PEER_NAME
      Logical remote hostname, see note below.

      Notes:

      • net.peer.name SHOULD NOT be set if capturing it would require an extra DNS lookup.

    • NET_PEER_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> NET_PEER_PORT
      Logical remote port number

    • NET_HOST_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_NAME
      Logical local hostname or similar, see note below.

    • NET_HOST_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> NET_HOST_PORT
      Logical local port number, preferably the one that the peer used to connect

    • NET_SOCK_HOST_ADDR

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_SOCK_HOST_ADDR
      Local socket address. Useful in case of a multi-IP host.

    • NET_SOCK_HOST_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> NET_SOCK_HOST_PORT
      Local socket port number.

    • NET_HOST_CONNECTION_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> NET_HOST_CONNECTION_TYPE
      The internet connection type currently being used by the host.

    • NET_HOST_CONNECTION_SUBTYPE

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

    • NET_HOST_CARRIER_NAME

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

    • NET_HOST_CARRIER_MCC

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

    • NET_HOST_CARRIER_MNC

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

    • NET_HOST_CARRIER_ICC

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

    • HTTP_METHOD

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

    • HTTP_STATUS_CODE

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

    • HTTP_FLAVOR

      public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_FLAVOR
      Kind of HTTP protocol used.

      Notes:

      • 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 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 header. For requests using transport encoding, this should be the compressed size.

    • 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 header. For requests using transport encoding, this should be the compressed size.

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

      Notes:

      • http.url MUST NOT contain credentials passed via URL in form of https://username:[email protected]/. In such case the attribute's value should be https://www.example.com/.

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

    • HTTP_SCHEME

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

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

      • 'http.route' 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.

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

      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.

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

    • 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_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 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_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 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_CONSUMER_ID

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

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_RABBITMQ_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_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_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_TOMBSTONE

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> MESSAGING_KAFKA_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_CLIENT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> MESSAGING_ROCKETMQ_CLIENT_ID
      The unique identifier for each client.

    • MESSAGING_ROCKETMQ_DELIVERY_TIMESTAMP

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

    • MESSAGING_ROCKETMQ_DELAY_TIME_LEVEL

      public static final io.opentelemetry.api.common.AttributeKey<Long> MESSAGING_ROCKETMQ_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.

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

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