Module rama::telemetry::opentelemetry::semantic_conventions::trace

Trace Semantic Conventions

The trace semantic conventions define a set of standardized attributes to be used in Spans.

Usage

use opentelemetry::KeyValue;
use opentelemetry::{global, trace::Tracer as _};
use opentelemetry_semantic_conventions as semconv;

let tracer = global::tracer("my-component");
let _span = tracer
    .span_builder("span-name")
    .with_attributes([
        KeyValue::new(semconv::trace::CLIENT_ADDRESS, "example.org"),
        KeyValue::new(semconv::trace::CLIENT_PORT, 80i64),
    ])
    .start(&tracer);

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 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 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).
• AWS_REQUEST_ID
  The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid.
• AWS_S3_BUCKET
  The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations.
• AWS_S3_COPY_SOURCE
  The source object (in the form bucket/key) for the copy operation.
• AWS_S3_DELETE
  The delete request container that specifies the objects to be deleted.
• AWS_S3_KEY
  The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.
• 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.
• AWS_S3_UPLOAD_ID
  Upload ID that identifies the multipart upload.
• AZ_SERVICE_REQUEST_ID
  The unique identifier of the service request. It's generated by the Azure service and returned with the response.
• CLIENT_ADDRESS
  Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
• CLIENT_PORT
  Client port number.
• CLOUDEVENTS_EVENT_ID
  The event_id uniquely identifies the event.
• CLOUDEVENTS_EVENT_SOURCE
  The source identifies the context in which an event happened.
• CLOUDEVENTS_EVENT_SPEC_VERSION
  The version of the CloudEvents specification which the event uses.
• CLOUDEVENTS_EVENT_SUBJECT
  The subject of the event in the context of the event producer (identified by source).
• CLOUDEVENTS_EVENT_TYPE
  The event_type contains a value describing the type of event related to the originating occurrence.
• CLOUD_RESOURCE_ID
  The Fully Qualified Azure Resource ID the log is emitted for.
• CODE_COLUMN
  The column number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function.
• 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.
• CODE_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.
• DB_CASSANDRA_CONSISTENCY_LEVEL
  The consistency level of the query. Based on consistency values from CQL.
• 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_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_COLLECTION_NAME
  The name of a collection (table, container) within the database.
• DB_COSMOSDB_CLIENT_ID
  Unique Cosmos client instance id.
• DB_COSMOSDB_CONNECTION_MODE
  Cosmos client connection mode.
• DB_COSMOSDB_OPERATION_TYPE
  CosmosDB Operation Type.
• DB_COSMOSDB_REQUEST_CHARGE
  RU consumed for that operation.
• DB_COSMOSDB_REQUEST_CONTENT_LENGTH
  Request payload size in bytes.
• DB_COSMOSDB_STATUS_CODE
  Cosmos DB status code.
• DB_COSMOSDB_SUB_STATUS_CODE
  Cosmos DB sub status code.
• DB_ELASTICSEARCH_NODE_NAME
  Represents the human-readable identifier of the node/instance to which a request was routed.
• DB_NAMESPACE
  The name of the database, fully qualified within the server address and port.
• DB_OPERATION_NAME
  The name of the operation or command being executed.
• DB_QUERY_TEXT
  The database query being executed.
• DB_SYSTEM
  The database management system (DBMS) product as identified by the client instrumentation.
• ERROR_TYPE
  Describes a class of error the operation ended with.
• EVENT_NAME
  Identifies the class / type of event.
• 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.
• 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.
• 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 format expressed in UTC.
• FAAS_INVOCATION_ID
  The invocation ID of the current function invocation.
• FAAS_INVOKED_NAME
  The name of the invoked function.
• FAAS_INVOKED_PROVIDER
  The cloud provider of the invoked function.
• FAAS_INVOKED_REGION
  The cloud region of the invoked function.
• FAAS_TIME
  A string containing the function invocation time in the ISO 8601 format expressed in UTC.
• FAAS_TRIGGER
  Type of the trigger which caused this function invocation.
• FEATURE_FLAG_KEY
  The unique identifier of the feature flag.
• FEATURE_FLAG_PROVIDER_NAME
  The name of the service provider that performs the flag evaluation.
• FEATURE_FLAG_VARIANT
  SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used.
• GEN_AI_COMPLETION
  The full response received from the GenAI model.
• GEN_AI_OPERATION_NAME
  The name of the operation being performed.
• GEN_AI_PROMPT
  The full prompt sent to the GenAI model.
• GEN_AI_REQUEST_FREQUENCY_PENALTY
  The frequency penalty setting for the GenAI request.
• GEN_AI_REQUEST_MAX_TOKENS
  The maximum number of tokens the model generates for a request.
• GEN_AI_REQUEST_MODEL
  The name of the GenAI model a request is being made to.
• GEN_AI_REQUEST_PRESENCE_PENALTY
  The presence penalty setting for the GenAI request.
• GEN_AI_REQUEST_STOP_SEQUENCES
  List of sequences that the model will use to stop generating further tokens.
• GEN_AI_REQUEST_TEMPERATURE
  The temperature setting for the GenAI request.
• GEN_AI_REQUEST_TOP_K
  The top_k sampling setting for the GenAI request.
