Module: OpenTelemetry::SemanticConventions::Trace

Defined in:: lib/opentelemetry/semantic_conventions/trace.rb

Constant Summary collapse

AWS_LAMBDA_INVOKED_ARN =

Note:

This may be different from faas.id if an alias is involved

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)

'aws.lambda.invoked_arn'

CLOUDEVENTS_EVENT_ID = The event_id uniquely identifies the event

'cloudevents.event_id'

CLOUDEVENTS_EVENT_SOURCE = The source identifies the context in which an event happened

'cloudevents.event_source'

CLOUDEVENTS_EVENT_SPEC_VERSION = The version of the CloudEvents specification which the event uses

'cloudevents.event_spec_version'

CLOUDEVENTS_EVENT_TYPE = The event_type contains a value describing the type of event related to the originating occurrence

'cloudevents.event_type'

CLOUDEVENTS_EVENT_SUBJECT = The subject of the event in the context of the event producer (identified by source)

'cloudevents.event_subject'

OPENTRACING_REF_TYPE =

Note:

The causal relationship between a child Span and a parent Span

Parent-child Reference type

'opentracing.ref_type'

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

'db.system'

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

'db.connection_string'

DB_USER = Username for accessing the database

'db.user'

DB_JDBC_DRIVER_CLASSNAME = The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect

'db.jdbc.driver_classname'

DB_NAME =

Note:

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)

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)

'db.name'

DB_STATEMENT =

Note:

The value may be sanitized to exclude sensitive information

The database statement being executed

'db.statement'

DB_OPERATION =

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

The name of the operation being executed, e.g. the MongoDB command name such as findAndModify, or the SQL keyword

'db.operation'

NET_PEER_NAME = Remote hostname or similar, see note below

'net.peer.name'

NET_PEER_IP = Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6)

'net.peer.ip'

NET_PEER_PORT = Remote port number

'net.peer.port'

NET_TRANSPORT = Transport protocol used. See note below

'net.transport'

DB_MSSQL_INSTANCE_NAME =

Note:

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

The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance

'db.mssql.instance_name'

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

'db.cassandra.page_size'

DB_CASSANDRA_CONSISTENCY_LEVEL = The consistency level of the query. Based on consistency values from CQL

'db.cassandra.consistency_level'

DB_CASSANDRA_TABLE =

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

The name of the primary table that the operation is acting upon, including the keyspace name (if applicable)

'db.cassandra.table'

DB_CASSANDRA_IDEMPOTENCE = Whether or not the query is idempotent

'db.cassandra.idempotence'

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.speculative_execution_count'

DB_CASSANDRA_COORDINATOR_ID = The ID of the coordinating node for a query

'db.cassandra.coordinator.id'

DB_CASSANDRA_COORDINATOR_DC = The data center of the coordinating node for a query

'db.cassandra.coordinator.dc'

DB_REDIS_DATABASE_INDEX = The index of the database being accessed as used in the command[https://redis.io/commands/select], provided as an integer. To be used instead of the generic db.name attribute

'db.redis.database_index'

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

'db.mongodb.collection'

DB_SQL_TABLE =

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

The name of the primary table that the operation is acting upon, including the database name (if applicable)

'db.sql.table'

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.type'

EXCEPTION_MESSAGE = The exception message

'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.stacktrace'

EXCEPTION_ESCAPED =

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.

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

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

'exception.escaped'

FAAS_TRIGGER =

Note:

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)

Type of the trigger which caused this function execution

'faas.trigger'

FAAS_EXECUTION = The execution ID of the current function execution

'faas.execution'

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.collection'

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

'faas.document.operation'

FAAS_DOCUMENT_TIME = A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC

'faas.document.time'

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.name'

HTTP_METHOD = HTTP request method

'http.method'

HTTP_URL =

Note:

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

Full HTTP request URL in the form scheme://host[:port]/path?query[#fragment]. Usually the fragment is not transmitted over HTTP, but if it is known, it should be included nevertheless

'http.url'

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

'http.target'

HTTP_HOST =

Note:

When the header is present but empty the attribute SHOULD be set to the empty string. Note that this is a valid situation that is expected in certain cases, according the aforementioned section of RFC 7230. When the header is not set the attribute MUST NOT be set

The value of the HTTP host header. An empty Host header should also be reported, see note

'http.host'

HTTP_SCHEME = The URI scheme identifying the used protocol

