module OpenTelemetry::SemanticConventions::Trace

Constants

AWS_DYNAMODB_ATTRIBUTES_TO_GET

The value of the `AttributesToGet` request parameter

AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS

The JSON-serialized value of each item in the `AttributeDefinitions` request field

AWS_DYNAMODB_CONSISTENT_READ

The value of the `ConsistentRead` request parameter

AWS_DYNAMODB_CONSUMED_CAPACITY

The JSON-serialized value of each item in the `ConsumedCapacity` response field

AWS_DYNAMODB_COUNT

The value of the `Count` response parameter

AWS_DYNAMODB_EXCLUSIVE_START_TABLE

The value of the `ExclusiveStartTableName` request parameter

AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES

The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field

AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES

The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field

AWS_DYNAMODB_INDEX_NAME

The value of the `IndexName` request parameter

AWS_DYNAMODB_ITEM_COLLECTION_METRICS

The JSON-serialized value of the `ItemCollectionMetrics` response field

AWS_DYNAMODB_LIMIT

The value of the `Limit` request parameter

AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES

The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field

AWS_DYNAMODB_PROJECTION

The value of the `ProjectionExpression` request parameter

AWS_DYNAMODB_PROVISIONED_READ_CAPACITY

The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter

AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY

The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter

AWS_DYNAMODB_SCANNED_COUNT

The value of the `ScannedCount` response parameter

AWS_DYNAMODB_SCAN_FORWARD

The value of the `ScanIndexForward` request parameter

AWS_DYNAMODB_SEGMENT

The value of the `Segment` request parameter

AWS_DYNAMODB_SELECT

The value of the `Select` request parameter

AWS_DYNAMODB_TABLE_COUNT

The the number of items in the `TableNames` response parameter

AWS_DYNAMODB_TABLE_NAMES

The keys in the `RequestItems` object field

AWS_DYNAMODB_TOTAL_SEGMENTS

The value of the `TotalSegments` request parameter

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) @note This may be different from `faas.id` if an alias is involved

CODE_FILEPATH

The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path)

CODE_FUNCTION

