Module opentelemetry_semantic_conventions::trace
source · [−]Expand description
Trace Semantic Conventions
The trace semantic conventions define a set of standardized attributes to
be used in Spans.
Usage
use opentelemetry::{global, trace::Tracer as _, trace::OrderMap};
use opentelemetry_semantic_conventions as semcov;
let tracer = global::tracer("my-component");
let _span = tracer
.span_builder("span-name")
.with_attributes([
semcov::trace::NET_PEER_IP.string("10.0.0.1"),
semcov::trace::NET_PEER_PORT.i64(80),
])
.start(&tracer);Constants
The value of the AttributesToGet request parameter.
The JSON-serialized value of each item in the AttributeDefinitions request field.
The value of the ConsistentRead request parameter.
The JSON-serialized value of each item in the ConsumedCapacity response field.
The value of the Count response parameter.
The value of the ExclusiveStartTableName request parameter.
The JSON-serialized value of each item of the GlobalSecondaryIndexes request field.
The JSON-serialized value of each item in the the GlobalSecondaryIndexUpdates request field.
The value of the IndexName request parameter.
The JSON-serialized value of the ItemCollectionMetrics response field.
The value of the Limit request parameter.
The JSON-serialized value of each item of the LocalSecondaryIndexes request field.
The value of the ProjectionExpression request parameter.
The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.
The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.
The value of the ScannedCount response parameter.
The value of the ScanIndexForward request parameter.
The value of the Segment request parameter.
The value of the Select request parameter.
The the number of items in the TableNames response parameter.
The keys in the RequestItems object field.
The value of the TotalSegments request parameter.
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).
The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
The method or function name, or equivalent (usually rightmost part of the code unit's name).
The line number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function.
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.
The consistency level of the query. Based on consistency values from CQL.
The data center of the coordinating node for a query.
The ID of the coordinating node for a query.
Whether or not the query is idempotent.
The fetch size used for paging, i.e. how many rows will be returned at once.
The number of times a query was speculatively executed. Not set or 0 if the query was not executed speculatively.
The name of the primary table that the operation is acting upon, including the keyspace name (if applicable).
The connection string used to connect to the database. It is recommended to remove embedded credentials.
The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect.
The collection being accessed within the database stated in db.name.
The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance.
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).
The name of the operation being executed, e.g. the MongoDB command name such as findAndModify, or the SQL keyword.
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.
The name of the primary table that the operation is acting upon, including the database name (if applicable).
The database statement being executed.
An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.
Username for accessing the database.
Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system.
Actual/assumed role the client is making the request under extracted from token or application security context.
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.
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.
The exception message.
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.
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.
A boolean that is true if the serverless function is executed for the first time (aka cold-start).
A string containing the schedule period as Cron Expression.
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.
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.
Describes the type of the operation that was performed on the data.
The execution ID of the current function execution.
The name of the invoked function.
The cloud provider of the invoked function.
The cloud region of the invoked function.
Type of the trigger which caused this function execution.
The IP address of the original client behind all proxies, if known (e.g. from X-Forwarded-For).
Kind of HTTP protocol used.
The value of the HTTP host header. An empty Host header should also be reported, see note.
HTTP request method.
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.
The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used.
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.
The size of the uncompressed response payload body after transport decoding. Not set if transport encoding not used.
The matched route (path template).
The URI scheme identifying the used protocol.
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).
The full request target as passed in a HTTP request line or equivalent.
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.
Value of the HTTP User-Agent header sent by the client.
Compressed size of the message in bytes.
MUST be calculated as two different counters starting from 1 one for sent messages and one for received message.
Whether this is a received or sent message.
Uncompressed size of the message in bytes.
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.
The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".
The message destination name. This might be equal to the span name but is required nevertheless.
The kind of message destination.
Client Id for the Consumer or Producer that is handling the message.
Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers.
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.
Partition the message is sent to.
A boolean that is true if the message is a tombstone.
A value used by the messaging system as an identifier for the message, represented as a string.
The compressed size of the message payload in 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.
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.
The name of the transport protocol.
The version of the transport protocol.
RabbitMQ message routing key.
Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind.
The unique identifier for each client.
Model of message consumption. This only applies to consumer spans.
Key(s) of message, another way to mark message besides message id.
The secondary classifier of message besides topic.
Type of message.
Namespace of RocketMQ resources, resources in different namespaces are individual.
A string identifying the messaging system.
A boolean that is true if the message destination is temporary.
Connection string.
The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network.
The mobile carrier country code.
The mobile carrier network code.
The name of the mobile carrier.
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.
The internet connection type currently being used by the host.
Like net.peer.ip but for the host IP. Useful in case of a multi-IP host.
Local hostname or similar, see note below.
Like net.peer.port but for the host port.
Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6).
Remote hostname or similar, see note below.
Remote port number.
Transport protocol used. See note below.
Parent-child Reference type.
The service.name of the remote service. SHOULD be equal to the actual service.name resource attribute of the remote service if any.
The numeric status code of the gRPC request.
error.code property of response if it is an error response.
error.message property of response if it is an error response.
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.
Protocol version as in jsonrpc property of request/response. Since JSON-RPC 1.0 does not specify this, the value can be omitted.
The name of the operation corresponding to the request, as returned by the AWS SDK.
The name of the service to which a request is made, as returned by the AWS SDK.
The value aws-api.
Current "managed" thread ID (as opposed to OS thread ID).
Current thread name.