'http.scheme'

HTTP_STATUS_CODE = HTTP response status code

'http.status_code'

HTTP_FLAVOR =

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

Kind of HTTP protocol used

'http.flavor'

HTTP_USER_AGENT = Value of the HTTP User-Agent header sent by the client

'http.user_agent'

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.request_content_length'

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

'http.request_content_length_uncompressed'

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.response_content_length'

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

'http.response_content_length_uncompressed'

HTTP_RETRY_COUNT = The ordinal number of request re-sending attempt

'http.retry_count'

HTTP_SERVER_NAME =

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

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)

'http.server_name'

HTTP_ROUTE = The matched route (path template)

'http.route'

HTTP_CLIENT_IP =

Note:

This is not necessarily the same as net.peer.ip, 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.peer.ip, is available even if that other source just confirms the same value as net.peer.ip. Rationale: For net.peer.ip, 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.peer.ip means that one is at least somewhat confident that the address is not that of the closest proxy

The IP address of the original client behind all proxies, if known (e.g. from X-Forwarded-For)

'http.client_ip'

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

'net.host.ip'

NET_HOST_PORT = Like net.peer.port but for the host port

'net.host.port'

NET_HOST_NAME = Local hostname or similar, see note below

'net.host.name'

NET_HOST_CONNECTION_TYPE = The internet connection type currently being used by the host

'net.host.connection.type'

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.subtype'

NET_HOST_CARRIER_NAME = The name of the mobile carrier

'net.host.carrier.name'

NET_HOST_CARRIER_MCC = The mobile carrier country code

'net.host.carrier.mcc'

NET_HOST_CARRIER_MNC = The mobile carrier network code

'net.host.carrier.mnc'

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

'net.host.carrier.icc'

MESSAGING_SYSTEM = A string identifying the messaging system

'messaging.system'

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

'messaging.destination'

MESSAGING_DESTINATION_KIND = The kind of message destination

'messaging.destination_kind'

MESSAGING_TEMP_DESTINATION = A boolean that is true if the message destination is temporary

'messaging.temp_destination'

MESSAGING_PROTOCOL = The name of the transport protocol

'messaging.protocol'

MESSAGING_PROTOCOL_VERSION = The version of the transport protocol

'messaging.protocol_version'

MESSAGING_URL = Connection string

'messaging.url'

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

'messaging.message_id'

MESSAGING_CONVERSATION_ID = The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called “Correlation ID”

'messaging.conversation_id'

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_size_bytes'

MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES = The compressed size of the message payload in bytes

'messaging.message_payload_compressed_size_bytes'

FAAS_TIME = A string containing the function invocation time in the ISO 8601 format expressed in UTC

'faas.time'

FAAS_CRON = A string containing the schedule period as Cron Expression

'faas.cron'

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

'faas.coldstart'

FAAS_INVOKED_NAME =

Note:

SHOULD be equal to the faas.name resource attribute of the invoked function

The name of the invoked function

'faas.invoked_name'

FAAS_INVOKED_PROVIDER =

Note:

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

The cloud provider of the invoked function

'faas.invoked_provider'

FAAS_INVOKED_REGION =

Note:

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

The cloud region of the invoked function

'faas.invoked_region'

PEER_SERVICE = The href="../../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

'peer.service'

ENDUSER_ID = Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system

'enduser.id'

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

'enduser.role'

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

'enduser.scope'

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

'thread.id'

THREAD_NAME = Current thread name

'thread.name'

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

'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

'code.namespace'

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

'code.filepath'

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

'code.lineno'

RPC_SYSTEM = The value aws-api

'rpc.system'

RPC_SERVICE =

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)

The name of the service to which a request is made, as returned by the AWS SDK

'rpc.service'

RPC_METHOD =

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)

The name of the operation corresponding to the request, as returned by the AWS SDK

'rpc.method'

AWS_DYNAMODB_TABLE_NAMES = The keys in the RequestItems object field

'aws.dynamodb.table_names'

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

'aws.dynamodb.consumed_capacity'

AWS_DYNAMODB_ITEM_COLLECTION_METRICS = The JSON-serialized value of the ItemCollectionMetrics response field

'aws.dynamodb.item_collection_metrics'

AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = The value of the ProvisionedThroughput.ReadCapacityUnits request parameter

'aws.dynamodb.provisioned_read_capacity'

AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = The value of the ProvisionedThroughput.WriteCapacityUnits request parameter