The method or function name, or equivalent (usually rightmost part of the code unit's name)

CODE_LINENO

The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`

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

DB_CASSANDRA_CONSISTENCY_LEVEL

The consistency level of the query. Based on consistency values from [CQL](docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html)

DB_CASSANDRA_COORDINATOR_DC

The data center of the coordinating node for a query

DB_CASSANDRA_COORDINATOR_ID

The ID of the coordinating node for a query

DB_CASSANDRA_IDEMPOTENCE

Whether or not the query is idempotent

DB_CASSANDRA_KEYSPACE

The name of the keyspace being accessed. To be used instead of the generic `db.name` attribute

DB_CASSANDRA_PAGE_SIZE

The fetch size used for paging, i.e. how many rows will be returned at once

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_TABLE

The name of the primary table that the operation is acting upon, including the schema name (if applicable) @note This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set

DB_CONNECTION_STRING

The connection string used to connect to the database. It is recommended to remove embedded credentials

DB_HBASE_NAMESPACE

The [HBase namespace](hbase.apache.org/book.html#_namespace) being accessed. To be used instead of the generic `db.name` attribute

DB_JDBC_DRIVER_CLASSNAME

The fully-qualified class name of the [Java Database Connectivity (JDBC)](docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect

DB_MONGODB_COLLECTION

The collection being accessed within the database stated in `db.name`

DB_MSSQL_INSTANCE_NAME

The Microsoft SQL Server [instance name](docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to. This name is used to determine the port of a named instance @note If setting a `db.mssql.instance_name`, `net.peer.port` is no longer required (but still recommended if non-standard)

DB_NAME

If no [tech-specific attribute](call-level-attributes-for-specific-technologies) is defined, this attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails) @note In some SQL databases, the database name to be used is called “schema name”

DB_OPERATION

The name of the operation being executed, e.g. the [MongoDB command name](docs.mongodb.com/manual/reference/command/#database-operations) such as `findAndModify`, or the SQL keyword @note When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted

DB_REDIS_DATABASE_INDEX

The index of the database being accessed as used in the [`SELECT` command](redis.io/commands/select), provided as an integer. To be used instead of the generic `db.name` attribute

DB_SQL_TABLE

The name of the primary table that the operation is acting upon, including the schema name (if applicable) @note It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set

DB_STATEMENT

The database statement being executed @note The value may be sanitized to exclude sensitive information

DB_SYSTEM

An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers

DB_USER

Username for accessing the database

ENDUSER_ID

Username or client_id extracted from the access token or [Authorization](tools.ietf.org/html/rfc7235#section-4.2) header in the inbound request from outside the system

ENDUSER_ROLE

Actual/assumed role the client is making the request under extracted from token or application security context

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](tools.ietf.org/html/rfc6749#section-3.3) or an attribute value in a [SAML 2.0 Assertion](docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html)

EXCEPTION_ESCAPED

SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span @note An exception is considered to have escaped (or left) the scope of a span,

if that span is ended while the exception is still logically "in flight".
This may be actually "in flight" in some languages (e.g. if the exception
is passed to a Context manager's `__exit__` method in Python) but will
usually be caught at the point of recording the exception in most languages.

It is usually not possible to determine at the point where an exception is thrown
whether it will escape the scope of a span.
However, it is trivial to know that an exception
will escape, if one checks for an active exception just before ending the span,
as done in the [example above](#exception-end-example).

It follows that an exception may still escape the scope of the span
even if the `exception.escaped` attribute was not set or set to false,
since the event might have been recorded at a time where it was not
clear whether the exception will escape
EXCEPTION_MESSAGE

The exception message

EXCEPTION_STACKTRACE

A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG

EXCEPTION_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

FAAS_COLDSTART

A boolean that is true if the serverless function is executed for the first time (aka cold-start)

FAAS_CRON

A string containing the schedule period as [Cron Expression](docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm)

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

Describes the type of the operation that was performed on the data

FAAS_DOCUMENT_TIME

A string containing the time when the data was accessed in the [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](www.w3.org/TR/NOTE-datetime)

FAAS_EXECUTION

The execution ID of the current function execution

FAAS_INVOKED_NAME

The name of the invoked function @note SHOULD be equal to the `faas.name` resource attribute of the invoked function

FAAS_INVOKED_PROVIDER

The cloud provider of the invoked function @note SHOULD be equal to the `cloud.provider` resource attribute of the invoked function

FAAS_INVOKED_REGION

The cloud region of the invoked function @note SHOULD be equal to the `cloud.region` resource attribute of the invoked function

FAAS_TIME

A string containing the function invocation time in the [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](www.w3.org/TR/NOTE-datetime)

FAAS_TRIGGER

Type of the trigger on which the function is executed

HTTP_CLIENT_IP

The IP address of the original client behind all proxies, if known (e.g. from [X-Forwarded-For](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For)) @note This is not necessarily the same as `net.peer.ip`, which would identify the network-level peer, which may be a proxy

HTTP_FLAVOR

Kind of HTTP protocol used @note If `net.transport` is not specified, it can be assumed to be `IP.TCP` except if `http.flavor` is `QUIC`, in which case `IP.UDP` is assumed

HTTP_HOST

The value of the [HTTP host header](tools.ietf.org/html/rfc7230#section-5.4). When the header is empty or not present, this attribute should be the same

HTTP_METHOD

HTTP request method

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](tools.ietf.org/html/rfc7230#section-3.3.2) header. For requests using transport encoding, this should be the compressed size

HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED

The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used

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](tools.ietf.org/html/rfc7230#section-3.3.2) header. For requests using transport encoding, this should be the compressed size

HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED

The size of the uncompressed response payload body after transport decoding. Not set if transport encoding not used

HTTP_ROUTE

The matched route (path template)

HTTP_SCHEME

The URI scheme identifying the used protocol

HTTP_SERVER_NAME

The primary server name of the matched virtual host. This should be obtained via configuration. If no such configuration can be obtained, this attribute MUST NOT be set ( `net.host.name` should be used instead) @note `http.url` is usually not readily available on the server side but would have to be assembled in a cumbersome and sometimes lossy process from other information (see e.g. open-telemetry/opentelemetry-python/pull/148). It is thus preferred to supply the raw data that is available

HTTP_STATUS_CODE

[HTTP response status code](tools.ietf.org/html/rfc7231#section-6)

HTTP_TARGET

The full request target as passed in a HTTP request line or equivalent

HTTP_URL

Full HTTP request URL in the form `scheme://host/path?query`. Usually the fragment is not transmitted over HTTP, but if it is known, it should be included nevertheless @note `http.url` MUST NOT contain credentials passed via URL in form of `username:password@www.example.com/`. In such case the attribute's value should be `www.example.com/`

HTTP_USER_AGENT

Value of the [HTTP User-Agent](tools.ietf.org/html/rfc7231#section-5.5.3) header sent by the client

MESSAGING_CONVERSATION_ID

The [conversation ID](conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called “Correlation ID”

MESSAGING_DESTINATION

The message destination name. This might be equal to the span name but is required nevertheless

MESSAGING_DESTINATION_KIND

The kind of message destination

MESSAGING_KAFKA_CLIENT_ID

Client Id for the Consumer or Producer that is handling the message

MESSAGING_KAFKA_CONSUMER_GROUP

Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers

MESSAGING_KAFKA_MESSAGE_KEY

Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from `messaging.message_id` in that they're not unique. If the key is `null`, the attribute MUST NOT be set @note If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value

MESSAGING_KAFKA_PARTITION

Partition the message is sent to

MESSAGING_KAFKA_TOMBSTONE

A boolean that is true if the message is a tombstone

MESSAGING_MESSAGE_ID

A value used by the messaging system as an identifier for the message, represented as a string

MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES

The compressed size of the message payload in bytes

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_OPERATION

A string identifying the kind of message consumption as defined in the [Operation names](operation-names) section above. If the operation is “send”, this attribute MUST NOT be set, since the operation can be inferred from the span kind in that case

MESSAGING_PROTOCOL

The name of the transport protocol

MESSAGING_PROTOCOL_VERSION

The version of the transport protocol

MESSAGING_RABBITMQ_ROUTING_KEY

RabbitMQ message routing key

MESSAGING_SYSTEM

A string identifying the messaging system

MESSAGING_TEMP_DESTINATION

A boolean that is true if the message destination is temporary

MESSAGING_URL

Connection string

NET_HOST_CARRIER_ICC

The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network

NET_HOST_CARRIER_MCC

The mobile carrier country code

NET_HOST_CARRIER_MNC

The mobile carrier network code

NET_HOST_CARRIER_NAME

The name of the mobile carrier

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_CONNECTION_TYPE

The internet connection type currently being used by the host

NET_HOST_IP

Like `net.peer.ip` but for the host IP. Useful in case of a multi-IP host

NET_HOST_NAME

Local hostname or similar, see note below

NET_HOST_PORT

Like `net.peer.port` but for the host port

NET_PEER_IP

Remote address of the peer (dotted decimal for IPv4 or [RFC5952](tools.ietf.org/html/rfc5952) for IPv6)

NET_PEER_NAME

Remote hostname or similar, see note below

NET_PEER_PORT

Remote port number

NET_TRANSPORT

Transport protocol used. See note below

PEER_SERVICE

The [`service.name`](../../resource/semantic_conventions/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any

RPC_GRPC_STATUS_CODE

The [numeric status code](github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request

RPC_JSONRPC_ERROR_CODE

`error.code` property of response if it is an error response

RPC_JSONRPC_ERROR_MESSAGE

`error.message` property of response if it is an error response

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

The name of the operation corresponding to the request, as returned by the AWS SDK @note 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_SERVICE

The name of the service to which a request is made, as returned by the AWS SDK @note 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_SYSTEM

The value `aws-api`

THREAD_ID

Current “managed” thread ID (as opposed to OS thread ID)

THREAD_NAME

Current thread name