• GEN_AI_REQUEST_TOP_P
  The top_p sampling setting for the GenAI request.
• GEN_AI_RESPONSE_FINISH_REASONS
  Array of reasons the model stopped generating tokens, corresponding to each generation received.
• GEN_AI_RESPONSE_ID
  The unique identifier for the completion.
• GEN_AI_RESPONSE_MODEL
  The name of the model that generated the response.
• GEN_AI_SYSTEM
  The Generative AI product as identified by the client or server instrumentation.
• GEN_AI_USAGE_INPUT_TOKENS
  The number of tokens used in the GenAI input (prompt).
• GEN_AI_USAGE_OUTPUT_TOKENS
  The number of tokens used in the GenAI response (completion).
• GRAPHQL_DOCUMENT
  The GraphQL document being executed.
• GRAPHQL_OPERATION_NAME
  The name of the operation being executed.
• GRAPHQL_OPERATION_TYPE
  The type of the operation being executed.
• HTTP_REQUEST_METHOD
  HTTP request method.
• HTTP_REQUEST_METHOD_ORIGINAL
  Original HTTP method sent by the client in the request line.
• HTTP_REQUEST_RESEND_COUNT
  The ordinal number of request resending attempt (for any reason, including redirects).
• HTTP_RESPONSE_STATUS_CODE
  HTTP response status code.
• HTTP_ROUTE
  The matched route, that is, the path template in the format used by the respective server framework.
• MESSAGING_BATCH_MESSAGE_COUNT
  The number of messages sent, received, or processed in the scope of the batching operation.
• MESSAGING_CLIENT_ID
  A unique identifier for the client that consumes or produces a message.
• MESSAGING_CONSUMER_GROUP_NAME
  The name of the consumer group with which a consumer is associated.
• MESSAGING_DESTINATION_ANONYMOUS
  A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).
• MESSAGING_DESTINATION_NAME
  The message destination name.
• MESSAGING_DESTINATION_PARTITION_ID
  The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.
• MESSAGING_DESTINATION_SUBSCRIPTION_NAME
  The name of the destination subscription from which a message is consumed.
• MESSAGING_DESTINATION_TEMPLATE
  Low cardinality representation of the messaging destination name.
• MESSAGING_DESTINATION_TEMPORARY
  A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.
• MESSAGING_MESSAGE_BODY_SIZE
  The size of the message body in bytes.
• 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_ENVELOPE_SIZE
  The size of the message body and metadata in bytes.
• MESSAGING_MESSAGE_ID
  A value used by the messaging system as an identifier for the message, represented as a string.
• MESSAGING_OPERATION_NAME
  The system-specific name of the messaging operation.
• MESSAGING_OPERATION_TYPE
  A string identifying the type of the messaging operation.
• MESSAGING_SYSTEM
  The messaging system as identified by the client instrumentation.
• NETWORK_LOCAL_ADDRESS
  Local address of the network connection - IP address or Unix domain socket name.
• NETWORK_LOCAL_PORT
  Local port number of the network connection.
• NETWORK_PEER_ADDRESS
  Peer address of the database node where the operation was performed.
• NETWORK_PEER_PORT
  Peer port number of the network connection.
• NETWORK_PROTOCOL_NAME
  OSI application layer or non-OSI equivalent.
• NETWORK_PROTOCOL_VERSION
  The actual version of the protocol used for network communication.
• NETWORK_TRANSPORT
  OSI transport layer or inter-process communication method.
• NETWORK_TYPE
  OSI network layer or non-OSI equivalent.
• OPENTRACING_REF_TYPE
  Parent-child Reference type.
• OTEL_STATUS_CODE
  Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET.
• OTEL_STATUS_DESCRIPTION
  Description of the Status if it has a value, otherwise not set.
• 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.
• RPC_CONNECT_RPC_ERROR_CODE
  The error codes of the Connect request. Error codes are always string values.
• RPC_GRPC_STATUS_CODE
  The numeric status code 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 doesn't specify this, the value can be omitted.
• RPC_MESSAGE_COMPRESSED_SIZE
  Compressed size of the message in bytes.
• RPC_MESSAGE_ID
  MUST be calculated as two different counters starting from 1 one for sent messages and one for received message.
• RPC_MESSAGE_TYPE
  Whether this is a received or sent message.
• RPC_MESSAGE_UNCOMPRESSED_SIZE
  Uncompressed size of the message in bytes.
• RPC_METHOD
  The name of the (logical) method being called, must be equal to the $method part in the span name.
• RPC_SERVICE
  The full (logical) name of the service being called, including its package name, if applicable.
• RPC_SYSTEM
  A string identifying the remoting system. See below for a list of well-known identifiers.
• SERVER_ADDRESS
  Name of the database host.
• SERVER_PORT
  Server port number.
• THREAD_ID
  Current "managed" thread ID (as opposed to OS thread ID).
• THREAD_NAME
  Current thread name.
• URL_FULL
  Absolute URL describing a network resource according to RFC3986.
• URL_PATH
  The URI path component.
• URL_QUERY
  The URI query component.
• URL_SCHEME
  The URI scheme component identifying the used protocol.
• USER_AGENT_ORIGINAL
  Value of the HTTP User-Agent header sent by the client.