'aws.dynamodb.provisioned_write_capacity'

AWS_DYNAMODB_CONSISTENT_READ = The value of the ConsistentRead request parameter

'aws.dynamodb.consistent_read'

AWS_DYNAMODB_PROJECTION = The value of the ProjectionExpression request parameter

'aws.dynamodb.projection'

AWS_DYNAMODB_LIMIT = The value of the Limit request parameter

'aws.dynamodb.limit'

AWS_DYNAMODB_ATTRIBUTES_TO_GET = The value of the AttributesToGet request parameter

'aws.dynamodb.attributes_to_get'

AWS_DYNAMODB_INDEX_NAME = The value of the IndexName request parameter

'aws.dynamodb.index_name'

AWS_DYNAMODB_SELECT = The value of the Select request parameter

'aws.dynamodb.select'

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

'aws.dynamodb.global_secondary_indexes'

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

'aws.dynamodb.local_secondary_indexes'

AWS_DYNAMODB_EXCLUSIVE_START_TABLE = The value of the ExclusiveStartTableName request parameter

'aws.dynamodb.exclusive_start_table'

AWS_DYNAMODB_TABLE_COUNT = The the number of items in the TableNames response parameter

'aws.dynamodb.table_count'

AWS_DYNAMODB_SCAN_FORWARD = The value of the ScanIndexForward request parameter

'aws.dynamodb.scan_forward'

AWS_DYNAMODB_SEGMENT = The value of the Segment request parameter

'aws.dynamodb.segment'

AWS_DYNAMODB_TOTAL_SEGMENTS = The value of the TotalSegments request parameter

'aws.dynamodb.total_segments'

AWS_DYNAMODB_COUNT = The value of the Count response parameter

'aws.dynamodb.count'

AWS_DYNAMODB_SCANNED_COUNT = The value of the ScannedCount response parameter

'aws.dynamodb.scanned_count'

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

'aws.dynamodb.attribute_definitions'

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

'aws.dynamodb.global_secondary_index_updates'

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.operation'

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.consumer_id'

MESSAGING_RABBITMQ_ROUTING_KEY = RabbitMQ message routing key

'messaging.rabbitmq.routing_key'

MESSAGING_KAFKA_MESSAGE_KEY =

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

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

'messaging.kafka.message_key'

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

'messaging.kafka.consumer_group'

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

'messaging.kafka.client_id'

MESSAGING_KAFKA_PARTITION = Partition the message is sent to

'messaging.kafka.partition'

MESSAGING_KAFKA_TOMBSTONE = A boolean that is true if the message is a tombstone

'messaging.kafka.tombstone'

MESSAGING_ROCKETMQ_NAMESPACE = Namespace of RocketMQ resources, resources in different namespaces are individual

'messaging.rocketmq.namespace'

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_group'

MESSAGING_ROCKETMQ_CLIENT_ID = The unique identifier for each client

'messaging.rocketmq.client_id'

MESSAGING_ROCKETMQ_MESSAGE_TYPE = Type of message

'messaging.rocketmq.message_type'

MESSAGING_ROCKETMQ_MESSAGE_TAG = The secondary classifier of message besides topic

'messaging.rocketmq.message_tag'

MESSAGING_ROCKETMQ_MESSAGE_KEYS = Key(s) of message, another way to mark message besides message id

'messaging.rocketmq.message_keys'

MESSAGING_ROCKETMQ_CONSUMPTION_MODEL = Model of message consumption. This only applies to consumer spans

'messaging.rocketmq.consumption_model'

RPC_GRPC_STATUS_CODE = The numeric status code of the gRPC request

'rpc.grpc.status_code'

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.version'

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.request_id'

RPC_JSONRPC_ERROR_CODE = error.code property of response if it is an error response

'rpc.jsonrpc.error_code'

RPC_JSONRPC_ERROR_MESSAGE = error.message property of response if it is an error response

'rpc.jsonrpc.error_message'

MESSAGE_TYPE = Whether this is a received or sent message

'message.type'

MESSAGE_ID =

Note:

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

MUST be calculated as two different counters starting from 1 one for sent messages and one for received message

'message.id'

MESSAGE_COMPRESSED_SIZE = Compressed size of the message in bytes

'message.compressed_size'

MESSAGE_UNCOMPRESSED_SIZE = Uncompressed size of the message in bytes

'message.uncompressed_size'