package semconv
Import Path
go.opentelemetry.io/otel/semconv/v1.37.0 (on go.dev)
Dependency Relation
imports 3 packages, and imported by 4 packages
Involved Source Files
attribute_group.go
Package semconv implements OpenTelemetry semantic conventions.
OpenTelemetry semantic conventions are agreed standardized naming
patterns for OpenTelemetry things. This package represents the v1.37.0
version of the OpenTelemetry semantic conventions.
error_type.go
exception.go
schema.go
Package-Level Functions (total 551)
AndroidOSAPILevel returns an attribute KeyValue conforming to the
"android.os.api_level" semantic conventions. It represents the uniquely
identifies the framework API revision offered by a version (`os.version`) of
the android operating system. More information can be found in the
[Android API levels documentation].
AppBuildID returns an attribute KeyValue conforming to the "app.build_id"
semantic conventions. It represents the unique identifier for a particular
build or compilation of the application.
AppInstallationID returns an attribute KeyValue conforming to the
"app.installation.id" semantic conventions. It represents a unique identifier
representing the installation of an application on a specific device.
AppJankFrameCount returns an attribute KeyValue conforming to the
"app.jank.frame_count" semantic conventions. It represents a number of frame
renders that experienced jank.
AppJankPeriod returns an attribute KeyValue conforming to the
"app.jank.period" semantic conventions. It represents the time period, in
seconds, for which this jank is being reported.
AppJankThreshold returns an attribute KeyValue conforming to the
"app.jank.threshold" semantic conventions. It represents the minimum rendering
threshold for this jank, in seconds.
AppScreenCoordinateX returns an attribute KeyValue conforming to the
"app.screen.coordinate.x" semantic conventions. It represents the x
(horizontal) coordinate of a screen coordinate, in screen pixels.
AppScreenCoordinateY returns an attribute KeyValue conforming to the
"app.screen.coordinate.y" semantic conventions. It represents the y (vertical)
component of a screen coordinate, in screen pixels.
AppWidgetID returns an attribute KeyValue conforming to the "app.widget.id"
semantic conventions. It represents an identifier that uniquely differentiates
this widget from other widgets in the same application.
AppWidgetName returns an attribute KeyValue conforming to the
"app.widget.name" semantic conventions. It represents the name of an
application widget.
ArtifactAttestationFilename returns an attribute KeyValue conforming to the
"artifact.attestation.filename" semantic conventions. It represents the
provenance filename of the built attestation which directly relates to the
build artifact filename. This filename SHOULD accompany the artifact at
publish time. See the [SLSA Relationship] specification for more information.
ArtifactAttestationHash returns an attribute KeyValue conforming to the
"artifact.attestation.hash" semantic conventions. It represents the full
[hash value (see glossary)], of the built attestation. Some envelopes in the
[software attestation space] also refer to this as the **digest**.
ArtifactAttestationID returns an attribute KeyValue conforming to the
"artifact.attestation.id" semantic conventions. It represents the id of the
build [software attestation].
ArtifactFilename returns an attribute KeyValue conforming to the
"artifact.filename" semantic conventions. It represents the human readable
file name of the artifact, typically generated during build and release
processes. Often includes the package name and version in the file name.
ArtifactHash returns an attribute KeyValue conforming to the "artifact.hash"
semantic conventions. It represents the full [hash value (see glossary)],
often found in checksum.txt on a release of the artifact and used to verify
package integrity.
ArtifactPurl returns an attribute KeyValue conforming to the "artifact.purl"
semantic conventions. It represents the [Package URL] of the
[package artifact] provides a standard way to identify and locate the packaged
artifact.
ArtifactVersion returns an attribute KeyValue conforming to the
"artifact.version" semantic conventions. It represents the version of the
artifact.
AWSBedrockGuardrailID returns an attribute KeyValue conforming to the
"aws.bedrock.guardrail.id" semantic conventions. It represents the unique
identifier of the AWS Bedrock Guardrail. A [guardrail] helps safeguard and
prevent unwanted behavior from model responses or user messages.
AWSBedrockKnowledgeBaseID returns an attribute KeyValue conforming to the
"aws.bedrock.knowledge_base.id" semantic conventions. It represents the unique
identifier of the AWS Bedrock Knowledge base. A [knowledge base] is a bank of
information that can be queried by models to generate more relevant responses
and augment prompts.
AWSDynamoDBAttributeDefinitions returns an attribute KeyValue conforming to
the "aws.dynamodb.attribute_definitions" semantic conventions. It represents
the JSON-serialized value of each item in the `AttributeDefinitions` request
field.
AWSDynamoDBAttributesToGet returns an attribute KeyValue conforming to the
"aws.dynamodb.attributes_to_get" semantic conventions. It represents the value
of the `AttributesToGet` request parameter.
AWSDynamoDBConsistentRead returns an attribute KeyValue conforming to the
"aws.dynamodb.consistent_read" semantic conventions. It represents the value
of the `ConsistentRead` request parameter.
AWSDynamoDBConsumedCapacity returns an attribute KeyValue conforming to the
"aws.dynamodb.consumed_capacity" semantic conventions. It represents the
JSON-serialized value of each item in the `ConsumedCapacity` response field.
AWSDynamoDBCount returns an attribute KeyValue conforming to the
"aws.dynamodb.count" semantic conventions. It represents the value of the
`Count` response parameter.
AWSDynamoDBExclusiveStartTable returns an attribute KeyValue conforming to the
"aws.dynamodb.exclusive_start_table" semantic conventions. It represents the
value of the `ExclusiveStartTableName` request parameter.
AWSDynamoDBGlobalSecondaryIndexes returns an attribute KeyValue conforming to
the "aws.dynamodb.global_secondary_indexes" semantic conventions. It
represents the JSON-serialized value of each item of the
`GlobalSecondaryIndexes` request field.
AWSDynamoDBGlobalSecondaryIndexUpdates returns an attribute KeyValue
conforming to the "aws.dynamodb.global_secondary_index_updates" semantic
conventions. It represents the JSON-serialized value of each item in the
`GlobalSecondaryIndexUpdates` request field.
AWSDynamoDBIndexName returns an attribute KeyValue conforming to the
"aws.dynamodb.index_name" semantic conventions. It represents the value of the
`IndexName` request parameter.
AWSDynamoDBItemCollectionMetrics returns an attribute KeyValue conforming to
the "aws.dynamodb.item_collection_metrics" semantic conventions. It represents
the JSON-serialized value of the `ItemCollectionMetrics` response field.
AWSDynamoDBLimit returns an attribute KeyValue conforming to the
"aws.dynamodb.limit" semantic conventions. It represents the value of the
`Limit` request parameter.
AWSDynamoDBLocalSecondaryIndexes returns an attribute KeyValue conforming to
the "aws.dynamodb.local_secondary_indexes" semantic conventions. It represents
the JSON-serialized value of each item of the `LocalSecondaryIndexes` request
field.
AWSDynamoDBProjection returns an attribute KeyValue conforming to the
"aws.dynamodb.projection" semantic conventions. It represents the value of the
`ProjectionExpression` request parameter.
AWSDynamoDBProvisionedReadCapacity returns an attribute KeyValue conforming to
the "aws.dynamodb.provisioned_read_capacity" semantic conventions. It
represents the value of the `ProvisionedThroughput.ReadCapacityUnits` request
parameter.
AWSDynamoDBProvisionedWriteCapacity returns an attribute KeyValue conforming
to the "aws.dynamodb.provisioned_write_capacity" semantic conventions. It
represents the value of the `ProvisionedThroughput.WriteCapacityUnits` request
parameter.
AWSDynamoDBScanForward returns an attribute KeyValue conforming to the
"aws.dynamodb.scan_forward" semantic conventions. It represents the value of
the `ScanIndexForward` request parameter.
AWSDynamoDBScannedCount returns an attribute KeyValue conforming to the
"aws.dynamodb.scanned_count" semantic conventions. It represents the value of
the `ScannedCount` response parameter.
AWSDynamoDBSegment returns an attribute KeyValue conforming to the
"aws.dynamodb.segment" semantic conventions. It represents the value of the
`Segment` request parameter.
AWSDynamoDBSelect returns an attribute KeyValue conforming to the
"aws.dynamodb.select" semantic conventions. It represents the value of the
`Select` request parameter.
AWSDynamoDBTableCount returns an attribute KeyValue conforming to the
"aws.dynamodb.table_count" semantic conventions. It represents the number of
items in the `TableNames` response parameter.
AWSDynamoDBTableNames returns an attribute KeyValue conforming to the
"aws.dynamodb.table_names" semantic conventions. It represents the keys in the
`RequestItems` object field.
AWSDynamoDBTotalSegments returns an attribute KeyValue conforming to the
"aws.dynamodb.total_segments" semantic conventions. It represents the value of
the `TotalSegments` request parameter.
AWSECSClusterARN returns an attribute KeyValue conforming to the
"aws.ecs.cluster.arn" semantic conventions. It represents the ARN of an
[ECS cluster].
AWSECSContainerARN returns an attribute KeyValue conforming to the
"aws.ecs.container.arn" semantic conventions. It represents the Amazon
Resource Name (ARN) of an [ECS container instance].
AWSECSTaskARN returns an attribute KeyValue conforming to the
"aws.ecs.task.arn" semantic conventions. It represents the ARN of a running
[ECS task].
AWSECSTaskFamily returns an attribute KeyValue conforming to the
"aws.ecs.task.family" semantic conventions. It represents the family name of
the [ECS task definition] used to create the ECS task.
AWSECSTaskID returns an attribute KeyValue conforming to the "aws.ecs.task.id"
semantic conventions. It represents the ID of a running ECS task. The ID MUST
be extracted from `task.arn`.
AWSECSTaskRevision returns an attribute KeyValue conforming to the
"aws.ecs.task.revision" semantic conventions. It represents the revision for
the task definition used to create the ECS task.
AWSEKSClusterARN returns an attribute KeyValue conforming to the
"aws.eks.cluster.arn" semantic conventions. It represents the ARN of an EKS
cluster.
AWSExtendedRequestID returns an attribute KeyValue conforming to the
"aws.extended_request_id" semantic conventions. It represents the AWS extended
request ID as returned in the response header `x-amz-id-2`.
AWSKinesisStreamName returns an attribute KeyValue conforming to the
"aws.kinesis.stream_name" semantic conventions. It represents the name of the
AWS Kinesis [stream] the request refers to. Corresponds to the `--stream-name`
parameter of the Kinesis [describe-stream] operation.
AWSLambdaInvokedARN returns an attribute KeyValue conforming to the
"aws.lambda.invoked_arn" semantic conventions. It represents 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).
AWSLambdaResourceMappingID returns an attribute KeyValue conforming to the
"aws.lambda.resource_mapping.id" semantic conventions. It represents the UUID
of the [AWS Lambda EvenSource Mapping]. An event source is mapped to a lambda
function. It's contents are read by Lambda and used to trigger a function.
This isn't available in the lambda execution context or the lambda runtime
environtment. This is going to be populated by the AWS SDK for each language
when that UUID is present. Some of these operations are
Create/Delete/Get/List/Update EventSourceMapping.
AWSLogGroupARNs returns an attribute KeyValue conforming to the
"aws.log.group.arns" semantic conventions. It represents the Amazon Resource
Name(s) (ARN) of the AWS log group(s).
AWSLogGroupNames returns an attribute KeyValue conforming to the
"aws.log.group.names" semantic conventions. It represents the name(s) of the
AWS log group(s) an application is writing to.
AWSLogStreamARNs returns an attribute KeyValue conforming to the
"aws.log.stream.arns" semantic conventions. It represents the ARN(s) of the
AWS log stream(s).
AWSLogStreamNames returns an attribute KeyValue conforming to the
"aws.log.stream.names" semantic conventions. It represents the name(s) of the
AWS log stream(s) an application is writing to.
AWSRequestID returns an attribute KeyValue conforming to the "aws.request_id"
semantic conventions. It represents the AWS request ID as returned in the
response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`
.
AWSS3Bucket returns an attribute KeyValue conforming to the "aws.s3.bucket"
semantic conventions. It represents the S3 bucket name the request refers to.
Corresponds to the `--bucket` parameter of the [S3 API] operations.
AWSS3CopySource returns an attribute KeyValue conforming to the
"aws.s3.copy_source" semantic conventions. It represents the source object (in
the form `bucket`/`key`) for the copy operation.
AWSS3Delete returns an attribute KeyValue conforming to the "aws.s3.delete"
semantic conventions. It represents the delete request container that
specifies the objects to be deleted.
AWSS3Key returns an attribute KeyValue conforming to the "aws.s3.key" semantic
conventions. It represents the S3 object key the request refers to.
Corresponds to the `--key` parameter of the [S3 API] operations.
AWSS3PartNumber returns an attribute KeyValue conforming to the
"aws.s3.part_number" semantic conventions. It represents the part number of
the part being uploaded in a multipart-upload operation. This is a positive
integer between 1 and 10,000.
AWSS3UploadID returns an attribute KeyValue conforming to the
"aws.s3.upload_id" semantic conventions. It represents the upload ID that
identifies the multipart upload.
AWSSecretsmanagerSecretARN returns an attribute KeyValue conforming to the
"aws.secretsmanager.secret.arn" semantic conventions. It represents the ARN of
the Secret stored in the Secrets Mangger.
AWSSNSTopicARN returns an attribute KeyValue conforming to the
"aws.sns.topic.arn" semantic conventions. It represents the ARN of the AWS SNS
Topic. An Amazon SNS [topic] is a logical access point that acts as a
communication channel.
AWSSQSQueueURL returns an attribute KeyValue conforming to the
"aws.sqs.queue.url" semantic conventions. It represents the URL of the AWS SQS
Queue. It's a unique identifier for a queue in Amazon Simple Queue Service
(SQS) and is used to access the queue and perform actions on it.
AWSStepFunctionsActivityARN returns an attribute KeyValue conforming to the
"aws.step_functions.activity.arn" semantic conventions. It represents the ARN
of the AWS Step Functions Activity.
AWSStepFunctionsStateMachineARN returns an attribute KeyValue conforming to
the "aws.step_functions.state_machine.arn" semantic conventions. It represents
the ARN of the AWS Step Functions State Machine.
AzureClientID returns an attribute KeyValue conforming to the
"azure.client.id" semantic conventions. It represents the unique identifier of
the client instance.
AzureCosmosDBOperationContactedRegions returns an attribute KeyValue
conforming to the "azure.cosmosdb.operation.contacted_regions" semantic
conventions. It represents the list of regions contacted during operation in
the order that they were contacted. If there is more than one region listed,
it indicates that the operation was performed on multiple regions i.e.
cross-regional call.
AzureCosmosDBOperationRequestCharge returns an attribute KeyValue conforming
to the "azure.cosmosdb.operation.request_charge" semantic conventions. It
represents the number of request units consumed by the operation.
AzureCosmosDBRequestBodySize returns an attribute KeyValue conforming to the
"azure.cosmosdb.request.body.size" semantic conventions. It represents the
request payload size in bytes.
AzureCosmosDBResponseSubStatusCode returns an attribute KeyValue conforming to
the "azure.cosmosdb.response.sub_status_code" semantic conventions. It
represents the cosmos DB sub status code.
AzureResourceProviderNamespace returns an attribute KeyValue conforming to the
"azure.resource_provider.namespace" semantic conventions. It represents the
[Azure Resource Provider Namespace] as recognized by the client.
AzureServiceRequestID returns an attribute KeyValue conforming to the
"azure.service.request.id" semantic conventions. It represents the unique
identifier of the service request. It's generated by the Azure service and
returned with the response.
BrowserBrands returns an attribute KeyValue conforming to the "browser.brands"
semantic conventions. It represents the array of brand name and version
separated by a space.
BrowserLanguage returns an attribute KeyValue conforming to the
"browser.language" semantic conventions. It represents the preferred language
of the user using the browser.
BrowserMobile returns an attribute KeyValue conforming to the "browser.mobile"
semantic conventions. It represents a boolean that is true if the browser is
running on a mobile device.
BrowserPlatform returns an attribute KeyValue conforming to the
"browser.platform" semantic conventions. It represents the platform on which
the browser is running.
CassandraCoordinatorDC returns an attribute KeyValue conforming to the
"cassandra.coordinator.dc" semantic conventions. It represents the data center
of the coordinating node for a query.
CassandraCoordinatorID returns an attribute KeyValue conforming to the
"cassandra.coordinator.id" semantic conventions. It represents the ID of the
coordinating node for a query.
CassandraPageSize returns an attribute KeyValue conforming to the
"cassandra.page.size" semantic conventions. It represents the fetch size used
for paging, i.e. how many rows will be returned at once.
CassandraQueryIdempotent returns an attribute KeyValue conforming to the
"cassandra.query.idempotent" semantic conventions. It represents the whether
or not the query is idempotent.
CassandraSpeculativeExecutionCount returns an attribute KeyValue conforming to
the "cassandra.speculative_execution.count" semantic conventions. It
represents the number of times a query was speculatively executed. Not set or
`0` if the query was not executed speculatively.
CICDPipelineName returns an attribute KeyValue conforming to the
"cicd.pipeline.name" semantic conventions. It represents the human readable
name of the pipeline within a CI/CD system.
CICDPipelineRunID returns an attribute KeyValue conforming to the
"cicd.pipeline.run.id" semantic conventions. It represents the unique
identifier of a pipeline run within a CI/CD system.
CICDPipelineRunURLFull returns an attribute KeyValue conforming to the
"cicd.pipeline.run.url.full" semantic conventions. It represents the [URL] of
the pipeline run, providing the complete address in order to locate and
identify the pipeline run.
CICDPipelineTaskName returns an attribute KeyValue conforming to the
"cicd.pipeline.task.name" semantic conventions. It represents the human
readable name of a task within a pipeline. Task here most closely aligns with
a [computing process] in a pipeline. Other terms for tasks include commands,
steps, and procedures.
CICDPipelineTaskRunID returns an attribute KeyValue conforming to the
"cicd.pipeline.task.run.id" semantic conventions. It represents the unique
identifier of a task run within a pipeline.
CICDPipelineTaskRunURLFull returns an attribute KeyValue conforming to the
"cicd.pipeline.task.run.url.full" semantic conventions. It represents the
[URL] of the pipeline task run, providing the complete address in order to
locate and identify the pipeline task run.
CICDSystemComponent returns an attribute KeyValue conforming to the
"cicd.system.component" semantic conventions. It represents the name of a
component of the CICD system.
CICDWorkerID returns an attribute KeyValue conforming to the "cicd.worker.id"
semantic conventions. It represents the unique identifier of a worker within a
CICD system.
CICDWorkerName returns an attribute KeyValue conforming to the
"cicd.worker.name" semantic conventions. It represents the name of a worker
within a CICD system.
CICDWorkerURLFull returns an attribute KeyValue conforming to the
"cicd.worker.url.full" semantic conventions. It represents the [URL] of the
worker, providing the complete address in order to locate and identify the
worker.
ClientAddress returns an attribute KeyValue conforming to the "client.address"
semantic conventions. It represents the client address - domain name if
available without reverse DNS lookup; otherwise, IP address or Unix domain
socket name.
ClientPort returns an attribute KeyValue conforming to the "client.port"
semantic conventions. It represents the client port number.
CloudAccountID returns an attribute KeyValue conforming to the
"cloud.account.id" semantic conventions. It represents the cloud account ID
the resource is assigned to.
CloudAvailabilityZone returns an attribute KeyValue conforming to the
"cloud.availability_zone" semantic conventions. It represents the cloud
regions often have multiple, isolated locations known as zones to increase
availability. Availability zone represents the zone where the resource is
running.
CloudEventsEventID returns an attribute KeyValue conforming to the
"cloudevents.event_id" semantic conventions. It represents the [event_id]
uniquely identifies the event.
CloudEventsEventSource returns an attribute KeyValue conforming to the
"cloudevents.event_source" semantic conventions. It represents the [source]
identifies the context in which an event happened.
CloudEventsEventSpecVersion returns an attribute KeyValue conforming to the
"cloudevents.event_spec_version" semantic conventions. It represents the
[version of the CloudEvents specification] which the event uses.
CloudEventsEventSubject returns an attribute KeyValue conforming to the
"cloudevents.event_subject" semantic conventions. It represents the [subject]
of the event in the context of the event producer (identified by source).
CloudEventsEventType returns an attribute KeyValue conforming to the
"cloudevents.event_type" semantic conventions. It represents the [event_type]
contains a value describing the type of event related to the originating
occurrence.
CloudFoundryAppID returns an attribute KeyValue conforming to the
"cloudfoundry.app.id" semantic conventions. It represents the guid of the
application.
CloudFoundryAppInstanceID returns an attribute KeyValue conforming to the
"cloudfoundry.app.instance.id" semantic conventions. It represents the index
of the application instance. 0 when just one instance is active.
CloudFoundryAppName returns an attribute KeyValue conforming to the
"cloudfoundry.app.name" semantic conventions. It represents the name of the
application.
CloudFoundryOrgID returns an attribute KeyValue conforming to the
"cloudfoundry.org.id" semantic conventions. It represents the guid of the
CloudFoundry org the application is running in.
CloudFoundryOrgName returns an attribute KeyValue conforming to the
"cloudfoundry.org.name" semantic conventions. It represents the name of the
CloudFoundry organization the app is running in.
CloudFoundryProcessID returns an attribute KeyValue conforming to the
"cloudfoundry.process.id" semantic conventions. It represents the UID
identifying the process.
CloudFoundryProcessType returns an attribute KeyValue conforming to the
"cloudfoundry.process.type" semantic conventions. It represents the type of
process.
CloudFoundrySpaceID returns an attribute KeyValue conforming to the
"cloudfoundry.space.id" semantic conventions. It represents the guid of the
CloudFoundry space the application is running in.
CloudFoundrySpaceName returns an attribute KeyValue conforming to the
"cloudfoundry.space.name" semantic conventions. It represents the name of the
CloudFoundry space the application is running in.
CloudFoundrySystemID returns an attribute KeyValue conforming to the
"cloudfoundry.system.id" semantic conventions. It represents a guid or another
name describing the event source.
CloudFoundrySystemInstanceID returns an attribute KeyValue conforming to the
"cloudfoundry.system.instance.id" semantic conventions. It represents a guid
describing the concrete instance of the event source.
CloudRegion returns an attribute KeyValue conforming to the "cloud.region"
semantic conventions. It represents the geographical region within a cloud
provider. When associated with a resource, this attribute specifies the region
where the resource operates. When calling services or APIs deployed on a
cloud, this attribute identifies the region where the called destination is
deployed.
CloudResourceID returns an attribute KeyValue conforming to the
"cloud.resource_id" semantic conventions. It represents the cloud
provider-specific native identifier of the monitored cloud resource (e.g. an
[ARN] on AWS, a [fully qualified resource ID] on Azure, a [full resource name]
on GCP).
CodeColumnNumber returns an attribute KeyValue conforming to the
"code.column.number" semantic conventions. It represents the column number in
`code.file.path` best representing the operation. It SHOULD point within the
code unit named in `code.function.name`. This attribute MUST NOT be used on
the Profile signal since the data is already captured in 'message Line'. This
constraint is imposed to prevent redundancy and maintain data integrity.
CodeFilePath returns an attribute KeyValue conforming to the "code.file.path"
semantic conventions. It represents the source code file name that identifies
the code unit as uniquely as possible (preferably an absolute file path). This
attribute MUST NOT be used on the Profile signal since the data is already
captured in 'message Function'. This constraint is imposed to prevent
redundancy and maintain data integrity.
CodeFunctionName returns an attribute KeyValue conforming to the
"code.function.name" semantic conventions. It represents the method or
function fully-qualified name without arguments. The value should fit the
natural representation of the language runtime, which is also likely the same
used within `code.stacktrace` attribute value. This attribute MUST NOT be used
on the Profile signal since the data is already captured in 'message
Function'. This constraint is imposed to prevent redundancy and maintain data
integrity.
CodeLineNumber returns an attribute KeyValue conforming to the
"code.line.number" semantic conventions. It represents the line number in
`code.file.path` best representing the operation. It SHOULD point within the
code unit named in `code.function.name`. This attribute MUST NOT be used on
the Profile signal since the data is already captured in 'message Line'. This
constraint is imposed to prevent redundancy and maintain data integrity.
CodeStacktrace returns an attribute KeyValue conforming to the
"code.stacktrace" semantic conventions. It represents a stacktrace as a string
in the natural representation for the language runtime. The representation is
identical to [`exception.stacktrace`]. This attribute MUST NOT be used on the
Profile signal since the data is already captured in 'message Location'. This
constraint is imposed to prevent redundancy and maintain data integrity.
[`exception.stacktrace`]: /docs/exceptions/exceptions-spans.md#stacktrace-representation
ContainerCommand returns an attribute KeyValue conforming to the
"container.command" semantic conventions. It represents the command used to
run the container (i.e. the command name).
ContainerCommandArgs returns an attribute KeyValue conforming to the
"container.command_args" semantic conventions. It represents the all the
command arguments (including the command/executable itself) run by the
container.
ContainerCommandLine returns an attribute KeyValue conforming to the
"container.command_line" semantic conventions. It represents the full command
run by the container as a single string representing the full command.
ContainerCSIPluginName returns an attribute KeyValue conforming to the
"container.csi.plugin.name" semantic conventions. It represents the name of
the CSI ([Container Storage Interface]) plugin used by the volume.
ContainerCSIVolumeID returns an attribute KeyValue conforming to the
"container.csi.volume.id" semantic conventions. It represents the unique
volume ID returned by the CSI ([Container Storage Interface]) plugin.
ContainerID returns an attribute KeyValue conforming to the "container.id"
semantic conventions. It represents the container ID. Usually a UUID, as for
example used to [identify Docker containers]. The UUID might be abbreviated.
ContainerImageID returns an attribute KeyValue conforming to the
"container.image.id" semantic conventions. It represents the runtime specific
image identifier. Usually a hash algorithm followed by a UUID.
ContainerImageName returns an attribute KeyValue conforming to the
"container.image.name" semantic conventions. It represents the name of the
image the container was built on.
ContainerImageRepoDigests returns an attribute KeyValue conforming to the
"container.image.repo_digests" semantic conventions. It represents the repo
digests of the container image as provided by the container runtime.
ContainerImageTags returns an attribute KeyValue conforming to the
"container.image.tags" semantic conventions. It represents the container image
tags. An example can be found in [Docker Image Inspect]. Should be only the
`<tag>` section of the full name for example from
`registry.example.com/my-org/my-image:<tag>`.
ContainerLabel returns an attribute KeyValue conforming to the
"container.label" semantic conventions. It represents the container labels,
`<key>` being the label name, the value being the label value.
ContainerName returns an attribute KeyValue conforming to the "container.name"
semantic conventions. It represents the container name used by container
runtime.
ContainerRuntimeDescription returns an attribute KeyValue conforming to the
"container.runtime.description" semantic conventions. It represents a
description about the runtime which could include, for example details about
the CRI/API version being used or other customisations.
ContainerRuntimeName returns an attribute KeyValue conforming to the
"container.runtime.name" semantic conventions. It represents the container
runtime managing this container.
ContainerRuntimeVersion returns an attribute KeyValue conforming to the
"container.runtime.version" semantic conventions. It represents the version of
the runtime of this process, as returned by the runtime without modification.
CPULogicalNumber returns an attribute KeyValue conforming to the
"cpu.logical_number" semantic conventions. It represents the logical CPU
number [0..n-1].
DBClientConnectionPoolName returns an attribute KeyValue conforming to the
"db.client.connection.pool.name" semantic conventions. It represents the name
of the connection pool; unique within the instrumented application. In case
the connection pool implementation doesn't provide a name, instrumentation
SHOULD use a combination of parameters that would make the name unique, for
example, combining attributes `server.address`, `server.port`, and
`db.namespace`, formatted as `server.address:server.port/db.namespace`.
Instrumentations that generate connection pool name following different
patterns SHOULD document it.
DBCollectionName returns an attribute KeyValue conforming to the
"db.collection.name" semantic conventions. It represents the name of a
collection (table, container) within the database.
DBNamespace returns an attribute KeyValue conforming to the "db.namespace"
semantic conventions. It represents the name of the database, fully qualified
within the server address and port.
DBOperationBatchSize returns an attribute KeyValue conforming to the
"db.operation.batch.size" semantic conventions. It represents the number of
queries included in a batch operation.
DBOperationName returns an attribute KeyValue conforming to the
"db.operation.name" semantic conventions. It represents the name of the
operation or command being executed.
DBOperationParameter returns an attribute KeyValue conforming to the
"db.operation.parameter" semantic conventions. It represents a database
operation parameter, with `<key>` being the parameter name, and the attribute
value being a string representation of the parameter value.
DBQueryParameter returns an attribute KeyValue conforming to the
"db.query.parameter" semantic conventions. It represents a database query
parameter, with `<key>` being the parameter name, and the attribute value
being a string representation of the parameter value.
DBQuerySummary returns an attribute KeyValue conforming to the
"db.query.summary" semantic conventions. It represents the low cardinality
summary of a database query.
DBQueryText returns an attribute KeyValue conforming to the "db.query.text"
semantic conventions. It represents the database query being executed.
DBResponseReturnedRows returns an attribute KeyValue conforming to the
"db.response.returned_rows" semantic conventions. It represents the number of
rows returned by the operation.
DBResponseStatusCode returns an attribute KeyValue conforming to the
"db.response.status_code" semantic conventions. It represents the database
response status code.
DBStoredProcedureName returns an attribute KeyValue conforming to the
"db.stored_procedure.name" semantic conventions. It represents the name of a
stored procedure within the database.
DeploymentEnvironmentName returns an attribute KeyValue conforming to the
"deployment.environment.name" semantic conventions. It represents the name of
the [deployment environment] (aka deployment tier).
DeploymentID returns an attribute KeyValue conforming to the "deployment.id"
semantic conventions. It represents the id of the deployment.
DeploymentName returns an attribute KeyValue conforming to the
"deployment.name" semantic conventions. It represents the name of the
deployment.
DestinationAddress returns an attribute KeyValue conforming to the
"destination.address" semantic conventions. It represents the destination
address - domain name if available without reverse DNS lookup; otherwise, IP
address or Unix domain socket name.
DestinationPort returns an attribute KeyValue conforming to the
"destination.port" semantic conventions. It represents the destination port
number.
DeviceID returns an attribute KeyValue conforming to the "device.id" semantic
conventions. It represents a unique identifier representing the device.
DeviceManufacturer returns an attribute KeyValue conforming to the
"device.manufacturer" semantic conventions. It represents the name of the
device manufacturer.
DeviceModelIdentifier returns an attribute KeyValue conforming to the
"device.model.identifier" semantic conventions. It represents the model
identifier for the device.
DeviceModelName returns an attribute KeyValue conforming to the
"device.model.name" semantic conventions. It represents the marketing name for
the device model.
DNSAnswers returns an attribute KeyValue conforming to the "dns.answers"
semantic conventions. It represents the list of IPv4 or IPv6 addresses
resolved during DNS lookup.
DNSQuestionName returns an attribute KeyValue conforming to the
"dns.question.name" semantic conventions. It represents the name being
queried.
ElasticsearchNodeName returns an attribute KeyValue conforming to the
"elasticsearch.node.name" semantic conventions. It represents the represents
the human-readable identifier of the node/instance to which a request was
routed.
EnduserID returns an attribute KeyValue conforming to the "enduser.id"
semantic conventions. It represents the unique identifier of an end user in
the system. It maybe a username, email address, or other identifier.
EnduserPseudoID returns an attribute KeyValue conforming to the
"enduser.pseudo.id" semantic conventions. It represents the pseudonymous
identifier of an end user. This identifier should be a random value that is
not directly linked or associated with the end user's actual identity.
ErrorMessage returns an attribute KeyValue conforming to the "error.message"
semantic conventions. It represents a message providing more detail about an
error in human-readable form.
ErrorType returns an [attribute.KeyValue] identifying the error type of err.
ExceptionMessage returns an attribute KeyValue conforming to the
"exception.message" semantic conventions. It represents the exception message.
ExceptionStacktrace returns an attribute KeyValue conforming to the
"exception.stacktrace" semantic conventions. It represents 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.
ExceptionType returns an attribute KeyValue conforming to the "exception.type"
semantic conventions. It represents 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.
FaaSColdstart returns an attribute KeyValue conforming to the "faas.coldstart"
semantic conventions. It represents a boolean that is true if the serverless
function is executed for the first time (aka cold-start).
FaaSCron returns an attribute KeyValue conforming to the "faas.cron" semantic
conventions. It represents a string containing the schedule period as
[Cron Expression].
FaaSDocumentCollection returns an attribute KeyValue conforming to the
"faas.document.collection" semantic conventions. It represents 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.
FaaSDocumentName returns an attribute KeyValue conforming to the
"faas.document.name" semantic conventions. It represents 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.
FaaSDocumentTime returns an attribute KeyValue conforming to the
"faas.document.time" semantic conventions. It represents a string containing
the time when the data was accessed in the [ISO 8601] format expressed in
[UTC].
FaaSInstance returns an attribute KeyValue conforming to the "faas.instance"
semantic conventions. It represents the execution environment ID as a string,
that will be potentially reused for other invocations to the same
function/function version.
FaaSInvocationID returns an attribute KeyValue conforming to the
"faas.invocation_id" semantic conventions. It represents the invocation ID of
the current function invocation.
FaaSInvokedName returns an attribute KeyValue conforming to the
"faas.invoked_name" semantic conventions. It represents the name of the
invoked function.
FaaSInvokedRegion returns an attribute KeyValue conforming to the
"faas.invoked_region" semantic conventions. It represents the cloud region of
the invoked function.
FaaSMaxMemory returns an attribute KeyValue conforming to the
"faas.max_memory" semantic conventions. It represents the amount of memory
available to the serverless function converted to Bytes.
FaaSName returns an attribute KeyValue conforming to the "faas.name" semantic
conventions. It represents the name of the single function that this runtime
instance executes.
FaaSTime returns an attribute KeyValue conforming to the "faas.time" semantic
conventions. It represents a string containing the function invocation time in
the [ISO 8601] format expressed in [UTC].
FaaSVersion returns an attribute KeyValue conforming to the "faas.version"
semantic conventions. It represents the immutable version of the function
being executed.
FeatureFlagContextID returns an attribute KeyValue conforming to the
"feature_flag.context.id" semantic conventions. It represents the unique
identifier for the flag evaluation context. For example, the targeting key.
FeatureFlagKey returns an attribute KeyValue conforming to the
"feature_flag.key" semantic conventions. It represents the lookup key of the
feature flag.
FeatureFlagProviderName returns an attribute KeyValue conforming to the
"feature_flag.provider.name" semantic conventions. It represents the
identifies the feature flag provider.
FeatureFlagResultVariant returns an attribute KeyValue conforming to the
"feature_flag.result.variant" semantic conventions. It represents a semantic
identifier for an evaluated flag value.
FeatureFlagSetID returns an attribute KeyValue conforming to the
"feature_flag.set.id" semantic conventions. It represents the identifier of
the [flag set] to which the feature flag belongs.
FeatureFlagVersion returns an attribute KeyValue conforming to the
"feature_flag.version" semantic conventions. It represents the version of the
ruleset used during the evaluation. This may be any stable value which
uniquely identifies the ruleset.
FileAccessed returns an attribute KeyValue conforming to the "file.accessed"
semantic conventions. It represents the time when the file was last accessed,
in ISO 8601 format.
FileAttributes returns an attribute KeyValue conforming to the
"file.attributes" semantic conventions. It represents the array of file
attributes.
FileChanged returns an attribute KeyValue conforming to the "file.changed"
semantic conventions. It represents the time when the file attributes or
metadata was last changed, in ISO 8601 format.
FileCreated returns an attribute KeyValue conforming to the "file.created"
semantic conventions. It represents the time when the file was created, in ISO
8601 format.
FileDirectory returns an attribute KeyValue conforming to the "file.directory"
semantic conventions. It represents the directory where the file is located.
It should include the drive letter, when appropriate.
FileExtension returns an attribute KeyValue conforming to the "file.extension"
semantic conventions. It represents the file extension, excluding the leading
dot.
FileForkName returns an attribute KeyValue conforming to the "file.fork_name"
semantic conventions. It represents the name of the fork. A fork is additional
data associated with a filesystem object.
FileGroupID returns an attribute KeyValue conforming to the "file.group.id"
semantic conventions. It represents the primary Group ID (GID) of the file.
FileGroupName returns an attribute KeyValue conforming to the
"file.group.name" semantic conventions. It represents the primary group name
of the file.
FileInode returns an attribute KeyValue conforming to the "file.inode"
semantic conventions. It represents the inode representing the file in the
filesystem.
FileMode returns an attribute KeyValue conforming to the "file.mode" semantic
conventions. It represents the mode of the file in octal representation.
FileModified returns an attribute KeyValue conforming to the "file.modified"
semantic conventions. It represents the time when the file content was last
modified, in ISO 8601 format.
FileName returns an attribute KeyValue conforming to the "file.name" semantic
conventions. It represents the name of the file including the extension,
without the directory.
FileOwnerID returns an attribute KeyValue conforming to the "file.owner.id"
semantic conventions. It represents the user ID (UID) or security identifier
(SID) of the file owner.
FileOwnerName returns an attribute KeyValue conforming to the
"file.owner.name" semantic conventions. It represents the username of the file
owner.
FilePath returns an attribute KeyValue conforming to the "file.path" semantic
conventions. It represents the full path to the file, including the file name.
It should include the drive letter, when appropriate.
FileSize returns an attribute KeyValue conforming to the "file.size" semantic
conventions. It represents the file size in bytes.
FileSymbolicLinkTargetPath returns an attribute KeyValue conforming to the
"file.symbolic_link.target_path" semantic conventions. It represents the path
to the target of a symbolic link.
GCPAppHubApplicationContainer returns an attribute KeyValue conforming to the
"gcp.apphub.application.container" semantic conventions. It represents the
container within GCP where the AppHub application is defined.
GCPAppHubApplicationID returns an attribute KeyValue conforming to the
"gcp.apphub.application.id" semantic conventions. It represents the name of
the application as configured in AppHub.
GCPAppHubApplicationLocation returns an attribute KeyValue conforming to the
"gcp.apphub.application.location" semantic conventions. It represents the GCP
zone or region where the application is defined.
GCPAppHubServiceID returns an attribute KeyValue conforming to the
"gcp.apphub.service.id" semantic conventions. It represents the name of the
service as configured in AppHub.
GCPAppHubWorkloadID returns an attribute KeyValue conforming to the
"gcp.apphub.workload.id" semantic conventions. It represents the name of the
workload as configured in AppHub.
GCPClientService returns an attribute KeyValue conforming to the
"gcp.client.service" semantic conventions. It represents the identifies the
Google Cloud service for which the official client library is intended.
GCPCloudRunJobExecution returns an attribute KeyValue conforming to the
"gcp.cloud_run.job.execution" semantic conventions. It represents the name of
the Cloud Run [execution] being run for the Job, as set by the
[`CLOUD_RUN_EXECUTION`] environment variable.
GCPCloudRunJobTaskIndex returns an attribute KeyValue conforming to the
"gcp.cloud_run.job.task_index" semantic conventions. It represents the index
for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`]
environment variable.
GCPGCEInstanceHostname returns an attribute KeyValue conforming to the
"gcp.gce.instance.hostname" semantic conventions. It represents the hostname
of a GCE instance. This is the full value of the default or [custom hostname]
.
GCPGCEInstanceName returns an attribute KeyValue conforming to the
"gcp.gce.instance.name" semantic conventions. It represents the instance name
of a GCE instance. This is the value provided by `host.name`, the visible name
of the instance in the Cloud Console UI, and the prefix for the default
hostname of the instance as defined by the [default internal DNS name].
GenAIAgentDescription returns an attribute KeyValue conforming to the
"gen_ai.agent.description" semantic conventions. It represents the free-form
description of the GenAI agent provided by the application.
GenAIAgentID returns an attribute KeyValue conforming to the "gen_ai.agent.id"
semantic conventions. It represents the unique identifier of the GenAI agent.
GenAIAgentName returns an attribute KeyValue conforming to the
"gen_ai.agent.name" semantic conventions. It represents the human-readable
name of the GenAI agent provided by the application.
GenAIConversationID returns an attribute KeyValue conforming to the
"gen_ai.conversation.id" semantic conventions. It represents the unique
identifier for a conversation (session, thread), used to store and correlate
messages within this conversation.
GenAIDataSourceID returns an attribute KeyValue conforming to the
"gen_ai.data_source.id" semantic conventions. It represents the data source
identifier.
GenAIRequestChoiceCount returns an attribute KeyValue conforming to the
"gen_ai.request.choice.count" semantic conventions. It represents the target
number of candidate completions to return.
GenAIRequestEncodingFormats returns an attribute KeyValue conforming to the
"gen_ai.request.encoding_formats" semantic conventions. It represents the
encoding formats requested in an embeddings operation, if specified.
GenAIRequestFrequencyPenalty returns an attribute KeyValue conforming to the
"gen_ai.request.frequency_penalty" semantic conventions. It represents the
frequency penalty setting for the GenAI request.
GenAIRequestMaxTokens returns an attribute KeyValue conforming to the
"gen_ai.request.max_tokens" semantic conventions. It represents the maximum
number of tokens the model generates for a request.
GenAIRequestModel returns an attribute KeyValue conforming to the
"gen_ai.request.model" semantic conventions. It represents the name of the
GenAI model a request is being made to.
GenAIRequestPresencePenalty returns an attribute KeyValue conforming to the
"gen_ai.request.presence_penalty" semantic conventions. It represents the
presence penalty setting for the GenAI request.
GenAIRequestSeed returns an attribute KeyValue conforming to the
"gen_ai.request.seed" semantic conventions. It represents the requests with
same seed value more likely to return same result.
GenAIRequestStopSequences returns an attribute KeyValue conforming to the
"gen_ai.request.stop_sequences" semantic conventions. It represents the list
of sequences that the model will use to stop generating further tokens.
GenAIRequestTemperature returns an attribute KeyValue conforming to the
"gen_ai.request.temperature" semantic conventions. It represents the
temperature setting for the GenAI request.
GenAIRequestTopK returns an attribute KeyValue conforming to the
"gen_ai.request.top_k" semantic conventions. It represents the top_k sampling
setting for the GenAI request.
GenAIRequestTopP returns an attribute KeyValue conforming to the
"gen_ai.request.top_p" semantic conventions. It represents the top_p sampling
setting for the GenAI request.
GenAIResponseFinishReasons returns an attribute KeyValue conforming to the
"gen_ai.response.finish_reasons" semantic conventions. It represents the array
of reasons the model stopped generating tokens, corresponding to each
generation received.
GenAIResponseID returns an attribute KeyValue conforming to the
"gen_ai.response.id" semantic conventions. It represents the unique identifier
for the completion.
GenAIResponseModel returns an attribute KeyValue conforming to the
"gen_ai.response.model" semantic conventions. It represents the name of the
model that generated the response.
GenAIToolCallID returns an attribute KeyValue conforming to the
"gen_ai.tool.call.id" semantic conventions. It represents the tool call
identifier.
GenAIToolDescription returns an attribute KeyValue conforming to the
"gen_ai.tool.description" semantic conventions. It represents the tool
description.
GenAIToolName returns an attribute KeyValue conforming to the
"gen_ai.tool.name" semantic conventions. It represents the name of the tool
utilized by the agent.
GenAIToolType returns an attribute KeyValue conforming to the
"gen_ai.tool.type" semantic conventions. It represents the type of the tool
utilized by the agent.
GenAIUsageInputTokens returns an attribute KeyValue conforming to the
"gen_ai.usage.input_tokens" semantic conventions. It represents the number of
tokens used in the GenAI input (prompt).
GenAIUsageOutputTokens returns an attribute KeyValue conforming to the
"gen_ai.usage.output_tokens" semantic conventions. It represents the number of
tokens used in the GenAI response (completion).
GeoCountryISOCode returns an attribute KeyValue conforming to the
"geo.country.iso_code" semantic conventions. It represents the two-letter ISO
Country Code ([ISO 3166-1 alpha2]).
GeoLocalityName returns an attribute KeyValue conforming to the
"geo.locality.name" semantic conventions. It represents the locality name.
Represents the name of a city, town, village, or similar populated place.
GeoLocationLat returns an attribute KeyValue conforming to the
"geo.location.lat" semantic conventions. It represents the latitude of the geo
location in [WGS84].
GeoLocationLon returns an attribute KeyValue conforming to the
"geo.location.lon" semantic conventions. It represents the longitude of the
geo location in [WGS84].
GeoPostalCode returns an attribute KeyValue conforming to the
"geo.postal_code" semantic conventions. It represents the postal code
associated with the location. Values appropriate for this field may also be
known as a postcode or ZIP code and will vary widely from country to country.
GeoRegionISOCode returns an attribute KeyValue conforming to the
"geo.region.iso_code" semantic conventions. It represents the region ISO code
([ISO 3166-2]).
GraphQLDocument returns an attribute KeyValue conforming to the
"graphql.document" semantic conventions. It represents the GraphQL document
being executed.
GraphQLOperationName returns an attribute KeyValue conforming to the
"graphql.operation.name" semantic conventions. It represents the name of the
operation being executed.
HerokuAppID returns an attribute KeyValue conforming to the "heroku.app.id"
semantic conventions. It represents the unique identifier for the application.
HerokuReleaseCommit returns an attribute KeyValue conforming to the
"heroku.release.commit" semantic conventions. It represents the commit hash
for the current release.
HerokuReleaseCreationTimestamp returns an attribute KeyValue conforming to the
"heroku.release.creation_timestamp" semantic conventions. It represents the
time and date the release was created.
HostCPUCacheL2Size returns an attribute KeyValue conforming to the
"host.cpu.cache.l2.size" semantic conventions. It represents the amount of
level 2 memory cache available to the processor (in Bytes).
HostCPUFamily returns an attribute KeyValue conforming to the
"host.cpu.family" semantic conventions. It represents the family or generation
of the CPU.
HostCPUModelID returns an attribute KeyValue conforming to the
"host.cpu.model.id" semantic conventions. It represents the model identifier.
It provides more granular information about the CPU, distinguishing it from
other CPUs within the same family.
HostCPUModelName returns an attribute KeyValue conforming to the
"host.cpu.model.name" semantic conventions. It represents the model
designation of the processor.
HostCPUStepping returns an attribute KeyValue conforming to the
"host.cpu.stepping" semantic conventions. It represents the stepping or core
revisions.
HostCPUVendorID returns an attribute KeyValue conforming to the
"host.cpu.vendor.id" semantic conventions. It represents the processor
manufacturer identifier. A maximum 12-character string.
HostID returns an attribute KeyValue conforming to the "host.id" semantic
conventions. It represents the unique host ID. For Cloud, this must be the
instance_id assigned by the cloud provider. For non-containerized systems,
this should be the `machine-id`. See the table below for the sources to use to
determine the `machine-id` based on operating system.
HostImageID returns an attribute KeyValue conforming to the "host.image.id"
semantic conventions. It represents the VM image ID or host OS image ID. For
Cloud, this value is from the provider.
HostImageName returns an attribute KeyValue conforming to the
"host.image.name" semantic conventions. It represents the name of the VM image
or OS install the host was instantiated from.
HostImageVersion returns an attribute KeyValue conforming to the
"host.image.version" semantic conventions. It represents the version string of
the VM image or host OS as defined in [Version Attributes].
[Version Attributes]: /docs/resource/README.md#version-attributes
HostIP returns an attribute KeyValue conforming to the "host.ip" semantic
conventions. It represents the available IP addresses of the host, excluding
loopback interfaces.
HostMac returns an attribute KeyValue conforming to the "host.mac" semantic
conventions. It represents the available MAC addresses of the host, excluding
loopback interfaces.
HostName returns an attribute KeyValue conforming to the "host.name" semantic
conventions. It represents the name of the host. On Unix systems, it may
contain what the hostname command returns, or the fully qualified hostname, or
another name specified by the user.
HostType returns an attribute KeyValue conforming to the "host.type" semantic
conventions. It represents the type of host. For Cloud, this must be the
machine type.
HTTPRequestBodySize returns an attribute KeyValue conforming to the
"http.request.body.size" semantic conventions. It represents 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.
HTTPRequestHeader returns an attribute KeyValue conforming to the
"http.request.header" semantic conventions. It represents the HTTP request
headers, `<key>` being the normalized HTTP Header name (lowercase), the value
being the header values.
HTTPRequestMethodOriginal returns an attribute KeyValue conforming to the
"http.request.method_original" semantic conventions. It represents the
original HTTP method sent by the client in the request line.
HTTPRequestResendCount returns an attribute KeyValue conforming to the
"http.request.resend_count" semantic conventions. It represents the ordinal
number of request resending attempt (for any reason, including redirects).
HTTPRequestSize returns an attribute KeyValue conforming to the
"http.request.size" semantic conventions. It represents the total size of the
request in bytes. This should be the total number of bytes sent over the wire,
including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers,
and request body if any.
HTTPResponseBodySize returns an attribute KeyValue conforming to the
"http.response.body.size" semantic conventions. It represents 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.
HTTPResponseHeader returns an attribute KeyValue conforming to the
"http.response.header" semantic conventions. It represents the HTTP response
headers, `<key>` being the normalized HTTP Header name (lowercase), the value
being the header values.
HTTPResponseSize returns an attribute KeyValue conforming to the
"http.response.size" semantic conventions. It represents the total size of the
response in bytes. This should be the total number of bytes sent over the
wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3),
headers, and response body and trailers if any.
HTTPResponseStatusCode returns an attribute KeyValue conforming to the
"http.response.status_code" semantic conventions. It represents the
[HTTP response status code].
HTTPRoute returns an attribute KeyValue conforming to the "http.route"
semantic conventions. It represents the matched route, that is, the path
template in the format used by the respective server framework.
HwBatteryCapacity returns an attribute KeyValue conforming to the
"hw.battery.capacity" semantic conventions. It represents the design capacity
in Watts-hours or Amper-hours.
HwBatteryChemistry returns an attribute KeyValue conforming to the
"hw.battery.chemistry" semantic conventions. It represents the battery
[chemistry], e.g. Lithium-Ion, Nickel-Cadmium, etc.
HwBiosVersion returns an attribute KeyValue conforming to the
"hw.bios_version" semantic conventions. It represents the BIOS version of the
hardware component.
HwDriverVersion returns an attribute KeyValue conforming to the
"hw.driver_version" semantic conventions. It represents the driver version for
the hardware component.
HwEnclosureType returns an attribute KeyValue conforming to the
"hw.enclosure.type" semantic conventions. It represents the type of the
enclosure (useful for modular systems).
HwFirmwareVersion returns an attribute KeyValue conforming to the
"hw.firmware_version" semantic conventions. It represents the firmware version
of the hardware component.
HwID returns an attribute KeyValue conforming to the "hw.id" semantic
conventions. It represents an identifier for the hardware component, unique
within the monitored host.
HwLogicalDiskRaidLevel returns an attribute KeyValue conforming to the
"hw.logical_disk.raid_level" semantic conventions. It represents the RAID
Level of the logical disk.
HwMemoryType returns an attribute KeyValue conforming to the "hw.memory.type"
semantic conventions. It represents the type of the memory module.
HwModel returns an attribute KeyValue conforming to the "hw.model" semantic
conventions. It represents the descriptive model name of the hardware
component.
HwName returns an attribute KeyValue conforming to the "hw.name" semantic
conventions. It represents an easily-recognizable name for the hardware
component.
HwNetworkLogicalAddresses returns an attribute KeyValue conforming to the
"hw.network.logical_addresses" semantic conventions. It represents the logical
addresses of the adapter (e.g. IP address, or WWPN).
HwNetworkPhysicalAddress returns an attribute KeyValue conforming to the
"hw.network.physical_address" semantic conventions. It represents the physical
address of the adapter (e.g. MAC address, or WWNN).
HwParent returns an attribute KeyValue conforming to the "hw.parent" semantic
conventions. It represents the unique identifier of the parent component
(typically the `hw.id` attribute of the enclosure, or disk controller).
HwPhysicalDiskSmartAttribute returns an attribute KeyValue conforming to the
"hw.physical_disk.smart_attribute" semantic conventions. It represents the
[S.M.A.R.T.] (Self-Monitoring, Analysis, and Reporting Technology) attribute
of the physical disk.
HwPhysicalDiskType returns an attribute KeyValue conforming to the
"hw.physical_disk.type" semantic conventions. It represents the type of the
physical disk.
HwSensorLocation returns an attribute KeyValue conforming to the
"hw.sensor_location" semantic conventions. It represents the location of the
sensor.
HwSerialNumber returns an attribute KeyValue conforming to the
"hw.serial_number" semantic conventions. It represents the serial number of
the hardware component.
HwVendor returns an attribute KeyValue conforming to the "hw.vendor" semantic
conventions. It represents the vendor name of the hardware component.
K8SClusterName returns an attribute KeyValue conforming to the
"k8s.cluster.name" semantic conventions. It represents the name of the
cluster.
K8SClusterUID returns an attribute KeyValue conforming to the
"k8s.cluster.uid" semantic conventions. It represents a pseudo-ID for the
cluster, set to the UID of the `kube-system` namespace.
K8SContainerName returns an attribute KeyValue conforming to the
"k8s.container.name" semantic conventions. It represents the name of the
Container from Pod specification, must be unique within a Pod. Container
runtime usually uses different globally unique name (`container.name`).
K8SContainerRestartCount returns an attribute KeyValue conforming to the
"k8s.container.restart_count" semantic conventions. It represents the number
of times the container was restarted. This attribute can be used to identify a
particular container (running or stopped) within a container spec.
K8SContainerStatusLastTerminatedReason returns an attribute KeyValue
conforming to the "k8s.container.status.last_terminated_reason" semantic
conventions. It represents the last terminated reason of the Container.
K8SCronJobAnnotation returns an attribute KeyValue conforming to the
"k8s.cronjob.annotation" semantic conventions. It represents the cronjob
annotation placed on the CronJob, the `<key>` being the annotation name, the
value being the annotation value.
K8SCronJobLabel returns an attribute KeyValue conforming to the
"k8s.cronjob.label" semantic conventions. It represents the label placed on
the CronJob, the `<key>` being the label name, the value being the label
value.
K8SCronJobName returns an attribute KeyValue conforming to the
"k8s.cronjob.name" semantic conventions. It represents the name of the
CronJob.
K8SCronJobUID returns an attribute KeyValue conforming to the
"k8s.cronjob.uid" semantic conventions. It represents the UID of the CronJob.
K8SDaemonSetAnnotation returns an attribute KeyValue conforming to the
"k8s.daemonset.annotation" semantic conventions. It represents the annotation
placed on the DaemonSet, the `<key>` being the annotation name, the value
being the annotation value, even if the value is empty.
K8SDaemonSetLabel returns an attribute KeyValue conforming to the
"k8s.daemonset.label" semantic conventions. It represents the label placed on
the DaemonSet, the `<key>` being the label name, the value being the label
value, even if the value is empty.
K8SDaemonSetName returns an attribute KeyValue conforming to the
"k8s.daemonset.name" semantic conventions. It represents the name of the
DaemonSet.
K8SDaemonSetUID returns an attribute KeyValue conforming to the
"k8s.daemonset.uid" semantic conventions. It represents the UID of the
DaemonSet.
K8SDeploymentAnnotation returns an attribute KeyValue conforming to the
"k8s.deployment.annotation" semantic conventions. It represents the annotation
placed on the Deployment, the `<key>` being the annotation name, the value
being the annotation value, even if the value is empty.
K8SDeploymentLabel returns an attribute KeyValue conforming to the
"k8s.deployment.label" semantic conventions. It represents the label placed on
the Deployment, the `<key>` being the label name, the value being the label
value, even if the value is empty.
K8SDeploymentName returns an attribute KeyValue conforming to the
"k8s.deployment.name" semantic conventions. It represents the name of the
Deployment.
K8SDeploymentUID returns an attribute KeyValue conforming to the
"k8s.deployment.uid" semantic conventions. It represents the UID of the
Deployment.
K8SHPAMetricType returns an attribute KeyValue conforming to the
"k8s.hpa.metric.type" semantic conventions. It represents the type of metric
source for the horizontal pod autoscaler.
K8SHPAName returns an attribute KeyValue conforming to the "k8s.hpa.name"
semantic conventions. It represents the name of the horizontal pod autoscaler.
K8SHPAScaletargetrefAPIVersion returns an attribute KeyValue conforming to the
"k8s.hpa.scaletargetref.api_version" semantic conventions. It represents the
API version of the target resource to scale for the HorizontalPodAutoscaler.
K8SHPAScaletargetrefKind returns an attribute KeyValue conforming to the
"k8s.hpa.scaletargetref.kind" semantic conventions. It represents the kind of
the target resource to scale for the HorizontalPodAutoscaler.
K8SHPAScaletargetrefName returns an attribute KeyValue conforming to the
"k8s.hpa.scaletargetref.name" semantic conventions. It represents the name of
the target resource to scale for the HorizontalPodAutoscaler.
K8SHPAUID returns an attribute KeyValue conforming to the "k8s.hpa.uid"
semantic conventions. It represents the UID of the horizontal pod autoscaler.
K8SHugepageSize returns an attribute KeyValue conforming to the
"k8s.hugepage.size" semantic conventions. It represents the size (identifier)
of the K8s huge page.
K8SJobAnnotation returns an attribute KeyValue conforming to the
"k8s.job.annotation" semantic conventions. It represents the annotation placed
on the Job, the `<key>` being the annotation name, the value being the
annotation value, even if the value is empty.
K8SJobLabel returns an attribute KeyValue conforming to the "k8s.job.label"
semantic conventions. It represents the label placed on the Job, the `<key>`
being the label name, the value being the label value, even if the value is
empty.
K8SJobName returns an attribute KeyValue conforming to the "k8s.job.name"
semantic conventions. It represents the name of the Job.
K8SJobUID returns an attribute KeyValue conforming to the "k8s.job.uid"
semantic conventions. It represents the UID of the Job.
K8SNamespaceAnnotation returns an attribute KeyValue conforming to the
"k8s.namespace.annotation" semantic conventions. It represents the annotation
placed on the Namespace, the `<key>` being the annotation name, the value
being the annotation value, even if the value is empty.
K8SNamespaceLabel returns an attribute KeyValue conforming to the
"k8s.namespace.label" semantic conventions. It represents the label placed on
the Namespace, the `<key>` being the label name, the value being the label
value, even if the value is empty.
K8SNamespaceName returns an attribute KeyValue conforming to the
"k8s.namespace.name" semantic conventions. It represents the name of the
namespace that the pod is running in.
K8SNodeAnnotation returns an attribute KeyValue conforming to the
"k8s.node.annotation" semantic conventions. It represents the annotation
placed on the Node, the `<key>` being the annotation name, the value being the
annotation value, even if the value is empty.
K8SNodeLabel returns an attribute KeyValue conforming to the "k8s.node.label"
semantic conventions. It represents the label placed on the Node, the `<key>`
being the label name, the value being the label value, even if the value is
empty.
K8SNodeName returns an attribute KeyValue conforming to the "k8s.node.name"
semantic conventions. It represents the name of the Node.
K8SNodeUID returns an attribute KeyValue conforming to the "k8s.node.uid"
semantic conventions. It represents the UID of the Node.
K8SPodAnnotation returns an attribute KeyValue conforming to the
"k8s.pod.annotation" semantic conventions. It represents the annotation placed
on the Pod, the `<key>` being the annotation name, the value being the
annotation value.
K8SPodLabel returns an attribute KeyValue conforming to the "k8s.pod.label"
semantic conventions. It represents the label placed on the Pod, the `<key>`
being the label name, the value being the label value.
K8SPodName returns an attribute KeyValue conforming to the "k8s.pod.name"
semantic conventions. It represents the name of the Pod.
K8SPodUID returns an attribute KeyValue conforming to the "k8s.pod.uid"
semantic conventions. It represents the UID of the Pod.
K8SReplicaSetAnnotation returns an attribute KeyValue conforming to the
"k8s.replicaset.annotation" semantic conventions. It represents the annotation
placed on the ReplicaSet, the `<key>` being the annotation name, the value
being the annotation value, even if the value is empty.
K8SReplicaSetLabel returns an attribute KeyValue conforming to the
"k8s.replicaset.label" semantic conventions. It represents the label placed on
the ReplicaSet, the `<key>` being the label name, the value being the label
value, even if the value is empty.
K8SReplicaSetName returns an attribute KeyValue conforming to the
"k8s.replicaset.name" semantic conventions. It represents the name of the
ReplicaSet.
K8SReplicaSetUID returns an attribute KeyValue conforming to the
"k8s.replicaset.uid" semantic conventions. It represents the UID of the
ReplicaSet.
K8SReplicationControllerName returns an attribute KeyValue conforming to the
"k8s.replicationcontroller.name" semantic conventions. It represents the name
of the replication controller.
K8SReplicationControllerUID returns an attribute KeyValue conforming to the
"k8s.replicationcontroller.uid" semantic conventions. It represents the UID of
the replication controller.
K8SResourceQuotaName returns an attribute KeyValue conforming to the
"k8s.resourcequota.name" semantic conventions. It represents the name of the
resource quota.
K8SResourceQuotaResourceName returns an attribute KeyValue conforming to the
"k8s.resourcequota.resource_name" semantic conventions. It represents the name
of the K8s resource a resource quota defines.
K8SResourceQuotaUID returns an attribute KeyValue conforming to the
"k8s.resourcequota.uid" semantic conventions. It represents the UID of the
resource quota.
K8SStatefulSetAnnotation returns an attribute KeyValue conforming to the
"k8s.statefulset.annotation" semantic conventions. It represents the
annotation placed on the StatefulSet, the `<key>` being the annotation name,
the value being the annotation value, even if the value is empty.
K8SStatefulSetLabel returns an attribute KeyValue conforming to the
"k8s.statefulset.label" semantic conventions. It represents the label placed
on the StatefulSet, the `<key>` being the label name, the value being the
label value, even if the value is empty.
K8SStatefulSetName returns an attribute KeyValue conforming to the
"k8s.statefulset.name" semantic conventions. It represents the name of the
StatefulSet.
K8SStatefulSetUID returns an attribute KeyValue conforming to the
"k8s.statefulset.uid" semantic conventions. It represents the UID of the
StatefulSet.
K8SStorageclassName returns an attribute KeyValue conforming to the
"k8s.storageclass.name" semantic conventions. It represents the name of K8s
[StorageClass] object.
K8SVolumeName returns an attribute KeyValue conforming to the
"k8s.volume.name" semantic conventions. It represents the name of the K8s
volume.
LogFileName returns an attribute KeyValue conforming to the "log.file.name"
semantic conventions. It represents the basename of the file.
LogFileNameResolved returns an attribute KeyValue conforming to the
"log.file.name_resolved" semantic conventions. It represents the basename of
the file, with symlinks resolved.
LogFilePath returns an attribute KeyValue conforming to the "log.file.path"
semantic conventions. It represents the full path to the file.
LogFilePathResolved returns an attribute KeyValue conforming to the
"log.file.path_resolved" semantic conventions. It represents the full path to
the file, with symlinks resolved.
LogRecordOriginal returns an attribute KeyValue conforming to the
"log.record.original" semantic conventions. It represents the complete
original Log Record.
LogRecordUID returns an attribute KeyValue conforming to the "log.record.uid"
semantic conventions. It represents a unique identifier for the Log Record.
MainframeLparName returns an attribute KeyValue conforming to the
"mainframe.lpar.name" semantic conventions. It represents the name of the
logical partition that hosts a systems with a mainframe operating system.
MessagingBatchMessageCount returns an attribute KeyValue conforming to the
"messaging.batch.message_count" semantic conventions. It represents the number
of messages sent, received, or processed in the scope of the batching
operation.
MessagingClientID returns an attribute KeyValue conforming to the
"messaging.client.id" semantic conventions. It represents a unique identifier
for the client that consumes or produces a message.
MessagingConsumerGroupName returns an attribute KeyValue conforming to the
"messaging.consumer.group.name" semantic conventions. It represents the name
of the consumer group with which a consumer is associated.
MessagingDestinationAnonymous returns an attribute KeyValue conforming to the
"messaging.destination.anonymous" semantic conventions. It represents a
boolean that is true if the message destination is anonymous (could be unnamed
or have auto-generated name).
MessagingDestinationName returns an attribute KeyValue conforming to the
"messaging.destination.name" semantic conventions. It represents the message
destination name.
MessagingDestinationPartitionID returns an attribute KeyValue conforming to
the "messaging.destination.partition.id" semantic conventions. It represents
the identifier of the partition messages are sent to or received from, unique
within the `messaging.destination.name`.
MessagingDestinationSubscriptionName returns an attribute KeyValue conforming
to the "messaging.destination.subscription.name" semantic conventions. It
represents the name of the destination subscription from which a message is
consumed.
MessagingDestinationTemplate returns an attribute KeyValue conforming to the
"messaging.destination.template" semantic conventions. It represents the low
cardinality representation of the messaging destination name.
MessagingDestinationTemporary returns an attribute KeyValue conforming to the
"messaging.destination.temporary" semantic conventions. It represents a
boolean that is true if the message destination is temporary and might not
exist anymore after messages are processed.
MessagingEventHubsMessageEnqueuedTime returns an attribute KeyValue conforming
to the "messaging.eventhubs.message.enqueued_time" semantic conventions. It
represents the UTC epoch seconds at which the message has been accepted and
stored in the entity.
MessagingGCPPubSubMessageAckDeadline returns an attribute KeyValue conforming
to the "messaging.gcp_pubsub.message.ack_deadline" semantic conventions. It
represents the ack deadline in seconds set for the modify ack deadline
request.
MessagingGCPPubSubMessageAckID returns an attribute KeyValue conforming to the
"messaging.gcp_pubsub.message.ack_id" semantic conventions. It represents the
ack id for a given message.
MessagingGCPPubSubMessageDeliveryAttempt returns an attribute KeyValue
conforming to the "messaging.gcp_pubsub.message.delivery_attempt" semantic
conventions. It represents the delivery attempt for a given message.
MessagingGCPPubSubMessageOrderingKey returns an attribute KeyValue conforming
to the "messaging.gcp_pubsub.message.ordering_key" semantic conventions. It
represents the ordering key for a given message. If the attribute is not
present, the message does not have an ordering key.
MessagingKafkaMessageKey returns an attribute KeyValue conforming to the
"messaging.kafka.message.key" semantic conventions. It represents the 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.
MessagingKafkaMessageTombstone returns an attribute KeyValue conforming to the
"messaging.kafka.message.tombstone" semantic conventions. It represents a
boolean that is true if the message is a tombstone.
MessagingKafkaOffset returns an attribute KeyValue conforming to the
"messaging.kafka.offset" semantic conventions. It represents the offset of a
record in the corresponding Kafka partition.
MessagingMessageBodySize returns an attribute KeyValue conforming to the
"messaging.message.body.size" semantic conventions. It represents the size of
the message body in bytes.
MessagingMessageConversationID returns an attribute KeyValue conforming to the
"messaging.message.conversation_id" semantic conventions. It represents the
conversation ID identifying the conversation to which the message belongs,
represented as a string. Sometimes called "Correlation ID".
MessagingMessageEnvelopeSize returns an attribute KeyValue conforming to the
"messaging.message.envelope.size" semantic conventions. It represents the size
of the message body and metadata in bytes.
MessagingMessageID returns an attribute KeyValue conforming to the
"messaging.message.id" semantic conventions. It represents a value used by the
messaging system as an identifier for the message, represented as a string.
MessagingOperationName returns an attribute KeyValue conforming to the
"messaging.operation.name" semantic conventions. It represents the
system-specific name of the messaging operation.
MessagingRabbitMQDestinationRoutingKey returns an attribute KeyValue
conforming to the "messaging.rabbitmq.destination.routing_key" semantic
conventions. It represents the rabbitMQ message routing key.
MessagingRabbitMQMessageDeliveryTag returns an attribute KeyValue conforming
to the "messaging.rabbitmq.message.delivery_tag" semantic conventions. It
represents the rabbitMQ message delivery tag.
MessagingRocketMQMessageDelayTimeLevel returns an attribute KeyValue
conforming to the "messaging.rocketmq.message.delay_time_level" semantic
conventions. It represents the delay time level for delay message, which
determines the message delay time.
MessagingRocketMQMessageDeliveryTimestamp returns an attribute KeyValue
conforming to the "messaging.rocketmq.message.delivery_timestamp" semantic
conventions. It represents the timestamp in milliseconds that the delay
message is expected to be delivered to consumer.
MessagingRocketMQMessageGroup returns an attribute KeyValue conforming to the
"messaging.rocketmq.message.group" semantic conventions. It represents the 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.
MessagingRocketMQMessageKeys returns an attribute KeyValue conforming to the
"messaging.rocketmq.message.keys" semantic conventions. It represents the
key(s) of message, another way to mark message besides message id.
MessagingRocketMQMessageTag returns an attribute KeyValue conforming to the
"messaging.rocketmq.message.tag" semantic conventions. It represents the
secondary classifier of message besides topic.
MessagingRocketMQNamespace returns an attribute KeyValue conforming to the
"messaging.rocketmq.namespace" semantic conventions. It represents the
namespace of RocketMQ resources, resources in different namespaces are
individual.
MessagingServiceBusMessageDeliveryCount returns an attribute KeyValue
conforming to the "messaging.servicebus.message.delivery_count" semantic
conventions. It represents the number of deliveries that have been attempted
for this message.
MessagingServiceBusMessageEnqueuedTime returns an attribute KeyValue
conforming to the "messaging.servicebus.message.enqueued_time" semantic
conventions. It represents the UTC epoch seconds at which the message has been
accepted and stored in the entity.
NetworkCarrierICC returns an attribute KeyValue conforming to the
"network.carrier.icc" semantic conventions. It represents the ISO 3166-1
alpha-2 2-character country code associated with the mobile carrier network.
NetworkCarrierMCC returns an attribute KeyValue conforming to the
"network.carrier.mcc" semantic conventions. It represents the mobile carrier
country code.
NetworkCarrierMNC returns an attribute KeyValue conforming to the
"network.carrier.mnc" semantic conventions. It represents the mobile carrier
network code.
NetworkCarrierName returns an attribute KeyValue conforming to the
"network.carrier.name" semantic conventions. It represents the name of the
mobile carrier.
NetworkInterfaceName returns an attribute KeyValue conforming to the
"network.interface.name" semantic conventions. It represents the network
interface name.
NetworkLocalAddress returns an attribute KeyValue conforming to the
"network.local.address" semantic conventions. It represents the local address
of the network connection - IP address or Unix domain socket name.
NetworkLocalPort returns an attribute KeyValue conforming to the
"network.local.port" semantic conventions. It represents the local port number
of the network connection.
NetworkPeerAddress returns an attribute KeyValue conforming to the
"network.peer.address" semantic conventions. It represents the peer address of
the network connection - IP address or Unix domain socket name.
NetworkPeerPort returns an attribute KeyValue conforming to the
"network.peer.port" semantic conventions. It represents the peer port number
of the network connection.
NetworkProtocolName returns an attribute KeyValue conforming to the
"network.protocol.name" semantic conventions. It represents the
[OSI application layer] or non-OSI equivalent.
NetworkProtocolVersion returns an attribute KeyValue conforming to the
"network.protocol.version" semantic conventions. It represents the actual
version of the protocol used for network communication.
OCIManifestDigest returns an attribute KeyValue conforming to the
"oci.manifest.digest" semantic conventions. It represents the digest of the
OCI image manifest. For container images specifically is the digest by which
the container image is known.
OpenAIResponseServiceTier returns an attribute KeyValue conforming to the
"openai.response.service_tier" semantic conventions. It represents the service
tier used for the response.
OpenAIResponseSystemFingerprint returns an attribute KeyValue conforming to
the "openai.response.system_fingerprint" semantic conventions. It represents a
fingerprint to track any eventual change in the Generative AI environment.
OSBuildID returns an attribute KeyValue conforming to the "os.build_id"
semantic conventions. It represents the unique identifier for a particular
build or compilation of the operating system.
OSDescription returns an attribute KeyValue conforming to the "os.description"
semantic conventions. It represents the human readable (not intended to be
parsed) OS version information, like e.g. reported by `ver` or
`lsb_release -a` commands.
OSName returns an attribute KeyValue conforming to the "os.name" semantic
conventions. It represents the human readable operating system name.
OSVersion returns an attribute KeyValue conforming to the "os.version"
semantic conventions. It represents the version string of the operating system
as defined in [Version Attributes].
[Version Attributes]: /docs/resource/README.md#version-attributes
OTelComponentName returns an attribute KeyValue conforming to the
"otel.component.name" semantic conventions. It represents a name uniquely
identifying the instance of the OpenTelemetry component within its containing
SDK instance.
OTelScopeName returns an attribute KeyValue conforming to the
"otel.scope.name" semantic conventions. It represents the name of the
instrumentation scope - (`InstrumentationScope.Name` in OTLP).
OTelScopeSchemaURL returns an attribute KeyValue conforming to the
"otel.scope.schema_url" semantic conventions. It represents the schema URL of
the instrumentation scope.
OTelScopeVersion returns an attribute KeyValue conforming to the
"otel.scope.version" semantic conventions. It represents the version of the
instrumentation scope - (`InstrumentationScope.Version` in OTLP).
OTelStatusDescription returns an attribute KeyValue conforming to the
"otel.status_description" semantic conventions. It represents the description
of the Status if it has a value, otherwise not set.
PeerService returns an attribute KeyValue conforming to the "peer.service"
semantic conventions. It represents the [`service.name`] of the remote
service. SHOULD be equal to the actual `service.name` resource attribute of
the remote service if any.
[`service.name`]: /docs/resource/README.md#service
ProcessArgsCount returns an attribute KeyValue conforming to the
"process.args_count" semantic conventions. It represents the length of the
process.command_args array.
ProcessCommand returns an attribute KeyValue conforming to the
"process.command" semantic conventions. It represents the command used to
launch the process (i.e. the command name). On Linux based systems, can be set
to the zeroth string in `proc/[pid]/cmdline`. On Windows, can be set to the
first parameter extracted from `GetCommandLineW`.
ProcessCommandArgs returns an attribute KeyValue conforming to the
"process.command_args" semantic conventions. It represents the all the command
arguments (including the command/executable itself) as received by the
process. On Linux-based systems (and some other Unixoid systems supporting
procfs), can be set according to the list of null-delimited strings extracted
from `proc/[pid]/cmdline`. For libc-based executables, this would be the full
argv vector passed to `main`. SHOULD NOT be collected by default unless there
is sanitization that excludes sensitive data.
ProcessCommandLine returns an attribute KeyValue conforming to the
"process.command_line" semantic conventions. It represents the full command
used to launch the process as a single string representing the full command.
On Windows, can be set to the result of `GetCommandLineW`. Do not set this if
you have to assemble it just for monitoring; use `process.command_args`
instead. SHOULD NOT be collected by default unless there is sanitization that
excludes sensitive data.
ProcessCreationTime returns an attribute KeyValue conforming to the
"process.creation.time" semantic conventions. It represents the date and time
the process was created, in ISO 8601 format.
ProcessEnvironmentVariable returns an attribute KeyValue conforming to the
"process.environment_variable" semantic conventions. It represents the process
environment variables, `<key>` being the environment variable name, the value
being the environment variable value.
ProcessExecutableBuildIDGNU returns an attribute KeyValue conforming to the
"process.executable.build_id.gnu" semantic conventions. It represents the GNU
build ID as found in the `.note.gnu.build-id` ELF section (hex string).
ProcessExecutableBuildIDGo returns an attribute KeyValue conforming to the
"process.executable.build_id.go" semantic conventions. It represents the Go
build ID as retrieved by `go tool buildid <go executable>`.
ProcessExecutableBuildIDHtlhash returns an attribute KeyValue conforming to
the "process.executable.build_id.htlhash" semantic conventions. It represents
the profiling specific build ID for executables. See the OTel specification
for Profiles for more information.
ProcessExecutableName returns an attribute KeyValue conforming to the
"process.executable.name" semantic conventions. It represents the name of the
process executable. On Linux based systems, this SHOULD be set to the base
name of the target of `/proc/[pid]/exe`. On Windows, this SHOULD be set to the
base name of `GetProcessImageFileNameW`.
ProcessExecutablePath returns an attribute KeyValue conforming to the
"process.executable.path" semantic conventions. It represents the full path to
the process executable. On Linux based systems, can be set to the target of
`proc/[pid]/exe`. On Windows, can be set to the result of
`GetProcessImageFileNameW`.
ProcessExitCode returns an attribute KeyValue conforming to the
"process.exit.code" semantic conventions. It represents the exit code of the
process.
ProcessExitTime returns an attribute KeyValue conforming to the
"process.exit.time" semantic conventions. It represents the date and time the
process exited, in ISO 8601 format.
ProcessGroupLeaderPID returns an attribute KeyValue conforming to the
"process.group_leader.pid" semantic conventions. It represents the PID of the
process's group leader. This is also the process group ID (PGID) of the
process.
ProcessInteractive returns an attribute KeyValue conforming to the
"process.interactive" semantic conventions. It represents the whether the
process is connected to an interactive shell.
ProcessLinuxCgroup returns an attribute KeyValue conforming to the
"process.linux.cgroup" semantic conventions. It represents the control group
associated with the process.
ProcessOwner returns an attribute KeyValue conforming to the "process.owner"
semantic conventions. It represents the username of the user that owns the
process.
ProcessParentPID returns an attribute KeyValue conforming to the
"process.parent_pid" semantic conventions. It represents the parent Process
identifier (PPID).
ProcessPID returns an attribute KeyValue conforming to the "process.pid"
semantic conventions. It represents the process identifier (PID).
ProcessRealUserID returns an attribute KeyValue conforming to the
"process.real_user.id" semantic conventions. It represents the real user ID
(RUID) of the process.
ProcessRealUserName returns an attribute KeyValue conforming to the
"process.real_user.name" semantic conventions. It represents the username of
the real user of the process.
ProcessRuntimeDescription returns an attribute KeyValue conforming to the
"process.runtime.description" semantic conventions. It represents an
additional description about the runtime of the process, for example a
specific vendor customization of the runtime environment.
ProcessRuntimeName returns an attribute KeyValue conforming to the
"process.runtime.name" semantic conventions. It represents the name of the
runtime of this process.
ProcessRuntimeVersion returns an attribute KeyValue conforming to the
"process.runtime.version" semantic conventions. It represents the version of
the runtime of this process, as returned by the runtime without modification.
ProcessSavedUserID returns an attribute KeyValue conforming to the
"process.saved_user.id" semantic conventions. It represents the saved user ID
(SUID) of the process.
ProcessSavedUserName returns an attribute KeyValue conforming to the
"process.saved_user.name" semantic conventions. It represents the username of
the saved user.
ProcessSessionLeaderPID returns an attribute KeyValue conforming to the
"process.session_leader.pid" semantic conventions. It represents the PID of
the process's session leader. This is also the session ID (SID) of the
process.
ProcessTitle returns an attribute KeyValue conforming to the "process.title"
semantic conventions. It represents the process title (proctitle).
ProcessUserID returns an attribute KeyValue conforming to the
"process.user.id" semantic conventions. It represents the effective user ID
(EUID) of the process.
ProcessUserName returns an attribute KeyValue conforming to the
"process.user.name" semantic conventions. It represents the username of the
effective user of the process.
ProcessVpid returns an attribute KeyValue conforming to the "process.vpid"
semantic conventions. It represents the virtual process identifier.
ProcessWorkingDirectory returns an attribute KeyValue conforming to the
"process.working_directory" semantic conventions. It represents the working
directory of the process.
RPCConnectRPCRequestMetadata returns an attribute KeyValue conforming to the
"rpc.connect_rpc.request.metadata" semantic conventions. It represents the
connect request metadata, `<key>` being the normalized Connect Metadata key
(lowercase), the value being the metadata values.
RPCConnectRPCResponseMetadata returns an attribute KeyValue conforming to the
"rpc.connect_rpc.response.metadata" semantic conventions. It represents the
connect response metadata, `<key>` being the normalized Connect Metadata key
(lowercase), the value being the metadata values.
RPCGRPCRequestMetadata returns an attribute KeyValue conforming to the
"rpc.grpc.request.metadata" semantic conventions. It represents the gRPC
request metadata, `<key>` being the normalized gRPC Metadata key (lowercase),
the value being the metadata values.
RPCGRPCResponseMetadata returns an attribute KeyValue conforming to the
"rpc.grpc.response.metadata" semantic conventions. It represents the gRPC
response metadata, `<key>` being the normalized gRPC Metadata key (lowercase),
the value being the metadata values.
RPCJSONRPCErrorCode returns an attribute KeyValue conforming to the
"rpc.jsonrpc.error_code" semantic conventions. It represents the `error.code`
property of response if it is an error response.
RPCJSONRPCErrorMessage returns an attribute KeyValue conforming to the
"rpc.jsonrpc.error_message" semantic conventions. It represents the
`error.message` property of response if it is an error response.
RPCJSONRPCRequestID returns an attribute KeyValue conforming to the
"rpc.jsonrpc.request_id" semantic conventions. It represents the `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.
RPCJSONRPCVersion returns an attribute KeyValue conforming to the
"rpc.jsonrpc.version" semantic conventions. It represents the protocol version
as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't
specify this, the value can be omitted.
RPCMessageCompressedSize returns an attribute KeyValue conforming to the
"rpc.message.compressed_size" semantic conventions. It represents the
compressed size of the message in bytes.
RPCMessageID returns an attribute KeyValue conforming to the "rpc.message.id"
semantic conventions. It MUST be calculated as two different counters starting
from `1` one for sent messages and one for received message..
RPCMessageUncompressedSize returns an attribute KeyValue conforming to the
"rpc.message.uncompressed_size" semantic conventions. It represents the
uncompressed size of the message in bytes.
RPCMethod returns an attribute KeyValue conforming to the "rpc.method"
semantic conventions. It represents the name of the (logical) method being
called, must be equal to the $method part in the span name.
RPCService returns an attribute KeyValue conforming to the "rpc.service"
semantic conventions. It represents the full (logical) name of the service
being called, including its package name, if applicable.
SecurityRuleCategory returns an attribute KeyValue conforming to the
"security_rule.category" semantic conventions. It represents a categorization
value keyword used by the entity using the rule for detection of this event.
SecurityRuleDescription returns an attribute KeyValue conforming to the
"security_rule.description" semantic conventions. It represents the
description of the rule generating the event.
SecurityRuleLicense returns an attribute KeyValue conforming to the
"security_rule.license" semantic conventions. It represents the name of the
license under which the rule used to generate this event is made available.
SecurityRuleName returns an attribute KeyValue conforming to the
"security_rule.name" semantic conventions. It represents the name of the rule
or signature generating the event.
SecurityRuleReference returns an attribute KeyValue conforming to the
"security_rule.reference" semantic conventions. It represents the reference
URL to additional information about the rule used to generate this event.
SecurityRuleRulesetName returns an attribute KeyValue conforming to the
"security_rule.ruleset.name" semantic conventions. It represents the name of
the ruleset, policy, group, or parent category in which the rule used to
generate this event is a member.
SecurityRuleUUID returns an attribute KeyValue conforming to the
"security_rule.uuid" semantic conventions. It represents a rule ID that is
unique within the scope of a set or group of agents, observers, or other
entities using the rule for detection of this event.
SecurityRuleVersion returns an attribute KeyValue conforming to the
"security_rule.version" semantic conventions. It represents the version /
revision of the rule being used for analysis.
ServerAddress returns an attribute KeyValue conforming to the "server.address"
semantic conventions. It represents the server domain name if available
without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
ServerPort returns an attribute KeyValue conforming to the "server.port"
semantic conventions. It represents the server port number.
ServiceInstanceID returns an attribute KeyValue conforming to the
"service.instance.id" semantic conventions. It represents the string ID of the
service instance.
ServiceName returns an attribute KeyValue conforming to the "service.name"
semantic conventions. It represents the logical name of the service.
ServiceNamespace returns an attribute KeyValue conforming to the
"service.namespace" semantic conventions. It represents a namespace for
`service.name`.
ServiceVersion returns an attribute KeyValue conforming to the
"service.version" semantic conventions. It represents the version string of
the service API or implementation. The format is not defined by these
conventions.
SessionID returns an attribute KeyValue conforming to the "session.id"
semantic conventions. It represents a unique id to identify a session.
SessionPreviousID returns an attribute KeyValue conforming to the
"session.previous_id" semantic conventions. It represents the previous
`session.id` for this user, when known.
SourceAddress returns an attribute KeyValue conforming to the "source.address"
semantic conventions. It represents the source address - domain name if
available without reverse DNS lookup; otherwise, IP address or Unix domain
socket name.
SourcePort returns an attribute KeyValue conforming to the "source.port"
semantic conventions. It represents the source port number.
SystemCPULogicalNumber returns an attribute KeyValue conforming to the
"system.cpu.logical_number" semantic conventions. It represents the
deprecated, use `cpu.logical_number` instead.
SystemDevice returns an attribute KeyValue conforming to the "system.device"
semantic conventions. It represents the device identifier.
SystemFilesystemMode returns an attribute KeyValue conforming to the
"system.filesystem.mode" semantic conventions. It represents the filesystem
mode.
SystemFilesystemMountpoint returns an attribute KeyValue conforming to the
"system.filesystem.mountpoint" semantic conventions. It represents the
filesystem mount path.
TelemetryDistroName returns an attribute KeyValue conforming to the
"telemetry.distro.name" semantic conventions. It represents the name of the
auto instrumentation agent or distribution, if used.
TelemetryDistroVersion returns an attribute KeyValue conforming to the
"telemetry.distro.version" semantic conventions. It represents the version
string of the auto instrumentation agent or distribution, if used.
TelemetrySDKName returns an attribute KeyValue conforming to the
"telemetry.sdk.name" semantic conventions. It represents the name of the
telemetry SDK as defined above.
TelemetrySDKVersion returns an attribute KeyValue conforming to the
"telemetry.sdk.version" semantic conventions. It represents the version string
of the telemetry SDK.
TestCaseName returns an attribute KeyValue conforming to the "test.case.name"
semantic conventions. It represents the fully qualified human readable name of
the [test case].
TestSuiteName returns an attribute KeyValue conforming to the
"test.suite.name" semantic conventions. It represents the human readable name
of a [test suite].
ThreadID returns an attribute KeyValue conforming to the "thread.id" semantic
conventions. It represents the current "managed" thread ID (as opposed to OS
thread ID).
ThreadName returns an attribute KeyValue conforming to the "thread.name"
semantic conventions. It represents the current thread name.
TLSCipher returns an attribute KeyValue conforming to the "tls.cipher"
semantic conventions. It represents the string indicating the [cipher] used
during the current connection.
TLSClientCertificate returns an attribute KeyValue conforming to the
"tls.client.certificate" semantic conventions. It represents the PEM-encoded
stand-alone certificate offered by the client. This is usually
mutually-exclusive of `client.certificate_chain` since this value also exists
in that list.
TLSClientCertificateChain returns an attribute KeyValue conforming to the
"tls.client.certificate_chain" semantic conventions. It represents the array
of PEM-encoded certificates that make up the certificate chain offered by the
client. This is usually mutually-exclusive of `client.certificate` since that
value should be the first certificate in the chain.
TLSClientHashMd5 returns an attribute KeyValue conforming to the
"tls.client.hash.md5" semantic conventions. It represents the certificate
fingerprint using the MD5 digest of DER-encoded version of certificate offered
by the client. For consistency with other hash values, this value should be
formatted as an uppercase hash.
TLSClientHashSha1 returns an attribute KeyValue conforming to the
"tls.client.hash.sha1" semantic conventions. It represents the certificate
fingerprint using the SHA1 digest of DER-encoded version of certificate
offered by the client. For consistency with other hash values, this value
should be formatted as an uppercase hash.
TLSClientHashSha256 returns an attribute KeyValue conforming to the
"tls.client.hash.sha256" semantic conventions. It represents the certificate
fingerprint using the SHA256 digest of DER-encoded version of certificate
offered by the client. For consistency with other hash values, this value
should be formatted as an uppercase hash.
TLSClientIssuer returns an attribute KeyValue conforming to the
"tls.client.issuer" semantic conventions. It represents the distinguished name
of [subject] of the issuer of the x.509 certificate presented by the client.
TLSClientJa3 returns an attribute KeyValue conforming to the "tls.client.ja3"
semantic conventions. It represents a hash that identifies clients based on
how they perform an SSL/TLS handshake.
TLSClientNotAfter returns an attribute KeyValue conforming to the
"tls.client.not_after" semantic conventions. It represents the date/Time
indicating when client certificate is no longer considered valid.
TLSClientNotBefore returns an attribute KeyValue conforming to the
"tls.client.not_before" semantic conventions. It represents the date/Time
indicating when client certificate is first considered valid.
TLSClientSubject returns an attribute KeyValue conforming to the
"tls.client.subject" semantic conventions. It represents the distinguished
name of subject of the x.509 certificate presented by the client.
TLSClientSupportedCiphers returns an attribute KeyValue conforming to the
"tls.client.supported_ciphers" semantic conventions. It represents the array
of ciphers offered by the client during the client hello.
TLSCurve returns an attribute KeyValue conforming to the "tls.curve" semantic
conventions. It represents the string indicating the curve used for the given
cipher, when applicable.
TLSEstablished returns an attribute KeyValue conforming to the
"tls.established" semantic conventions. It represents the boolean flag
indicating if the TLS negotiation was successful and transitioned to an
encrypted tunnel.
TLSNextProtocol returns an attribute KeyValue conforming to the
"tls.next_protocol" semantic conventions. It represents the string indicating
the protocol being tunneled. Per the values in the [IANA registry], this
string should be lower case.
TLSProtocolVersion returns an attribute KeyValue conforming to the
"tls.protocol.version" semantic conventions. It represents the numeric part of
the version parsed from the original string of the negotiated
[SSL/TLS protocol version].
TLSResumed returns an attribute KeyValue conforming to the "tls.resumed"
semantic conventions. It represents the boolean flag indicating if this TLS
connection was resumed from an existing TLS negotiation.
TLSServerCertificate returns an attribute KeyValue conforming to the
"tls.server.certificate" semantic conventions. It represents the PEM-encoded
stand-alone certificate offered by the server. This is usually
mutually-exclusive of `server.certificate_chain` since this value also exists
in that list.
TLSServerCertificateChain returns an attribute KeyValue conforming to the
"tls.server.certificate_chain" semantic conventions. It represents the array
of PEM-encoded certificates that make up the certificate chain offered by the
server. This is usually mutually-exclusive of `server.certificate` since that
value should be the first certificate in the chain.
TLSServerHashMd5 returns an attribute KeyValue conforming to the
"tls.server.hash.md5" semantic conventions. It represents the certificate
fingerprint using the MD5 digest of DER-encoded version of certificate offered
by the server. For consistency with other hash values, this value should be
formatted as an uppercase hash.
TLSServerHashSha1 returns an attribute KeyValue conforming to the
"tls.server.hash.sha1" semantic conventions. It represents the certificate
fingerprint using the SHA1 digest of DER-encoded version of certificate
offered by the server. For consistency with other hash values, this value
should be formatted as an uppercase hash.
TLSServerHashSha256 returns an attribute KeyValue conforming to the
"tls.server.hash.sha256" semantic conventions. It represents the certificate
fingerprint using the SHA256 digest of DER-encoded version of certificate
offered by the server. For consistency with other hash values, this value
should be formatted as an uppercase hash.
TLSServerIssuer returns an attribute KeyValue conforming to the
"tls.server.issuer" semantic conventions. It represents the distinguished name
of [subject] of the issuer of the x.509 certificate presented by the client.
TLSServerJa3s returns an attribute KeyValue conforming to the
"tls.server.ja3s" semantic conventions. It represents a hash that identifies
servers based on how they perform an SSL/TLS handshake.
TLSServerNotAfter returns an attribute KeyValue conforming to the
"tls.server.not_after" semantic conventions. It represents the date/Time
indicating when server certificate is no longer considered valid.
TLSServerNotBefore returns an attribute KeyValue conforming to the
"tls.server.not_before" semantic conventions. It represents the date/Time
indicating when server certificate is first considered valid.
TLSServerSubject returns an attribute KeyValue conforming to the
"tls.server.subject" semantic conventions. It represents the distinguished
name of subject of the x.509 certificate presented by the server.
URLDomain returns an attribute KeyValue conforming to the "url.domain"
semantic conventions. It represents the domain extracted from the `url.full`,
such as "opentelemetry.io".
URLExtension returns an attribute KeyValue conforming to the "url.extension"
semantic conventions. It represents the file extension extracted from the
`url.full`, excluding the leading dot.
URLFragment returns an attribute KeyValue conforming to the "url.fragment"
semantic conventions. It represents the [URI fragment] component.
URLFull returns an attribute KeyValue conforming to the "url.full" semantic
conventions. It represents the absolute URL describing a network resource
according to [RFC3986].
URLOriginal returns an attribute KeyValue conforming to the "url.original"
semantic conventions. It represents the unmodified original URL as seen in the
event source.
URLPath returns an attribute KeyValue conforming to the "url.path" semantic
conventions. It represents the [URI path] component.
URLPort returns an attribute KeyValue conforming to the "url.port" semantic
conventions. It represents the port extracted from the `url.full`.
URLQuery returns an attribute KeyValue conforming to the "url.query" semantic
conventions. It represents the [URI query] component.
URLRegisteredDomain returns an attribute KeyValue conforming to the
"url.registered_domain" semantic conventions. It represents the highest
registered url domain, stripped of the subdomain.
URLScheme returns an attribute KeyValue conforming to the "url.scheme"
semantic conventions. It represents the [URI scheme] component identifying the
used protocol.
URLSubdomain returns an attribute KeyValue conforming to the "url.subdomain"
semantic conventions. It represents the subdomain portion of a fully qualified
domain name includes all of the names except the host name under the
registered_domain. In a partially qualified domain, or if the qualification
level of the full name cannot be determined, subdomain contains all of the
names below the registered domain.
URLTemplate returns an attribute KeyValue conforming to the "url.template"
semantic conventions. It represents the low-cardinality template of an
[absolute path reference].
URLTopLevelDomain returns an attribute KeyValue conforming to the
"url.top_level_domain" semantic conventions. It represents the effective top
level domain (eTLD), also known as the domain suffix, is the last part of the
domain name. For example, the top level domain for example.com is `com`.
UserAgentName returns an attribute KeyValue conforming to the
"user_agent.name" semantic conventions. It represents the name of the
user-agent extracted from original. Usually refers to the browser's name.
UserAgentOriginal returns an attribute KeyValue conforming to the
"user_agent.original" semantic conventions. It represents the value of the
[HTTP User-Agent] header sent by the client.
UserAgentOSName returns an attribute KeyValue conforming to the
"user_agent.os.name" semantic conventions. It represents the human readable
operating system name.
UserAgentOSVersion returns an attribute KeyValue conforming to the
"user_agent.os.version" semantic conventions. It represents the version string
of the operating system as defined in [Version Attributes].
[Version Attributes]: /docs/resource/README.md#version-attributes
UserAgentVersion returns an attribute KeyValue conforming to the
"user_agent.version" semantic conventions. It represents the version of the
user-agent extracted from original. Usually refers to the browser's version.
UserEmail returns an attribute KeyValue conforming to the "user.email"
semantic conventions. It represents the user email address.
UserFullName returns an attribute KeyValue conforming to the "user.full_name"
semantic conventions. It represents the user's full name.
UserHash returns an attribute KeyValue conforming to the "user.hash" semantic
conventions. It represents the unique user hash to correlate information for a
user in anonymized form.
UserID returns an attribute KeyValue conforming to the "user.id" semantic
conventions. It represents the unique identifier of the user.
UserName returns an attribute KeyValue conforming to the "user.name" semantic
conventions. It represents the short name or login/username of the user.
UserRoles returns an attribute KeyValue conforming to the "user.roles"
semantic conventions. It represents the array of user roles at the time of the
event.
VCSChangeID returns an attribute KeyValue conforming to the "vcs.change.id"
semantic conventions. It represents the ID of the change (pull request/merge
request/changelist) if applicable. This is usually a unique (within
repository) identifier generated by the VCS system.
VCSChangeTitle returns an attribute KeyValue conforming to the
"vcs.change.title" semantic conventions. It represents the human readable
title of the change (pull request/merge request/changelist). This title is
often a brief summary of the change and may get merged in to a ref as the
commit summary.
VCSOwnerName returns an attribute KeyValue conforming to the "vcs.owner.name"
semantic conventions. It represents the group owner within the version control
system.
VCSRefBaseName returns an attribute KeyValue conforming to the
"vcs.ref.base.name" semantic conventions. It represents the name of the
[reference] such as **branch** or **tag** in the repository.
VCSRefBaseRevision returns an attribute KeyValue conforming to the
"vcs.ref.base.revision" semantic conventions. It represents the revision,
literally [revised version], The revision most often refers to a commit object
in Git, or a revision number in SVN.
VCSRefHeadName returns an attribute KeyValue conforming to the
"vcs.ref.head.name" semantic conventions. It represents the name of the
[reference] such as **branch** or **tag** in the repository.
VCSRefHeadRevision returns an attribute KeyValue conforming to the
"vcs.ref.head.revision" semantic conventions. It represents the revision,
literally [revised version], The revision most often refers to a commit object
in Git, or a revision number in SVN.
VCSRepositoryName returns an attribute KeyValue conforming to the
"vcs.repository.name" semantic conventions. It represents the human readable
name of the repository. It SHOULD NOT include any additional identifier like
Group/SubGroup in GitLab or organization in GitHub.
VCSRepositoryURLFull returns an attribute KeyValue conforming to the
"vcs.repository.url.full" semantic conventions. It represents the
[canonical URL] of the repository providing the complete HTTP(S) address in
order to locate and identify the repository through a browser.
WebEngineDescription returns an attribute KeyValue conforming to the
"webengine.description" semantic conventions. It represents the additional
description of the web engine (e.g. detailed version and edition information).
WebEngineName returns an attribute KeyValue conforming to the "webengine.name"
semantic conventions. It represents the name of the web engine.
WebEngineVersion returns an attribute KeyValue conforming to the
"webengine.version" semantic conventions. It represents the version of the web
engine.
ZOSSmfID returns an attribute KeyValue conforming to the "zos.smf.id" semantic
conventions. It represents the System Management Facility (SMF) Identifier
uniquely identified a z/OS system within a SYSPLEX or mainframe environment
and is used for system and performance analysis.
ZOSSysplexName returns an attribute KeyValue conforming to the
"zos.sysplex.name" semantic conventions. It represents the name of the SYSPLEX
to which the z/OS system belongs too.
Package-Level Variables (total 554)
Any time after Activity.onPause() or, if the app has no Activity,
Context.stopService() has been called when the app was in the foreground
state.
Stability: development
Any time before Activity.onResume() or, if the app has no Activity,
Context.startService() has been called in the app for the first time.
Stability: development
Any time after Activity.onResume() or, if the app has no Activity,
Context.startService() has been called when the app was in either the created
or background states.
Stability: development
Amazon EC2
Stability: development
Amazon Fargate
Stability: development
Direct connection.
Stability: development
Gateway (HTTP) connection.
Stability: development
Bounded Staleness
Stability: development
Consistent Prefix
Stability: development
Eventual
Stability: development
Session
Stability: development
Strong
Stability: development
All
Stability: development
Any
Stability: development
Each Quorum
Stability: development
Local One
Stability: development
Local Quorum
Stability: development
Local Serial
Stability: development
One
Stability: development
Quorum
Stability: development
Serial
Stability: development
Three
Stability: development
Two
Stability: development
The pipeline run is executing a build.
Stability: development
The pipeline run is executing.
Stability: development
The pipeline run is executing a sync.
Stability: development
The pipeline run was cancelled, eg. by a user manually cancelling the
pipeline run.
Stability: development
The pipeline run failed due to an error in the CICD system, eg. due to the
worker being killed.
Stability: development
The pipeline run did not finish successfully, eg. due to a compile error or a
failing test. Such failures are usually detected by non-zero exit codes of
the tools executed in the pipeline run.
Stability: development
The pipeline run was skipped, eg. due to a precondition not being met.
Stability: development
The pipeline run finished successfully.
Stability: development
A timeout caused the pipeline run to be interrupted.
Stability: development
The executing state spans the execution of any run tasks (eg. build, test).
Stability: development
The finalizing state spans from when the run has finished executing (eg.
cleanup of run resources).
Stability: development
The run pending state spans from the event triggering the pipeline run until
the execution of the run starts (eg. time spent in a queue, provisioning
agents, creating run resources).
Stability: development
The task run was cancelled, eg. by a user manually cancelling the task run.
Stability: development
The task run failed due to an error in the CICD system, eg. due to the worker
being killed.
Stability: development
The task run did not finish successfully, eg. due to a compile error or a
failing test. Such failures are usually detected by non-zero exit codes of
the tools executed in the task run.
Stability: development
The task run was skipped, eg. due to a precondition not being met.
Stability: development
The task run finished successfully.
Stability: development
A timeout caused the task run to be interrupted.
Stability: development
build
Stability: development
deploy
Stability: development
test
Stability: development
The worker is not performing work for the CICD system. It is available to the
CICD system to perform work on (online / idle).
Stability: development
The worker is performing work for the CICD system.
Stability: development
The worker is not available to the CICD system (disconnected / down).
Stability: development
Alibaba Cloud Elastic Compute Service
Stability: development
Alibaba Cloud Function Compute
Stability: development
Red Hat OpenShift on Alibaba Cloud
Stability: development
AWS App Runner
Stability: development
AWS Elastic Compute Cloud
Stability: development
AWS Elastic Container Service
Stability: development
AWS Elastic Kubernetes Service
Stability: development
AWS Elastic Beanstalk
Stability: development
AWS Lambda
Stability: development
Red Hat OpenShift on AWS (ROSA)
Stability: development
Azure Kubernetes Service
Stability: development
Azure App Service
Stability: development
Azure Container Apps
Stability: development
Azure Container Instances
Stability: development
Azure Functions
Stability: development
Azure Red Hat OpenShift
Stability: development
Azure Virtual Machines
Stability: development
Google Cloud App Engine (GAE)
Stability: development
Google Bare Metal Solution (BMS)
Stability: development
Google Cloud Functions (GCF)
Stability: development
Google Cloud Run
Stability: development
Google Cloud Compute Engine (GCE)
Stability: development
Google Cloud Kubernetes Engine (GKE)
Stability: development
Red Hat OpenShift on Google Cloud
Stability: development
Red Hat OpenShift on IBM Cloud
Stability: development
Compute on Oracle Cloud Infrastructure (OCI)
Stability: development
Kubernetes Engine (OKE) on Oracle Cloud Infrastructure (OCI)
Stability: development
Tencent Cloud Cloud Virtual Machine (CVM)
Stability: development
Tencent Cloud Elastic Kubernetes Service (EKS)
Stability: development
Tencent Cloud Serverless Cloud Function (SCF)
Stability: development
Alibaba Cloud
Stability: development
Amazon Web Services
Stability: development
Microsoft Azure
Stability: development
Google Cloud Platform
Stability: development
Heroku Platform as a Service
Stability: development
IBM Cloud
Stability: development
Oracle Cloud Infrastructure (OCI)
Stability: development
Tencent Cloud
Stability: development
Idle
Stability: development
Interrupt
Stability: development
IO Wait
Stability: development
Kernel
Stability: development
Nice
Stability: development
Steal
Stability: development
System
Stability: development
User
Stability: development
idle
Stability: development
used
Stability: development
[Actian Ingres]
Stability: development
[Amazon DynamoDB]
Stability: development
[Amazon Redshift]
Stability: development
[Azure Cosmos DB]
Stability: development
[Apache Cassandra]
Stability: development
[ClickHouse]
Stability: development
[CockroachDB]
Stability: development
[Couchbase]
Stability: development
[Apache CouchDB]
Stability: development
[Apache Derby]
Stability: development
[Elasticsearch]
Stability: development
[Firebird]
Stability: development
[Google Cloud Spanner]
Stability: development
[Apache Geode]
Stability: development
[H2 Database]
Stability: development
[Apache HBase]
Stability: development
[Apache Hive]
Stability: development
[HyperSQL Database]
Stability: development
[IBM Db2]
Stability: development
[IBM Informix]
Stability: development
[IBM Netezza]
Stability: development
[InfluxDB]
Stability: development
[Instant]
Stability: development
[InterSystems Caché]
Stability: development
[MariaDB]
Stability: stable
[Memcached]
Stability: development
[Microsoft SQL Server]
Stability: stable
[MongoDB]
Stability: development
[MySQL]
Stability: stable
[Neo4j]
Stability: development
[OpenSearch]
Stability: development
[Oracle Database]
Stability: development
Some other SQL database. Fallback only.
Stability: development
[PostgreSQL]
Stability: stable
[Redis]
Stability: development
[SAP HANA]
Stability: development
[SAP MaxDB]
Stability: development
[Adabas (Adaptable Database System)]
Stability: development
[SQLite]
Stability: development
[Teradata]
Stability: development
[Trino]
Stability: development
failed
Stability: development
succeeded
Stability: development
read
Stability: development
write
Stability: development
A fallback error value to be used when the instrumentation doesn't define a
custom value.
Stability: stable
When an object is deleted.
Stability: development
When an object is modified.
Stability: development
When a new object is created.
Stability: development
Alibaba Cloud
Stability: development
Amazon Web Services
Stability: development
Microsoft Azure
Stability: development
Google Cloud Platform
Stability: development
Tencent Cloud
Stability: development
A response to some data source operation such as a database or filesystem
read/write
Stability: development
To provide an answer to an inbound HTTP request
Stability: development
If none of the others apply
Stability: development
A function is set to be executed when messages are sent to a messaging system
Stability: development
A function is scheduled to be executed regularly
Stability: development
The resolved value was retrieved from cache.
Stability: release_candidate
The resolved value fell back to a pre-configured value (no dynamic evaluation
occurred or dynamic evaluation yielded no result).
Stability: release_candidate
The resolved value was the result of the flag being disabled in the
management system.
Stability: release_candidate
The resolved value was the result of an error.
Stability: release_candidate
The resolved value was the result of pseudorandom assignment.
Stability: release_candidate
The resolved value is non-authoritative or possibly out of date
Stability: release_candidate
The resolved value is static (no dynamic evaluation).
Stability: release_candidate
The resolved value was the result of a dynamic evaluation, such as a rule or
specific user-targeting.
Stability: release_candidate
The reason for the resolved value could not be determined.
Stability: release_candidate
High impact.
Stability: development
Low impact.
Stability: development
Medium impact.
Stability: development
Mission critical service.
Stability: development
Development environment.
Stability: development
Production environment.
Stability: development
Staging environment.
Stability: development
Test environment.
Stability: development
High impact.
Stability: development
Low impact.
Stability: development
Medium impact.
Stability: development
Mission critical service.
Stability: development
Development environment.
Stability: development
Production environment.
Stability: development
Staging environment.
Stability: development
Test environment.
Stability: development
Chat completion operation such as [OpenAI Chat API]
Stability: development
Create GenAI agent
Stability: development
Embeddings operation such as [OpenAI Create embeddings API]
Stability: development
Execute a tool
Stability: development
Multimodal content generation operation such as [Gemini Generate Content]
Stability: development
Invoke GenAI agent
Stability: development
Text completions operation such as [OpenAI Completions API (Legacy)]
Stability: development
Image
Stability: development
JSON object with known or unknown schema
Stability: development
Speech
Stability: development
Plain text
Stability: development
[Anthropic]
Stability: development
[AWS Bedrock]
Stability: development
Azure AI Inference
Stability: development
[Azure OpenAI]
Stability: development
[Cohere]
Stability: development
[DeepSeek]
Stability: development
[Gemini]
Stability: development
Any Google generative AI endpoint
Stability: development
[Vertex AI]
Stability: development
[Groq]
Stability: development
[IBM Watsonx AI]
Stability: development
[Mistral AI]
Stability: development
[OpenAI]
Stability: development
[Perplexity]
Stability: development
[xAI]
Stability: development
Input tokens (prompt, input, etc.)
Stability: development
Output tokens (completion, response, etc.)
Stability: development
Africa
Stability: development
Antarctica
Stability: development
Asia
Stability: development
Europe
Stability: development
North America
Stability: development
Oceania
Stability: development
South America
Stability: development
Memory used by the Go runtime, excluding other categories of memory usage
described in this enumeration.
Stability: development
Memory allocated from the heap that is reserved for stack space, whether or
not it is currently in-use.
Stability: development
GraphQL mutation
Stability: development
GraphQL query
Stability: development
GraphQL subscription
Stability: development
AMD64
Stability: development
ARM32
Stability: development
ARM64
Stability: development
Itanium
Stability: development
32-bit PowerPC
Stability: development
64-bit PowerPC
Stability: development
IBM z/Architecture
Stability: development
32-bit x86
Stability: development
active state.
Stability: development
idle state.
Stability: development
CONNECT method.
Stability: stable
DELETE method.
Stability: stable
GET method.
Stability: stable
HEAD method.
Stability: stable
OPTIONS method.
Stability: stable
Any HTTP method that the instrumentation has no prior knowledge of.
Stability: stable
PATCH method.
Stability: stable
POST method.
Stability: stable
PUT method.
Stability: stable
TRACE method.
Stability: stable
Charging
Stability: development
Discharging
Stability: development
Decoder
Stability: development
Encoder
Stability: development
General
Stability: development
Critical
Stability: development
Degraded
Stability: development
High Critical
Stability: development
High Degraded
Stability: development
Low Critical
Stability: development
Low Degraded
Stability: development
Maximum
Stability: development
Throttled
Stability: development
Turbo
Stability: development
Free
Stability: development
Used
Stability: development
Remaining
Stability: development
Degraded
Stability: development
Failed
Stability: development
Needs Cleaning
Stability: development
OK
Stability: development
Predicted Failure
Stability: development
Clean
Stability: development
Mount
Stability: development
Unmount
Stability: development
Battery
Stability: development
CPU
Stability: development
Disk controller
Stability: development
Enclosure
Stability: development
Fan
Stability: development
GPU
Stability: development
Logical disk
Stability: development
Memory
Stability: development
Network
Stability: development
Physical disk
Stability: development
Power supply
Stability: development
Tape drive
Stability: development
Temperature
Stability: development
Voltage
Stability: development
The app has become `active`. Associated with UIKit notification
`applicationDidBecomeActive`.
Stability: development
The app is now in the background. This value is associated with UIKit
notification `applicationDidEnterBackground`.
Stability: development
The app is now in the foreground. This value is associated with UIKit
notification `applicationWillEnterForeground`.
Stability: development
The app is now `inactive`. Associated with UIKit notification
`applicationWillResignActive`.
Stability: development
The app is about to terminate. Associated with UIKit notification
`applicationWillTerminate`.
Stability: development
The container has completed execution.
Stability: development
The container cannot run.
Stability: development
The container is being created.
Stability: development
The container is in a crash loop back off state.
Stability: development
There was an error creating the container configuration.
Stability: development
There was an error pulling the container image.
Stability: development
There was an error with the container.
Stability: development
The container image pull is in back off state.
Stability: development
The container was killed due to out of memory.
Stability: development
The container is running.
Stability: development
The container has terminated.
Stability: development
The container is waiting.
Stability: development
Active namespace phase as described by [K8s API]
Stability: development
Terminating namespace phase as described by [K8s API]
Stability: development
condition_false
Stability: development
condition_true
Stability: development
condition_unknown
Stability: development
Pressure exists on the disk size—that is, if the disk capacity is low
Stability: development
Pressure exists on the node memory—that is, if the node memory is low
Stability: development
Pressure exists on the processes—that is, if there are too many processes
on the node
Stability: development
The node is healthy and ready to accept pods
Stability: development
A [configMap] volume
Stability: development
A [downwardAPI] volume
Stability: development
An [emptyDir] volume
Stability: development
A [local] volume
Stability: development
A [persistentVolumeClaim] volume
Stability: development
A [secret] volume
Stability: development
reclaimable
Stability: development
unreclaimable
Stability: development
Events from stderr stream
Stability: development
Logs from stdout stream
Stability: development
A message is created. "Create" spans always refer to a single message and are
used to provide a unique creation context for messages in batch sending
scenarios.
Stability: development
One or more messages are processed by a consumer.
Stability: development
One or more messages are requested by a consumer. This operation refers to
pull-based scenarios, where consumers explicitly call methods of messaging
SDKs to receive messages.
Stability: development
One or more messages are provided for sending to an intermediary. If a single
message is sent, the context of the "Send" span can be used as the creation
context and no "Create" span needs to be created.
Stability: development
One or more messages are settled.
Stability: development
Broadcasting consumption model
Stability: development
Clustering consumption model
Stability: development
Delay message
Stability: development
FIFO message
Stability: development
Normal message
Stability: development
Transaction message
Stability: development
Message is abandoned
Stability: development
Message is completed
Stability: development
Message is sent to dead letter queue
Stability: development
Message is deferred
Stability: development
Apache ActiveMQ
Stability: development
Amazon Simple Notification Service (SNS)
Stability: development
Amazon Simple Queue Service (SQS)
Stability: development
Azure Event Grid
Stability: development
Azure Event Hubs
Stability: development
Google Cloud Pub/Sub
Stability: development
Java Message Service
Stability: development
Apache Kafka
Stability: development
Apache Pulsar
Stability: development
RabbitMQ
Stability: development
Apache RocketMQ
Stability: development
Azure Service Bus
Stability: development
closed
Stability: development
close_wait
Stability: development
closing
Stability: development
established
Stability: development
fin_wait_1
Stability: development
fin_wait_2
Stability: development
last_ack
Stability: development
listen
Stability: development
syn_received
Stability: development
syn_sent
Stability: development
time_wait
Stability: development
CDMA
Stability: development
CDMA2000 1XRTT
Stability: development
EDGE
Stability: development
EHRPD
Stability: development
EVDO Rel. 0
Stability: development
EVDO Rev. A
Stability: development
EVDO Rev. B
Stability: development
GPRS
Stability: development
GSM
Stability: development
HSDPA
Stability: development
HSPA
Stability: development
HSPAP
Stability: development
HSUPA
Stability: development
IDEN
Stability: development
IWLAN
Stability: development
LTE
Stability: development
LTE CA
Stability: development
5G NR (New Radio)
Stability: development
5G NRNSA (New Radio Non-Standalone)
Stability: development
TD-SCDMA
Stability: development
UMTS
Stability: development
cell
Stability: development
unknown
Stability: development
wifi
Stability: development
wired
Stability: development
receive
Stability: development
transmit
Stability: development
Named or anonymous pipe.
Stability: stable
QUIC
Stability: stable
TCP
Stability: stable
UDP
Stability: stable
Unix domain socket
Stability: stable
IPv4
Stability: stable
IPv6
Stability: stable
The system will utilize scale tier credits until they are exhausted.
Stability: development
The system will utilize the default scale tier.
Stability: development
The parent Span depends on the child Span in some capacity
Stability: development
The parent Span doesn't depend in any way on the result of the child Span
Stability: development
AIX (Advanced Interactive eXecutive)
Stability: development
Apple Darwin
Stability: development
DragonFly BSD
Stability: development
FreeBSD
Stability: development
HP-UX (Hewlett Packard Unix)
Stability: development
Linux
Stability: development
NetBSD
Stability: development
OpenBSD
Stability: development
SunOS, Oracle Solaris
Stability: development
Microsoft Windows
Stability: development
IBM z/OS
Stability: development
The builtin SDK batching log record processor
Stability: development
The builtin SDK batching span processor
Stability: development
OTLP log record exporter over gRPC with protobuf serialization
Stability: development
OTLP metric exporter over gRPC with protobuf serialization
Stability: development
OTLP span exporter over gRPC with protobuf serialization
Stability: development
OTLP log record exporter over HTTP with JSON serialization
Stability: development
OTLP metric exporter over HTTP with JSON serialization
Stability: development
OTLP span exporter over HTTP with JSON serialization
Stability: development
OTLP log record exporter over HTTP with protobuf serialization
Stability: development
OTLP metric exporter over HTTP with protobuf serialization
Stability: development
OTLP span exporter over HTTP with protobuf serialization
Stability: development
The builtin SDK periodically exporting metric reader
Stability: development
Prometheus metric exporter over HTTP with the default text-based format
Stability: development
The builtin SDK simple log record processor
Stability: development
The builtin SDK simple span processor
Stability: development
Zipkin span exporter over HTTP
Stability: development
The span has a parent and the parent's span context [isRemote()] is false
Stability: development
The span does not have a parent, it is a root span
Stability: development
The span has a parent and the parent's span context [isRemote()] is true
Stability: development
The span is not sampled and not recording
Stability: development
The span is sampled and recording
Stability: development
The span is not sampled, but recording
Stability: development
The operation contains an error.
Stability: stable
The operation has been validated by an Application developer or Operator to
have completed successfully.
Stability: stable
involuntary
Stability: development
voluntary
Stability: development
major
Stability: development
minor
Stability: development
[Erlang]
Stability: development
[Python]
Stability: development
[.NET]
Stability: development
[Go],
Stability: development
[JVM]
Stability: development
[Kernel]
Stability: development
Can be one of but not limited to [C], [C++], [Go] or [Rust]. If possible, a
more precise value MUST be used.
Stability: development
[Perl]
Stability: development
[PHP]
Stability: development
[Ruby]
Stability: development
[Rust]
Stability: development
[V8JS]
Stability: development
aborted
Stability: development
already_exists
Stability: development
cancelled
Stability: development
data_loss
Stability: development
deadline_exceeded
Stability: development
failed_precondition
Stability: development
internal
Stability: development
invalid_argument
Stability: development
not_found
Stability: development
out_of_range
Stability: development
permission_denied
Stability: development
resource_exhausted
Stability: development
unauthenticated
Stability: development
unimplemented
Stability: development
unknown
Stability: development
ABORTED
Stability: development
ALREADY_EXISTS
Stability: development
CANCELLED
Stability: development
DATA_LOSS
Stability: development
DEADLINE_EXCEEDED
Stability: development
FAILED_PRECONDITION
Stability: development
INTERNAL
Stability: development
INVALID_ARGUMENT
Stability: development
NOT_FOUND
Stability: development
OK
Stability: development
OUT_OF_RANGE
Stability: development
PERMISSION_DENIED
Stability: development
RESOURCE_EXHAUSTED
Stability: development
UNAUTHENTICATED
Stability: development
UNIMPLEMENTED
Stability: development
UNKNOWN
Stability: development
received
Stability: development
sent
Stability: development
Apache Dubbo
Stability: development
Connect RPC
Stability: development
.NET WCF
Stability: development
gRPC
Stability: development
Java RMI
Stability: development
The connection was closed because the app is shutting down.
Stability: stable
The connection was closed normally.
Stability: stable
The connection was closed due to a timeout.
Stability: stable
LongPolling protocol
Stability: stable
ServerSentEvents protocol
Stability: stable
WebSockets protocol
Stability: stable
free
Stability: development
reserved
Stability: development
used
Stability: development
exfat
Stability: development
ext4
Stability: development
fat32
Stability: development
hfsplus
Stability: development
ntfs
Stability: development
refs
Stability: development
buffers
Stability: development
cached
Stability: development
free
Stability: development
Actual used virtual memory in bytes.
Stability: development
in
Stability: development
out
Stability: development
free
Stability: development
used
Stability: development
major
Stability: development
minor
Stability: development
defunct
Stability: development
running
Stability: development
sleeping
Stability: development
stopped
Stability: development
cpp
Stability: stable
dotnet
Stability: stable
erlang
Stability: stable
go
Stability: stable
java
Stability: stable
nodejs
Stability: stable
php
Stability: stable
python
Stability: stable
ruby
Stability: stable
rust
Stability: stable
swift
Stability: stable
webjs
Stability: stable
fail
Stability: development
pass
Stability: development
aborted
Stability: development
failure
Stability: development
in_progress
Stability: development
skipped
Stability: development
success
Stability: development
timed_out
Stability: development
ssl
Stability: development
tls
Stability: development
Bot source.
Stability: development
Synthetic test source.
Stability: development
Closed means the merge request has been closed without merging. This can
happen for various reasons, such as the changes being deemed unnecessary, the
issue being resolved in another way, or the author deciding to withdraw the
request.
Stability: development
Merged indicates that the change has been successfully integrated into the
target codebase.
Stability: development
Open means the change is currently active and under review. It hasn't been
merged into the target branch yet, and it's still possible to make changes or
add comments.
Stability: development
WIP (work-in-progress, draft) means the change is still in progress and not
yet ready for a full review. It might still undergo significant changes.
Stability: development
How many lines were added.
Stability: development
How many lines were removed.
Stability: development
[Bitbucket]
Stability: development
[Gitea]
Stability: development
[GitHub]
Stability: development
[GitLab]
Stability: development
[branch]
Stability: development
[tag]
Stability: development
[branch]
Stability: development
[tag]
Stability: development
[branch]
Stability: development
[tag]
Stability: development
How many revisions the change is ahead of the target ref.
Stability: development
How many revisions the change is behind the target ref.
Stability: development
Package-Level Constants (total 628)
AndroidAppStateKey is the attribute Key conforming to the "android.app.state"
semantic conventions. It represents the this attribute represents the state
of the application.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "created"
Note: The Android lifecycle states are defined in
[Activity lifecycle callbacks], and from which the `OS identifiers` are
derived.
AndroidOSAPILevelKey is the attribute Key conforming to the
"android.os.api_level" semantic conventions. It represents the uniquely
identifies the framework API revision offered by a version (`os.version`) of
the android operating system. More information can be found in the
[Android API levels documentation].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "33", "32"
AppBuildIDKey is the attribute Key conforming to the "app.build_id" semantic
conventions. It represents the unique identifier for a particular build or
compilation of the application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "6cff0a7e-cefc-4668-96f5-1273d8b334d0",
"9f2b833506aa6973a92fde9733e6271f", "my-app-1.0.0-code-123"
AppInstallationIDKey is the attribute Key conforming to the
"app.installation.id" semantic conventions. It represents a unique identifier
representing the installation of an application on a specific device.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2ab2916d-a51f-4ac8-80ee-45ac31a28092"
Note: Its value SHOULD persist across launches of the same application
installation, including through application upgrades.
It SHOULD change if the application is uninstalled or if all applications of
the vendor are uninstalled.
Additionally, users might be able to reset this value (e.g. by clearing
application data).
If an app is installed multiple times on the same device (e.g. in different
accounts on Android), each `app.installation.id` SHOULD have a different
value.
If multiple OpenTelemetry SDKs are used within the same application, they
SHOULD use the same value for `app.installation.id`.
Hardware IDs (e.g. serial number, IMEI, MAC address) MUST NOT be used as the
`app.installation.id`.
For iOS, this value SHOULD be equal to the [vendor identifier].
For Android, examples of `app.installation.id` implementations include:
- [Firebase Installation ID].
- A globally unique UUID which is persisted across sessions in your
application.
- [App set ID].
- [`Settings.getString(Settings.Secure.ANDROID_ID)`].
More information about Android identifier best practices can be found in the
[Android user data IDs guide].
AppJankFrameCountKey is the attribute Key conforming to the
"app.jank.frame_count" semantic conventions. It represents a number of frame
renders that experienced jank.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 9, 42
Note: Depending on platform limitations, the value provided MAY be
approximation.
AppJankPeriodKey is the attribute Key conforming to the "app.jank.period"
semantic conventions. It represents the time period, in seconds, for which
this jank is being reported.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 1.0, 5.0, 10.24
AppJankThresholdKey is the attribute Key conforming to the
"app.jank.threshold" semantic conventions. It represents the minimum
rendering threshold for this jank, in seconds.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 0.016, 0.7, 1.024
AppScreenCoordinateXKey is the attribute Key conforming to the
"app.screen.coordinate.x" semantic conventions. It represents the x
(horizontal) coordinate of a screen coordinate, in screen pixels.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 0, 131
AppScreenCoordinateYKey is the attribute Key conforming to the
"app.screen.coordinate.y" semantic conventions. It represents the y
(vertical) component of a screen coordinate, in screen pixels.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 12, 99
AppWidgetIDKey is the attribute Key conforming to the "app.widget.id"
semantic conventions. It represents an identifier that uniquely
differentiates this widget from other widgets in the same application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "f9bc787d-ff05-48ad-90e1-fca1d46130b3", "submit_order_1829"
Note: A widget is an application component, typically an on-screen visual GUI
element.
AppWidgetNameKey is the attribute Key conforming to the "app.widget.name"
semantic conventions. It represents the name of an application widget.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "submit", "attack", "Clear Cart"
Note: A widget is an application component, typically an on-screen visual GUI
element.
ArtifactAttestationFilenameKey is the attribute Key conforming to the
"artifact.attestation.filename" semantic conventions. It represents the
provenance filename of the built attestation which directly relates to the
build artifact filename. This filename SHOULD accompany the artifact at
publish time. See the [SLSA Relationship] specification for more information.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "golang-binary-amd64-v0.1.0.attestation",
"docker-image-amd64-v0.1.0.intoto.json1", "release-1.tar.gz.attestation",
"file-name-package.tar.gz.intoto.json1"
ArtifactAttestationHashKey is the attribute Key conforming to the
"artifact.attestation.hash" semantic conventions. It represents the full
[hash value (see glossary)], of the built attestation. Some envelopes in the
[software attestation space] also refer to this as the **digest**.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1b31dfcd5b7f9267bf2ff47651df1cfb9147b9e4df1f335accf65b4cda498408"
ArtifactAttestationIDKey is the attribute Key conforming to the
"artifact.attestation.id" semantic conventions. It represents the id of the
build [software attestation].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "123"
ArtifactFilenameKey is the attribute Key conforming to the
"artifact.filename" semantic conventions. It represents the human readable
file name of the artifact, typically generated during build and release
processes. Often includes the package name and version in the file name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "golang-binary-amd64-v0.1.0", "docker-image-amd64-v0.1.0",
"release-1.tar.gz", "file-name-package.tar.gz"
Note: This file name can also act as the [Package Name]
in cases where the package ecosystem maps accordingly.
Additionally, the artifact [can be published]
for others, but that is not a guarantee.
ArtifactHashKey is the attribute Key conforming to the "artifact.hash"
semantic conventions. It represents the full [hash value (see glossary)],
often found in checksum.txt on a release of the artifact and used to verify
package integrity.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "9ff4c52759e2c4ac70b7d517bc7fcdc1cda631ca0045271ddd1b192544f8a3e9"
Note: The specific algorithm used to create the cryptographic hash value is
not defined. In situations where an artifact has multiple
cryptographic hashes, it is up to the implementer to choose which
hash value to set here; this should be the most secure hash algorithm
that is suitable for the situation and consistent with the
corresponding attestation. The implementer can then provide the other
hash values through an additional set of attribute extensions as they
deem necessary.
ArtifactPurlKey is the attribute Key conforming to the "artifact.purl"
semantic conventions. It represents the [Package URL] of the
[package artifact] provides a standard way to identify and locate the
packaged artifact.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "pkg:github/package-url/purl-spec@1209109710924",
"pkg:npm/foo@12.12.3"
ArtifactVersionKey is the attribute Key conforming to the "artifact.version"
semantic conventions. It represents the version of the artifact.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "v0.1.0", "1.2.1", "122691-build"
AWSBedrockGuardrailIDKey is the attribute Key conforming to the
"aws.bedrock.guardrail.id" semantic conventions. It represents the unique
identifier of the AWS Bedrock Guardrail. A [guardrail] helps safeguard and
prevent unwanted behavior from model responses or user messages.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "sgi5gkybzqak"
AWSBedrockKnowledgeBaseIDKey is the attribute Key conforming to the
"aws.bedrock.knowledge_base.id" semantic conventions. It represents the
unique identifier of the AWS Bedrock Knowledge base. A [knowledge base] is a
bank of information that can be queried by models to generate more relevant
responses and augment prompts.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "XFWUPB9PAW"
AWSDynamoDBAttributeDefinitionsKey is the attribute Key conforming to the
"aws.dynamodb.attribute_definitions" semantic conventions. It represents the
JSON-serialized value of each item in the `AttributeDefinitions` request
field.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "{ "AttributeName": "string", "AttributeType": "string" }"
AWSDynamoDBAttributesToGetKey is the attribute Key conforming to the
"aws.dynamodb.attributes_to_get" semantic conventions. It represents the
value of the `AttributesToGet` request parameter.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "lives", "id"
AWSDynamoDBConsistentReadKey is the attribute Key conforming to the
"aws.dynamodb.consistent_read" semantic conventions. It represents the value
of the `ConsistentRead` request parameter.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
AWSDynamoDBConsumedCapacityKey is the attribute Key conforming to the
"aws.dynamodb.consumed_capacity" semantic conventions. It represents the
JSON-serialized value of each item in the `ConsumedCapacity` response field.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "{ "CapacityUnits": number, "GlobalSecondaryIndexes": { "string" :
{ "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits":
number } }, "LocalSecondaryIndexes": { "string" : { "CapacityUnits": number,
"ReadCapacityUnits": number, "WriteCapacityUnits": number } },
"ReadCapacityUnits": number, "Table": { "CapacityUnits": number,
"ReadCapacityUnits": number, "WriteCapacityUnits": number }, "TableName":
"string", "WriteCapacityUnits": number }"
AWSDynamoDBCountKey is the attribute Key conforming to the
"aws.dynamodb.count" semantic conventions. It represents the value of the
`Count` response parameter.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 10
AWSDynamoDBExclusiveStartTableKey is the attribute Key conforming to the
"aws.dynamodb.exclusive_start_table" semantic conventions. It represents the
value of the `ExclusiveStartTableName` request parameter.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Users", "CatsTable"
AWSDynamoDBGlobalSecondaryIndexesKey is the attribute Key conforming to the
"aws.dynamodb.global_secondary_indexes" semantic conventions. It represents
the JSON-serialized value of each item of the `GlobalSecondaryIndexes`
request field.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "{ "IndexName": "string", "KeySchema": [ { "AttributeName":
"string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [
"string" ], "ProjectionType": "string" }, "ProvisionedThroughput": {
"ReadCapacityUnits": number, "WriteCapacityUnits": number } }"
AWSDynamoDBGlobalSecondaryIndexUpdatesKey is the attribute Key conforming to
the "aws.dynamodb.global_secondary_index_updates" semantic conventions. It
represents the JSON-serialized value of each item in the
`GlobalSecondaryIndexUpdates` request field.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "{ "Create": { "IndexName": "string", "KeySchema": [ {
"AttributeName": "string", "KeyType": "string" } ], "Projection": {
"NonKeyAttributes": [ "string" ], "ProjectionType": "string" },
"ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits":
number } }"
AWSDynamoDBIndexNameKey is the attribute Key conforming to the
"aws.dynamodb.index_name" semantic conventions. It represents the value of
the `IndexName` request parameter.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "name_to_group"
AWSDynamoDBItemCollectionMetricsKey is the attribute Key conforming to the
"aws.dynamodb.item_collection_metrics" semantic conventions. It represents
the JSON-serialized value of the `ItemCollectionMetrics` response field.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob,
"BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" :
"AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S":
"string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }"
AWSDynamoDBLimitKey is the attribute Key conforming to the
"aws.dynamodb.limit" semantic conventions. It represents the value of the
`Limit` request parameter.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 10
AWSDynamoDBLocalSecondaryIndexesKey is the attribute Key conforming to the
"aws.dynamodb.local_secondary_indexes" semantic conventions. It represents
the JSON-serialized value of each item of the `LocalSecondaryIndexes` request
field.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "{ "IndexArn": "string", "IndexName": "string", "IndexSizeBytes":
number, "ItemCount": number, "KeySchema": [ { "AttributeName": "string",
"KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ],
"ProjectionType": "string" } }"
AWSDynamoDBProjectionKey is the attribute Key conforming to the
"aws.dynamodb.projection" semantic conventions. It represents the value of
the `ProjectionExpression` request parameter.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Title", "Title, Price, Color", "Title, Description, RelatedItems,
ProductReviews"
AWSDynamoDBProvisionedReadCapacityKey is the attribute Key conforming to the
"aws.dynamodb.provisioned_read_capacity" semantic conventions. It represents
the value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 1.0, 2.0
AWSDynamoDBProvisionedWriteCapacityKey is the attribute Key conforming to the
"aws.dynamodb.provisioned_write_capacity" semantic conventions. It represents
the value of the `ProvisionedThroughput.WriteCapacityUnits` request
parameter.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 1.0, 2.0
AWSDynamoDBScanForwardKey is the attribute Key conforming to the
"aws.dynamodb.scan_forward" semantic conventions. It represents the value of
the `ScanIndexForward` request parameter.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
AWSDynamoDBScannedCountKey is the attribute Key conforming to the
"aws.dynamodb.scanned_count" semantic conventions. It represents the value of
the `ScannedCount` response parameter.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 50
AWSDynamoDBSegmentKey is the attribute Key conforming to the
"aws.dynamodb.segment" semantic conventions. It represents the value of the
`Segment` request parameter.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 10
AWSDynamoDBSelectKey is the attribute Key conforming to the
"aws.dynamodb.select" semantic conventions. It represents the value of the
`Select` request parameter.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "ALL_ATTRIBUTES", "COUNT"
AWSDynamoDBTableCountKey is the attribute Key conforming to the
"aws.dynamodb.table_count" semantic conventions. It represents the number of
items in the `TableNames` response parameter.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 20
AWSDynamoDBTableNamesKey is the attribute Key conforming to the
"aws.dynamodb.table_names" semantic conventions. It represents the keys in
the `RequestItems` object field.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "Users", "Cats"
AWSDynamoDBTotalSegmentsKey is the attribute Key conforming to the
"aws.dynamodb.total_segments" semantic conventions. It represents the value
of the `TotalSegments` request parameter.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 100
AWSECSClusterARNKey is the attribute Key conforming to the
"aws.ecs.cluster.arn" semantic conventions. It represents the ARN of an
[ECS cluster].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster"
AWSECSContainerARNKey is the attribute Key conforming to the
"aws.ecs.container.arn" semantic conventions. It represents the Amazon
Resource Name (ARN) of an [ECS container instance].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9"
AWSECSLaunchtypeKey is the attribute Key conforming to the
"aws.ecs.launchtype" semantic conventions. It represents the [launch type]
for an ECS task.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
AWSECSTaskARNKey is the attribute Key conforming to the "aws.ecs.task.arn"
semantic conventions. It represents the ARN of a running [ECS task].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b",
"arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd"
AWSECSTaskFamilyKey is the attribute Key conforming to the
"aws.ecs.task.family" semantic conventions. It represents the family name of
the [ECS task definition] used to create the ECS task.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry-family"
AWSECSTaskIDKey is the attribute Key conforming to the "aws.ecs.task.id"
semantic conventions. It represents the ID of a running ECS task. The ID MUST
be extracted from `task.arn`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "10838bed-421f-43ef-870a-f43feacbbb5b",
"23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd"
AWSECSTaskRevisionKey is the attribute Key conforming to the
"aws.ecs.task.revision" semantic conventions. It represents the revision for
the task definition used to create the ECS task.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "8", "26"
AWSEKSClusterARNKey is the attribute Key conforming to the
"aws.eks.cluster.arn" semantic conventions. It represents the ARN of an EKS
cluster.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster"
AWSExtendedRequestIDKey is the attribute Key conforming to the
"aws.extended_request_id" semantic conventions. It represents the AWS
extended request ID as returned in the response header `x-amz-id-2`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ="
AWSKinesisStreamNameKey is the attribute Key conforming to the
"aws.kinesis.stream_name" semantic conventions. It represents the name of the
AWS Kinesis [stream] the request refers to. Corresponds to the
`--stream-name` parameter of the Kinesis [describe-stream] operation.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "some-stream-name"
AWSLambdaInvokedARNKey is the attribute Key conforming to the
"aws.lambda.invoked_arn" semantic conventions. It represents 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).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:lambda:us-east-1:123456:function:myfunction:myalias"
Note: This may be different from `cloud.resource_id` if an alias is involved.
AWSLambdaResourceMappingIDKey is the attribute Key conforming to the
"aws.lambda.resource_mapping.id" semantic conventions. It represents the UUID
of the [AWS Lambda EvenSource Mapping]. An event source is mapped to a lambda
function. It's contents are read by Lambda and used to trigger a function.
This isn't available in the lambda execution context or the lambda runtime
environtment. This is going to be populated by the AWS SDK for each language
when that UUID is present. Some of these operations are
Create/Delete/Get/List/Update EventSourceMapping.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "587ad24b-03b9-4413-8202-bbd56b36e5b7"
AWSLogGroupARNsKey is the attribute Key conforming to the
"aws.log.group.arns" semantic conventions. It represents the Amazon Resource
Name(s) (ARN) of the AWS log group(s).
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"
Note: See the [log group ARN format documentation].
AWSLogGroupNamesKey is the attribute Key conforming to the
"aws.log.group.names" semantic conventions. It represents the name(s) of the
AWS log group(s) an application is writing to.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "/aws/lambda/my-function", "opentelemetry-service"
Note: Multiple log groups must be supported for cases like multi-container
applications, where a single application has sidecar containers, and each
write to their own log group.
AWSLogStreamARNsKey is the attribute Key conforming to the
"aws.log.stream.arns" semantic conventions. It represents the ARN(s) of the
AWS log stream(s).
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples:
"arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"
Note: See the [log stream ARN format documentation]. One log group can
contain several log streams, so these ARNs necessarily identify both a log
group and a log stream.
AWSLogStreamNamesKey is the attribute Key conforming to the
"aws.log.stream.names" semantic conventions. It represents the name(s) of the
AWS log stream(s) an application is writing to.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"
AWSRequestIDKey is the attribute Key conforming to the "aws.request_id"
semantic conventions. It represents the AWS request ID as returned in the
response headers `x-amzn-requestid`, `x-amzn-request-id` or
`x-amz-request-id`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "79b9da39-b7ae-508a-a6bc-864b2829c622", "C9ER4AJX75574TDJ"
AWSS3BucketKey is the attribute Key conforming to the "aws.s3.bucket"
semantic conventions. It represents the S3 bucket name the request refers to.
Corresponds to the `--bucket` parameter of the [S3 API] operations.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "some-bucket-name"
Note: The `bucket` attribute is applicable to all S3 operations that
reference a bucket, i.e. that require the bucket name as a mandatory
parameter.
This applies to almost all S3 operations except `list-buckets`.
AWSS3CopySourceKey is the attribute Key conforming to the
"aws.s3.copy_source" semantic conventions. It represents the source object
(in the form `bucket`/`key`) for the copy operation.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "someFile.yml"
Note: The `copy_source` attribute applies to S3 copy operations and
corresponds to the `--copy-source` parameter
of the [copy-object operation within the S3 API].
This applies in particular to the following operations:
- [copy-object]
- [upload-part-copy]
AWSS3DeleteKey is the attribute Key conforming to the "aws.s3.delete"
semantic conventions. It represents the delete request container that
specifies the objects to be deleted.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean"
Note: The `delete` attribute is only applicable to the [delete-object]
operation.
The `delete` attribute corresponds to the `--delete` parameter of the
[delete-objects operation within the S3 API].
AWSS3KeyKey is the attribute Key conforming to the "aws.s3.key" semantic
conventions. It represents the S3 object key the request refers to.
Corresponds to the `--key` parameter of the [S3 API] operations.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "someFile.yml"
Note: The `key` attribute is applicable to all object-related S3 operations,
i.e. that require the object key as a mandatory parameter.
This applies in particular to the following operations:
- [copy-object]
- [delete-object]
- [get-object]
- [head-object]
- [put-object]
- [restore-object]
- [select-object-content]
- [abort-multipart-upload]
- [complete-multipart-upload]
- [create-multipart-upload]
- [list-parts]
- [upload-part]
- [upload-part-copy]
AWSS3PartNumberKey is the attribute Key conforming to the
"aws.s3.part_number" semantic conventions. It represents the part number of
the part being uploaded in a multipart-upload operation. This is a positive
integer between 1 and 10,000.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 3456
Note: The `part_number` attribute is only applicable to the [upload-part]
and [upload-part-copy] operations.
The `part_number` attribute corresponds to the `--part-number` parameter of
the
[upload-part operation within the S3 API].
AWSS3UploadIDKey is the attribute Key conforming to the "aws.s3.upload_id"
semantic conventions. It represents the upload ID that identifies the
multipart upload.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ"
Note: The `upload_id` attribute applies to S3 multipart-upload operations and
corresponds to the `--upload-id` parameter
of the [S3 API] multipart operations.
This applies in particular to the following operations:
- [abort-multipart-upload]
- [complete-multipart-upload]
- [list-parts]
- [upload-part]
- [upload-part-copy]
AWSSecretsmanagerSecretARNKey is the attribute Key conforming to the
"aws.secretsmanager.secret.arn" semantic conventions. It represents the ARN
of the Secret stored in the Secrets Mangger.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters"
AWSSNSTopicARNKey is the attribute Key conforming to the "aws.sns.topic.arn"
semantic conventions. It represents the ARN of the AWS SNS Topic. An Amazon
SNS [topic] is a logical access point that acts as a communication channel.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE"
AWSSQSQueueURLKey is the attribute Key conforming to the "aws.sqs.queue.url"
semantic conventions. It represents the URL of the AWS SQS Queue. It's a
unique identifier for a queue in Amazon Simple Queue Service (SQS) and is
used to access the queue and perform actions on it.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue"
AWSStepFunctionsActivityARNKey is the attribute Key conforming to the
"aws.step_functions.activity.arn" semantic conventions. It represents the ARN
of the AWS Step Functions Activity.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:states:us-east-1:123456789012:activity:get-greeting"
AWSStepFunctionsStateMachineARNKey is the attribute Key conforming to the
"aws.step_functions.state_machine.arn" semantic conventions. It represents
the ARN of the AWS Step Functions State Machine.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1"
AzureClientIDKey is the attribute Key conforming to the "azure.client.id"
semantic conventions. It represents the unique identifier of the client
instance.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "3ba4827d-4422-483f-b59f-85b74211c11d", "storage-client-1"
AzureCosmosDBConnectionModeKey is the attribute Key conforming to the
"azure.cosmosdb.connection.mode" semantic conventions. It represents the
cosmos client connection mode.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
AzureCosmosDBConsistencyLevelKey is the attribute Key conforming to the
"azure.cosmosdb.consistency.level" semantic conventions. It represents the
account or request [consistency level].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "Eventual", "ConsistentPrefix", "BoundedStaleness", "Strong",
"Session"
AzureCosmosDBOperationContactedRegionsKey is the attribute Key conforming to
the "azure.cosmosdb.operation.contacted_regions" semantic conventions. It
represents the list of regions contacted during operation in the order that
they were contacted. If there is more than one region listed, it indicates
that the operation was performed on multiple regions i.e. cross-regional
call.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "North Central US", "Australia East", "Australia Southeast"
Note: Region name matches the format of `displayName` in [Azure Location API]
AzureCosmosDBOperationRequestChargeKey is the attribute Key conforming to the
"azure.cosmosdb.operation.request_charge" semantic conventions. It represents
the number of request units consumed by the operation.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 46.18, 1.0
AzureCosmosDBRequestBodySizeKey is the attribute Key conforming to the
"azure.cosmosdb.request.body.size" semantic conventions. It represents the
request payload size in bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples:
AzureCosmosDBResponseSubStatusCodeKey is the attribute Key conforming to the
"azure.cosmosdb.response.sub_status_code" semantic conventions. It represents
the cosmos DB sub status code.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1000, 1002
AzureResourceProviderNamespaceKey is the attribute Key conforming to the
"azure.resource_provider.namespace" semantic conventions. It represents the
[Azure Resource Provider Namespace] as recognized by the client.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Microsoft.Storage", "Microsoft.KeyVault", "Microsoft.ServiceBus"
AzureServiceRequestIDKey is the attribute Key conforming to the
"azure.service.request.id" semantic conventions. It represents the unique
identifier of the service request. It's generated by the Azure service and
returned with the response.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "00000000-0000-0000-0000-000000000000"
BrowserBrandsKey is the attribute Key conforming to the "browser.brands"
semantic conventions. It represents the array of brand name and version
separated by a space.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: " Not A;Brand 99", "Chromium 99", "Chrome 99"
Note: This value is intended to be taken from the [UA client hints API] (
`navigator.userAgentData.brands`).
BrowserLanguageKey is the attribute Key conforming to the "browser.language"
semantic conventions. It represents the preferred language of the user using
the browser.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "en", "en-US", "fr", "fr-FR"
Note: This value is intended to be taken from the Navigator API
`navigator.language`.
BrowserMobileKey is the attribute Key conforming to the "browser.mobile"
semantic conventions. It represents a boolean that is true if the browser is
running on a mobile device.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
Note: This value is intended to be taken from the [UA client hints API] (
`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be
left unset.
BrowserPlatformKey is the attribute Key conforming to the "browser.platform"
semantic conventions. It represents the platform on which the browser is
running.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Windows", "macOS", "Android"
Note: This value is intended to be taken from the [UA client hints API] (
`navigator.userAgentData.platform`). If unavailable, the legacy
`navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD
be left unset in order for the values to be consistent.
The list of possible values is defined in the
[W3C User-Agent Client Hints specification]. Note that some (but not all) of
these values can overlap with values in the
[`os.type` and `os.name` attributes]. However, for consistency, the values in
the `browser.platform` attribute should capture the exact value that the user
agent provides.
[`os.type` and `os.name` attributes]: ./os.md
CassandraConsistencyLevelKey is the attribute Key conforming to the
"cassandra.consistency.level" semantic conventions. It represents the
consistency level of the query. Based on consistency values from [CQL].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
CassandraCoordinatorDCKey is the attribute Key conforming to the
"cassandra.coordinator.dc" semantic conventions. It represents the data
center of the coordinating node for a query.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: us-west-2
CassandraCoordinatorIDKey is the attribute Key conforming to the
"cassandra.coordinator.id" semantic conventions. It represents the ID of the
coordinating node for a query.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: be13faa2-8574-4d71-926d-27f16cf8a7af
CassandraPageSizeKey is the attribute Key conforming to the
"cassandra.page.size" semantic conventions. It represents the fetch size used
for paging, i.e. how many rows will be returned at once.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 5000
CassandraQueryIdempotentKey is the attribute Key conforming to the
"cassandra.query.idempotent" semantic conventions. It represents the whether
or not the query is idempotent.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
CassandraSpeculativeExecutionCountKey is the attribute Key conforming to the
"cassandra.speculative_execution.count" semantic conventions. It represents
the number of times a query was speculatively executed. Not set or `0` if the
query was not executed speculatively.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 0, 2
CICDPipelineActionNameKey is the attribute Key conforming to the
"cicd.pipeline.action.name" semantic conventions. It represents the kind of
action a pipeline run is performing.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "BUILD", "RUN", "SYNC"
CICDPipelineNameKey is the attribute Key conforming to the
"cicd.pipeline.name" semantic conventions. It represents the human readable
name of the pipeline within a CI/CD system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Build and Test", "Lint", "Deploy Go Project",
"deploy_to_environment"
CICDPipelineResultKey is the attribute Key conforming to the
"cicd.pipeline.result" semantic conventions. It represents the result of a
pipeline run.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "success", "failure", "timeout", "skipped"
CICDPipelineRunIDKey is the attribute Key conforming to the
"cicd.pipeline.run.id" semantic conventions. It represents the unique
identifier of a pipeline run within a CI/CD system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "120912"
CICDPipelineRunStateKey is the attribute Key conforming to the
"cicd.pipeline.run.state" semantic conventions. It represents the pipeline
run goes through these states during its lifecycle.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "pending", "executing", "finalizing"
CICDPipelineRunURLFullKey is the attribute Key conforming to the
"cicd.pipeline.run.url.full" semantic conventions. It represents the [URL] of
the pipeline run, providing the complete address in order to locate and
identify the pipeline run.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075"
CICDPipelineTaskNameKey is the attribute Key conforming to the
"cicd.pipeline.task.name" semantic conventions. It represents the human
readable name of a task within a pipeline. Task here most closely aligns with
a [computing process] in a pipeline. Other terms for tasks include commands,
steps, and procedures.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Run GoLang Linter", "Go Build", "go-test", "deploy_binary"
CICDPipelineTaskRunIDKey is the attribute Key conforming to the
"cicd.pipeline.task.run.id" semantic conventions. It represents the unique
identifier of a task run within a pipeline.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "12097"
CICDPipelineTaskRunResultKey is the attribute Key conforming to the
"cicd.pipeline.task.run.result" semantic conventions. It represents the
result of a task run.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "success", "failure", "timeout", "skipped"
CICDPipelineTaskRunURLFullKey is the attribute Key conforming to the
"cicd.pipeline.task.run.url.full" semantic conventions. It represents the
[URL] of the pipeline task run, providing the complete address in order to
locate and identify the pipeline task run.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075"
CICDPipelineTaskTypeKey is the attribute Key conforming to the
"cicd.pipeline.task.type" semantic conventions. It represents the type of the
task within a pipeline.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "build", "test", "deploy"
CICDSystemComponentKey is the attribute Key conforming to the
"cicd.system.component" semantic conventions. It represents the name of a
component of the CICD system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "controller", "scheduler", "agent"
CICDWorkerIDKey is the attribute Key conforming to the "cicd.worker.id"
semantic conventions. It represents the unique identifier of a worker within
a CICD system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "abc123", "10.0.1.2", "controller"
CICDWorkerNameKey is the attribute Key conforming to the "cicd.worker.name"
semantic conventions. It represents the name of a worker within a CICD
system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "agent-abc", "controller", "Ubuntu LTS"
CICDWorkerStateKey is the attribute Key conforming to the "cicd.worker.state"
semantic conventions. It represents the state of a CICD worker / agent.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "idle", "busy", "down"
CICDWorkerURLFullKey is the attribute Key conforming to the
"cicd.worker.url.full" semantic conventions. It represents the [URL] of the
worker, providing the complete address in order to locate and identify the
worker.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "https://cicd.example.org/worker/abc123"
ClientAddressKey is the attribute Key conforming to the "client.address"
semantic conventions. It represents the client address - domain name if
available without reverse DNS lookup; otherwise, IP address or Unix domain
socket name.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "client.example.com", "10.1.2.80", "/tmp/my.sock"
Note: When observed from the server side, and when communicating through an
intermediary, `client.address` SHOULD represent the client address behind any
intermediaries, for example proxies, if it's available.
ClientPortKey is the attribute Key conforming to the "client.port" semantic
conventions. It represents the client port number.
Type: int
RequirementLevel: Recommended
Stability: Stable
Examples: 65123
Note: When observed from the server side, and when communicating through an
intermediary, `client.port` SHOULD represent the client port behind any
intermediaries, for example proxies, if it's available.
CloudAccountIDKey is the attribute Key conforming to the "cloud.account.id"
semantic conventions. It represents the cloud account ID the resource is
assigned to.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "111111111111", "opentelemetry"
CloudAvailabilityZoneKey is the attribute Key conforming to the
"cloud.availability_zone" semantic conventions. It represents the cloud
regions often have multiple, isolated locations known as zones to increase
availability. Availability zone represents the zone where the resource is
running.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "us-east-1c"
Note: Availability zones are called "zones" on Alibaba Cloud and Google
Cloud.
CloudEventsEventIDKey is the attribute Key conforming to the
"cloudevents.event_id" semantic conventions. It represents the [event_id]
uniquely identifies the event.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "123e4567-e89b-12d3-a456-426614174000", "0001"
CloudEventsEventSourceKey is the attribute Key conforming to the
"cloudevents.event_source" semantic conventions. It represents the [source]
identifies the context in which an event happened.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "https://github.com/cloudevents", "/cloudevents/spec/pull/123",
"my-service"
CloudEventsEventSpecVersionKey is the attribute Key conforming to the
"cloudevents.event_spec_version" semantic conventions. It represents the
[version of the CloudEvents specification] which the event uses.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 1.0
CloudEventsEventSubjectKey is the attribute Key conforming to the
"cloudevents.event_subject" semantic conventions. It represents the [subject]
of the event in the context of the event producer (identified by source).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: mynewfile.jpg
CloudEventsEventTypeKey is the attribute Key conforming to the
"cloudevents.event_type" semantic conventions. It represents the [event_type]
contains a value describing the type of event related to the originating
occurrence.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "com.github.pull_request.opened", "com.example.object.deleted.v2"
CloudFoundryAppIDKey is the attribute Key conforming to the
"cloudfoundry.app.id" semantic conventions. It represents the guid of the
application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "218fc5a9-a5f1-4b54-aa05-46717d0ab26d"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.application_id`. This is the same value as
reported by `cf app <app-name> --guid`.
CloudFoundryAppInstanceIDKey is the attribute Key conforming to the
"cloudfoundry.app.instance.id" semantic conventions. It represents the index
of the application instance. 0 when just one instance is active.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0", "1"
Note: CloudFoundry defines the `instance_id` in the [Loggregator v2 envelope]
.
It is used for logs and metrics emitted by CloudFoundry. It is
supposed to contain the application instance index for applications
deployed on the runtime.
Application instrumentation should use the value from environment
variable `CF_INSTANCE_INDEX`.
CloudFoundryAppNameKey is the attribute Key conforming to the
"cloudfoundry.app.name" semantic conventions. It represents the name of the
application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-app-name"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.application_name`. This is the same value
as reported by `cf apps`.
CloudFoundryOrgIDKey is the attribute Key conforming to the
"cloudfoundry.org.id" semantic conventions. It represents the guid of the
CloudFoundry org the application is running in.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "218fc5a9-a5f1-4b54-aa05-46717d0ab26d"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.org_id`. This is the same value as
reported by `cf org <org-name> --guid`.
CloudFoundryOrgNameKey is the attribute Key conforming to the
"cloudfoundry.org.name" semantic conventions. It represents the name of the
CloudFoundry organization the app is running in.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-org-name"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.org_name`. This is the same value as
reported by `cf orgs`.
CloudFoundryProcessIDKey is the attribute Key conforming to the
"cloudfoundry.process.id" semantic conventions. It represents the UID
identifying the process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "218fc5a9-a5f1-4b54-aa05-46717d0ab26d"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.process_id`. It is supposed to be equal to
`VCAP_APPLICATION.app_id` for applications deployed to the runtime.
For system components, this could be the actual PID.
CloudFoundryProcessTypeKey is the attribute Key conforming to the
"cloudfoundry.process.type" semantic conventions. It represents the type of
process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "web"
Note: CloudFoundry applications can consist of multiple jobs. Usually the
main process will be of type `web`. There can be additional background
tasks or side-cars with different process types.
CloudFoundrySpaceIDKey is the attribute Key conforming to the
"cloudfoundry.space.id" semantic conventions. It represents the guid of the
CloudFoundry space the application is running in.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "218fc5a9-a5f1-4b54-aa05-46717d0ab26d"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.space_id`. This is the same value as
reported by `cf space <space-name> --guid`.
CloudFoundrySpaceNameKey is the attribute Key conforming to the
"cloudfoundry.space.name" semantic conventions. It represents the name of the
CloudFoundry space the application is running in.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-space-name"
Note: Application instrumentation should use the value from environment
variable `VCAP_APPLICATION.space_name`. This is the same value as
reported by `cf spaces`.
CloudFoundrySystemIDKey is the attribute Key conforming to the
"cloudfoundry.system.id" semantic conventions. It represents a guid or
another name describing the event source.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "cf/gorouter"
Note: CloudFoundry defines the `source_id` in the [Loggregator v2 envelope].
It is used for logs and metrics emitted by CloudFoundry. It is
supposed to contain the component name, e.g. "gorouter", for
CloudFoundry components.
When system components are instrumented, values from the
[Bosh spec]
should be used. The `system.id` should be set to
`spec.deployment/spec.name`.
CloudFoundrySystemInstanceIDKey is the attribute Key conforming to the
"cloudfoundry.system.instance.id" semantic conventions. It represents a guid
describing the concrete instance of the event source.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "218fc5a9-a5f1-4b54-aa05-46717d0ab26d"
Note: CloudFoundry defines the `instance_id` in the [Loggregator v2 envelope]
.
It is used for logs and metrics emitted by CloudFoundry. It is
supposed to contain the vm id for CloudFoundry components.
When system components are instrumented, values from the
[Bosh spec]
should be used. The `system.instance.id` should be set to `spec.id`.
CloudPlatformKey is the attribute Key conforming to the "cloud.platform"
semantic conventions. It represents the cloud platform in use.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: The prefix of the service SHOULD match the one specified in
`cloud.provider`.
CloudProviderKey is the attribute Key conforming to the "cloud.provider"
semantic conventions. It represents the name of the cloud provider.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
CloudRegionKey is the attribute Key conforming to the "cloud.region" semantic
conventions. It represents the geographical region within a cloud provider.
When associated with a resource, this attribute specifies the region where
the resource operates. When calling services or APIs deployed on a cloud,
this attribute identifies the region where the called destination is
deployed.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "us-central1", "us-east-1"
Note: Refer to your provider's docs to see the available regions, for example
[Alibaba Cloud regions], [AWS regions], [Azure regions],
[Google Cloud regions], or [Tencent Cloud regions].
CloudResourceIDKey is the attribute Key conforming to the "cloud.resource_id"
semantic conventions. It represents the cloud provider-specific native
identifier of the monitored cloud resource (e.g. an [ARN] on AWS, a
[fully qualified resource ID] on Azure, a [full resource name] on GCP).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function",
"//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID",
"/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>
/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>"
Note: On some cloud providers, it may not be possible to determine the full
ID at startup,
so it may be necessary to set `cloud.resource_id` as a span attribute
instead.
The exact value to use for `cloud.resource_id` depends on the cloud provider.
The following well-known definitions MUST be used if you set this attribute
and they apply:
- **AWS Lambda:** The function [ARN].
Take care not to use the "invoked ARN" directly but replace any
[alias suffix]
with the resolved function version, as the same runtime instance may be
invocable with
multiple different aliases.
- **GCP:** The [URI of the resource]
- **Azure:** The [Fully Qualified Resource ID] of the invoked function,
*not* the function app, having the form
`/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`
.
This means that a span attribute MUST be used, as an Azure function app
can host multiple functions that would usually share
a TracerProvider.
CodeColumnNumberKey is the attribute Key conforming to the
"code.column.number" semantic conventions. It represents the column number in
`code.file.path` best representing the operation. It SHOULD point within the
code unit named in `code.function.name`. This attribute MUST NOT be used on
the Profile signal since the data is already captured in 'message Line'. This
constraint is imposed to prevent redundancy and maintain data integrity.
Type: int
RequirementLevel: Recommended
Stability: Stable
CodeFilePathKey is the attribute Key conforming to the "code.file.path"
semantic conventions. It represents the source code file name that identifies
the code unit as uniquely as possible (preferably an absolute file path).
This attribute MUST NOT be used on the Profile signal since the data is
already captured in 'message Function'. This constraint is imposed to prevent
redundancy and maintain data integrity.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: /usr/local/MyApplication/content_root/app/index.php
CodeFunctionNameKey is the attribute Key conforming to the
"code.function.name" semantic conventions. It represents the method or
function fully-qualified name without arguments. The value should fit the
natural representation of the language runtime, which is also likely the same
used within `code.stacktrace` attribute value. This attribute MUST NOT be
used on the Profile signal since the data is already captured in 'message
Function'. This constraint is imposed to prevent redundancy and maintain data
integrity.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "com.example.MyHttpService.serveRequest",
"GuzzleHttp\Client::transfer", "fopen"
Note: Values and format depends on each language runtime, thus it is
impossible to provide an exhaustive list of examples.
The values are usually the same (or prefixes of) the ones found in native
stack trace representation stored in
`code.stacktrace` without information on arguments.
Examples:
- Java method: `com.example.MyHttpService.serveRequest`
- Java anonymous class method: `com.mycompany.Main$1.myMethod`
- Java lambda method:
`com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod`
- PHP function: `GuzzleHttp\Client::transfer`
- Go function: `github.com/my/repo/pkg.foo.func5`
- Elixir: `OpenTelemetry.Ctx.new`
- Erlang: `opentelemetry_ctx:new`
- Rust: `playground::my_module::my_cool_func`
- C function: `fopen`
CodeLineNumberKey is the attribute Key conforming to the "code.line.number"
semantic conventions. It represents the line number in `code.file.path` best
representing the operation. It SHOULD point within the code unit named in
`code.function.name`. This attribute MUST NOT be used on the Profile signal
since the data is already captured in 'message Line'. This constraint is
imposed to prevent redundancy and maintain data integrity.
Type: int
RequirementLevel: Recommended
Stability: Stable
CodeStacktraceKey is the attribute Key conforming to the "code.stacktrace"
semantic conventions. It represents a stacktrace as a string in the natural
representation for the language runtime. The representation is identical to
[`exception.stacktrace`]. This attribute MUST NOT be used on the Profile
signal since the data is already captured in 'message Location'. This
constraint is imposed to prevent redundancy and maintain data integrity.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at
com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at
com.example.GenerateTrace.main(GenerateTrace.java:5)
[`exception.stacktrace`]: /docs/exceptions/exceptions-spans.md#stacktrace-representation
ContainerCommandArgsKey is the attribute Key conforming to the
"container.command_args" semantic conventions. It represents the all the
command arguments (including the command/executable itself) run by the
container.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "otelcontribcol", "--config", "config.yaml"
ContainerCommandKey is the attribute Key conforming to the
"container.command" semantic conventions. It represents the command used to
run the container (i.e. the command name).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "otelcontribcol"
Note: If using embedded credentials or sensitive data, it is recommended to
remove them to prevent potential leakage.
ContainerCommandLineKey is the attribute Key conforming to the
"container.command_line" semantic conventions. It represents the full command
run by the container as a single string representing the full command.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "otelcontribcol --config config.yaml"
ContainerCSIPluginNameKey is the attribute Key conforming to the
"container.csi.plugin.name" semantic conventions. It represents the name of
the CSI ([Container Storage Interface]) plugin used by the volume.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "pd.csi.storage.gke.io"
Note: This can sometimes be referred to as a "driver" in CSI implementations.
This should represent the `name` field of the GetPluginInfo RPC.
ContainerCSIVolumeIDKey is the attribute Key conforming to the
"container.csi.volume.id" semantic conventions. It represents the unique
volume ID returned by the CSI ([Container Storage Interface]) plugin.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk"
Note: This can sometimes be referred to as a "volume handle" in CSI
implementations. This should represent the `Volume.volume_id` field in CSI
spec.
ContainerIDKey is the attribute Key conforming to the "container.id" semantic
conventions. It represents the container ID. Usually a UUID, as for example
used to [identify Docker containers]. The UUID might be abbreviated.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "a3bf90e006b2"
ContainerImageIDKey is the attribute Key conforming to the
"container.image.id" semantic conventions. It represents the runtime specific
image identifier. Usually a hash algorithm followed by a UUID.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f"
Note: Docker defines a sha256 of the image id; `container.image.id`
corresponds to the `Image` field from the Docker container inspect [API]
endpoint.
K8s defines a link to the container registry repository with digest
`"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`
.
The ID is assigned by the container runtime and can vary in different
environments. Consider using `oci.manifest.digest` if it is important to
identify the same image in different environments/runtimes.
ContainerImageNameKey is the attribute Key conforming to the
"container.image.name" semantic conventions. It represents the name of the
image the container was built on.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "gcr.io/opentelemetry/operator"
ContainerImageRepoDigestsKey is the attribute Key conforming to the
"container.image.repo_digests" semantic conventions. It represents the repo
digests of the container image as provided by the container runtime.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples:
"example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
"internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
Note: [Docker] and [CRI] report those under the `RepoDigests` field.
ContainerImageTagsKey is the attribute Key conforming to the
"container.image.tags" semantic conventions. It represents the container
image tags. An example can be found in [Docker Image Inspect]. Should be only
the `<tag>` section of the full name for example from
`registry.example.com/my-org/my-image:<tag>`.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "v1.27.1", "3.5.7-0"
ContainerNameKey is the attribute Key conforming to the "container.name"
semantic conventions. It represents the container name used by container
runtime.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry-autoconf"
ContainerRuntimeDescriptionKey is the attribute Key conforming to the
"container.runtime.description" semantic conventions. It represents a
description about the runtime which could include, for example details about
the CRI/API version being used or other customisations.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "docker://19.3.1 - CRI: 1.22.0"
ContainerRuntimeNameKey is the attribute Key conforming to the
"container.runtime.name" semantic conventions. It represents the container
runtime managing this container.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "docker", "containerd", "rkt"
ContainerRuntimeVersionKey is the attribute Key conforming to the
"container.runtime.version" semantic conventions. It represents the version
of the runtime of this process, as returned by the runtime without
modification.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 1.0.0
CPULogicalNumberKey is the attribute Key conforming to the
"cpu.logical_number" semantic conventions. It represents the logical CPU
number [0..n-1].
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1
CPUModeKey is the attribute Key conforming to the "cpu.mode" semantic
conventions. It represents the mode of the CPU.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "user", "system"
DBClientConnectionPoolNameKey is the attribute Key conforming to the
"db.client.connection.pool.name" semantic conventions. It represents the name
of the connection pool; unique within the instrumented application. In case
the connection pool implementation doesn't provide a name, instrumentation
SHOULD use a combination of parameters that would make the name unique, for
example, combining attributes `server.address`, `server.port`, and
`db.namespace`, formatted as `server.address:server.port/db.namespace`.
Instrumentations that generate connection pool name following different
patterns SHOULD document it.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "myDataSource"
DBClientConnectionStateKey is the attribute Key conforming to the
"db.client.connection.state" semantic conventions. It represents the state of
a connection in the pool.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "idle"
DBCollectionNameKey is the attribute Key conforming to the
"db.collection.name" semantic conventions. It represents the name of a
collection (table, container) within the database.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "public.users", "customers"
Note: It is RECOMMENDED to capture the value as provided by the application
without attempting to do any case normalization.
The collection name SHOULD NOT be extracted from `db.query.text`,
when the database system supports query text with multiple collections
in non-batch operations.
For batch operations, if the individual operations are known to have the same
collection name then that collection name SHOULD be used.
DBNamespaceKey is the attribute Key conforming to the "db.namespace" semantic
conventions. It represents the name of the database, fully qualified within
the server address and port.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "customers", "test.users"
Note: If a database system has multiple namespace components, they SHOULD be
concatenated from the most general to the most specific namespace component,
using `|` as a separator between the components. Any missing components (and
their associated separators) SHOULD be omitted.
Semantic conventions for individual database systems SHOULD document what
`db.namespace` means in the context of that system.
It is RECOMMENDED to capture the value as provided by the application without
attempting to do any case normalization.
DBOperationBatchSizeKey is the attribute Key conforming to the
"db.operation.batch.size" semantic conventions. It represents the number of
queries included in a batch operation.
Type: int
RequirementLevel: Recommended
Stability: Stable
Examples: 2, 3, 4
Note: Operations are only considered batches when they contain two or more
operations, and so `db.operation.batch.size` SHOULD never be `1`.
DBOperationNameKey is the attribute Key conforming to the "db.operation.name"
semantic conventions. It represents the name of the operation or command
being executed.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "findAndModify", "HMSET", "SELECT"
Note: It is RECOMMENDED to capture the value as provided by the application
without attempting to do any case normalization.
The operation name SHOULD NOT be extracted from `db.query.text`,
when the database system supports query text with multiple operations
in non-batch operations.
If spaces can occur in the operation name, multiple consecutive spaces
SHOULD be normalized to a single space.
For batch operations, if the individual operations are known to have the same
operation name
then that operation name SHOULD be used prepended by `BATCH `,
otherwise `db.operation.name` SHOULD be `BATCH` or some other database
system specific term if more applicable.
DBQuerySummaryKey is the attribute Key conforming to the "db.query.summary"
semantic conventions. It represents the low cardinality summary of a database
query.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "SELECT wuser_table", "INSERT shipping_details SELECT orders", "get
user by id"
Note: The query summary describes a class of database queries and is useful
as a grouping key, especially when analyzing telemetry for database
calls involving complex queries.
Summary may be available to the instrumentation through
instrumentation hooks or other means. If it is not available,
instrumentations
that support query parsing SHOULD generate a summary following
[Generating query summary]
section.
[Generating query summary]: /docs/database/database-spans.md#generating-a-summary-of-the-query
DBQueryTextKey is the attribute Key conforming to the "db.query.text"
semantic conventions. It represents the database query being executed.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "SELECT * FROM wuser_table where username = ?", "SET mykey ?"
Note: For sanitization see [Sanitization of `db.query.text`].
For batch operations, if the individual operations are known to have the same
query text then that query text SHOULD be used, otherwise all of the
individual query texts SHOULD be concatenated with separator `; ` or some
other database system specific separator if more applicable.
Parameterized query text SHOULD NOT be sanitized. Even though parameterized
query text can potentially have sensitive data, by using a parameterized
query the user is giving a strong signal that any sensitive data will be
passed as parameter values, and the benefit to observability of capturing the
static part of the query text by default outweighs the risk.
[Sanitization of `db.query.text`]: /docs/database/database-spans.md#sanitization-of-dbquerytext
DBResponseReturnedRowsKey is the attribute Key conforming to the
"db.response.returned_rows" semantic conventions. It represents the number of
rows returned by the operation.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 10, 30, 1000
DBResponseStatusCodeKey is the attribute Key conforming to the
"db.response.status_code" semantic conventions. It represents the database
response status code.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "102", "ORA-17002", "08P01", "404"
Note: The status code returned by the database. Usually it represents an
error code, but may also represent partial success, warning, or differentiate
between various types of successful outcomes.
Semantic conventions for individual database systems SHOULD document what
`db.response.status_code` means in the context of that system.
DBStoredProcedureNameKey is the attribute Key conforming to the
"db.stored_procedure.name" semantic conventions. It represents the name of a
stored procedure within the database.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "GetCustomer"
Note: It is RECOMMENDED to capture the value as provided by the application
without attempting to do any case normalization.
For batch operations, if the individual operations are known to have the same
stored procedure name then that stored procedure name SHOULD be used.
DBSystemNameKey is the attribute Key conforming to the "db.system.name"
semantic conventions. It represents the database management system (DBMS)
product as identified by the client instrumentation.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples:
Note: The actual DBMS may differ from the one identified by the client. For
example, when using PostgreSQL client libraries to connect to a CockroachDB,
the `db.system.name` is set to `postgresql` based on the instrumentation's
best knowledge.
DeploymentEnvironmentNameKey is the attribute Key conforming to the
"deployment.environment.name" semantic conventions. It represents the name of
the [deployment environment] (aka deployment tier).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "staging", "production"
Note: `deployment.environment.name` does not affect the uniqueness
constraints defined through
the `service.namespace`, `service.name` and `service.instance.id` resource
attributes.
This implies that resources carrying the following attribute combinations
MUST be
considered to be identifying the same service:
- `service.name=frontend`, `deployment.environment.name=production`
- `service.name=frontend`, `deployment.environment.name=staging`.
DeploymentIDKey is the attribute Key conforming to the "deployment.id"
semantic conventions. It represents the id of the deployment.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1208"
DeploymentNameKey is the attribute Key conforming to the "deployment.name"
semantic conventions. It represents the name of the deployment.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "deploy my app", "deploy-frontend"
DeploymentStatusKey is the attribute Key conforming to the
"deployment.status" semantic conventions. It represents the status of the
deployment.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
DestinationAddressKey is the attribute Key conforming to the
"destination.address" semantic conventions. It represents the destination
address - domain name if available without reverse DNS lookup; otherwise, IP
address or Unix domain socket name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "destination.example.com", "10.1.2.80", "/tmp/my.sock"
Note: When observed from the source side, and when communicating through an
intermediary, `destination.address` SHOULD represent the destination address
behind any intermediaries, for example proxies, if it's available.
DestinationPortKey is the attribute Key conforming to the "destination.port"
semantic conventions. It represents the destination port number.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 3389, 2888
DeviceIDKey is the attribute Key conforming to the "device.id" semantic
conventions. It represents a unique identifier representing the device.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "123456789012345", "01:23:45:67:89:AB"
Note: Its value SHOULD be identical for all apps on a device and it SHOULD
NOT change if an app is uninstalled and re-installed.
However, it might be resettable by the user for all apps on a device.
Hardware IDs (e.g. vendor-specific serial number, IMEI or MAC address) MAY be
used as values.
More information about Android identifier best practices can be found in the
[Android user data IDs guide].
> [!WARNING]> This attribute may contain sensitive (PII) information. Caution
> should be taken when storing personal data or anything which can identify a
> user. GDPR and data protection laws may apply,
> ensure you do your own due diligence.> Due to these reasons, this
> identifier is not recommended for consumer applications and will likely
> result in rejection from both Google Play and App Store.
> However, it may be appropriate for specific enterprise scenarios, such as
> kiosk devices or enterprise-managed devices, with appropriate compliance
> clearance.
> Any instrumentation providing this identifier MUST implement it as an
> opt-in feature.> See [`app.installation.id`]> for a more
> privacy-preserving alternative.
[`app.installation.id`]: /docs/registry/attributes/app.md#app-installation-id
DeviceManufacturerKey is the attribute Key conforming to the
"device.manufacturer" semantic conventions. It represents the name of the
device manufacturer.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Apple", "Samsung"
Note: The Android OS provides this field via [Build]. iOS apps SHOULD
hardcode the value `Apple`.
DeviceModelIdentifierKey is the attribute Key conforming to the
"device.model.identifier" semantic conventions. It represents the model
identifier for the device.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "iPhone3,4", "SM-G920F"
Note: It's recommended this value represents a machine-readable version of
the model identifier rather than the market or consumer-friendly name of the
device.
DeviceModelNameKey is the attribute Key conforming to the "device.model.name"
semantic conventions. It represents the marketing name for the device model.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "iPhone 6s Plus", "Samsung Galaxy S6"
Note: It's recommended this value represents a human-readable version of the
device model rather than a machine-readable alternative.
DiskIODirectionKey is the attribute Key conforming to the "disk.io.direction"
semantic conventions. It represents the disk IO operation direction.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "read"
DNSAnswersKey is the attribute Key conforming to the "dns.answers" semantic
conventions. It represents the list of IPv4 or IPv6 addresses resolved during
DNS lookup.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "10.0.0.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
DNSQuestionNameKey is the attribute Key conforming to the "dns.question.name"
semantic conventions. It represents the name being queried.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "www.example.com", "opentelemetry.io"
Note: If the name field contains non-printable characters (below 32 or above
126), those characters should be represented as escaped base 10 integers
(\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns,
and line feeds should be converted to \t, \r, and \n respectively.
ElasticsearchNodeNameKey is the attribute Key conforming to the
"elasticsearch.node.name" semantic conventions. It represents the represents
the human-readable identifier of the node/instance to which a request was
routed.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "instance-0000000001"
EnduserIDKey is the attribute Key conforming to the "enduser.id" semantic
conventions. It represents the unique identifier of an end user in the
system. It maybe a username, email address, or other identifier.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "username"
Note: Unique identifier of an end user in the system.
> [!Warning]
> This field contains sensitive (PII) information.
EnduserPseudoIDKey is the attribute Key conforming to the "enduser.pseudo.id"
semantic conventions. It represents the pseudonymous identifier of an end
user. This identifier should be a random value that is not directly linked or
associated with the end user's actual identity.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "QdH5CAWJgqVT4rOr0qtumf"
Note: Pseudonymous identifier of an end user.
> [!Warning]
> This field contains sensitive (linkable PII) information.
ErrorMessageKey is the attribute Key conforming to the "error.message"
semantic conventions. It represents a message providing more detail about an
error in human-readable form.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Unexpected input type: string", "The user has exceeded their
storage quota"
Note: `error.message` should provide additional context and detail about an
error.
It is NOT RECOMMENDED to duplicate the value of `error.type` in
`error.message`.
It is also NOT RECOMMENDED to duplicate the value of `exception.message` in
`error.message`.
`error.message` is NOT RECOMMENDED for metrics or spans due to its unbounded
cardinality and overlap with span status.
ErrorTypeKey is the attribute Key conforming to the "error.type" semantic
conventions. It represents the describes a class of error the operation ended
with.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples: "timeout", "java.net.UnknownHostException",
"server_certificate_invalid", "500"
Note: The `error.type` SHOULD be predictable, and SHOULD have low
cardinality.
When `error.type` is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
Instrumentations SHOULD document the list of errors they report.
The cardinality of `error.type` within one instrumentation library SHOULD be
low.
Telemetry consumers that aggregate data from multiple instrumentation
libraries and applications
should be prepared for `error.type` to have high cardinality at query time
when no
additional filters are applied.
If the operation has completed successfully, instrumentations SHOULD NOT set
`error.type`.
If a specific domain defines its own set of error identifiers (such as HTTP
or gRPC status codes),
it's RECOMMENDED to:
- Use a domain-specific attribute
- Set `error.type` to capture all errors, regardless of whether they are
defined within the domain-specific set or not.
ExceptionEventName is the name of the Span event representing an exception.
ExceptionMessageKey is the attribute Key conforming to the
"exception.message" semantic conventions. It represents the exception
message.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "Division by zero", "Can't convert 'int' object to str implicitly"
ExceptionStacktraceKey is the attribute Key conforming to the
"exception.stacktrace" semantic conventions. It represents 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.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: Exception in thread "main" java.lang.RuntimeException: Test
exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at
com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at
com.example.GenerateTrace.main(GenerateTrace.java:5)
ExceptionTypeKey is the attribute Key conforming to the "exception.type"
semantic conventions. It represents 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.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "java.net.ConnectException", "OSError"
FaaSColdstartKey is the attribute Key conforming to the "faas.coldstart"
semantic conventions. It represents a boolean that is true if the serverless
function is executed for the first time (aka cold-start).
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
FaaSCronKey is the attribute Key conforming to the "faas.cron" semantic
conventions. It represents a string containing the schedule period as
[Cron Expression].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 0/5 * * * ? *
FaaSDocumentCollectionKey is the attribute Key conforming to the
"faas.document.collection" semantic conventions. It represents 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.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "myBucketName", "myDbName"
FaaSDocumentNameKey is the attribute Key conforming to the
"faas.document.name" semantic conventions. It represents 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.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "myFile.txt", "myTableName"
FaaSDocumentOperationKey is the attribute Key conforming to the
"faas.document.operation" semantic conventions. It represents the describes
the type of the operation that was performed on the data.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
FaaSDocumentTimeKey is the attribute Key conforming to the
"faas.document.time" semantic conventions. It represents a string containing
the time when the data was accessed in the [ISO 8601] format expressed in
[UTC].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 2020-01-23T13:47:06Z
FaaSInstanceKey is the attribute Key conforming to the "faas.instance"
semantic conventions. It represents the execution environment ID as a string,
that will be potentially reused for other invocations to the same
function/function version.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de"
Note: - **AWS Lambda:** Use the (full) log stream name.
FaaSInvocationIDKey is the attribute Key conforming to the
"faas.invocation_id" semantic conventions. It represents the invocation ID of
the current function invocation.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: af9d5aa4-a685-4c5f-a22b-444f80b3cc28
FaaSInvokedNameKey is the attribute Key conforming to the "faas.invoked_name"
semantic conventions. It represents the name of the invoked function.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: my-function
Note: SHOULD be equal to the `faas.name` resource attribute of the invoked
function.
FaaSInvokedProviderKey is the attribute Key conforming to the
"faas.invoked_provider" semantic conventions. It represents the cloud
provider of the invoked function.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: SHOULD be equal to the `cloud.provider` resource attribute of the
invoked function.
FaaSInvokedRegionKey is the attribute Key conforming to the
"faas.invoked_region" semantic conventions. It represents the cloud region of
the invoked function.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: eu-central-1
Note: SHOULD be equal to the `cloud.region` resource attribute of the invoked
function.
FaaSMaxMemoryKey is the attribute Key conforming to the "faas.max_memory"
semantic conventions. It represents the amount of memory available to the
serverless function converted to Bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Note: It's recommended to set this attribute since e.g. too little memory can
easily stop a Java AWS Lambda function from working correctly. On AWS Lambda,
the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` provides this
information (which must be multiplied by 1,048,576).
FaaSNameKey is the attribute Key conforming to the "faas.name" semantic
conventions. It represents the name of the single function that this runtime
instance executes.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-function", "myazurefunctionapp/some-function-name"
Note: This is the name of the function as configured/deployed on the FaaS
platform and is usually different from the name of the callback
function (which may be stored in the
[`code.namespace`/`code.function.name`]
span attributes).
For some cloud providers, the above definition is ambiguous. The following
definition of function name MUST be used for this attribute
(and consequently the span name) for the listed cloud providers/products:
- **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
followed by a forward slash followed by the function name (this form
can also be seen in the resource JSON for the function).
This means that a span attribute MUST be used, as an Azure function
app can host multiple functions that would usually share
a TracerProvider (see also the `cloud.resource_id` attribute).
[`code.namespace`/`code.function.name`]: /docs/general/attributes.md#source-code-attributes
FaaSTimeKey is the attribute Key conforming to the "faas.time" semantic
conventions. It represents a string containing the function invocation time
in the [ISO 8601] format expressed in [UTC].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 2020-01-23T13:47:06Z
FaaSTriggerKey is the attribute Key conforming to the "faas.trigger" semantic
conventions. It represents the type of the trigger which caused this function
invocation.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
FaaSVersionKey is the attribute Key conforming to the "faas.version" semantic
conventions. It represents the immutable version of the function being
executed.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "26", "pinkfroid-00002"
Note: Depending on the cloud provider and platform, use:
- **AWS Lambda:** The [function version]
(an integer represented as a decimal string).
- **Google Cloud Run (Services):** The [revision]
(i.e., the function name plus the revision suffix).
- **Google Cloud Functions:** The value of the
[`K_REVISION` environment variable].
- **Azure Functions:** Not applicable. Do not set this attribute.
FeatureFlagContextIDKey is the attribute Key conforming to the
"feature_flag.context.id" semantic conventions. It represents the unique
identifier for the flag evaluation context. For example, the targeting key.
Type: string
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "5157782b-2203-4c80-a857-dbbd5e7761db"
FeatureFlagKeyKey is the attribute Key conforming to the "feature_flag.key"
semantic conventions. It represents the lookup key of the feature flag.
Type: string
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "logo-color"
FeatureFlagProviderNameKey is the attribute Key conforming to the
"feature_flag.provider.name" semantic conventions. It represents the
identifies the feature flag provider.
Type: string
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "Flag Manager"
FeatureFlagResultReasonKey is the attribute Key conforming to the
"feature_flag.result.reason" semantic conventions. It represents the reason
code which shows how a feature flag value was determined.
Type: Enum
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "static", "targeting_match", "error", "default"
FeatureFlagResultValueKey is the attribute Key conforming to the
"feature_flag.result.value" semantic conventions. It represents the evaluated
value of the feature flag.
Type: any
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "#ff0000", true, 3
Note: With some feature flag providers, feature flag results can be quite
large or contain private or sensitive details.
Because of this, `feature_flag.result.variant` is often the preferred
attribute if it is available.
It may be desirable to redact or otherwise limit the size and scope of
`feature_flag.result.value` if possible.
Because the evaluated flag value is unstructured and may be any type, it is
left to the instrumentation author to determine how best to achieve this.
FeatureFlagResultVariantKey is the attribute Key conforming to the
"feature_flag.result.variant" semantic conventions. It represents a semantic
identifier for an evaluated flag value.
Type: string
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "red", "true", "on"
Note: 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`.
FeatureFlagSetIDKey is the attribute Key conforming to the
"feature_flag.set.id" semantic conventions. It represents the identifier of
the [flag set] to which the feature flag belongs.
Type: string
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "proj-1", "ab98sgs", "service1/dev"
FeatureFlagVersionKey is the attribute Key conforming to the
"feature_flag.version" semantic conventions. It represents the version of the
ruleset used during the evaluation. This may be any stable value which
uniquely identifies the ruleset.
Type: string
RequirementLevel: Recommended
Stability: Release_Candidate
Examples: "1", "01ABCDEF"
FileAccessedKey is the attribute Key conforming to the "file.accessed"
semantic conventions. It represents the time when the file was last accessed,
in ISO 8601 format.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021-01-01T12:00:00Z"
Note: This attribute might not be supported by some file systems — NFS,
FAT32, in embedded OS, etc.
FileAttributesKey is the attribute Key conforming to the "file.attributes"
semantic conventions. It represents the array of file attributes.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "readonly", "hidden"
Note: Attributes names depend on the OS or file system. Here’s a
non-exhaustive list of values expected for this attribute: `archive`,
`compressed`, `directory`, `encrypted`, `execute`, `hidden`, `immutable`,
`journaled`, `read`, `readonly`, `symbolic link`, `system`, `temporary`,
`write`.
FileChangedKey is the attribute Key conforming to the "file.changed" semantic
conventions. It represents the time when the file attributes or metadata was
last changed, in ISO 8601 format.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021-01-01T12:00:00Z"
Note: `file.changed` captures the time when any of the file's properties or
attributes (including the content) are changed, while `file.modified`
captures the timestamp when the file content is modified.
FileCreatedKey is the attribute Key conforming to the "file.created" semantic
conventions. It represents the time when the file was created, in ISO 8601
format.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021-01-01T12:00:00Z"
Note: This attribute might not be supported by some file systems — NFS,
FAT32, in embedded OS, etc.
FileDirectoryKey is the attribute Key conforming to the "file.directory"
semantic conventions. It represents the directory where the file is located.
It should include the drive letter, when appropriate.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/home/user", "C:\Program Files\MyApp"
FileExtensionKey is the attribute Key conforming to the "file.extension"
semantic conventions. It represents the file extension, excluding the leading
dot.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "png", "gz"
Note: When the file name has multiple extensions (example.tar.gz), only the
last one should be captured ("gz", not "tar.gz").
FileForkNameKey is the attribute Key conforming to the "file.fork_name"
semantic conventions. It represents the name of the fork. A fork is
additional data associated with a filesystem object.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Zone.Identifier"
Note: On Linux, a resource fork is used to store additional data with a
filesystem object. A file always has at least one fork for the data portion,
and additional forks may exist.
On NTFS, this is analogous to an Alternate Data Stream (ADS), and the default
data stream for a file is just called $DATA. Zone.Identifier is commonly used
by Windows to track contents downloaded from the Internet. An ADS is
typically of the form: C:\path\to\filename.extension:some_fork_name, and
some_fork_name is the value that should populate `fork_name`.
`filename.extension` should populate `file.name`, and `extension` should
populate `file.extension`. The full path, `file.path`, will include the fork
name.
FileGroupIDKey is the attribute Key conforming to the "file.group.id"
semantic conventions. It represents the primary Group ID (GID) of the file.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1000"
FileGroupNameKey is the attribute Key conforming to the "file.group.name"
semantic conventions. It represents the primary group name of the file.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "users"
FileInodeKey is the attribute Key conforming to the "file.inode" semantic
conventions. It represents the inode representing the file in the filesystem.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "256383"
FileModeKey is the attribute Key conforming to the "file.mode" semantic
conventions. It represents the mode of the file in octal representation.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0640"
FileModifiedKey is the attribute Key conforming to the "file.modified"
semantic conventions. It represents the time when the file content was last
modified, in ISO 8601 format.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021-01-01T12:00:00Z"
FileNameKey is the attribute Key conforming to the "file.name" semantic
conventions. It represents the name of the file including the extension,
without the directory.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "example.png"
FileOwnerIDKey is the attribute Key conforming to the "file.owner.id"
semantic conventions. It represents the user ID (UID) or security identifier
(SID) of the file owner.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1000"
FileOwnerNameKey is the attribute Key conforming to the "file.owner.name"
semantic conventions. It represents the username of the file owner.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "root"
FilePathKey is the attribute Key conforming to the "file.path" semantic
conventions. It represents the full path to the file, including the file
name. It should include the drive letter, when appropriate.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/home/alice/example.png", "C:\Program Files\MyApp\myapp.exe"
FileSizeKey is the attribute Key conforming to the "file.size" semantic
conventions. It represents the file size in bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples:
FileSymbolicLinkTargetPathKey is the attribute Key conforming to the
"file.symbolic_link.target_path" semantic conventions. It represents the path
to the target of a symbolic link.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/usr/bin/python3"
Note: This attribute is only applicable to symbolic links.
GCPAppHubApplicationContainerKey is the attribute Key conforming to the
"gcp.apphub.application.container" semantic conventions. It represents the
container within GCP where the AppHub application is defined.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "projects/my-container-project"
GCPAppHubApplicationIDKey is the attribute Key conforming to the
"gcp.apphub.application.id" semantic conventions. It represents the name of
the application as configured in AppHub.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-application"
GCPAppHubApplicationLocationKey is the attribute Key conforming to the
"gcp.apphub.application.location" semantic conventions. It represents the GCP
zone or region where the application is defined.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "us-central1"
GCPAppHubServiceCriticalityTypeKey is the attribute Key conforming to the
"gcp.apphub.service.criticality_type" semantic conventions. It represents the
criticality of a service indicates its importance to the business.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: [See AppHub type enum]
GCPAppHubServiceEnvironmentTypeKey is the attribute Key conforming to the
"gcp.apphub.service.environment_type" semantic conventions. It represents the
environment of a service is the stage of a software lifecycle.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: [See AppHub environment type]
GCPAppHubServiceIDKey is the attribute Key conforming to the
"gcp.apphub.service.id" semantic conventions. It represents the name of the
service as configured in AppHub.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-service"
GCPAppHubWorkloadCriticalityTypeKey is the attribute Key conforming to the
"gcp.apphub.workload.criticality_type" semantic conventions. It represents
the criticality of a workload indicates its importance to the business.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: [See AppHub type enum]
GCPAppHubWorkloadEnvironmentTypeKey is the attribute Key conforming to the
"gcp.apphub.workload.environment_type" semantic conventions. It represents
the environment of a workload is the stage of a software lifecycle.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: [See AppHub environment type]
GCPAppHubWorkloadIDKey is the attribute Key conforming to the
"gcp.apphub.workload.id" semantic conventions. It represents the name of the
workload as configured in AppHub.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-workload"
GCPClientServiceKey is the attribute Key conforming to the
"gcp.client.service" semantic conventions. It represents the identifies the
Google Cloud service for which the official client library is intended.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "appengine", "run", "firestore", "alloydb", "spanner"
Note: Intended to be a stable identifier for Google Cloud client libraries
that is uniform across implementation languages. The value should be derived
from the canonical service domain for the service; for example,
'foo.googleapis.com' should result in a value of 'foo'.
GCPCloudRunJobExecutionKey is the attribute Key conforming to the
"gcp.cloud_run.job.execution" semantic conventions. It represents the name of
the Cloud Run [execution] being run for the Job, as set by the
[`CLOUD_RUN_EXECUTION`] environment variable.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "job-name-xxxx", "sample-job-mdw84"
GCPCloudRunJobTaskIndexKey is the attribute Key conforming to the
"gcp.cloud_run.job.task_index" semantic conventions. It represents the index
for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`]
environment variable.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 0, 1
GCPGCEInstanceHostnameKey is the attribute Key conforming to the
"gcp.gce.instance.hostname" semantic conventions. It represents the hostname
of a GCE instance. This is the full value of the default or [custom hostname]
.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-host1234.example.com",
"sample-vm.us-west1-b.c.my-project.internal"
GCPGCEInstanceNameKey is the attribute Key conforming to the
"gcp.gce.instance.name" semantic conventions. It represents the instance name
of a GCE instance. This is the value provided by `host.name`, the visible
name of the instance in the Cloud Console UI, and the prefix for the default
hostname of the instance as defined by the [default internal DNS name].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "instance-1", "my-vm-name"
GenAIAgentDescriptionKey is the attribute Key conforming to the
"gen_ai.agent.description" semantic conventions. It represents the free-form
description of the GenAI agent provided by the application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Helps with math problems", "Generates fiction stories"
GenAIAgentIDKey is the attribute Key conforming to the "gen_ai.agent.id"
semantic conventions. It represents the unique identifier of the GenAI agent.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "asst_5j66UpCpwteGg4YSxUnt7lPY"
GenAIAgentNameKey is the attribute Key conforming to the "gen_ai.agent.name"
semantic conventions. It represents the human-readable name of the GenAI
agent provided by the application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Math Tutor", "Fiction Writer"
GenAIConversationIDKey is the attribute Key conforming to the
"gen_ai.conversation.id" semantic conventions. It represents the unique
identifier for a conversation (session, thread), used to store and correlate
messages within this conversation.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "conv_5j66UpCpwteGg4YSxUnt7lPY"
GenAIDataSourceIDKey is the attribute Key conforming to the
"gen_ai.data_source.id" semantic conventions. It represents the data source
identifier.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "H7STPQYOND"
Note: Data sources are used by AI agents and RAG applications to store
grounding data. A data source may be an external database, object store,
document collection, website, or any other storage system used by the GenAI
agent or application. The `gen_ai.data_source.id` SHOULD match the identifier
used by the GenAI system rather than a name specific to the external storage,
such as a database or object store. Semantic conventions referencing
`gen_ai.data_source.id` MAY also leverage additional attributes, such as
`db.*`, to further identify and describe the data source.
GenAIInputMessagesKey is the attribute Key conforming to the
"gen_ai.input.messages" semantic conventions. It represents the chat history
provided to the model as an input.
Type: any
RequirementLevel: Recommended
Stability: Development
Examples: "[\n {\n "role": "user",\n "parts": [\n {\n "type": "text",\n
"content": "Weather in Paris?"\n }\n ]\n },\n {\n "role": "assistant",\n
"parts": [\n {\n "type": "tool_call",\n "id":
"call_VSPygqKTWdrhaFErNvMV18Yl",\n "name": "get_weather",\n "arguments": {\n
"location": "Paris"\n }\n }\n ]\n },\n {\n "role": "tool",\n "parts": [\n {\n
"type": "tool_call_response",\n "id": " call_VSPygqKTWdrhaFErNvMV18Yl",\n
"result": "rainy, 57°F"\n }\n ]\n }\n]\n"
Note: Instrumentations MUST follow [Input messages JSON schema].
When the attribute is recorded on events, it MUST be recorded in structured
form. When recorded on spans, it MAY be recorded as a JSON string if
structured
format is not supported and SHOULD be recorded in structured form otherwise.
Messages MUST be provided in the order they were sent to the model.
Instrumentations MAY provide a way for users to filter or truncate
input messages.
> [!Warning]
> This attribute is likely to contain sensitive information including
> user/PII data.
See [Recording content on attributes]
section for more details.
[Input messages JSON schema]: /docs/gen-ai/gen-ai-input-messages.json
[Recording content on attributes]: /docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes
GenAIOperationNameKey is the attribute Key conforming to the
"gen_ai.operation.name" semantic conventions. It represents the name of the
operation being performed.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: If one of the predefined values applies, but specific system uses a
different name it's RECOMMENDED to document it in the semantic conventions
for specific GenAI system and use system-specific name in the
instrumentation. If a different name is not documented, instrumentation
libraries SHOULD use applicable predefined value.
GenAIOutputMessagesKey is the attribute Key conforming to the
"gen_ai.output.messages" semantic conventions. It represents the messages
returned by the model where each message represents a specific model response
(choice, candidate).
Type: any
RequirementLevel: Recommended
Stability: Development
Examples: "[\n {\n "role": "assistant",\n "parts": [\n {\n "type": "text",\n
"content": "The weather in Paris is currently rainy with a temperature of
57°F."\n }\n ],\n "finish_reason": "stop"\n }\n]\n"
Note: Instrumentations MUST follow [Output messages JSON schema]
Each message represents a single output choice/candidate generated by
the model. Each message corresponds to exactly one generation
(choice/candidate) and vice versa - one choice cannot be split across
multiple messages or one message cannot contain parts from multiple choices.
When the attribute is recorded on events, it MUST be recorded in structured
form. When recorded on spans, it MAY be recorded as a JSON string if
structured
format is not supported and SHOULD be recorded in structured form otherwise.
Instrumentations MAY provide a way for users to filter or truncate
output messages.
> [!Warning]
> This attribute is likely to contain sensitive information including
> user/PII data.
See [Recording content on attributes]
section for more details.
[Output messages JSON schema]: /docs/gen-ai/gen-ai-output-messages.json
[Recording content on attributes]: /docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes
GenAIOutputTypeKey is the attribute Key conforming to the
"gen_ai.output.type" semantic conventions. It represents the represents the
content type requested by the client.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: This attribute SHOULD be used when the client requests output of a
specific type. The model may return zero or more outputs of this type.
This attribute specifies the output modality and not the actual output
format. For example, if an image is requested, the actual output could be a
URL pointing to an image file.
Additional output format details may be recorded in the future in the
`gen_ai.output.{type}.*` attributes.
GenAIProviderNameKey is the attribute Key conforming to the
"gen_ai.provider.name" semantic conventions. It represents the Generative AI
provider as identified by the client or server instrumentation.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: The attribute SHOULD be set based on the instrumentation's best
knowledge and may differ from the actual model provider.
Multiple providers, including Azure OpenAI, Gemini, and AI hosting platforms
are accessible using the OpenAI REST API and corresponding client libraries,
but may proxy or host models from different providers.
The `gen_ai.request.model`, `gen_ai.response.model`, and `server.address`
attributes may help identify the actual system in use.
The `gen_ai.provider.name` attribute acts as a discriminator that
identifies the GenAI telemetry format flavor specific to that provider
within GenAI semantic conventions.
It SHOULD be set consistently with provider-specific attributes and signals.
For example, GenAI spans, metrics, and events related to AWS Bedrock
should have the `gen_ai.provider.name` set to `aws.bedrock` and include
applicable `aws.bedrock.*` attributes and are not expected to include
`openai.*` attributes.
GenAIRequestChoiceCountKey is the attribute Key conforming to the
"gen_ai.request.choice.count" semantic conventions. It represents the target
number of candidate completions to return.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 3
GenAIRequestEncodingFormatsKey is the attribute Key conforming to the
"gen_ai.request.encoding_formats" semantic conventions. It represents the
encoding formats requested in an embeddings operation, if specified.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "base64"], ["float", "binary"
Note: In some GenAI systems the encoding formats are called embedding types.
Also, some GenAI systems only accept a single format per request.
GenAIRequestFrequencyPenaltyKey is the attribute Key conforming to the
"gen_ai.request.frequency_penalty" semantic conventions. It represents the
frequency penalty setting for the GenAI request.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 0.1
GenAIRequestMaxTokensKey is the attribute Key conforming to the
"gen_ai.request.max_tokens" semantic conventions. It represents the maximum
number of tokens the model generates for a request.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 100
GenAIRequestModelKey is the attribute Key conforming to the
"gen_ai.request.model" semantic conventions. It represents the name of the
GenAI model a request is being made to.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: gpt-4
GenAIRequestPresencePenaltyKey is the attribute Key conforming to the
"gen_ai.request.presence_penalty" semantic conventions. It represents the
presence penalty setting for the GenAI request.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 0.1
GenAIRequestSeedKey is the attribute Key conforming to the
"gen_ai.request.seed" semantic conventions. It represents the requests with
same seed value more likely to return same result.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 100
GenAIRequestStopSequencesKey is the attribute Key conforming to the
"gen_ai.request.stop_sequences" semantic conventions. It represents the list
of sequences that the model will use to stop generating further tokens.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "forest", "lived"
GenAIRequestTemperatureKey is the attribute Key conforming to the
"gen_ai.request.temperature" semantic conventions. It represents the
temperature setting for the GenAI request.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 0.0
GenAIRequestTopKKey is the attribute Key conforming to the
"gen_ai.request.top_k" semantic conventions. It represents the top_k sampling
setting for the GenAI request.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 1.0
GenAIRequestTopPKey is the attribute Key conforming to the
"gen_ai.request.top_p" semantic conventions. It represents the top_p sampling
setting for the GenAI request.
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 1.0
GenAIResponseFinishReasonsKey is the attribute Key conforming to the
"gen_ai.response.finish_reasons" semantic conventions. It represents the
array of reasons the model stopped generating tokens, corresponding to each
generation received.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "stop"], ["stop", "length"
GenAIResponseIDKey is the attribute Key conforming to the
"gen_ai.response.id" semantic conventions. It represents the unique
identifier for the completion.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "chatcmpl-123"
GenAIResponseModelKey is the attribute Key conforming to the
"gen_ai.response.model" semantic conventions. It represents the name of the
model that generated the response.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "gpt-4-0613"
GenAISystemInstructionsKey is the attribute Key conforming to the
"gen_ai.system_instructions" semantic conventions. It represents the system
message or instructions provided to the GenAI model separately from the chat
history.
Type: any
RequirementLevel: Recommended
Stability: Development
Examples: "[\n {\n "type": "text",\n "content": "You are an Agent that greet
users, always use greetings tool to respond"\n }\n]\n", "[\n {\n "type":
"text",\n "content": "You are a language translator."\n },\n {\n "type":
"text",\n "content": "Your mission is to translate text in English to
French."\n }\n]\n"
Note: This attribute SHOULD be used when the corresponding provider or API
allows to provide system instructions or messages separately from the
chat history.
Instructions that are part of the chat history SHOULD be recorded in
`gen_ai.input.messages` attribute instead.
Instrumentations MUST follow [System instructions JSON schema].
When recorded on spans, it MAY be recorded as a JSON string if structured
format is not supported and SHOULD be recorded in structured form otherwise.
Instrumentations MAY provide a way for users to filter or truncate
system instructions.
> [!Warning]
> This attribute may contain sensitive information.
See [Recording content on attributes]
section for more details.
[System instructions JSON schema]: /docs/gen-ai/gen-ai-system-instructions.json
[Recording content on attributes]: /docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes
GenAITokenTypeKey is the attribute Key conforming to the "gen_ai.token.type"
semantic conventions. It represents the type of token being counted.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "input", "output"
GenAIToolCallIDKey is the attribute Key conforming to the
"gen_ai.tool.call.id" semantic conventions. It represents the tool call
identifier.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "call_mszuSIzqtI65i1wAUOE8w5H4"
GenAIToolDescriptionKey is the attribute Key conforming to the
"gen_ai.tool.description" semantic conventions. It represents the tool
description.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Multiply two numbers"
GenAIToolNameKey is the attribute Key conforming to the "gen_ai.tool.name"
semantic conventions. It represents the name of the tool utilized by the
agent.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Flights"
GenAIToolTypeKey is the attribute Key conforming to the "gen_ai.tool.type"
semantic conventions. It represents the type of the tool utilized by the
agent.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "function", "extension", "datastore"
Note: Extension: A tool executed on the agent-side to directly call external
APIs, bridging the gap between the agent and real-world systems.
Agent-side operations involve actions that are performed by the agent on the
server or within the agent's controlled environment.
Function: A tool executed on the client-side, where the agent generates
parameters for a predefined function, and the client executes the logic.
Client-side operations are actions taken on the user's end or within the
client application.
Datastore: A tool used by the agent to access and query structured or
unstructured external data for retrieval-augmented tasks or knowledge
updates.
GenAIUsageInputTokensKey is the attribute Key conforming to the
"gen_ai.usage.input_tokens" semantic conventions. It represents the number of
tokens used in the GenAI input (prompt).
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 100
GenAIUsageOutputTokensKey is the attribute Key conforming to the
"gen_ai.usage.output_tokens" semantic conventions. It represents the number
of tokens used in the GenAI response (completion).
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 180
GeoContinentCodeKey is the attribute Key conforming to the
"geo.continent.code" semantic conventions. It represents the two-letter code
representing continent’s name.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
GeoCountryISOCodeKey is the attribute Key conforming to the
"geo.country.iso_code" semantic conventions. It represents the two-letter ISO
Country Code ([ISO 3166-1 alpha2]).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CA"
GeoLocalityNameKey is the attribute Key conforming to the "geo.locality.name"
semantic conventions. It represents the locality name. Represents the name of
a city, town, village, or similar populated place.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Montreal", "Berlin"
GeoLocationLatKey is the attribute Key conforming to the "geo.location.lat"
semantic conventions. It represents the latitude of the geo location in
[WGS84].
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: 45.505918
GeoLocationLonKey is the attribute Key conforming to the "geo.location.lon"
semantic conventions. It represents the longitude of the geo location in
[WGS84].
Type: double
RequirementLevel: Recommended
Stability: Development
Examples: -73.61483
GeoPostalCodeKey is the attribute Key conforming to the "geo.postal_code"
semantic conventions. It represents the postal code associated with the
location. Values appropriate for this field may also be known as a postcode
or ZIP code and will vary widely from country to country.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "94040"
GeoRegionISOCodeKey is the attribute Key conforming to the
"geo.region.iso_code" semantic conventions. It represents the region ISO code
([ISO 3166-2]).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CA-QC"
GoMemoryTypeKey is the attribute Key conforming to the "go.memory.type"
semantic conventions. It represents the type of memory.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "other", "stack"
GraphQLDocumentKey is the attribute Key conforming to the "graphql.document"
semantic conventions. It represents the GraphQL document being executed.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: query findBookById { bookById(id: ?) { name } }
Note: The value may be sanitized to exclude sensitive information.
GraphQLOperationNameKey is the attribute Key conforming to the
"graphql.operation.name" semantic conventions. It represents the name of the
operation being executed.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: findBookById
GraphQLOperationTypeKey is the attribute Key conforming to the
"graphql.operation.type" semantic conventions. It represents the type of the
operation being executed.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "query", "mutation", "subscription"
HerokuAppIDKey is the attribute Key conforming to the "heroku.app.id"
semantic conventions. It represents the unique identifier for the
application.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2daa2797-e42b-4624-9322-ec3f968df4da"
HerokuReleaseCommitKey is the attribute Key conforming to the
"heroku.release.commit" semantic conventions. It represents the commit hash
for the current release.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "e6134959463efd8966b20e75b913cafe3f5ec"
HerokuReleaseCreationTimestampKey is the attribute Key conforming to the
"heroku.release.creation_timestamp" semantic conventions. It represents the
time and date the release was created.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2022-10-23T18:00:42Z"
HostArchKey is the attribute Key conforming to the "host.arch" semantic
conventions. It represents the CPU architecture the host system is running
on.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HostCPUCacheL2SizeKey is the attribute Key conforming to the
"host.cpu.cache.l2.size" semantic conventions. It represents the amount of
level 2 memory cache available to the processor (in Bytes).
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 12288000
HostCPUFamilyKey is the attribute Key conforming to the "host.cpu.family"
semantic conventions. It represents the family or generation of the CPU.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "6", "PA-RISC 1.1e"
HostCPUModelIDKey is the attribute Key conforming to the "host.cpu.model.id"
semantic conventions. It represents the model identifier. It provides more
granular information about the CPU, distinguishing it from other CPUs within
the same family.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "6", "9000/778/B180L"
HostCPUModelNameKey is the attribute Key conforming to the
"host.cpu.model.name" semantic conventions. It represents the model
designation of the processor.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz"
HostCPUSteppingKey is the attribute Key conforming to the "host.cpu.stepping"
semantic conventions. It represents the stepping or core revisions.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1", "r1p1"
HostCPUVendorIDKey is the attribute Key conforming to the
"host.cpu.vendor.id" semantic conventions. It represents the processor
manufacturer identifier. A maximum 12-character string.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "GenuineIntel"
Note: [CPUID] command returns the vendor ID string in EBX, EDX and ECX
registers. Writing these to memory in this order results in a 12-character
string.
HostIDKey is the attribute Key conforming to the "host.id" semantic
conventions. It represents the unique host ID. For Cloud, this must be the
instance_id assigned by the cloud provider. For non-containerized systems,
this should be the `machine-id`. See the table below for the sources to use
to determine the `machine-id` based on operating system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "fdbf79e8af94cb7f9e8df36789187052"
HostImageIDKey is the attribute Key conforming to the "host.image.id"
semantic conventions. It represents the VM image ID or host OS image ID. For
Cloud, this value is from the provider.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "ami-07b06b442921831e5"
HostImageNameKey is the attribute Key conforming to the "host.image.name"
semantic conventions. It represents the name of the VM image or OS install
the host was instantiated from.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "infra-ami-eks-worker-node-7d4ec78312", "CentOS-8-x86_64-1905"
HostImageVersionKey is the attribute Key conforming to the
"host.image.version" semantic conventions. It represents the version string
of the VM image or host OS as defined in [Version Attributes].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0.1"
[Version Attributes]: /docs/resource/README.md#version-attributes
HostIPKey is the attribute Key conforming to the "host.ip" semantic
conventions. It represents the available IP addresses of the host, excluding
loopback interfaces.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "192.168.1.140", "fe80::abc2:4a28:737a:609e"
Note: IPv4 Addresses MUST be specified in dotted-quad notation. IPv6
addresses MUST be specified in the [RFC 5952] format.
HostMacKey is the attribute Key conforming to the "host.mac" semantic
conventions. It represents the available MAC addresses of the host, excluding
loopback interfaces.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "AC-DE-48-23-45-67", "AC-DE-48-23-45-67-01-9F"
Note: MAC Addresses MUST be represented in [IEEE RA hexadecimal form]: as
hyphen-separated octets in uppercase hexadecimal form from most to least
significant.
HostNameKey is the attribute Key conforming to the "host.name" semantic
conventions. It represents the name of the host. On Unix systems, it may
contain what the hostname command returns, or the fully qualified hostname,
or another name specified by the user.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry-test"
HostTypeKey is the attribute Key conforming to the "host.type" semantic
conventions. It represents the type of host. For Cloud, this must be the
machine type.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "n1-standard-1"
HTTPConnectionStateKey is the attribute Key conforming to the
"http.connection.state" semantic conventions. It represents the state of the
HTTP connection in the HTTP connection pool.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "active", "idle"
HTTPRequestBodySizeKey is the attribute Key conforming to the
"http.request.body.size" semantic conventions. It represents 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.
Type: int
RequirementLevel: Recommended
Stability: Development
HTTPRequestMethodKey is the attribute Key conforming to the
"http.request.method" semantic conventions. It represents the HTTP request
method.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples: "GET", "POST", "HEAD"
Note: HTTP request method value SHOULD be "known" to the instrumentation.
By default, this convention defines "known" methods as the ones listed in
[RFC9110]
and the PATCH method defined in [RFC5789].
If the HTTP request method is not known to instrumentation, it MUST set the
`http.request.method` attribute to `_OTHER`.
If the HTTP instrumentation could end up converting valid HTTP request
methods to `_OTHER`, then it MUST provide a way to override
the list of known HTTP methods. If this override is done via environment
variable, then the environment variable MUST be named
OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of
case-sensitive known HTTP methods
(this list MUST be a full override of the default known method, it is not a
list of known methods in addition to the defaults).
HTTP method names are case-sensitive and `http.request.method` attribute
value MUST match a known HTTP method name exactly.
Instrumentations for specific web frameworks that consider HTTP methods to be
case insensitive, SHOULD populate a canonical equivalent.
Tracing instrumentations that do so, MUST also set
`http.request.method_original` to the original value.
HTTPRequestMethodOriginalKey is the attribute Key conforming to the
"http.request.method_original" semantic conventions. It represents the
original HTTP method sent by the client in the request line.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "GeT", "ACL", "foo"
HTTPRequestResendCountKey is the attribute Key conforming to the
"http.request.resend_count" semantic conventions. It represents the ordinal
number of request resending attempt (for any reason, including redirects).
Type: int
RequirementLevel: Recommended
Stability: Stable
Note: 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).
HTTPRequestSizeKey is the attribute Key conforming to the "http.request.size"
semantic conventions. It represents the total size of the request in bytes.
This should be the total number of bytes sent over the wire, including the
request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request
body if any.
Type: int
RequirementLevel: Recommended
Stability: Development
HTTPResponseBodySizeKey is the attribute Key conforming to the
"http.response.body.size" semantic conventions. It represents 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.
Type: int
RequirementLevel: Recommended
Stability: Development
HTTPResponseSizeKey is the attribute Key conforming to the
"http.response.size" semantic conventions. It represents the total size of
the response in bytes. This should be the total number of bytes sent over the
wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3),
headers, and response body and trailers if any.
Type: int
RequirementLevel: Recommended
Stability: Development
HTTPResponseStatusCodeKey is the attribute Key conforming to the
"http.response.status_code" semantic conventions. It represents the
[HTTP response status code].
Type: int
RequirementLevel: Recommended
Stability: Stable
Examples: 200
HTTPRouteKey is the attribute Key conforming to the "http.route" semantic
conventions. It represents the matched route, that is, the path template in
the format used by the respective server framework.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "/users/:userID?", "{controller}/{action}/{id?}"
Note: 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.
SHOULD include the [application root] if there is one.
[application root]: /docs/http/http-spans.md#http-server-definitions
HwBatteryCapacityKey is the attribute Key conforming to the
"hw.battery.capacity" semantic conventions. It represents the design capacity
in Watts-hours or Amper-hours.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "9.3Ah", "50Wh"
HwBatteryChemistryKey is the attribute Key conforming to the
"hw.battery.chemistry" semantic conventions. It represents the battery
[chemistry], e.g. Lithium-Ion, Nickel-Cadmium, etc.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Li-ion", "NiMH"
HwBatteryStateKey is the attribute Key conforming to the "hw.battery.state"
semantic conventions. It represents the current state of the battery.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwBiosVersionKey is the attribute Key conforming to the "hw.bios_version"
semantic conventions. It represents the BIOS version of the hardware
component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1.2.3"
HwDriverVersionKey is the attribute Key conforming to the "hw.driver_version"
semantic conventions. It represents the driver version for the hardware
component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "10.2.1-3"
HwEnclosureTypeKey is the attribute Key conforming to the "hw.enclosure.type"
semantic conventions. It represents the type of the enclosure (useful for
modular systems).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Computer", "Storage", "Switch"
HwFirmwareVersionKey is the attribute Key conforming to the
"hw.firmware_version" semantic conventions. It represents the firmware
version of the hardware component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2.0.1"
HwGpuTaskKey is the attribute Key conforming to the "hw.gpu.task" semantic
conventions. It represents the type of task the GPU is performing.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwIDKey is the attribute Key conforming to the "hw.id" semantic conventions.
It represents an identifier for the hardware component, unique within the
monitored host.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "win32battery_battery_testsysa33_1"
HwLimitTypeKey is the attribute Key conforming to the "hw.limit_type"
semantic conventions. It represents the type of limit for hardware
components.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwLogicalDiskRaidLevelKey is the attribute Key conforming to the
"hw.logical_disk.raid_level" semantic conventions. It represents the RAID
Level of the logical disk.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "RAID0+1", "RAID5", "RAID10"
HwLogicalDiskStateKey is the attribute Key conforming to the
"hw.logical_disk.state" semantic conventions. It represents the state of the
logical disk space usage.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwMemoryTypeKey is the attribute Key conforming to the "hw.memory.type"
semantic conventions. It represents the type of the memory module.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "DDR4", "DDR5", "LPDDR5"
HwModelKey is the attribute Key conforming to the "hw.model" semantic
conventions. It represents the descriptive model name of the hardware
component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "PERC H740P", "Intel(R) Core(TM) i7-10700K", "Dell XPS 15 Battery"
HwNameKey is the attribute Key conforming to the "hw.name" semantic
conventions. It represents an easily-recognizable name for the hardware
component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "eth0"
HwNetworkLogicalAddressesKey is the attribute Key conforming to the
"hw.network.logical_addresses" semantic conventions. It represents the
logical addresses of the adapter (e.g. IP address, or WWPN).
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "172.16.8.21", "57.11.193.42"
HwNetworkPhysicalAddressKey is the attribute Key conforming to the
"hw.network.physical_address" semantic conventions. It represents the
physical address of the adapter (e.g. MAC address, or WWNN).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "00-90-F5-E9-7B-36"
HwParentKey is the attribute Key conforming to the "hw.parent" semantic
conventions. It represents the unique identifier of the parent component
(typically the `hw.id` attribute of the enclosure, or disk controller).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "dellStorage_perc_0"
HwPhysicalDiskSmartAttributeKey is the attribute Key conforming to the
"hw.physical_disk.smart_attribute" semantic conventions. It represents the
[S.M.A.R.T.] (Self-Monitoring, Analysis, and Reporting Technology) attribute
of the physical disk.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Spin Retry Count", "Seek Error Rate", "Raw Read Error Rate"
HwPhysicalDiskStateKey is the attribute Key conforming to the
"hw.physical_disk.state" semantic conventions. It represents the state of the
physical disk endurance utilization.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwPhysicalDiskTypeKey is the attribute Key conforming to the
"hw.physical_disk.type" semantic conventions. It represents the type of the
physical disk.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "HDD", "SSD", "10K"
HwSensorLocationKey is the attribute Key conforming to the
"hw.sensor_location" semantic conventions. It represents the location of the
sensor.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "cpu0", "ps1", "INLET", "CPU0_DIE", "AMBIENT", "MOTHERBOARD", "PS0
V3_3", "MAIN_12V", "CPU_VCORE"
HwSerialNumberKey is the attribute Key conforming to the "hw.serial_number"
semantic conventions. It represents the serial number of the hardware
component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CNFCP0123456789"
HwStateKey is the attribute Key conforming to the "hw.state" semantic
conventions. It represents the current state of the component.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwTapeDriveOperationTypeKey is the attribute Key conforming to the
"hw.tape_drive.operation_type" semantic conventions. It represents the type
of tape drive operation.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
HwTypeKey is the attribute Key conforming to the "hw.type" semantic
conventions. It represents the type of the component.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: Describes the category of the hardware component for which `hw.state`
is being reported. For example, `hw.type=temperature` along with
`hw.state=degraded` would indicate that the temperature of the hardware
component has been reported as `degraded`.
HwVendorKey is the attribute Key conforming to the "hw.vendor" semantic
conventions. It represents the vendor name of the hardware component.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Dell", "HP", "Intel", "AMD", "LSI", "Lenovo"
IOSAppStateKey is the attribute Key conforming to the "ios.app.state"
semantic conventions. It represents the this attribute represents the state
of the application.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: The iOS lifecycle states are defined in the
[UIApplicationDelegate documentation], and from which the `OS terminology`
column values are derived.
K8SClusterNameKey is the attribute Key conforming to the "k8s.cluster.name"
semantic conventions. It represents the name of the cluster.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry-cluster"
K8SClusterUIDKey is the attribute Key conforming to the "k8s.cluster.uid"
semantic conventions. It represents a pseudo-ID for the cluster, set to the
UID of the `kube-system` namespace.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "218fc5a9-a5f1-4b54-aa05-46717d0ab26d"
Note: K8s doesn't have support for obtaining a cluster ID. If this is ever
added, we will recommend collecting the `k8s.cluster.uid` through the
official APIs. In the meantime, we are able to use the `uid` of the
`kube-system` namespace as a proxy for cluster ID. Read on for the
rationale.
Every object created in a K8s cluster is assigned a distinct UID. The
`kube-system` namespace is used by Kubernetes itself and will exist
for the lifetime of the cluster. Using the `uid` of the `kube-system`
namespace is a reasonable proxy for the K8s ClusterID as it will only
change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are
UUIDs as standardized by
[ISO/IEC 9834-8 and ITU-T X.667].
Which states:
> If generated according to one of the mechanisms defined in Rec.
> ITU-T X.667 | ISO/IEC 9834-8, a UUID is either guaranteed to be
> different from all other UUIDs generated before 3603 A.D., or is
> extremely likely to be different (depending on the mechanism chosen).
Therefore, UIDs between clusters should be extremely unlikely to
conflict.
K8SContainerNameKey is the attribute Key conforming to the
"k8s.container.name" semantic conventions. It represents the name of the
Container from Pod specification, must be unique within a Pod. Container
runtime usually uses different globally unique name (`container.name`).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "redis"
K8SContainerRestartCountKey is the attribute Key conforming to the
"k8s.container.restart_count" semantic conventions. It represents the number
of times the container was restarted. This attribute can be used to identify
a particular container (running or stopped) within a container spec.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples:
K8SContainerStatusLastTerminatedReasonKey is the attribute Key conforming to
the "k8s.container.status.last_terminated_reason" semantic conventions. It
represents the last terminated reason of the Container.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Evicted", "Error"
K8SContainerStatusReasonKey is the attribute Key conforming to the
"k8s.container.status.reason" semantic conventions. It represents the reason
for the container state. Corresponds to the `reason` field of the:
[K8s ContainerStateWaiting] or [K8s ContainerStateTerminated].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "ContainerCreating", "CrashLoopBackOff",
"CreateContainerConfigError", "ErrImagePull", "ImagePullBackOff",
"OOMKilled", "Completed", "Error", "ContainerCannotRun"
K8SContainerStatusStateKey is the attribute Key conforming to the
"k8s.container.status.state" semantic conventions. It represents the state of
the container. [K8s ContainerState].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "terminated", "running", "waiting"
K8SCronJobNameKey is the attribute Key conforming to the "k8s.cronjob.name"
semantic conventions. It represents the name of the CronJob.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SCronJobUIDKey is the attribute Key conforming to the "k8s.cronjob.uid"
semantic conventions. It represents the UID of the CronJob.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SDaemonSetNameKey is the attribute Key conforming to the
"k8s.daemonset.name" semantic conventions. It represents the name of the
DaemonSet.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SDaemonSetUIDKey is the attribute Key conforming to the "k8s.daemonset.uid"
semantic conventions. It represents the UID of the DaemonSet.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SDeploymentNameKey is the attribute Key conforming to the
"k8s.deployment.name" semantic conventions. It represents the name of the
Deployment.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SDeploymentUIDKey is the attribute Key conforming to the
"k8s.deployment.uid" semantic conventions. It represents the UID of the
Deployment.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SHPAMetricTypeKey is the attribute Key conforming to the
"k8s.hpa.metric.type" semantic conventions. It represents the type of metric
source for the horizontal pod autoscaler.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Resource", "ContainerResource"
Note: This attribute reflects the `type` field of spec.metrics[] in the HPA.
K8SHPANameKey is the attribute Key conforming to the "k8s.hpa.name" semantic
conventions. It represents the name of the horizontal pod autoscaler.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SHPAScaletargetrefAPIVersionKey is the attribute Key conforming to the
"k8s.hpa.scaletargetref.api_version" semantic conventions. It represents the
API version of the target resource to scale for the HorizontalPodAutoscaler.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "apps/v1", "autoscaling/v2"
Note: This maps to the `apiVersion` field in the `scaleTargetRef` of the HPA
spec.
K8SHPAScaletargetrefKindKey is the attribute Key conforming to the
"k8s.hpa.scaletargetref.kind" semantic conventions. It represents the kind of
the target resource to scale for the HorizontalPodAutoscaler.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Deployment", "StatefulSet"
Note: This maps to the `kind` field in the `scaleTargetRef` of the HPA spec.
K8SHPAScaletargetrefNameKey is the attribute Key conforming to the
"k8s.hpa.scaletargetref.name" semantic conventions. It represents the name of
the target resource to scale for the HorizontalPodAutoscaler.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-deployment", "my-statefulset"
Note: This maps to the `name` field in the `scaleTargetRef` of the HPA spec.
K8SHPAUIDKey is the attribute Key conforming to the "k8s.hpa.uid" semantic
conventions. It represents the UID of the horizontal pod autoscaler.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SHugepageSizeKey is the attribute Key conforming to the "k8s.hugepage.size"
semantic conventions. It represents the size (identifier) of the K8s huge
page.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2Mi"
K8SJobNameKey is the attribute Key conforming to the "k8s.job.name" semantic
conventions. It represents the name of the Job.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SJobUIDKey is the attribute Key conforming to the "k8s.job.uid" semantic
conventions. It represents the UID of the Job.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SNamespaceNameKey is the attribute Key conforming to the
"k8s.namespace.name" semantic conventions. It represents the name of the
namespace that the pod is running in.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "default"
K8SNamespacePhaseKey is the attribute Key conforming to the
"k8s.namespace.phase" semantic conventions. It represents the phase of the
K8s namespace.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "active", "terminating"
Note: This attribute aligns with the `phase` field of the
[K8s NamespaceStatus]
K8SNodeConditionStatusKey is the attribute Key conforming to the
"k8s.node.condition.status" semantic conventions. It represents the status of
the condition, one of True, False, Unknown.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "true", "false", "unknown"
Note: This attribute aligns with the `status` field of the
[NodeCondition]
K8SNodeConditionTypeKey is the attribute Key conforming to the
"k8s.node.condition.type" semantic conventions. It represents the condition
type of a K8s Node.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "Ready", "DiskPressure"
Note: K8s Node conditions as described
by [K8s documentation].
This attribute aligns with the `type` field of the
[NodeCondition]
The set of possible values is not limited to those listed here. Managed
Kubernetes environments,
or custom controllers MAY introduce additional node condition types.
When this occurs, the exact value as reported by the Kubernetes API SHOULD be
used.
K8SNodeNameKey is the attribute Key conforming to the "k8s.node.name"
semantic conventions. It represents the name of the Node.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "node-1"
K8SNodeUIDKey is the attribute Key conforming to the "k8s.node.uid" semantic
conventions. It represents the UID of the Node.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2"
K8SPodNameKey is the attribute Key conforming to the "k8s.pod.name" semantic
conventions. It represents the name of the Pod.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry-pod-autoconf"
K8SPodUIDKey is the attribute Key conforming to the "k8s.pod.uid" semantic
conventions. It represents the UID of the Pod.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SReplicaSetNameKey is the attribute Key conforming to the
"k8s.replicaset.name" semantic conventions. It represents the name of the
ReplicaSet.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SReplicaSetUIDKey is the attribute Key conforming to the
"k8s.replicaset.uid" semantic conventions. It represents the UID of the
ReplicaSet.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SReplicationControllerNameKey is the attribute Key conforming to the
"k8s.replicationcontroller.name" semantic conventions. It represents the name
of the replication controller.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SReplicationControllerUIDKey is the attribute Key conforming to the
"k8s.replicationcontroller.uid" semantic conventions. It represents the UID
of the replication controller.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SResourceQuotaNameKey is the attribute Key conforming to the
"k8s.resourcequota.name" semantic conventions. It represents the name of the
resource quota.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SResourceQuotaResourceNameKey is the attribute Key conforming to the
"k8s.resourcequota.resource_name" semantic conventions. It represents the
name of the K8s resource a resource quota defines.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "count/replicationcontrollers"
Note: The value for this attribute can be either the full
`count/<resource>[.<group>]` string (e.g., count/deployments.apps,
count/pods), or, for certain core Kubernetes resources, just the resource
name (e.g., pods, services, configmaps). Both forms are supported by
Kubernetes for object count quotas. See
[Kubernetes Resource Quotas documentation] for more details.
K8SResourceQuotaUIDKey is the attribute Key conforming to the
"k8s.resourcequota.uid" semantic conventions. It represents the UID of the
resource quota.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SStatefulSetNameKey is the attribute Key conforming to the
"k8s.statefulset.name" semantic conventions. It represents the name of the
StatefulSet.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "opentelemetry"
K8SStatefulSetUIDKey is the attribute Key conforming to the
"k8s.statefulset.uid" semantic conventions. It represents the UID of the
StatefulSet.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff"
K8SStorageclassNameKey is the attribute Key conforming to the
"k8s.storageclass.name" semantic conventions. It represents the name of K8s
[StorageClass] object.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "gold.storageclass.storage.k8s.io"
K8SVolumeNameKey is the attribute Key conforming to the "k8s.volume.name"
semantic conventions. It represents the name of the K8s volume.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "volume0"
K8SVolumeTypeKey is the attribute Key conforming to the "k8s.volume.type"
semantic conventions. It represents the type of the K8s volume.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "emptyDir", "persistentVolumeClaim"
LinuxMemorySlabStateKey is the attribute Key conforming to the
"linux.memory.slab.state" semantic conventions. It represents the Linux Slab
memory state.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "reclaimable", "unreclaimable"
LogFileNameKey is the attribute Key conforming to the "log.file.name"
semantic conventions. It represents the basename of the file.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "audit.log"
LogFileNameResolvedKey is the attribute Key conforming to the
"log.file.name_resolved" semantic conventions. It represents the basename of
the file, with symlinks resolved.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "uuid.log"
LogFilePathKey is the attribute Key conforming to the "log.file.path"
semantic conventions. It represents the full path to the file.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/var/log/mysql/audit.log"
LogFilePathResolvedKey is the attribute Key conforming to the
"log.file.path_resolved" semantic conventions. It represents the full path to
the file, with symlinks resolved.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/var/lib/docker/uuid.log"
LogIostreamKey is the attribute Key conforming to the "log.iostream" semantic
conventions. It represents the stream associated with the log. See below for
a list of well-known values.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
LogRecordOriginalKey is the attribute Key conforming to the
"log.record.original" semantic conventions. It represents the complete
original Log Record.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - -
Something happened", "[INFO] 8/3/24 12:34:56 Something happened"
Note: This value MAY be added when processing a Log Record which was
originally transmitted as a string or equivalent data type AND the Body field
of the Log Record does not contain the same value. (e.g. a syslog or a log
record read from a file.)
LogRecordUIDKey is the attribute Key conforming to the "log.record.uid"
semantic conventions. It represents a unique identifier for the Log Record.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "01ARZ3NDEKTSV4RRFFQ69G5FAV"
Note: If an id is provided, other log records with the same id will be
considered duplicates and can be removed safely. This means, that two
distinguishable log records MUST have different values.
The id MAY be an
[Universally Unique Lexicographically Sortable Identifier (ULID)], but other
identifiers (e.g. UUID) may be used as needed.
MainframeLparNameKey is the attribute Key conforming to the
"mainframe.lpar.name" semantic conventions. It represents the name of the
logical partition that hosts a systems with a mainframe operating system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "LPAR01"
MessagingBatchMessageCountKey is the attribute Key conforming to the
"messaging.batch.message_count" semantic conventions. It represents the
number of messages sent, received, or processed in the scope of the batching
operation.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 0, 1, 2
Note: Instrumentations SHOULD NOT set `messaging.batch.message_count` on
spans that operate with a single message. When a messaging client library
supports both batch and single-message API for the same operation,
instrumentations SHOULD use `messaging.batch.message_count` for batching APIs
and SHOULD NOT use it for single-message APIs.
MessagingClientIDKey is the attribute Key conforming to the
"messaging.client.id" semantic conventions. It represents a unique identifier
for the client that consumes or produces a message.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "client-5", "myhost@8742@s8083jm"
MessagingConsumerGroupNameKey is the attribute Key conforming to the
"messaging.consumer.group.name" semantic conventions. It represents the name
of the consumer group with which a consumer is associated.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-group", "indexer"
Note: Semantic conventions for individual messaging systems SHOULD document
whether `messaging.consumer.group.name` is applicable and what it means in
the context of that system.
MessagingDestinationAnonymousKey is the attribute Key conforming to the
"messaging.destination.anonymous" semantic conventions. It represents a
boolean that is true if the message destination is anonymous (could be
unnamed or have auto-generated name).
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
MessagingDestinationNameKey is the attribute Key conforming to the
"messaging.destination.name" semantic conventions. It represents the message
destination name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "MyQueue", "MyTopic"
Note: Destination name SHOULD uniquely identify a specific queue, topic or
other entity within the broker. If
the broker doesn't have such notion, the destination name SHOULD uniquely
identify the broker.
MessagingDestinationPartitionIDKey is the attribute Key conforming to the
"messaging.destination.partition.id" semantic conventions. It represents the
identifier of the partition messages are sent to or received from, unique
within the `messaging.destination.name`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 1
MessagingDestinationSubscriptionNameKey is the attribute Key conforming to
the "messaging.destination.subscription.name" semantic conventions. It
represents the name of the destination subscription from which a message is
consumed.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "subscription-a"
Note: Semantic conventions for individual messaging systems SHOULD document
whether `messaging.destination.subscription.name` is applicable and what it
means in the context of that system.
MessagingDestinationTemplateKey is the attribute Key conforming to the
"messaging.destination.template" semantic conventions. It represents the low
cardinality representation of the messaging destination name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/customers/{customerId}"
Note: Destination names could be constructed from templates. An example would
be a destination name involving a user name or product id. Although the
destination name in this case is of high cardinality, the underlying template
is of low cardinality and can be effectively used for grouping and
aggregation.
MessagingDestinationTemporaryKey is the attribute Key conforming to the
"messaging.destination.temporary" semantic conventions. It represents a
boolean that is true if the message destination is temporary and might not
exist anymore after messages are processed.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
MessagingEventHubsMessageEnqueuedTimeKey is the attribute Key conforming to
the "messaging.eventhubs.message.enqueued_time" semantic conventions. It
represents the UTC epoch seconds at which the message has been accepted and
stored in the entity.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingGCPPubSubMessageAckDeadlineKey is the attribute Key conforming to
the "messaging.gcp_pubsub.message.ack_deadline" semantic conventions. It
represents the ack deadline in seconds set for the modify ack deadline
request.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingGCPPubSubMessageAckIDKey is the attribute Key conforming to the
"messaging.gcp_pubsub.message.ack_id" semantic conventions. It represents the
ack id for a given message.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: ack_id
MessagingGCPPubSubMessageDeliveryAttemptKey is the attribute Key conforming
to the "messaging.gcp_pubsub.message.delivery_attempt" semantic conventions.
It represents the delivery attempt for a given message.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingGCPPubSubMessageOrderingKeyKey is the attribute Key conforming to
the "messaging.gcp_pubsub.message.ordering_key" semantic conventions. It
represents the ordering key for a given message. If the attribute is not
present, the message does not have an ordering key.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: ordering_key
MessagingKafkaMessageKeyKey is the attribute Key conforming to the
"messaging.kafka.message.key" semantic conventions. It represents the 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.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: myKey
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.
MessagingKafkaMessageTombstoneKey is the attribute Key conforming to the
"messaging.kafka.message.tombstone" semantic conventions. It represents a
boolean that is true if the message is a tombstone.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
MessagingKafkaOffsetKey is the attribute Key conforming to the
"messaging.kafka.offset" semantic conventions. It represents the offset of a
record in the corresponding Kafka partition.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingMessageBodySizeKey is the attribute Key conforming to the
"messaging.message.body.size" semantic conventions. It represents the size of
the message body in bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Note: This can refer to both the compressed or uncompressed body size. If
both sizes are known, the uncompressed
body size should be used.
MessagingMessageConversationIDKey is the attribute Key conforming to the
"messaging.message.conversation_id" semantic conventions. It represents the
conversation ID identifying the conversation to which the message belongs,
represented as a string. Sometimes called "Correlation ID".
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: MyConversationId
MessagingMessageEnvelopeSizeKey is the attribute Key conforming to the
"messaging.message.envelope.size" semantic conventions. It represents the
size of the message body and metadata in bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Note: This can refer to both the compressed or uncompressed size. If both
sizes are known, the uncompressed
size should be used.
MessagingMessageIDKey is the attribute Key conforming to the
"messaging.message.id" semantic conventions. It represents a value used by
the messaging system as an identifier for the message, represented as a
string.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 452a7c7c7c7048c2f887f61572b18fc2
MessagingOperationNameKey is the attribute Key conforming to the
"messaging.operation.name" semantic conventions. It represents the
system-specific name of the messaging operation.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "ack", "nack", "send"
MessagingOperationTypeKey is the attribute Key conforming to the
"messaging.operation.type" semantic conventions. It represents a string
identifying the type of the messaging operation.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: If a custom value is used, it MUST be of low cardinality.
MessagingRabbitMQDestinationRoutingKeyKey is the attribute Key conforming to
the "messaging.rabbitmq.destination.routing_key" semantic conventions. It
represents the rabbitMQ message routing key.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: myKey
MessagingRabbitMQMessageDeliveryTagKey is the attribute Key conforming to the
"messaging.rabbitmq.message.delivery_tag" semantic conventions. It represents
the rabbitMQ message delivery tag.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingRocketMQConsumptionModelKey is the attribute Key conforming to the
"messaging.rocketmq.consumption_model" semantic conventions. It represents
the model of message consumption. This only applies to consumer spans.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
MessagingRocketMQMessageDelayTimeLevelKey is the attribute Key conforming to
the "messaging.rocketmq.message.delay_time_level" semantic conventions. It
represents the delay time level for delay message, which determines the
message delay time.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingRocketMQMessageDeliveryTimestampKey is the attribute Key conforming
to the "messaging.rocketmq.message.delivery_timestamp" semantic conventions.
It represents the timestamp in milliseconds that the delay message is
expected to be delivered to consumer.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingRocketMQMessageGroupKey is the attribute Key conforming to the
"messaging.rocketmq.message.group" semantic conventions. It represents the 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.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: myMessageGroup
MessagingRocketMQMessageKeysKey is the attribute Key conforming to the
"messaging.rocketmq.message.keys" semantic conventions. It represents the
key(s) of message, another way to mark message besides message id.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "keyA", "keyB"
MessagingRocketMQMessageTagKey is the attribute Key conforming to the
"messaging.rocketmq.message.tag" semantic conventions. It represents the
secondary classifier of message besides topic.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: tagA
MessagingRocketMQMessageTypeKey is the attribute Key conforming to the
"messaging.rocketmq.message.type" semantic conventions. It represents the
type of message.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
MessagingRocketMQNamespaceKey is the attribute Key conforming to the
"messaging.rocketmq.namespace" semantic conventions. It represents the
namespace of RocketMQ resources, resources in different namespaces are
individual.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: myNamespace
MessagingServiceBusDispositionStatusKey is the attribute Key conforming to
the "messaging.servicebus.disposition_status" semantic conventions. It
represents the describes the [settlement type].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
MessagingServiceBusMessageDeliveryCountKey is the attribute Key conforming to
the "messaging.servicebus.message.delivery_count" semantic conventions. It
represents the number of deliveries that have been attempted for this
message.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingServiceBusMessageEnqueuedTimeKey is the attribute Key conforming to
the "messaging.servicebus.message.enqueued_time" semantic conventions. It
represents the UTC epoch seconds at which the message has been accepted and
stored in the entity.
Type: int
RequirementLevel: Recommended
Stability: Development
MessagingSystemKey is the attribute Key conforming to the "messaging.system"
semantic conventions. It represents the messaging system as identified by the
client instrumentation.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: The actual messaging system may differ from the one known by the
client. For example, when using Kafka client libraries to communicate with
Azure Event Hubs, the `messaging.system` is set to `kafka` based on the
instrumentation's best knowledge.
NetworkCarrierICCKey is the attribute Key conforming to the
"network.carrier.icc" semantic conventions. It represents the ISO 3166-1
alpha-2 2-character country code associated with the mobile carrier network.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: DE
NetworkCarrierMCCKey is the attribute Key conforming to the
"network.carrier.mcc" semantic conventions. It represents the mobile carrier
country code.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 310
NetworkCarrierMNCKey is the attribute Key conforming to the
"network.carrier.mnc" semantic conventions. It represents the mobile carrier
network code.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 001
NetworkCarrierNameKey is the attribute Key conforming to the
"network.carrier.name" semantic conventions. It represents the name of the
mobile carrier.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: sprint
NetworkConnectionStateKey is the attribute Key conforming to the
"network.connection.state" semantic conventions. It represents the state of
network connection.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "close_wait"
Note: Connection states are defined as part of the [rfc9293]
NetworkConnectionSubtypeKey is the attribute Key conforming to the
"network.connection.subtype" semantic conventions. It represents the 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.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: LTE
NetworkConnectionTypeKey is the attribute Key conforming to the
"network.connection.type" semantic conventions. It represents the internet
connection type.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: wifi
NetworkInterfaceNameKey is the attribute Key conforming to the
"network.interface.name" semantic conventions. It represents the network
interface name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "lo", "eth0"
NetworkIODirectionKey is the attribute Key conforming to the
"network.io.direction" semantic conventions. It represents the network IO
operation direction.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "transmit"
NetworkLocalAddressKey is the attribute Key conforming to the
"network.local.address" semantic conventions. It represents the local address
of the network connection - IP address or Unix domain socket name.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "10.1.2.80", "/tmp/my.sock"
NetworkLocalPortKey is the attribute Key conforming to the
"network.local.port" semantic conventions. It represents the local port
number of the network connection.
Type: int
RequirementLevel: Recommended
Stability: Stable
Examples: 65123
NetworkPeerAddressKey is the attribute Key conforming to the
"network.peer.address" semantic conventions. It represents the peer address
of the network connection - IP address or Unix domain socket name.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "10.1.2.80", "/tmp/my.sock"
NetworkPeerPortKey is the attribute Key conforming to the "network.peer.port"
semantic conventions. It represents the peer port number of the network
connection.
Type: int
RequirementLevel: Recommended
Stability: Stable
Examples: 65123
NetworkProtocolNameKey is the attribute Key conforming to the
"network.protocol.name" semantic conventions. It represents the
[OSI application layer] or non-OSI equivalent.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "amqp", "http", "mqtt"
Note: The value SHOULD be normalized to lowercase.
NetworkProtocolVersionKey is the attribute Key conforming to the
"network.protocol.version" semantic conventions. It represents the actual
version of the protocol used for network communication.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "1.1", "2"
Note: If protocol version is subject to negotiation (for example using [ALPN]
), this attribute SHOULD be set to the negotiated version. If the actual
protocol version is not known, this attribute SHOULD NOT be set.
NetworkTransportKey is the attribute Key conforming to the
"network.transport" semantic conventions. It represents the
[OSI transport layer] or [inter-process communication method].
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples: "tcp", "udp"
Note: The value SHOULD be normalized to lowercase.
Consider always setting the transport when setting a port number, since
a port number is ambiguous without knowing the transport. For example
different processes could be listening on TCP port 12345 and UDP port 12345.
NetworkTypeKey is the attribute Key conforming to the "network.type" semantic
conventions. It represents the [OSI network layer] or non-OSI equivalent.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples: "ipv4", "ipv6"
Note: The value SHOULD be normalized to lowercase.
OCIManifestDigestKey is the attribute Key conforming to the
"oci.manifest.digest" semantic conventions. It represents the digest of the
OCI image manifest. For container images specifically is the digest by which
the container image is known.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4"
Note: Follows [OCI Image Manifest Specification], and specifically the
[Digest property].
An example can be found in [Example Image Manifest].
OpenAIRequestServiceTierKey is the attribute Key conforming to the
"openai.request.service_tier" semantic conventions. It represents the service
tier requested. May be a specific tier, default, or auto.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "auto", "default"
OpenAIResponseServiceTierKey is the attribute Key conforming to the
"openai.response.service_tier" semantic conventions. It represents the
service tier used for the response.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "scale", "default"
OpenAIResponseSystemFingerprintKey is the attribute Key conforming to the
"openai.response.system_fingerprint" semantic conventions. It represents a
fingerprint to track any eventual change in the Generative AI environment.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "fp_44709d6fcb"
OpenTracingRefTypeKey is the attribute Key conforming to the
"opentracing.ref_type" semantic conventions. It represents the parent-child
Reference type.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: The causal relationship between a child Span and a parent Span.
OSBuildIDKey is the attribute Key conforming to the "os.build_id" semantic
conventions. It represents the unique identifier for a particular build or
compilation of the operating system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "TQ3C.230805.001.B2", "20E247", "22621"
OSDescriptionKey is the attribute Key conforming to the "os.description"
semantic conventions. It represents the human readable (not intended to be
parsed) OS version information, like e.g. reported by `ver` or
`lsb_release -a` commands.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Microsoft Windows [Version 10.0.18363.778]", "Ubuntu 18.04.1 LTS"
OSNameKey is the attribute Key conforming to the "os.name" semantic
conventions. It represents the human readable operating system name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "iOS", "Android", "Ubuntu"
OSTypeKey is the attribute Key conforming to the "os.type" semantic
conventions. It represents the operating system type.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
OSVersionKey is the attribute Key conforming to the "os.version" semantic
conventions. It represents the version string of the operating system as
defined in [Version Attributes].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "14.2.1", "18.04.1"
[Version Attributes]: /docs/resource/README.md#version-attributes
OTelComponentNameKey is the attribute Key conforming to the
"otel.component.name" semantic conventions. It represents a name uniquely
identifying the instance of the OpenTelemetry component within its containing
SDK instance.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "otlp_grpc_span_exporter/0", "custom-name"
Note: Implementations SHOULD ensure a low cardinality for this attribute,
even across application or SDK restarts.
E.g. implementations MUST NOT use UUIDs as values for this attribute.
Implementations MAY achieve these goals by following a
`<otel.component.type>/<instance-counter>` pattern, e.g.
`batching_span_processor/0`.
Hereby `otel.component.type` refers to the corresponding attribute value of
the component.
The value of `instance-counter` MAY be automatically assigned by the
component and uniqueness within the enclosing SDK instance MUST be
guaranteed.
For example, `<instance-counter>` MAY be implemented by using a monotonically
increasing counter (starting with `0`), which is incremented every time an
instance of the given component type is started.
With this implementation, for example the first Batching Span Processor would
have `batching_span_processor/0`
as `otel.component.name`, the second one `batching_span_processor/1` and so
on.
These values will therefore be reused in the case of an application restart.
OTelComponentTypeKey is the attribute Key conforming to the
"otel.component.type" semantic conventions. It represents a name identifying
the type of the OpenTelemetry component.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "batching_span_processor", "com.example.MySpanExporter"
Note: If none of the standardized values apply, implementations SHOULD use
the language-defined name of the type.
E.g. for Java the fully qualified classname SHOULD be used in this case.
OTelScopeNameKey is the attribute Key conforming to the "otel.scope.name"
semantic conventions. It represents the name of the instrumentation scope - (
`InstrumentationScope.Name` in OTLP).
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "io.opentelemetry.contrib.mongodb"
OTelScopeSchemaURLKey is the attribute Key conforming to the
"otel.scope.schema_url" semantic conventions. It represents the schema URL of
the instrumentation scope.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "https://opentelemetry.io/schemas/1.31.0"
OTelScopeVersionKey is the attribute Key conforming to the
"otel.scope.version" semantic conventions. It represents the version of the
instrumentation scope - (`InstrumentationScope.Version` in OTLP).
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "1.0.0"
OTelSpanParentOriginKey is the attribute Key conforming to the
"otel.span.parent.origin" semantic conventions. It represents the determines
whether the span has a parent span, and if so,
[whether it is a remote parent].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
OTelSpanSamplingResultKey is the attribute Key conforming to the
"otel.span.sampling_result" semantic conventions. It represents the result
value of the sampler for this span.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
OTelStatusCodeKey is the attribute Key conforming to the "otel.status_code"
semantic conventions. It represents the name of the code, either "OK" or
"ERROR". MUST NOT be set if the status code is UNSET.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples:
OTelStatusDescriptionKey is the attribute Key conforming to the
"otel.status_description" semantic conventions. It represents the description
of the Status if it has a value, otherwise not set.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "resource not found"
PeerServiceKey is the attribute Key conforming to the "peer.service" semantic
conventions. It represents the [`service.name`] of the remote service. SHOULD
be equal to the actual `service.name` resource attribute of the remote
service if any.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: AuthTokenCache
[`service.name`]: /docs/resource/README.md#service
ProcessArgsCountKey is the attribute Key conforming to the
"process.args_count" semantic conventions. It represents the length of the
process.command_args array.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 4
Note: This field can be useful for querying or performing bucket analysis on
how many arguments were provided to start a process. More arguments may be an
indication of suspicious activity.
ProcessCommandArgsKey is the attribute Key conforming to the
"process.command_args" semantic conventions. It represents the all the
command arguments (including the command/executable itself) as received by
the process. On Linux-based systems (and some other Unixoid systems
supporting procfs), can be set according to the list of null-delimited
strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this
would be the full argv vector passed to `main`. SHOULD NOT be collected by
default unless there is sanitization that excludes sensitive data.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "cmd/otecol", "--config=config.yaml"
ProcessCommandKey is the attribute Key conforming to the "process.command"
semantic conventions. It represents the command used to launch the process
(i.e. the command name). On Linux based systems, can be set to the zeroth
string in `proc/[pid]/cmdline`. On Windows, can be set to the first parameter
extracted from `GetCommandLineW`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "cmd/otelcol"
ProcessCommandLineKey is the attribute Key conforming to the
"process.command_line" semantic conventions. It represents the full command
used to launch the process as a single string representing the full command.
On Windows, can be set to the result of `GetCommandLineW`. Do not set this if
you have to assemble it just for monitoring; use `process.command_args`
instead. SHOULD NOT be collected by default unless there is sanitization that
excludes sensitive data.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "C:\cmd\otecol --config="my directory\config.yaml""
ProcessContextSwitchTypeKey is the attribute Key conforming to the
"process.context_switch_type" semantic conventions. It represents the
specifies whether the context switches for this data point were voluntary or
involuntary.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
ProcessCreationTimeKey is the attribute Key conforming to the
"process.creation.time" semantic conventions. It represents the date and time
the process was created, in ISO 8601 format.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2023-11-21T09:25:34.853Z"
ProcessExecutableBuildIDGNUKey is the attribute Key conforming to the
"process.executable.build_id.gnu" semantic conventions. It represents the GNU
build ID as found in the `.note.gnu.build-id` ELF section (hex string).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "c89b11207f6479603b0d49bf291c092c2b719293"
ProcessExecutableBuildIDGoKey is the attribute Key conforming to the
"process.executable.build_id.go" semantic conventions. It represents the Go
build ID as retrieved by `go tool buildid <go executable>`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY"
ProcessExecutableBuildIDHtlhashKey is the attribute Key conforming to the
"process.executable.build_id.htlhash" semantic conventions. It represents the
profiling specific build ID for executables. See the OTel specification for
Profiles for more information.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "600DCAFE4A110000F2BF38C493F5FB92"
ProcessExecutableNameKey is the attribute Key conforming to the
"process.executable.name" semantic conventions. It represents the name of the
process executable. On Linux based systems, this SHOULD be set to the base
name of the target of `/proc/[pid]/exe`. On Windows, this SHOULD be set to
the base name of `GetProcessImageFileNameW`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "otelcol"
ProcessExecutablePathKey is the attribute Key conforming to the
"process.executable.path" semantic conventions. It represents the full path
to the process executable. On Linux based systems, can be set to the target
of `proc/[pid]/exe`. On Windows, can be set to the result of
`GetProcessImageFileNameW`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/usr/bin/cmd/otelcol"
ProcessExitCodeKey is the attribute Key conforming to the "process.exit.code"
semantic conventions. It represents the exit code of the process.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 127
ProcessExitTimeKey is the attribute Key conforming to the "process.exit.time"
semantic conventions. It represents the date and time the process exited, in
ISO 8601 format.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2023-11-21T09:26:12.315Z"
ProcessGroupLeaderPIDKey is the attribute Key conforming to the
"process.group_leader.pid" semantic conventions. It represents the PID of the
process's group leader. This is also the process group ID (PGID) of the
process.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 23
ProcessInteractiveKey is the attribute Key conforming to the
"process.interactive" semantic conventions. It represents the whether the
process is connected to an interactive shell.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples:
ProcessLinuxCgroupKey is the attribute Key conforming to the
"process.linux.cgroup" semantic conventions. It represents the control group
associated with the process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1:name=systemd:/user.slice/user-1000.slice/session-3.scope",
"0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope"
Note: Control groups (cgroups) are a kernel feature used to organize and
manage process resources. This attribute provides the path(s) to the
cgroup(s) associated with the process, which should match the contents of the
[/proc/[PID]/cgroup] file.
[/proc/[PID]/cgroup]: https://man7.org/linux/man-pages/man7/cgroups.7.html
ProcessOwnerKey is the attribute Key conforming to the "process.owner"
semantic conventions. It represents the username of the user that owns the
process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "root"
ProcessPagingFaultTypeKey is the attribute Key conforming to the
"process.paging.fault_type" semantic conventions. It represents the type of
page fault for this data point. Type `major` is for major/hard page faults,
and `minor` is for minor/soft page faults.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
ProcessParentPIDKey is the attribute Key conforming to the
"process.parent_pid" semantic conventions. It represents the parent Process
identifier (PPID).
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 111
ProcessPIDKey is the attribute Key conforming to the "process.pid" semantic
conventions. It represents the process identifier (PID).
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1234
ProcessRealUserIDKey is the attribute Key conforming to the
"process.real_user.id" semantic conventions. It represents the real user ID
(RUID) of the process.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1000
ProcessRealUserNameKey is the attribute Key conforming to the
"process.real_user.name" semantic conventions. It represents the username of
the real user of the process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "operator"
ProcessRuntimeDescriptionKey is the attribute Key conforming to the
"process.runtime.description" semantic conventions. It represents an
additional description about the runtime of the process, for example a
specific vendor customization of the runtime environment.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0
ProcessRuntimeNameKey is the attribute Key conforming to the
"process.runtime.name" semantic conventions. It represents the name of the
runtime of this process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "OpenJDK Runtime Environment"
ProcessRuntimeVersionKey is the attribute Key conforming to the
"process.runtime.version" semantic conventions. It represents the version of
the runtime of this process, as returned by the runtime without modification.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 14.0.2
ProcessSavedUserIDKey is the attribute Key conforming to the
"process.saved_user.id" semantic conventions. It represents the saved user ID
(SUID) of the process.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1002
ProcessSavedUserNameKey is the attribute Key conforming to the
"process.saved_user.name" semantic conventions. It represents the username of
the saved user.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "operator"
ProcessSessionLeaderPIDKey is the attribute Key conforming to the
"process.session_leader.pid" semantic conventions. It represents the PID of
the process's session leader. This is also the session ID (SID) of the
process.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 14
ProcessTitleKey is the attribute Key conforming to the "process.title"
semantic conventions. It represents the process title (proctitle).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "cat /etc/hostname", "xfce4-session", "bash"
Note: In many Unix-like systems, process title (proctitle), is the string
that represents the name or command line of a running process, displayed by
system monitoring tools like ps, top, and htop.
ProcessUserIDKey is the attribute Key conforming to the "process.user.id"
semantic conventions. It represents the effective user ID (EUID) of the
process.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1001
ProcessUserNameKey is the attribute Key conforming to the "process.user.name"
semantic conventions. It represents the username of the effective user of the
process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "root"
ProcessVpidKey is the attribute Key conforming to the "process.vpid" semantic
conventions. It represents the virtual process identifier.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 12
Note: The process ID within a PID namespace. This is not necessarily unique
across all processes on the host but it is unique within the process
namespace that the process exists within.
ProcessWorkingDirectoryKey is the attribute Key conforming to the
"process.working_directory" semantic conventions. It represents the working
directory of the process.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/root"
ProfileFrameTypeKey is the attribute Key conforming to the
"profile.frame.type" semantic conventions. It represents the describes the
interpreter or compiler of a single frame.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "cpython"
RPCConnectRPCErrorCodeKey is the attribute Key conforming to the
"rpc.connect_rpc.error_code" semantic conventions. It represents the
[error codes] of the Connect request. Error codes are always string values.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
RPCGRPCStatusCodeKey is the attribute Key conforming to the
"rpc.grpc.status_code" semantic conventions. It represents the
[numeric status code] of the gRPC request.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
RPCJSONRPCErrorCodeKey is the attribute Key conforming to the
"rpc.jsonrpc.error_code" semantic conventions. It represents the `error.code`
property of response if it is an error response.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: -32700, 100
RPCJSONRPCErrorMessageKey is the attribute Key conforming to the
"rpc.jsonrpc.error_message" semantic conventions. It represents the
`error.message` property of response if it is an error response.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Parse error", "User already exists"
RPCJSONRPCRequestIDKey is the attribute Key conforming to the
"rpc.jsonrpc.request_id" semantic conventions. It represents the `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.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "10", "request-7", ""
RPCJSONRPCVersionKey is the attribute Key conforming to the
"rpc.jsonrpc.version" semantic conventions. It represents the protocol
version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0
doesn't specify this, the value can be omitted.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2.0", "1.0"
RPCMessageCompressedSizeKey is the attribute Key conforming to the
"rpc.message.compressed_size" semantic conventions. It represents the
compressed size of the message in bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples:
RPCMessageIDKey is the attribute Key conforming to the "rpc.message.id"
semantic conventions. It MUST be calculated as two different counters
starting from `1` one for sent messages and one for received message..
Type: int
RequirementLevel: Recommended
Stability: Development
Examples:
Note: This way we guarantee that the values will be consistent between
different implementations.
RPCMessageTypeKey is the attribute Key conforming to the "rpc.message.type"
semantic conventions. It represents the whether this is a received or sent
message.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
RPCMessageUncompressedSizeKey is the attribute Key conforming to the
"rpc.message.uncompressed_size" semantic conventions. It represents the
uncompressed size of the message in bytes.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples:
RPCMethodKey is the attribute Key conforming to the "rpc.method" semantic
conventions. It represents the name of the (logical) method being called,
must be equal to the $method part in the span name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: exampleMethod
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.name` 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).
RPCServiceKey is the attribute Key conforming to the "rpc.service" semantic
conventions. It represents the full (logical) name of the service being
called, including its package name, if applicable.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: myservice.EchoService
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).
RPCSystemKey is the attribute Key conforming to the "rpc.system" semantic
conventions. It represents a string identifying the remoting system. See
below for a list of well-known identifiers.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
SchemaURL is the schema URL that matches the version of the semantic conventions
that this package defines. Semconv packages starting from v1.4.0 must declare
non-empty schema URL in the form https://opentelemetry.io/schemas/<version>
SecurityRuleCategoryKey is the attribute Key conforming to the
"security_rule.category" semantic conventions. It represents a categorization
value keyword used by the entity using the rule for detection of this event.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Attempted Information Leak"
SecurityRuleDescriptionKey is the attribute Key conforming to the
"security_rule.description" semantic conventions. It represents the
description of the rule generating the event.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Block requests to public DNS over HTTPS / TLS protocols"
SecurityRuleLicenseKey is the attribute Key conforming to the
"security_rule.license" semantic conventions. It represents the name of the
license under which the rule used to generate this event is made available.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Apache 2.0"
SecurityRuleNameKey is the attribute Key conforming to the
"security_rule.name" semantic conventions. It represents the name of the rule
or signature generating the event.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "BLOCK_DNS_over_TLS"
SecurityRuleReferenceKey is the attribute Key conforming to the
"security_rule.reference" semantic conventions. It represents the reference
URL to additional information about the rule used to generate this event.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "https://en.wikipedia.org/wiki/DNS_over_TLS"
Note: The URL can point to the vendor’s documentation about the rule. If
that’s not available, it can also be a link to a more general page
describing this type of alert.
SecurityRuleRulesetNameKey is the attribute Key conforming to the
"security_rule.ruleset.name" semantic conventions. It represents the name of
the ruleset, policy, group, or parent category in which the rule used to
generate this event is a member.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Standard_Protocol_Filters"
SecurityRuleUUIDKey is the attribute Key conforming to the
"security_rule.uuid" semantic conventions. It represents a rule ID that is
unique within the scope of a set or group of agents, observers, or other
entities using the rule for detection of this event.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "550e8400-e29b-41d4-a716-446655440000", "1100110011"
SecurityRuleVersionKey is the attribute Key conforming to the
"security_rule.version" semantic conventions. It represents the version /
revision of the rule being used for analysis.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1.0.0"
ServerAddressKey is the attribute Key conforming to the "server.address"
semantic conventions. It represents the server domain name if available
without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "example.com", "10.1.2.80", "/tmp/my.sock"
Note: When observed from the client side, and when communicating through an
intermediary, `server.address` SHOULD represent the server address behind any
intermediaries, for example proxies, if it's available.
ServerPortKey is the attribute Key conforming to the "server.port" semantic
conventions. It represents the server port number.
Type: int
RequirementLevel: Recommended
Stability: Stable
Examples: 80, 8080, 443
Note: When observed from the client side, and when communicating through an
intermediary, `server.port` SHOULD represent the server port behind any
intermediaries, for example proxies, if it's available.
ServiceInstanceIDKey is the attribute Key conforming to the
"service.instance.id" semantic conventions. It represents the string ID of
the service instance.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "627cc493-f310-47de-96bd-71410b7dec09"
Note: MUST be unique for each instance of the same
`service.namespace,service.name` pair (in other words
`service.namespace,service.name,service.instance.id` triplet MUST be globally
unique). The ID helps to
distinguish instances of the same service that exist at the same time (e.g.
instances of a horizontally scaled
service).
Implementations, such as SDKs, are recommended to generate a random Version 1
or Version 4 [RFC
4122] UUID, but are free to use an inherent unique ID as
the source of
this value if stability is desirable. In that case, the ID SHOULD be used as
source of a UUID Version 5 and
SHOULD use the following UUID as the namespace:
`4d63009a-8d0f-11ee-aad7-4c796ed8e320`.
UUIDs are typically recommended, as only an opaque value for the purposes of
identifying a service instance is
needed. Similar to what can be seen in the man page for the
[`/etc/machine-id`] file, the underlying
data, such as pod name and namespace should be treated as confidential, being
the user's choice to expose it
or not via another resource attribute.
For applications running behind an application server (like unicorn), we do
not recommend using one identifier
for all processes participating in the application. Instead, it's recommended
each division (e.g. a worker
thread in unicorn) to have its own instance.id.
It's not recommended for a Collector to set `service.instance.id` if it can't
unambiguously determine the
service instance that is generating that telemetry. For instance, creating an
UUID based on `pod.name` will
likely be wrong, as the Collector might not know from which container within
that pod the telemetry originated.
However, Collectors can set the `service.instance.id` if they can
unambiguously determine the service instance
for that telemetry. This is typically the case for scraping receivers, as
they know the target address and
port.
[RFC
4122]: https://www.ietf.org/rfc/rfc4122.txt
[`/etc/machine-id`]: https://www.freedesktop.org/software/systemd/man/latest/machine-id.html
ServiceNameKey is the attribute Key conforming to the "service.name" semantic
conventions. It represents the logical name of the service.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "shoppingcart"
Note: MUST be the same for all instances of horizontally scaled services. If
the value was not specified, SDKs MUST fallback to `unknown_service:`
concatenated with [`process.executable.name`], e.g. `unknown_service:bash`.
If `process.executable.name` is not available, the value MUST be set to
`unknown_service`.
[`process.executable.name`]: process.md
ServiceNamespaceKey is the attribute Key conforming to the
"service.namespace" semantic conventions. It represents a namespace for
`service.name`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Shop"
Note: A string value having a meaning that helps to distinguish a group of
services, for example the team name that owns a group of services.
`service.name` is expected to be unique within the same namespace. If
`service.namespace` is not specified in the Resource then `service.name` is
expected to be unique for all services that have no explicit namespace
defined (so the empty/unspecified namespace is simply one more valid
namespace). Zero-length namespace string is assumed equal to unspecified
namespace.
ServiceVersionKey is the attribute Key conforming to the "service.version"
semantic conventions. It represents the version string of the service API or
implementation. The format is not defined by these conventions.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "2.0.0", "a01dbef8a"
SessionIDKey is the attribute Key conforming to the "session.id" semantic
conventions. It represents a unique id to identify a session.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 00112233-4455-6677-8899-aabbccddeeff
SessionPreviousIDKey is the attribute Key conforming to the
"session.previous_id" semantic conventions. It represents the previous
`session.id` for this user, when known.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: 00112233-4455-6677-8899-aabbccddeeff
SignalRConnectionStatusKey is the attribute Key conforming to the
"signalr.connection.status" semantic conventions. It represents the signalR
HTTP connection closure status.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples: "app_shutdown", "timeout"
SignalRTransportKey is the attribute Key conforming to the
"signalr.transport" semantic conventions. It represents the
[SignalR transport type].
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples: "web_sockets", "long_polling"
SourceAddressKey is the attribute Key conforming to the "source.address"
semantic conventions. It represents the source address - domain name if
available without reverse DNS lookup; otherwise, IP address or Unix domain
socket name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "source.example.com", "10.1.2.80", "/tmp/my.sock"
Note: When observed from the destination side, and when communicating through
an intermediary, `source.address` SHOULD represent the source address behind
any intermediaries, for example proxies, if it's available.
SourcePortKey is the attribute Key conforming to the "source.port" semantic
conventions. It represents the source port number.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 3389, 2888
SystemCPULogicalNumberKey is the attribute Key conforming to the
"system.cpu.logical_number" semantic conventions. It represents the
deprecated, use `cpu.logical_number` instead.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 1
SystemDeviceKey is the attribute Key conforming to the "system.device"
semantic conventions. It represents the device identifier.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "(identifier)"
SystemFilesystemModeKey is the attribute Key conforming to the
"system.filesystem.mode" semantic conventions. It represents the filesystem
mode.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "rw, ro"
SystemFilesystemMountpointKey is the attribute Key conforming to the
"system.filesystem.mountpoint" semantic conventions. It represents the
filesystem mount path.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/mnt/data"
SystemFilesystemStateKey is the attribute Key conforming to the
"system.filesystem.state" semantic conventions. It represents the filesystem
state.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "used"
SystemFilesystemTypeKey is the attribute Key conforming to the
"system.filesystem.type" semantic conventions. It represents the filesystem
type.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "ext4"
SystemMemoryStateKey is the attribute Key conforming to the
"system.memory.state" semantic conventions. It represents the memory state.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "free", "cached"
SystemPagingDirectionKey is the attribute Key conforming to the
"system.paging.direction" semantic conventions. It represents the paging
access direction.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "in"
SystemPagingStateKey is the attribute Key conforming to the
"system.paging.state" semantic conventions. It represents the memory paging
state.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "free"
SystemPagingTypeKey is the attribute Key conforming to the
"system.paging.type" semantic conventions. It represents the memory paging
type.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "minor"
SystemProcessStatusKey is the attribute Key conforming to the
"system.process.status" semantic conventions. It represents the process
state, e.g., [Linux Process State Codes].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "running"
TelemetryDistroNameKey is the attribute Key conforming to the
"telemetry.distro.name" semantic conventions. It represents the name of the
auto instrumentation agent or distribution, if used.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "parts-unlimited-java"
Note: Official auto instrumentation agents and distributions SHOULD set the
`telemetry.distro.name` attribute to
a string starting with `opentelemetry-`, e.g.
`opentelemetry-java-instrumentation`.
TelemetryDistroVersionKey is the attribute Key conforming to the
"telemetry.distro.version" semantic conventions. It represents the version
string of the auto instrumentation agent or distribution, if used.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1.2.3"
TelemetrySDKLanguageKey is the attribute Key conforming to the
"telemetry.sdk.language" semantic conventions. It represents the language of
the telemetry SDK.
Type: Enum
RequirementLevel: Recommended
Stability: Stable
Examples:
TelemetrySDKNameKey is the attribute Key conforming to the
"telemetry.sdk.name" semantic conventions. It represents the name of the
telemetry SDK as defined above.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "opentelemetry"
Note: The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to
`opentelemetry`.
If another SDK, like a fork or a vendor-provided implementation, is used,
this SDK MUST set the
`telemetry.sdk.name` attribute to the fully-qualified class or module name of
this SDK's main entry point
or another suitable identifier depending on the language.
The identifier `opentelemetry` is reserved and MUST NOT be used in this case.
All custom identifiers SHOULD be stable across different versions of an
implementation.
TelemetrySDKVersionKey is the attribute Key conforming to the
"telemetry.sdk.version" semantic conventions. It represents the version
string of the telemetry SDK.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "1.2.3"
TestCaseNameKey is the attribute Key conforming to the "test.case.name"
semantic conventions. It represents the fully qualified human readable name
of the [test case].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "org.example.TestCase1.test1", "example/tests/TestCase1.test1",
"ExampleTestCase1_test1"
TestCaseResultStatusKey is the attribute Key conforming to the
"test.case.result.status" semantic conventions. It represents the status of
the actual test case result from test execution.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "pass", "fail"
TestSuiteNameKey is the attribute Key conforming to the "test.suite.name"
semantic conventions. It represents the human readable name of a [test suite]
.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "TestSuite1"
TestSuiteRunStatusKey is the attribute Key conforming to the
"test.suite.run.status" semantic conventions. It represents the status of the
test suite run.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "success", "failure", "skipped", "aborted", "timed_out",
"in_progress"
ThreadIDKey is the attribute Key conforming to the "thread.id" semantic
conventions. It represents the current "managed" thread ID (as opposed to OS
thread ID).
Type: int
RequirementLevel: Recommended
Stability: Development
ThreadNameKey is the attribute Key conforming to the "thread.name" semantic
conventions. It represents the current thread name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: main
TLSCipherKey is the attribute Key conforming to the "tls.cipher" semantic
conventions. It represents the string indicating the [cipher] used during the
current connection.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "TLS_RSA_WITH_3DES_EDE_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
Note: The values allowed for `tls.cipher` MUST be one of the `Descriptions`
of the [registered TLS Cipher Suits].
TLSClientCertificateChainKey is the attribute Key conforming to the
"tls.client.certificate_chain" semantic conventions. It represents the array
of PEM-encoded certificates that make up the certificate chain offered by the
client. This is usually mutually-exclusive of `client.certificate` since that
value should be the first certificate in the chain.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "MII...", "MI..."
TLSClientCertificateKey is the attribute Key conforming to the
"tls.client.certificate" semantic conventions. It represents the PEM-encoded
stand-alone certificate offered by the client. This is usually
mutually-exclusive of `client.certificate_chain` since this value also exists
in that list.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "MII..."
TLSClientHashMd5Key is the attribute Key conforming to the
"tls.client.hash.md5" semantic conventions. It represents the certificate
fingerprint using the MD5 digest of DER-encoded version of certificate
offered by the client. For consistency with other hash values, this value
should be formatted as an uppercase hash.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC"
TLSClientHashSha1Key is the attribute Key conforming to the
"tls.client.hash.sha1" semantic conventions. It represents the certificate
fingerprint using the SHA1 digest of DER-encoded version of certificate
offered by the client. For consistency with other hash values, this value
should be formatted as an uppercase hash.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "9E393D93138888D288266C2D915214D1D1CCEB2A"
TLSClientHashSha256Key is the attribute Key conforming to the
"tls.client.hash.sha256" semantic conventions. It represents the certificate
fingerprint using the SHA256 digest of DER-encoded version of certificate
offered by the client. For consistency with other hash values, this value
should be formatted as an uppercase hash.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0"
TLSClientIssuerKey is the attribute Key conforming to the "tls.client.issuer"
semantic conventions. It represents the distinguished name of [subject] of
the issuer of the x.509 certificate presented by the client.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com"
TLSClientJa3Key is the attribute Key conforming to the "tls.client.ja3"
semantic conventions. It represents a hash that identifies clients based on
how they perform an SSL/TLS handshake.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "d4e5b18d6b55c71272893221c96ba240"
TLSClientNotAfterKey is the attribute Key conforming to the
"tls.client.not_after" semantic conventions. It represents the date/Time
indicating when client certificate is no longer considered valid.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021-01-01T00:00:00.000Z"
TLSClientNotBeforeKey is the attribute Key conforming to the
"tls.client.not_before" semantic conventions. It represents the date/Time
indicating when client certificate is first considered valid.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1970-01-01T00:00:00.000Z"
TLSClientSubjectKey is the attribute Key conforming to the
"tls.client.subject" semantic conventions. It represents the distinguished
name of subject of the x.509 certificate presented by the client.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CN=myclient, OU=Documentation Team, DC=example, DC=com"
TLSClientSupportedCiphersKey is the attribute Key conforming to the
"tls.client.supported_ciphers" semantic conventions. It represents the array
of ciphers offered by the client during the client hello.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"
TLSCurveKey is the attribute Key conforming to the "tls.curve" semantic
conventions. It represents the string indicating the curve used for the given
cipher, when applicable.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "secp256r1"
TLSEstablishedKey is the attribute Key conforming to the "tls.established"
semantic conventions. It represents the boolean flag indicating if the TLS
negotiation was successful and transitioned to an encrypted tunnel.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples: true
TLSNextProtocolKey is the attribute Key conforming to the "tls.next_protocol"
semantic conventions. It represents the string indicating the protocol being
tunneled. Per the values in the [IANA registry], this string should be lower
case.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "http/1.1"
TLSProtocolNameKey is the attribute Key conforming to the "tls.protocol.name"
semantic conventions. It represents the normalized lowercase protocol name
parsed from original string of the negotiated [SSL/TLS protocol version].
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
TLSProtocolVersionKey is the attribute Key conforming to the
"tls.protocol.version" semantic conventions. It represents the numeric part
of the version parsed from the original string of the negotiated
[SSL/TLS protocol version].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1.2", "3"
TLSResumedKey is the attribute Key conforming to the "tls.resumed" semantic
conventions. It represents the boolean flag indicating if this TLS connection
was resumed from an existing TLS negotiation.
Type: boolean
RequirementLevel: Recommended
Stability: Development
Examples: true
TLSServerCertificateChainKey is the attribute Key conforming to the
"tls.server.certificate_chain" semantic conventions. It represents the array
of PEM-encoded certificates that make up the certificate chain offered by the
server. This is usually mutually-exclusive of `server.certificate` since that
value should be the first certificate in the chain.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "MII...", "MI..."
TLSServerCertificateKey is the attribute Key conforming to the
"tls.server.certificate" semantic conventions. It represents the PEM-encoded
stand-alone certificate offered by the server. This is usually
mutually-exclusive of `server.certificate_chain` since this value also exists
in that list.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "MII..."
TLSServerHashMd5Key is the attribute Key conforming to the
"tls.server.hash.md5" semantic conventions. It represents the certificate
fingerprint using the MD5 digest of DER-encoded version of certificate
offered by the server. For consistency with other hash values, this value
should be formatted as an uppercase hash.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC"
TLSServerHashSha1Key is the attribute Key conforming to the
"tls.server.hash.sha1" semantic conventions. It represents the certificate
fingerprint using the SHA1 digest of DER-encoded version of certificate
offered by the server. For consistency with other hash values, this value
should be formatted as an uppercase hash.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "9E393D93138888D288266C2D915214D1D1CCEB2A"
TLSServerHashSha256Key is the attribute Key conforming to the
"tls.server.hash.sha256" semantic conventions. It represents the certificate
fingerprint using the SHA256 digest of DER-encoded version of certificate
offered by the server. For consistency with other hash values, this value
should be formatted as an uppercase hash.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0"
TLSServerIssuerKey is the attribute Key conforming to the "tls.server.issuer"
semantic conventions. It represents the distinguished name of [subject] of
the issuer of the x.509 certificate presented by the client.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com"
TLSServerJa3sKey is the attribute Key conforming to the "tls.server.ja3s"
semantic conventions. It represents a hash that identifies servers based on
how they perform an SSL/TLS handshake.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "d4e5b18d6b55c71272893221c96ba240"
TLSServerNotAfterKey is the attribute Key conforming to the
"tls.server.not_after" semantic conventions. It represents the date/Time
indicating when server certificate is no longer considered valid.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "2021-01-01T00:00:00.000Z"
TLSServerNotBeforeKey is the attribute Key conforming to the
"tls.server.not_before" semantic conventions. It represents the date/Time
indicating when server certificate is first considered valid.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "1970-01-01T00:00:00.000Z"
TLSServerSubjectKey is the attribute Key conforming to the
"tls.server.subject" semantic conventions. It represents the distinguished
name of subject of the x.509 certificate presented by the server.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "CN=myserver, OU=Documentation Team, DC=example, DC=com"
URLDomainKey is the attribute Key conforming to the "url.domain" semantic
conventions. It represents the domain extracted from the `url.full`, such as
"opentelemetry.io".
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "www.foo.bar", "opentelemetry.io", "3.12.167.2",
"[1080:0:0:0:8:800:200C:417A]"
Note: In some cases a URL may refer to an IP and/or port directly, without a
domain name. In this case, the IP address would go to the domain field. If
the URL contains a [literal IPv6 address] enclosed by `[` and `]`, the `[`
and `]` characters should also be captured in the domain field.
URLExtensionKey is the attribute Key conforming to the "url.extension"
semantic conventions. It represents the file extension extracted from the
`url.full`, excluding the leading dot.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "png", "gz"
Note: The file extension is only set if it exists, as not every url has a
file extension. When the file name has multiple extensions `example.tar.gz`,
only the last one should be captured `gz`, not `tar.gz`.
URLFragmentKey is the attribute Key conforming to the "url.fragment" semantic
conventions. It represents the [URI fragment] component.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "SemConv"
URLFullKey is the attribute Key conforming to the "url.full" semantic
conventions. It represents the absolute URL describing a network resource
according to [RFC3986].
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "https://www.foo.bar/search?q=OpenTelemetry#SemConv", "//localhost"
Note: For network calls, URL usually has
`scheme://host[:port][path][?query][#fragment]` format, where the fragment
is not transmitted over HTTP, but if it is known, it SHOULD be included
nevertheless.
`url.full` MUST NOT contain credentials passed via URL in form of
`https://username:password@www.example.com/`.
In such case username and password SHOULD be redacted and attribute's value
SHOULD be `https://REDACTED:REDACTED@www.example.com/`.
`url.full` SHOULD capture the absolute URL when it is available (or can be
reconstructed).
Sensitive content provided in `url.full` SHOULD be scrubbed when
instrumentations can identify it.
Query string values for the following keys SHOULD be redacted by default and
replaced by the
value `REDACTED`:
- [`AWSAccessKeyId`]
- [`Signature`]
- [`sig`]
- [`X-Goog-Signature`]
This list is subject to change over time.
When a query string value is redacted, the query string key SHOULD still be
preserved, e.g.
`https://www.example.com/path?color=blue&sig=REDACTED`.
URLOriginalKey is the attribute Key conforming to the "url.original" semantic
conventions. It represents the unmodified original URL as seen in the event
source.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "https://www.foo.bar/search?q=OpenTelemetry#SemConv",
"search?q=OpenTelemetry"
Note: In network monitoring, the observed URL may be a full URL, whereas in
access logs, the URL is often just represented as a path. This field is meant
to represent the URL as it was observed, complete or not.
`url.original` might contain credentials passed via URL in form of
`https://username:password@www.example.com/`. In such case password and
username SHOULD NOT be redacted and attribute's value SHOULD remain the same.
URLPathKey is the attribute Key conforming to the "url.path" semantic
conventions. It represents the [URI path] component.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "/search"
Note: Sensitive content provided in `url.path` SHOULD be scrubbed when
instrumentations can identify it.
URLPortKey is the attribute Key conforming to the "url.port" semantic
conventions. It represents the port extracted from the `url.full`.
Type: int
RequirementLevel: Recommended
Stability: Development
Examples: 443
URLQueryKey is the attribute Key conforming to the "url.query" semantic
conventions. It represents the [URI query] component.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "q=OpenTelemetry"
Note: Sensitive content provided in `url.query` SHOULD be scrubbed when
instrumentations can identify it.
Query string values for the following keys SHOULD be redacted by default and
replaced by the value `REDACTED`:
- [`AWSAccessKeyId`]
- [`Signature`]
- [`sig`]
- [`X-Goog-Signature`]
This list is subject to change over time.
When a query string value is redacted, the query string key SHOULD still be
preserved, e.g.
`q=OpenTelemetry&sig=REDACTED`.
URLRegisteredDomainKey is the attribute Key conforming to the
"url.registered_domain" semantic conventions. It represents the highest
registered url domain, stripped of the subdomain.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "example.com", "foo.co.uk"
Note: This value can be determined precisely with the [public suffix list].
For example, the registered domain for `foo.example.com` is `example.com`.
Trying to approximate this by simply taking the last two labels will not work
well for TLDs such as `co.uk`.
URLSchemeKey is the attribute Key conforming to the "url.scheme" semantic
conventions. It represents the [URI scheme] component identifying the used
protocol.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "https", "ftp", "telnet"
URLSubdomainKey is the attribute Key conforming to the "url.subdomain"
semantic conventions. It represents the subdomain portion of a fully
qualified domain name includes all of the names except the host name under
the registered_domain. In a partially qualified domain, or if the
qualification level of the full name cannot be determined, subdomain contains
all of the names below the registered domain.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "east", "sub2.sub1"
Note: The subdomain portion of `www.east.mydomain.co.uk` is `east`. If the
domain has multiple levels of subdomain, such as `sub2.sub1.example.com`, the
subdomain field should contain `sub2.sub1`, with no trailing period.
URLTemplateKey is the attribute Key conforming to the "url.template" semantic
conventions. It represents the low-cardinality template of an
[absolute path reference].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "/users/{id}", "/users/:id", "/users?id={id}"
URLTopLevelDomainKey is the attribute Key conforming to the
"url.top_level_domain" semantic conventions. It represents the effective top
level domain (eTLD), also known as the domain suffix, is the last part of the
domain name. For example, the top level domain for example.com is `com`.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "com", "co.uk"
Note: This value can be determined precisely with the [public suffix list].
UserAgentNameKey is the attribute Key conforming to the "user_agent.name"
semantic conventions. It represents the name of the user-agent extracted from
original. Usually refers to the browser's name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Safari", "YourApp"
Note: [Example] of extracting browser's name from original string. In the
case of using a user-agent for non-browser products, such as microservices
with multiple names/versions inside the `user_agent.original`, the most
significant name SHOULD be selected. In such a scenario it should align with
`user_agent.version`
UserAgentOriginalKey is the attribute Key conforming to the
"user_agent.original" semantic conventions. It represents the value of the
[HTTP User-Agent] header sent by the client.
Type: string
RequirementLevel: Recommended
Stability: Stable
Examples: "CERN-LineMode/2.15 libwww/2.17b3", "Mozilla/5.0 (iPhone; CPU
iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko)
Version/14.1.2 Mobile/15E148 Safari/604.1", "YourApp/1.0.0
grpc-java-okhttp/1.27.2"
UserAgentOSNameKey is the attribute Key conforming to the
"user_agent.os.name" semantic conventions. It represents the human readable
operating system name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "iOS", "Android", "Ubuntu"
Note: For mapping user agent strings to OS names, libraries such as
[ua-parser] can be utilized.
UserAgentOSVersionKey is the attribute Key conforming to the
"user_agent.os.version" semantic conventions. It represents the version
string of the operating system as defined in [Version Attributes].
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "14.2.1", "18.04.1"
Note: For mapping user agent strings to OS versions, libraries such as
[ua-parser] can be utilized.
[Version Attributes]: /docs/resource/README.md#version-attributes
[ua-parser]: https://github.com/ua-parser
UserAgentSyntheticTypeKey is the attribute Key conforming to the
"user_agent.synthetic.type" semantic conventions. It represents the specifies
the category of synthetic traffic, such as tests or bots.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples:
Note: This attribute MAY be derived from the contents of the
`user_agent.original` attribute. Components that populate the attribute are
responsible for determining what they consider to be synthetic bot or test
traffic. This attribute can either be set for self-identification purposes,
or on telemetry detected to be generated as a result of a synthetic request.
This attribute is useful for distinguishing between genuine client traffic
and synthetic traffic generated by bots or tests.
UserAgentVersionKey is the attribute Key conforming to the
"user_agent.version" semantic conventions. It represents the version of the
user-agent extracted from original. Usually refers to the browser's version.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "14.1.2", "1.0.0"
Note: [Example] of extracting browser's version from original string. In the
case of using a user-agent for non-browser products, such as microservices
with multiple names/versions inside the `user_agent.original`, the most
significant version SHOULD be selected. In such a scenario it should align
with `user_agent.name`
UserEmailKey is the attribute Key conforming to the "user.email" semantic
conventions. It represents the user email address.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "a.einstein@example.com"
UserFullNameKey is the attribute Key conforming to the "user.full_name"
semantic conventions. It represents the user's full name.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Albert Einstein"
UserHashKey is the attribute Key conforming to the "user.hash" semantic
conventions. It represents the unique user hash to correlate information for
a user in anonymized form.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "364fc68eaf4c8acec74a4e52d7d1feaa"
Note: Useful if `user.id` or `user.name` contain confidential information and
cannot be used.
UserIDKey is the attribute Key conforming to the "user.id" semantic
conventions. It represents the unique identifier of the user.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "S-1-5-21-202424912787-2692429404-2351956786-1000"
UserNameKey is the attribute Key conforming to the "user.name" semantic
conventions. It represents the short name or login/username of the user.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "a.einstein"
UserRolesKey is the attribute Key conforming to the "user.roles" semantic
conventions. It represents the array of user roles at the time of the event.
Type: string[]
RequirementLevel: Recommended
Stability: Development
Examples: "admin", "reporting_user"
VCSChangeIDKey is the attribute Key conforming to the "vcs.change.id"
semantic conventions. It represents the ID of the change (pull request/merge
request/changelist) if applicable. This is usually a unique (within
repository) identifier generated by the VCS system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "123"
VCSChangeStateKey is the attribute Key conforming to the "vcs.change.state"
semantic conventions. It represents the state of the change (pull
request/merge request/changelist).
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "open", "closed", "merged"
VCSChangeTitleKey is the attribute Key conforming to the "vcs.change.title"
semantic conventions. It represents the human readable title of the change
(pull request/merge request/changelist). This title is often a brief summary
of the change and may get merged in to a ref as the commit summary.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "Fixes broken thing", "feat: add my new feature", "[chore] update
dependency"
VCSLineChangeTypeKey is the attribute Key conforming to the
"vcs.line_change.type" semantic conventions. It represents the type of line
change being measured on a branch or change.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "added", "removed"
VCSOwnerNameKey is the attribute Key conforming to the "vcs.owner.name"
semantic conventions. It represents the group owner within the version
control system.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-org", "myteam", "business-unit"
VCSProviderNameKey is the attribute Key conforming to the "vcs.provider.name"
semantic conventions. It represents the name of the version control system
provider.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "github", "gitlab", "gitea", "bitbucket"
VCSRefBaseNameKey is the attribute Key conforming to the "vcs.ref.base.name"
semantic conventions. It represents the name of the [reference] such as
**branch** or **tag** in the repository.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-feature-branch", "tag-1-test"
Note: `base` refers to the starting point of a change. For example, `main`
would be the base reference of type branch if you've created a new
reference of type branch from it and created new commits.
VCSRefBaseRevisionKey is the attribute Key conforming to the
"vcs.ref.base.revision" semantic conventions. It represents the revision,
literally [revised version], The revision most often refers to a commit
object in Git, or a revision number in SVN.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc",
"main", "123", "HEAD"
Note: `base` refers to the starting point of a change. For example, `main`
would be the base reference of type branch if you've created a new
reference of type branch from it and created new commits. The
revision can be a full [hash value (see
glossary)],
of the recorded change to a ref within a repository pointing to a
commit [commit] object. It does
not necessarily have to be a hash; it can simply define a [revision
number]
which is an integer that is monotonically increasing. In cases where
it is identical to the `ref.base.name`, it SHOULD still be included.
It is up to the implementer to decide which value to set as the
revision based on the VCS system and situational context.
[hash value (see
glossary)]: https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf
[commit]: https://git-scm.com/docs/git-commit
[revision
number]: https://svnbook.red-bean.com/en/1.7/svn.tour.revs.specifiers.html
VCSRefBaseTypeKey is the attribute Key conforming to the "vcs.ref.base.type"
semantic conventions. It represents the type of the [reference] in the
repository.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "branch", "tag"
Note: `base` refers to the starting point of a change. For example, `main`
would be the base reference of type branch if you've created a new
reference of type branch from it and created new commits.
VCSRefHeadNameKey is the attribute Key conforming to the "vcs.ref.head.name"
semantic conventions. It represents the name of the [reference] such as
**branch** or **tag** in the repository.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "my-feature-branch", "tag-1-test"
Note: `head` refers to where you are right now; the current reference at a
given time.
VCSRefHeadRevisionKey is the attribute Key conforming to the
"vcs.ref.head.revision" semantic conventions. It represents the revision,
literally [revised version], The revision most often refers to a commit
object in Git, or a revision number in SVN.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc",
"main", "123", "HEAD"
Note: `head` refers to where you are right now; the current reference at a
given time.The revision can be a full [hash value (see
glossary)],
of the recorded change to a ref within a repository pointing to a
commit [commit] object. It does
not necessarily have to be a hash; it can simply define a [revision
number]
which is an integer that is monotonically increasing. In cases where
it is identical to the `ref.head.name`, it SHOULD still be included.
It is up to the implementer to decide which value to set as the
revision based on the VCS system and situational context.
[hash value (see
glossary)]: https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf
[commit]: https://git-scm.com/docs/git-commit
[revision
number]: https://svnbook.red-bean.com/en/1.7/svn.tour.revs.specifiers.html
VCSRefHeadTypeKey is the attribute Key conforming to the "vcs.ref.head.type"
semantic conventions. It represents the type of the [reference] in the
repository.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "branch", "tag"
Note: `head` refers to where you are right now; the current reference at a
given time.
VCSRefTypeKey is the attribute Key conforming to the "vcs.ref.type" semantic
conventions. It represents the type of the [reference] in the repository.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "branch", "tag"
VCSRepositoryNameKey is the attribute Key conforming to the
"vcs.repository.name" semantic conventions. It represents the human readable
name of the repository. It SHOULD NOT include any additional identifier like
Group/SubGroup in GitLab or organization in GitHub.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "semantic-conventions", "my-cool-repo"
Note: Due to it only being the name, it can clash with forks of the same
repository if collecting telemetry across multiple orgs or groups in
the same backends.
VCSRepositoryURLFullKey is the attribute Key conforming to the
"vcs.repository.url.full" semantic conventions. It represents the
[canonical URL] of the repository providing the complete HTTP(S) address in
order to locate and identify the repository through a browser.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples:
"https://github.com/opentelemetry/open-telemetry-collector-contrib",
"https://gitlab.com/my-org/my-project/my-projects-project/repo"
Note: In Git Version Control Systems, the canonical URL SHOULD NOT include
the `.git` extension.
VCSRevisionDeltaDirectionKey is the attribute Key conforming to the
"vcs.revision_delta.direction" semantic conventions. It represents the type
of revision comparison.
Type: Enum
RequirementLevel: Recommended
Stability: Development
Examples: "ahead", "behind"
WebEngineDescriptionKey is the attribute Key conforming to the
"webengine.description" semantic conventions. It represents the additional
description of the web engine (e.g. detailed version and edition
information).
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) -
2.2.2.Final"
WebEngineNameKey is the attribute Key conforming to the "webengine.name"
semantic conventions. It represents the name of the web engine.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "WildFly"
WebEngineVersionKey is the attribute Key conforming to the
"webengine.version" semantic conventions. It represents the version of the
web engine.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "21.0.0"
ZOSSmfIDKey is the attribute Key conforming to the "zos.smf.id" semantic
conventions. It represents the System Management Facility (SMF) Identifier
uniquely identified a z/OS system within a SYSPLEX or mainframe environment
and is used for system and performance analysis.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "SYS1"
ZOSSysplexNameKey is the attribute Key conforming to the "zos.sysplex.name"
semantic conventions. It represents the name of the SYSPLEX to which the z/OS
system belongs too.
Type: string
RequirementLevel: Recommended
Stability: Development
Examples: "SYSPLEX1"
![]() |
The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds. |