package semconv
Import Path
go.opentelemetry.io/otel/semconv/v1.26.0 (on go.dev)
Dependency Relation
imports one package, and imported by one package
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.26.0
version of the OpenTelemetry semantic conventions.
exception.go
metric.go
schema.go
Package-Level Functions (total 360)
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
[here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#APILevels).
AspnetcoreDiagnosticsHandlerType returns an attribute KeyValue conforming
to the "aspnetcore.diagnostics.handler.type" semantic conventions. It
represents the full type name of the
[`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler)
implementation that handled the exception.
AspnetcoreRateLimitingPolicy returns an attribute KeyValue conforming to
the "aspnetcore.rate_limiting.policy" semantic conventions. It represents
the rate limiting policy name.
AspnetcoreRequestIsUnhandled returns an attribute KeyValue conforming to
the "aspnetcore.request.is_unhandled" semantic conventions. It represents
the flag indicating if request was handled by the application pipeline.
AspnetcoreRoutingIsFallback returns an attribute KeyValue conforming to
the "aspnetcore.routing.is_fallback" semantic conventions. It represents a
value that indicates whether the matched route is a fallback route.
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html).
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html).
AWSECSTaskARN returns an attribute KeyValue conforming to the
"aws.ecs.task.arn" semantic conventions. It represents the ARN of a running
[ECS
task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids).
AWSECSTaskFamily returns an attribute KeyValue conforming to the
"aws.ecs.task.family" semantic conventions. It represents the family name of
the [ECS task
definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)
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.
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).
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-amz-request-id` or `x-amz-requestid`.
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
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.
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
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](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id)
uniquely identifies the event.
CloudeventsEventSource returns an attribute KeyValue conforming to the
"cloudevents.event_source" semantic conventions. It represents the
[source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1)
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](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion)
which the event uses.
CloudeventsEventSubject returns an attribute KeyValue conforming to the
"cloudevents.event_subject" semantic conventions. It represents the
[subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#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](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type)
contains a value describing the type of event related to the originating
occurrence.
CloudRegion returns an attribute KeyValue conforming to the
"cloud.region" semantic conventions. It represents the geographical region
the resource is running.
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](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
on AWS, a [fully qualified resource
ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on
Azure, a [full resource
name](https://cloud.google.com/apis/design/resource_names#full_resource_name)
on GCP)
CodeColumn returns an attribute KeyValue conforming to the "code.column"
semantic conventions. It represents the column number in `code.filepath`
best representing the operation. It SHOULD point within the code unit named
in `code.function`.
CodeFilepath returns an attribute KeyValue conforming to the
"code.filepath" semantic conventions. It represents the source code file
name that identifies the code unit as uniquely as possible (preferably an
absolute file path).
CodeFunction returns an attribute KeyValue conforming to the
"code.function" semantic conventions. It represents the method or function
name, or equivalent (usually rightmost part of the code unit's name).
CodeLineNumber returns an attribute KeyValue conforming to the "code.lineno"
semantic conventions. It represents the line number in `code.filepath` best
representing the operation. It SHOULD point within the code unit named in
`code.function`.
CodeNamespace returns an attribute KeyValue conforming to the
"code.namespace" semantic conventions. It represents the "namespace" within
which `code.function` is defined. Usually the qualified class or module
name, such that `code.namespace` + some separator + `code.function` form a
unique identifier for the code unit.
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 to be determined and documented by each language SIG.
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. [2]
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. [2]
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](https://docs.docker.com/engine/reference/run/#container-identification).
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](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect).
Should be only the `<tag>` section of the full name for example from
`registry.example.com/my-org/my-image:<tag>`.
ContainerName returns an attribute KeyValue conforming to the
"container.name" semantic conventions. It represents the container name used
by container runtime.
ContainerRuntime returns an attribute KeyValue conforming to the
"container.runtime" semantic conventions. It represents the container
runtime managing this container.
DBCassandraCoordinatorDC returns an attribute KeyValue conforming to the
"db.cassandra.coordinator.dc" semantic conventions. It represents the data
center of the coordinating node for a query.
DBCassandraCoordinatorID returns an attribute KeyValue conforming to the
"db.cassandra.coordinator.id" semantic conventions. It represents the ID of
the coordinating node for a query.
DBCassandraIdempotence returns an attribute KeyValue conforming to the
"db.cassandra.idempotence" semantic conventions. It represents the whether
or not the query is idempotent.
DBCassandraPageSize returns an attribute KeyValue conforming to the
"db.cassandra.page_size" semantic conventions. It represents the fetch size
used for paging, i.e. how many rows will be returned at once.
DBCassandraSpeculativeExecutionCount returns an attribute KeyValue
conforming to the "db.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.
DBClientConnectionsPoolName returns an attribute KeyValue conforming to
the "db.client.connections.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 `server.address` and
`server.port` attributes formatted as `server.address:server.port`.
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.
DBCosmosDBClientID returns an attribute KeyValue conforming to the
"db.cosmosdb.client_id" semantic conventions. It represents the unique
Cosmos client instance id.
DBCosmosDBRequestCharge returns an attribute KeyValue conforming to the
"db.cosmosdb.request_charge" semantic conventions. It represents the rU
consumed for that operation
DBCosmosDBRequestContentLength returns an attribute KeyValue conforming
to the "db.cosmosdb.request_content_length" semantic conventions. It
represents the request payload size in bytes
DBCosmosDBStatusCode returns an attribute KeyValue conforming to the
"db.cosmosdb.status_code" semantic conventions. It represents the cosmos DB
status code.
DBCosmosDBSubStatusCode returns an attribute KeyValue conforming to the
"db.cosmosdb.sub_status_code" semantic conventions. It represents the cosmos
DB sub status code.
DBElasticsearchClusterName returns an attribute KeyValue conforming to
the "db.elasticsearch.cluster.name" semantic conventions. It represents the
represents the identifier of an Elasticsearch cluster.
DBElasticsearchNodeName returns an attribute KeyValue conforming to the
"db.elasticsearch.node.name" semantic conventions. It represents the
represents the human-readable identifier of the node/instance to which a
request was routed.
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.
DBOperationName returns an attribute KeyValue conforming to the
"db.operation.name" semantic conventions. It represents the name of the
operation or command being executed.
DBQueryText returns an attribute KeyValue conforming to the
"db.query.text" semantic conventions. It represents the database query being
executed.
DeploymentEnvironment returns an attribute KeyValue conforming to the
"deployment.environment" semantic conventions. It represents the name of the
[deployment environment](https://wikipedia.org/wiki/Deployment_environment)
(aka deployment tier).
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
DNSQuestionName returns an attribute KeyValue conforming to the
"dns.question.name" semantic conventions. It represents the name being
queried.
EnduserID returns an attribute KeyValue conforming to the "enduser.id"
semantic conventions. It represents the username or client_id extracted from
the access token or
[Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) header in
the inbound request from outside the system.
EnduserRole returns an attribute KeyValue conforming to the
"enduser.role" semantic conventions. It represents the actual/assumed role
the client is making the request under extracted from token or application
security context.
EnduserScope returns an attribute KeyValue conforming to the
"enduser.scope" semantic conventions. It represents the scopes or granted
authorities the client currently possesses extracted from token or
application security context. The value would come from the scope associated
with an [OAuth 2.0 Access
Token](https://tools.ietf.org/html/rfc6749#section-3.3) or an attribute
value in a [SAML 2.0
Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html).
EventName returns an attribute KeyValue conforming to the "event.name"
semantic conventions. It represents the identifies the class / type of
event.
ExceptionEscaped returns an attribute KeyValue conforming to the
"exception.escaped" semantic conventions. It represents the sHOULD be set to
true if the exception event is recorded at a point where it is known that
the exception is escaping the scope of the span.
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](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
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](https://www.iso.org/iso-8601-date-and-time-format.html) format
expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
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](https://www.iso.org/iso-8601-date-and-time-format.html) format
expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
FaaSVersion returns an attribute KeyValue conforming to the
"faas.version" semantic conventions. It represents the immutable version of
the function being executed.
FeatureFlagKey returns an attribute KeyValue conforming to the
"feature_flag.key" semantic conventions. It represents the unique identifier
of the feature flag.
FeatureFlagProviderName returns an attribute KeyValue conforming to the
"feature_flag.provider_name" semantic conventions. It represents the name of
the service provider that performs the flag evaluation.
FeatureFlagVariant returns an attribute KeyValue conforming to the
"feature_flag.variant" semantic conventions. It represents the sHOULD be a
semantic identifier for a value. If one is unavailable, a stringified
version of the value can be used.
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.
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.
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.
GCPCloudRunJobExecution returns an attribute KeyValue conforming to the
"gcp.cloud_run.job.execution" semantic conventions. It represents the name
of the Cloud Run
[execution](https://cloud.google.com/run/docs/managing/job-executions) being
run for the Job, as set by the
[`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
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`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
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](https://cloud.google.com/compute/docs/instances/custom-hostname-vm).
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](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
GenAiCompletion returns an attribute KeyValue conforming to the
"gen_ai.completion" semantic conventions. It represents the full response
received from the LLM.
GenAiPrompt returns an attribute KeyValue conforming to the
"gen_ai.prompt" semantic conventions. It represents the full prompt sent to
an LLM.
GenAiRequestMaxTokens returns an attribute KeyValue conforming to the
"gen_ai.request.max_tokens" semantic conventions. It represents the maximum
number of tokens the LLM generates for a request.
GenAiRequestModel returns an attribute KeyValue conforming to the
"gen_ai.request.model" semantic conventions. It represents the name of the
LLM a request is being made to.
GenAiRequestTemperature returns an attribute KeyValue conforming to the
"gen_ai.request.temperature" semantic conventions. It represents the
temperature setting for the LLM 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 LLM 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
LLM a response was generated from.
GenAiUsageCompletionTokens returns an attribute KeyValue conforming to
the "gen_ai.usage.completion_tokens" semantic conventions. It represents the
number of tokens used in the LLM response (completion).
GenAiUsagePromptTokens returns an attribute KeyValue conforming to the
"gen_ai.usage.prompt_tokens" semantic conventions. It represents the number
of tokens used in the LLM prompt.
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](/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](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length)
header. For requests using transport encoding, this should be the compressed
size.
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](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length)
header. For requests using transport encoding, this should be the compressed
size.
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](https://tools.ietf.org/html/rfc7231#section-6).
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.
JvmBufferPoolName returns an attribute KeyValue conforming to the
"jvm.buffer.pool.name" semantic conventions. It represents the name of the
buffer pool.
JvmGcAction returns an attribute KeyValue conforming to the
"jvm.gc.action" semantic conventions. It represents the name of the garbage
collector action.
JvmGcName returns an attribute KeyValue conforming to the "jvm.gc.name"
semantic conventions. It represents the name of the garbage collector.
JvmMemoryPoolName returns an attribute KeyValue conforming to the
"jvm.memory.pool.name" semantic conventions. It represents the name of the
memory pool.
JvmThreadDaemon returns an attribute KeyValue conforming to the
"jvm.thread.daemon" semantic conventions. It represents the whether the
thread is daemon or not.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
LogRecordUID returns an attribute KeyValue conforming to the
"log.record.uid" semantic conventions. It represents a unique identifier for
the Log Record.
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.
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`.
MessagingDestinationPublishAnonymous returns an attribute KeyValue
conforming to the "messaging.destination_publish.anonymous" semantic
conventions. It represents a boolean that is true if the publish message
destination is anonymous (could be unnamed or have auto-generated name).
MessagingDestinationPublishName returns an attribute KeyValue conforming
to the "messaging.destination_publish.name" semantic conventions. It
represents the name of the original destination the message was published to
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.
MessagingEventhubsConsumerGroup returns an attribute KeyValue conforming
to the "messaging.eventhubs.consumer.group" semantic conventions. It
represents the name of the consumer group the event consumer is associated
with.
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.
MessagingKafkaConsumerGroup returns an attribute KeyValue conforming to
the "messaging.kafka.consumer.group" semantic conventions. It represents the
name of the Kafka Consumer Group that is handling the message. Only applies
to consumers, not producers.
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.
MessagingKafkaMessageOffset returns an attribute KeyValue conforming to
the "messaging.kafka.message.offset" semantic conventions. It represents the
offset of a record in the corresponding Kafka partition.
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.
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
MessagingRocketmqClientGroup returns an attribute KeyValue conforming to
the "messaging.rocketmq.client_group" semantic conventions. It represents
the name of the RocketMQ producer/consumer group that is handling the
message. The client type is identified by the SpanKind.
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.
MessagingServicebusDestinationSubscriptionName returns an attribute
KeyValue conforming to the
"messaging.servicebus.destination.subscription_name" semantic conventions.
It represents the name of the subscription in the topic messages are
received from.
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.
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](https://osi-model.com/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.
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](/docs/resource/README.md#version-attributes).
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).
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`](/docs/resource/README.md#service) of the remote service.
SHOULD be equal to the actual `service.name` resource attribute of the
remote service if any.
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`.
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.
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.
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, can be set to the `Name` in
`proc/[pid]/status`. On Windows, can 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.
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. For compiled native binaries, this SHOULD be the
name of the compiler.
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.
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.
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 represents the 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.
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 logical
CPU number [0..n-1]
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.
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](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) 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](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) 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.
TLSClientServerName returns an attribute KeyValue conforming to the
"tls.client.server_name" semantic conventions. It represents the also called
an SNI, this tells the server which hostname to which the client is
attempting to connect to.
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](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids),
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](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES)
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](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) 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](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) 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](https://www.rfc-editor.org/rfc/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](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) 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](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) 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](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) 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](https://www.rfc-editor.org/rfc/rfc3986#section-4.2).
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](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent)
header sent by the client.
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
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.
Package-Level Variables (total 369)
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
Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time
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
Exception handling didn't run because the request was aborted
Exception was handled by the exception handling middleware
Exception handling was skipped because the response had started
Exception was not handled by the exception handling middleware
Lease was acquired
Lease request was rejected by the endpoint limiter
Lease request was rejected by the global limiter
Lease request was canceled
Match failed
Match succeeded
ec2
fargate
Alibaba Cloud Elastic Compute Service
Alibaba Cloud Function Compute
Red Hat OpenShift on Alibaba Cloud
AWS App Runner
AWS Elastic Compute Cloud
AWS Elastic Container Service
AWS Elastic Kubernetes Service
AWS Elastic Beanstalk
AWS Lambda
Red Hat OpenShift on AWS (ROSA)
Azure Kubernetes Service
Azure App Service
Azure Container Apps
Azure Container Instances
Azure Functions
Azure Red Hat OpenShift
Azure Virtual Machines
Google Cloud App Engine (GAE)
Google Bare Metal Solution (BMS)
Google Cloud Functions (GCF)
Google Cloud Run
Google Cloud Compute Engine (GCE)
Google Cloud Kubernetes Engine (GKE)
Red Hat OpenShift on Google Cloud
Red Hat OpenShift on IBM Cloud
Tencent Cloud Cloud Virtual Machine (CVM)
Tencent Cloud Elastic Kubernetes Service (EKS)
Tencent Cloud Serverless Cloud Function (SCF)
Alibaba Cloud
Amazon Web Services
Microsoft Azure
Google Cloud Platform
Heroku Platform as a Service
IBM Cloud
Tencent Cloud
When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows)
When CPU is used by the system (host OS)
When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows)
all
any
each_quorum
local_one
local_quorum
local_serial
one
quorum
serial
three
two
idle
used
Direct connection
Gateway (HTTP) connections mode
batch
create
delete
execute
execute_javascript
head
head_feed
invalid
patch
query
query_plan
read
read_feed
replace
upsert
Adabas (Adaptable Database System)
InterSystems Caché
Apache Cassandra
ClickHouse
Cloudscape
CockroachDB
ColdFusion IMQ
Microsoft Azure Cosmos DB
Couchbase
CouchDB
IBM DB2
Apache Derby
Amazon DynamoDB
EnterpriseDB
Elasticsearch
FileMaker
Firebird
FirstSQL
Apache Geode
H2
SAP HANA
Apache HBase
Apache Hive
HyperSQL DataBase
Informix
Ingres
InstantDB
InterBase
MariaDB
SAP MaxDB
Memcached
MongoDB
Microsoft SQL Server
Microsoft SQL Server Compact
MySQL
Neo4j
Netezza
OpenSearch
Oracle Database
Some other SQL database. Fallback only. See notes
Pervasive PSQL
PointBase
PostgreSQL
Progress Database
Redis
Amazon Redshift
Cloud Spanner
SQLite
Sybase
Teradata
Trino
Vertica
read
write
A fallback error value to be used when the instrumentation doesn't define a custom value
When an object is deleted
When an object is modified
When a new object is created
Alibaba Cloud
Amazon Web Services
Microsoft Azure
Google Cloud Platform
Tencent Cloud
A response to some data source operation such as a database or filesystem read/write
To provide an answer to an inbound HTTP request
If none of the others apply
A function is set to be executed when messages are sent to a messaging system
A function is scheduled to be executed regularly
OpenAI
GraphQL mutation
GraphQL query
GraphQL subscription
AMD64
ARM32
ARM64
Itanium
32-bit PowerPC
64-bit PowerPC
IBM z/Architecture
32-bit x86
active state
idle state
CONNECT method
DELETE method
GET method
HEAD method
OPTIONS method
Any HTTP method that the instrumentation has no prior knowledge of
PATCH method
POST method
PUT method
TRACE method
Heap memory
Non-heap memory
A thread that is blocked waiting for a monitor lock is in this state
A thread that has not yet started is in this state
A thread executing in the Java virtual machine is in this state
A thread that has exited is in this state
A thread that is waiting for another thread to perform an action for up to a specified waiting time is in this state
A thread that is waiting indefinitely for another thread to perform a particular action is in this state
Events from stderr stream
Logs from stdout stream
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 publishing scenarios
One or more messages are delivered to or processed by a consumer
One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created
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
One or more messages are settled
Broadcasting consumption model
Clustering consumption model
Delay message
FIFO message
Normal message
Transaction message
Message is abandoned
Message is completed
Message is sent to dead letter queue
Message is deferred
Apache ActiveMQ
Amazon Simple Queue Service (SQS)
Azure Event Grid
Azure Event Hubs
Google Cloud Pub/Sub
Java Message Service
Apache Kafka
RabbitMQ
Apache RocketMQ
Azure Service Bus
CDMA
CDMA2000 1XRTT
EDGE
EHRPD
EVDO Rel. 0
EVDO Rev. A
EVDO Rev. B
GPRS
GSM
HSDPA
HSPA
HSPAP
HSUPA
IDEN
IWLAN
LTE
LTE CA
5G NR (New Radio)
5G NRNSA (New Radio Non-Standalone)
TD-SCDMA
UMTS
cell
unknown
wifi
wired
receive
transmit
Named or anonymous pipe
TCP
UDP
Unix domain socket
IPv4
IPv6
The parent Span depends on the child Span in some capacity
The parent Span doesn't depend in any way on the result of the child Span
AIX (Advanced Interactive eXecutive)
Apple Darwin
DragonFly BSD
FreeBSD
HP-UX (Hewlett Packard Unix)
Linux
NetBSD
OpenBSD
SunOS, Oracle Solaris
Microsoft Windows
IBM z/OS
The operation contains an error
The operation has been validated by an Application developer or Operator to have completed successfully
involuntary
voluntary
system
user
wait
major
minor
aborted
already_exists
cancelled
data_loss
deadline_exceeded
failed_precondition
internal
invalid_argument
not_found
out_of_range
permission_denied
resource_exhausted
unauthenticated
unimplemented
unknown
ABORTED
ALREADY_EXISTS
CANCELLED
DATA_LOSS
DEADLINE_EXCEEDED
FAILED_PRECONDITION
INTERNAL
INVALID_ARGUMENT
NOT_FOUND
OK
OUT_OF_RANGE
PERMISSION_DENIED
RESOURCE_EXHAUSTED
UNAUTHENTICATED
UNIMPLEMENTED
UNKNOWN
received
sent
Apache Dubbo
Connect RPC
.NET WCF
gRPC
Java RMI
The connection was closed because the app is shutting down
The connection was closed normally
The connection was closed due to a timeout
LongPolling protocol
ServerSentEvents protocol
WebSockets protocol
idle
interrupt
iowait
nice
steal
system
user
free
reserved
used
exfat
ext4
fat32
hfsplus
ntfs
refs
buffers
cached
free
used
close
close_wait
closing
delete
established
fin_wait_1
fin_wait_2
last_ack
listen
syn_recv
syn_sent
time_wait
in
out
free
used
major
minor
defunct
running
sleeping
stopped
cpp
dotnet
erlang
go
java
nodejs
php
python
ruby
rust
swift
webjs
ssl
tls
Package-Level Constants (total 805)
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
[here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#APILevels).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '33', '32'
AndroidStateKey is the attribute Key conforming to the "android.state"
semantic conventions. It represents the deprecated use the
`device.app.lifecycle` event definition including `android.state` as a
payload field instead.
Type: Enum
RequirementLevel: Optional
Stability: experimental
Note: The Android lifecycle states are defined in [Activity lifecycle
callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc),
and from which the `OS identifiers` are derived.
AspnetcoreDiagnosticsExceptionResultKey is the attribute Key conforming
to the "aspnetcore.diagnostics.exception.result" semantic conventions.
It represents the aSP.NET Core exception middleware handling result
Type: Enum
RequirementLevel: Optional
Stability: stable
Examples: 'handled', 'unhandled'
const AspnetcoreDiagnosticsExceptionsDescription = "Number of exceptions caught by exception handling middleware."
AspnetcoreDiagnosticsExceptions is the metric conforming to the
"aspnetcore.diagnostics.exceptions" semantic conventions. It represents the
number of exceptions caught by exception handling middleware.
Instrument: counter
Unit: {exception}
Stability: Stable
const AspnetcoreDiagnosticsExceptionsUnit = "{exception}"
AspnetcoreDiagnosticsHandlerTypeKey is the attribute Key conforming to
the "aspnetcore.diagnostics.handler.type" semantic conventions. It
represents the full type name of the
[`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler)
implementation that handled the exception.
Type: string
RequirementLevel: ConditionallyRequired (if and only if the exception
was handled by this handler.)
Stability: stable
Examples: 'Contoso.MyHandler'
const AspnetcoreRateLimitingActiveRequestLeasesDescription = "Number of requests that are currently active on the server that hold...
AspnetcoreRateLimitingActiveRequestLeases is the metric conforming to the
"aspnetcore.rate_limiting.active_request_leases" semantic conventions. It
represents the number of requests that are currently active on the server
that hold a rate limiting lease.
Instrument: updowncounter
Unit: {request}
Stability: Stable
const AspnetcoreRateLimitingActiveRequestLeasesUnit = "{request}"
AspnetcoreRateLimitingPolicyKey is the attribute Key conforming to the
"aspnetcore.rate_limiting.policy" semantic conventions. It represents
the rate limiting policy name.
Type: string
RequirementLevel: Optional
Stability: stable
Examples: 'fixed', 'sliding', 'token'
const AspnetcoreRateLimitingQueuedRequestsDescription = "Number of requests that are currently queued, waiting to acquire a r...
AspnetcoreRateLimitingQueuedRequests is the metric conforming to the
"aspnetcore.rate_limiting.queued_requests" semantic conventions. It
represents the number of requests that are currently queued, waiting to
acquire a rate limiting lease.
Instrument: updowncounter
Unit: {request}
Stability: Stable
const AspnetcoreRateLimitingQueuedRequestsUnit = "{request}" const AspnetcoreRateLimitingRequestLeaseDurationDescription = "The duration of rate limiting lease held by requests on the server."
AspnetcoreRateLimitingRequestLeaseDuration is the metric conforming to the
"aspnetcore.rate_limiting.request_lease.duration" semantic conventions. It
represents the duration of rate limiting lease held by requests on the
server.
Instrument: histogram
Unit: s
Stability: Stable
const AspnetcoreRateLimitingRequestLeaseDurationUnit = "s" const AspnetcoreRateLimitingRequestsDescription = "Number of requests that tried to acquire a rate limiting lease."
AspnetcoreRateLimitingRequests is the metric conforming to the
"aspnetcore.rate_limiting.requests" semantic conventions. It represents the
number of requests that tried to acquire a rate limiting lease.
Instrument: counter
Unit: {request}
Stability: Stable
const AspnetcoreRateLimitingRequestsUnit = "{request}" const AspnetcoreRateLimitingRequestTimeInQueueDescription = "The time the request spent in a queue waiting to acquire a rate limi...
AspnetcoreRateLimitingRequestTimeInQueue is the metric conforming to the
"aspnetcore.rate_limiting.request.time_in_queue" semantic conventions. It
represents the time the request spent in a queue waiting to acquire a rate
limiting lease.
Instrument: histogram
Unit: s
Stability: Stable
const AspnetcoreRateLimitingRequestTimeInQueueUnit = "s"
AspnetcoreRateLimitingResultKey is the attribute Key conforming to the
"aspnetcore.rate_limiting.result" semantic conventions. It represents
the rate-limiting result, shows whether the lease was acquired or
contains a rejection reason
Type: Enum
RequirementLevel: Required
Stability: stable
Examples: 'acquired', 'request_canceled'
AspnetcoreRequestIsUnhandledKey is the attribute Key conforming to the
"aspnetcore.request.is_unhandled" semantic conventions. It represents
the flag indicating if request was handled by the application pipeline.
Type: boolean
RequirementLevel: Optional
Stability: stable
Examples: True
AspnetcoreRoutingIsFallbackKey is the attribute Key conforming to the
"aspnetcore.routing.is_fallback" semantic conventions. It represents a
value that indicates whether the matched route is a fallback route.
Type: boolean
RequirementLevel: Optional
Stability: stable
Examples: True
const AspnetcoreRoutingMatchAttemptsDescription = "Number of requests that were attempted to be matched to an endpoint."
AspnetcoreRoutingMatchAttempts is the metric conforming to the
"aspnetcore.routing.match_attempts" semantic conventions. It represents the
number of requests that were attempted to be matched to an endpoint.
Instrument: counter
Unit: {match_attempt}
Stability: Stable
const AspnetcoreRoutingMatchAttemptsUnit = "{match_attempt}"
AspnetcoreRoutingMatchStatusKey is the attribute Key conforming to the
"aspnetcore.routing.match_status" semantic conventions. It represents
the match result - success or failure
Type: Enum
RequirementLevel: Optional
Stability: stable
Examples: 'success', 'failure'
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 100
AWSECSClusterARNKey is the attribute Key conforming to the
"aws.ecs.cluster.arn" semantic conventions. It represents the ARN of an
[ECS
cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html).
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html).
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
for an ECS task.
Type: Enum
RequirementLevel: Optional
Stability: experimental
AWSECSTaskARNKey is the attribute Key conforming to the
"aws.ecs.task.arn" semantic conventions. It represents the ARN of a
running [ECS
task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids).
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)
used to create the ECS task.
Type: string
RequirementLevel: Optional
Stability: experimental
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: ConditionallyRequired (If and only if `task.arn` is
populated.)
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster'
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: Optional
Stability: experimental
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.
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: Optional
Stability: experimental
Examples:
'arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*'
Note: See the [log group ARN format
documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format).
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format).
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: Optional
Stability: experimental
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-amz-request-id` or `x-amz-requestid`.
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
operations.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html).
This applies in particular to the following operations:
-
[copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
-
[upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
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: Optional
Stability: experimental
Examples:
'Objects=[{Key=string,VersionID=string},{Key=string,VersionID=string}],Quiet=boolean'
Note: The `delete` attribute is only applicable to the
[delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
operation.
The `delete` attribute corresponds to the `--delete` parameter of the
[delete-objects operation within the S3
API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html).
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
operations.
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
-
[delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
-
[get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html)
-
[head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html)
-
[put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html)
-
[restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html)
-
[select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html)
-
[abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
-
[complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
-
[create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html)
-
[list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
-
[upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
-
[upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
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: Optional
Stability: experimental
Examples: 3456
Note: The `part_number` attribute is only applicable to the
[upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
and
[upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
operations.
The `part_number` attribute corresponds to the `--part-number` parameter
of the
[upload-part operation within the S3
API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html).
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: Optional
Stability: experimental
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](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
multipart operations.
This applies in particular to the following operations:
-
[abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
-
[complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
-
[list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
-
[upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
-
[upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
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: Optional
Stability: experimental
Examples: ' Not A;Brand 99', 'Chromium 99', 'Chrome 99'
Note: This value is intended to be taken from the [UA client hints
API](https://wicg.github.io/ua-client-hints/#interface)
(`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: Optional
Stability: experimental
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: Optional
Stability: experimental
Note: This value is intended to be taken from the [UA client hints
API](https://wicg.github.io/ua-client-hints/#interface)
(`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: Optional
Stability: experimental
Examples: 'Windows', 'macOS', 'Android'
Note: This value is intended to be taken from the [UA client hints
API](https://wicg.github.io/ua-client-hints/#interface)
(`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](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform).
Note that some (but not all) of these values can overlap with values in
the [`os.type` and `os.name` attributes](./os.md). However, for
consistency, the values in the `browser.platform` attribute should
capture the exact value that the user agent provides.
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: Optional
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: Optional
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id)
uniquely identifies the event.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '123e4567-e89b-12d3-a456-426614174000', '0001'
CloudeventsEventSourceKey is the attribute Key conforming to the
"cloudevents.event_source" semantic conventions. It represents the
[source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1)
identifies the context in which an event happened.
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion)
which the event uses.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '1.0'
CloudeventsEventSubjectKey is the attribute Key conforming to the
"cloudevents.event_subject" semantic conventions. It represents the
[subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject)
of the event in the context of the event producer (identified by
source).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'mynewfile.jpg'
CloudeventsEventTypeKey is the attribute Key conforming to the
"cloudevents.event_type" semantic conventions. It represents the
[event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type)
contains a value describing the type of event related to the originating
occurrence.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'com.github.pull_request.opened',
'com.example.object.deleted.v2'
CloudPlatformKey is the attribute Key conforming to the "cloud.platform"
semantic conventions. It represents the cloud platform in use.
Type: Enum
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
CloudRegionKey is the attribute Key conforming to the "cloud.region"
semantic conventions. It represents the geographical region the resource
is running.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'us-central1', 'us-east-1'
Note: Refer to your provider's docs to see the available regions, for
example [Alibaba Cloud
regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS
regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/),
[Azure
regions](https://azure.microsoft.com/global-infrastructure/geographies/),
[Google Cloud regions](https://cloud.google.com/about/locations), or
[Tencent Cloud
regions](https://www.tencentcloud.com/document/product/213/6091).
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](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
on AWS, a [fully qualified resource
ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id)
on Azure, a [full resource
name](https://cloud.google.com/apis/design/resource_names#full_resource_name)
on GCP)
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function',
'//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID',
'/subscriptions/<SUBSCIPTION_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](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
Take care not to use the "invoked ARN" directly but replace any
[alias
suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
with the resolved function version, as the same runtime instance may
be invokable with
multiple different aliases.
* **GCP:** The [URI of the
resource](https://cloud.google.com/iam/docs/full-resource-names)
* **Azure:** The [Fully Qualified Resource
ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id)
of the invoked function,
*not* the function app, having the form
`/subscriptions/<SUBSCIPTION_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.
CodeColumnKey is the attribute Key conforming to the "code.column"
semantic conventions. It represents the column number in `code.filepath`
best representing the operation. It SHOULD point within the code unit
named in `code.function`.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 16
CodeFilepathKey is the attribute Key conforming to the "code.filepath"
semantic conventions. It represents the source code file name that
identifies the code unit as uniquely as possible (preferably an absolute
file path).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '/usr/local/MyApplication/content_root/app/index.php'
CodeFunctionKey is the attribute Key conforming to the "code.function"
semantic conventions. It represents the method or function name, or
equivalent (usually rightmost part of the code unit's name).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'serveRequest'
CodeLineNumberKey is the attribute Key conforming to the "code.lineno"
semantic conventions. It represents the line number in `code.filepath`
best representing the operation. It SHOULD point within the code unit
named in `code.function`.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 42
CodeNamespaceKey is the attribute Key conforming to the "code.namespace"
semantic conventions. It represents the "namespace" within which
`code.function` is defined. Usually the qualified class or module name,
such that `code.namespace` + some separator + `code.function` form a
unique identifier for the code unit.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'com.example.MyHTTPService'
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 to be determined and documented by each language SIG.
Type: string
RequirementLevel: Optional
Stability: experimental
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)'
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. [2]
Type: string[]
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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. [2]
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'otelcontribcol --config config.yaml'
ContainerCPUStateKey is the attribute Key conforming to the
"container.cpu.state" semantic conventions. It represents the CPU state
for this data point.
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'user', 'kernel'
const ContainerCPUTimeDescription = "Total CPU time consumed"
ContainerCPUTime is the metric conforming to the "container.cpu.time"
semantic conventions. It represents the total CPU time consumed.
Instrument: counter
Unit: s
Stability: Experimental
const ContainerCPUTimeUnit = "s" const ContainerDiskIoDescription = "Disk bytes for the container."
ContainerDiskIo is the metric conforming to the "container.disk.io" semantic
conventions. It represents the disk bytes for the container.
Instrument: counter
Unit: By
Stability: Experimental
const ContainerDiskIoUnit = "By"
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](https://docs.docker.com/engine/reference/run/#container-identification).
The UUID might be abbreviated.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect)
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples:
'example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb',
'internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578'
Note:
[Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect)
and
[CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238)
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](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect).
Should be only the `<tag>` section of the full name for example from
`registry.example.com/my-org/my-image:<tag>`.
Type: string[]
RequirementLevel: Optional
Stability: experimental
Examples: 'v1.27.1', '3.5.7-0'
const ContainerMemoryUsageDescription = "Memory usage of the container."
ContainerMemoryUsage is the metric conforming to the
"container.memory.usage" semantic conventions. It represents the memory
usage of the container.
Instrument: counter
Unit: By
Stability: Experimental
const ContainerMemoryUsageUnit = "By"
ContainerNameKey is the attribute Key conforming to the "container.name"
semantic conventions. It represents the container name used by container
runtime.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'opentelemetry-autoconf'
const ContainerNetworkIoDescription = "Network bytes for the container."
ContainerNetworkIo is the metric conforming to the "container.network.io"
semantic conventions. It represents the network bytes for the container.
Instrument: counter
Unit: By
Stability: Experimental
const ContainerNetworkIoUnit = "By"
ContainerRuntimeKey is the attribute Key conforming to the
"container.runtime" semantic conventions. It represents the container
runtime managing this container.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'docker', 'containerd', 'rkt'
DBCassandraConsistencyLevelKey is the attribute Key conforming to the
"db.cassandra.consistency_level" semantic conventions. It represents the
consistency level of the query. Based on consistency values from
[CQL](https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html).
Type: Enum
RequirementLevel: Optional
Stability: experimental
DBCassandraCoordinatorDCKey is the attribute Key conforming to the
"db.cassandra.coordinator.dc" semantic conventions. It represents the
data center of the coordinating node for a query.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'us-west-2'
DBCassandraCoordinatorIDKey is the attribute Key conforming to the
"db.cassandra.coordinator.id" semantic conventions. It represents the ID
of the coordinating node for a query.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'be13faa2-8574-4d71-926d-27f16cf8a7af'
DBCassandraIdempotenceKey is the attribute Key conforming to the
"db.cassandra.idempotence" semantic conventions. It represents the
whether or not the query is idempotent.
Type: boolean
RequirementLevel: Optional
Stability: experimental
DBCassandraPageSizeKey is the attribute Key conforming to the
"db.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: Optional
Stability: experimental
Examples: 5000
DBCassandraSpeculativeExecutionCountKey is the attribute Key conforming
to the "db.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: Optional
Stability: experimental
Examples: 0, 2
const DBClientConnectionCountDescription = "The number of connections that are currently in state described by t...
DBClientConnectionCount is the metric conforming to the
"db.client.connection.count" semantic conventions. It represents the number
of connections that are currently in state described by the `state`
attribute.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionCountUnit = "{connection}" const DBClientConnectionCreateTimeDescription = "The time it took to create a new connection"
DBClientConnectionCreateTime is the metric conforming to the
"db.client.connection.create_time" semantic conventions. It represents the
time it took to create a new connection.
Instrument: histogram
Unit: s
Stability: Experimental
const DBClientConnectionCreateTimeUnit = "s" const DBClientConnectionIdleMaxDescription = "The maximum number of idle open connections allowed"
DBClientConnectionIdleMax is the metric conforming to the
"db.client.connection.idle.max" semantic conventions. It represents the
maximum number of idle open connections allowed.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionIdleMaxUnit = "{connection}" const DBClientConnectionIdleMinDescription = "The minimum number of idle open connections allowed"
DBClientConnectionIdleMin is the metric conforming to the
"db.client.connection.idle.min" semantic conventions. It represents the
minimum number of idle open connections allowed.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionIdleMinUnit = "{connection}" const DBClientConnectionMaxDescription = "The maximum number of open connections allowed"
DBClientConnectionMax is the metric conforming to the
"db.client.connection.max" semantic conventions. It represents the maximum
number of open connections allowed.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionMaxUnit = "{connection}" const DBClientConnectionPendingRequestsDescription = "The number of pending requests for an open connection, cumulative fo...
DBClientConnectionPendingRequests is the metric conforming to the
"db.client.connection.pending_requests" semantic conventions. It represents
the number of pending requests for an open connection, cumulative for the
entire pool.
Instrument: updowncounter
Unit: {request}
Stability: Experimental
const DBClientConnectionPendingRequestsUnit = "{request}" const DBClientConnectionsCreateTimeDescription = "Deprecated, use `db.client.connection.create_time` instead. Note: th...
DBClientConnectionsCreateTime is the metric conforming to the
"db.client.connections.create_time" semantic conventions. It represents the
deprecated, use `db.client.connection.create_time` instead. Note: the unit
also changed from `ms` to `s`.
Instrument: histogram
Unit: ms
Stability: Experimental
const DBClientConnectionsCreateTimeUnit = "ms" const DBClientConnectionsIdleMaxDescription = "Deprecated, use `db.client.connection.idle.max` instead."
DBClientConnectionsIdleMax is the metric conforming to the
"db.client.connections.idle.max" semantic conventions. It represents the
deprecated, use `db.client.connection.idle.max` instead.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionsIdleMaxUnit = "{connection}" const DBClientConnectionsIdleMinDescription = "Deprecated, use `db.client.connection.idle.min` instead."
DBClientConnectionsIdleMin is the metric conforming to the
"db.client.connections.idle.min" semantic conventions. It represents the
deprecated, use `db.client.connection.idle.min` instead.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionsIdleMinUnit = "{connection}" const DBClientConnectionsMaxDescription = "Deprecated, use `db.client.connection.max` instead."
DBClientConnectionsMax is the metric conforming to the
"db.client.connections.max" semantic conventions. It represents the
deprecated, use `db.client.connection.max` instead.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionsMaxUnit = "{connection}" const DBClientConnectionsPendingRequestsDescription = "Deprecated, use `db.client.connection.pending_requests` instead."
DBClientConnectionsPendingRequests is the metric conforming to the
"db.client.connections.pending_requests" semantic conventions. It represents
the deprecated, use `db.client.connection.pending_requests` instead.
Instrument: updowncounter
Unit: {request}
Stability: Experimental
const DBClientConnectionsPendingRequestsUnit = "{request}"
DBClientConnectionsPoolNameKey is the attribute Key conforming to the
"db.client.connections.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 `server.address` and
`server.port` attributes formatted as `server.address:server.port`.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'myDataSource'
DBClientConnectionsStateKey is the attribute Key conforming to the
"db.client.connections.state" semantic conventions. It represents the
state of a connection in the pool
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'idle'
const DBClientConnectionsTimeoutsDescription = "Deprecated, use `db.client.connection.timeouts` instead."
DBClientConnectionsTimeouts is the metric conforming to the
"db.client.connections.timeouts" semantic conventions. It represents the
deprecated, use `db.client.connection.timeouts` instead.
Instrument: counter
Unit: {timeout}
Stability: Experimental
const DBClientConnectionsTimeoutsUnit = "{timeout}" const DBClientConnectionsUsageDescription = "Deprecated, use `db.client.connection.count` instead."
DBClientConnectionsUsage is the metric conforming to the
"db.client.connections.usage" semantic conventions. It represents the
deprecated, use `db.client.connection.count` instead.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const DBClientConnectionsUsageUnit = "{connection}" const DBClientConnectionsUseTimeDescription = "Deprecated, use `db.client.connection.use_time` instead. Note: the u...
DBClientConnectionsUseTime is the metric conforming to the
"db.client.connections.use_time" semantic conventions. It represents the
deprecated, use `db.client.connection.use_time` instead. Note: the unit also
changed from `ms` to `s`.
Instrument: histogram
Unit: ms
Stability: Experimental
const DBClientConnectionsUseTimeUnit = "ms" const DBClientConnectionsWaitTimeDescription = "Deprecated, use `db.client.connection.wait_time` instead. Note: the ...
DBClientConnectionsWaitTime is the metric conforming to the
"db.client.connections.wait_time" semantic conventions. It represents the
deprecated, use `db.client.connection.wait_time` instead. Note: the unit
also changed from `ms` to `s`.
Instrument: histogram
Unit: ms
Stability: Experimental
const DBClientConnectionsWaitTimeUnit = "ms" const DBClientConnectionTimeoutsDescription = "The number of connection timeouts that have occurred trying to obtai...
DBClientConnectionTimeouts is the metric conforming to the
"db.client.connection.timeouts" semantic conventions. It represents the
number of connection timeouts that have occurred trying to obtain a
connection from the pool.
Instrument: counter
Unit: {timeout}
Stability: Experimental
const DBClientConnectionTimeoutsUnit = "{timeout}" const DBClientConnectionUseTimeDescription = "The time between borrowing a connection and returning it to the pool"
DBClientConnectionUseTime is the metric conforming to the
"db.client.connection.use_time" semantic conventions. It represents the time
between borrowing a connection and returning it to the pool.
Instrument: histogram
Unit: s
Stability: Experimental
const DBClientConnectionUseTimeUnit = "s" const DBClientConnectionWaitTimeDescription = "The time it took to obtain an open connection from the pool"
DBClientConnectionWaitTime is the metric conforming to the
"db.client.connection.wait_time" semantic conventions. It represents the
time it took to obtain an open connection from the pool.
Instrument: histogram
Unit: s
Stability: Experimental
const DBClientConnectionWaitTimeUnit = "s" const DBClientOperationDurationDescription = "Duration of database client operations."
DBClientOperationDuration is the metric conforming to the
"db.client.operation.duration" semantic conventions. It represents the
duration of database client operations.
Instrument: histogram
Unit: s
Stability: Experimental
const DBClientOperationDurationUnit = "s"
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: Optional
Stability: experimental
Examples: 'public.users', 'customers'
Note: If the collection name is parsed from the query, it SHOULD match
the value provided in the query and may be qualified with the schema and
database name.
It is RECOMMENDED to capture the value as provided by the application
without attempting to do any case normalization.
DBCosmosDBClientIDKey is the attribute Key conforming to the
"db.cosmosdb.client_id" semantic conventions. It represents the unique
Cosmos client instance id.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '3ba4827d-4422-483f-b59f-85b74211c11d'
DBCosmosDBConnectionModeKey is the attribute Key conforming to the
"db.cosmosdb.connection_mode" semantic conventions. It represents the
cosmos client connection mode.
Type: Enum
RequirementLevel: Optional
Stability: experimental
DBCosmosDBOperationTypeKey is the attribute Key conforming to the
"db.cosmosdb.operation_type" semantic conventions. It represents the
cosmosDB Operation Type.
Type: Enum
RequirementLevel: Optional
Stability: experimental
DBCosmosDBRequestChargeKey is the attribute Key conforming to the
"db.cosmosdb.request_charge" semantic conventions. It represents the rU
consumed for that operation
Type: double
RequirementLevel: Optional
Stability: experimental
Examples: 46.18, 1.0
DBCosmosDBRequestContentLengthKey is the attribute Key conforming to the
"db.cosmosdb.request_content_length" semantic conventions. It represents
the request payload size in bytes
Type: int
RequirementLevel: Optional
Stability: experimental
DBCosmosDBStatusCodeKey is the attribute Key conforming to the
"db.cosmosdb.status_code" semantic conventions. It represents the cosmos
DB status code.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 200, 201
DBCosmosDBSubStatusCodeKey is the attribute Key conforming to the
"db.cosmosdb.sub_status_code" semantic conventions. It represents the
cosmos DB sub status code.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 1000, 1002
DBElasticsearchClusterNameKey is the attribute Key conforming to the
"db.elasticsearch.cluster.name" semantic conventions. It represents the
represents the identifier of an Elasticsearch cluster.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'e9106fc68e3044f0b1475b04bf4ffd5f'
DBElasticsearchNodeNameKey is the attribute Key conforming to the
"db.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: Optional
Stability: experimental
Examples: 'instance-0000000001'
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: Optional
Stability: experimental
Examples: 'customers', 'test.users'
Note: If a database system has multiple namespace components, they
SHOULD be concatenated (potentially using database system specific
conventions) from most general to most specific namespace component, and
more specific namespaces SHOULD NOT be captured without the more general
namespaces, to ensure that "startswith" queries for the more general
namespaces will be valid.
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.
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: Optional
Stability: experimental
Examples: 'findAndModify', 'HMSET', 'SELECT'
Note: It is RECOMMENDED to capture the value as provided by the
application without attempting to do any case normalization.
DBQueryTextKey is the attribute Key conforming to the "db.query.text"
semantic conventions. It represents the database query being executed.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'SELECT * FROM wuser_table where username = ?', 'SET mykey
"WuValue"'
DBSystemKey is the attribute Key conforming to the "db.system" semantic
conventions. It represents the database management system (DBMS) product
as identified by the client instrumentation.
Type: Enum
RequirementLevel: Optional
Stability: experimental
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` is set to `postgresql` based on the
instrumentation's best knowledge.
DeploymentEnvironmentKey is the attribute Key conforming to the
"deployment.environment" semantic conventions. It represents the name of
the [deployment
environment](https://wikipedia.org/wiki/Deployment_environment) (aka
deployment tier).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'staging', 'production'
Note: `deployment.environment` 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=production`
* `service.name=frontend`, `deployment.environment=staging`.
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '2ab2916d-a51f-4ac8-80ee-45ac31a28092'
Note: The device identifier MUST only be defined using the values
outlined below. This value is not an advertising identifier and MUST NOT
be used as such. On iOS (Swift or Objective-C), this value MUST be equal
to the [vendor
identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor).
On Android (Java or Kotlin), this value MUST be equal to the Firebase
Installation ID or a globally unique UUID which is persisted across
sessions in your application. More information can be found
[here](https://developer.android.com/training/articles/user-data-ids) on
best practices and exact implementation details. 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.
DeviceManufacturerKey is the attribute Key conforming to the
"device.manufacturer" semantic conventions. It represents the name of
the device manufacturer
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'Apple', 'Samsung'
Note: The Android OS provides this field via
[Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER).
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'read'
const DNSLookupDurationDescription = "Measures the time taken to perform a DNS lookup."
DNSLookupDuration is the metric conforming to the "dns.lookup.duration"
semantic conventions. It represents the measures the time taken to perform a
DNS lookup.
Instrument: histogram
Unit: s
Stability: Experimental
const DNSLookupDurationUnit = "s"
DNSQuestionNameKey is the attribute Key conforming to the
"dns.question.name" semantic conventions. It represents the name being
queried.
Type: string
RequirementLevel: Optional
Stability: experimental
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.
EnduserIDKey is the attribute Key conforming to the "enduser.id"
semantic conventions. It represents the username or client_id extracted
from the access token or
[Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) header
in the inbound request from outside the system.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'username'
EnduserRoleKey is the attribute Key conforming to the "enduser.role"
semantic conventions. It represents the actual/assumed role the client
is making the request under extracted from token or application security
context.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'admin'
EnduserScopeKey is the attribute Key conforming to the "enduser.scope"
semantic conventions. It represents the scopes or granted authorities
the client currently possesses extracted from token or application
security context. The value would come from the scope associated with an
[OAuth 2.0 Access
Token](https://tools.ietf.org/html/rfc6749#section-3.3) or an attribute
value in a [SAML 2.0
Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'read:message, write:files'
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: Optional
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.
EventNameKey is the attribute Key conforming to the "event.name"
semantic conventions. It represents the identifies the class / type of
event.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'browser.mouse.click', 'device.app.lifecycle'
Note: Event names are subject to the same rules as [attribute
names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/common/attribute-naming.md).
Notably, event names are namespaced to avoid collisions and provide a
clean separation of semantics for events in separate domains like
browser, mobile, and kubernetes.
ExceptionEscapedKey is the attribute Key conforming to the
"exception.escaped" semantic conventions. It represents the sHOULD be
set to true if the exception event is recorded at a point where it is
known that the exception is escaping the scope of the span.
Type: boolean
RequirementLevel: Optional
Stability: stable
Note: An exception is considered to have escaped (or left) the scope of
a span,
if that span is ended while the exception is still logically "in
flight".
This may be actually "in flight" in some languages (e.g. if the
exception
is passed to a Context manager's `__exit__` method in Python) but will
usually be caught at the point of recording the exception in most
languages.
It is usually not possible to determine at the point where an exception
is thrown
whether it will escape the scope of a span.
However, it is trivial to know that an exception
will escape, if one checks for an active exception just before ending
the span,
as done in the [example for recording span
exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception).
It follows that an exception may still escape the scope of the span
even if the `exception.escaped` attribute was not set or set to false,
since the event might have been recorded at a time where it was not
clear whether the exception will escape.
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: Optional
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: Optional
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: Optional
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: Optional
Stability: experimental
const FaaSColdstartsDescription = "Number of invocation cold starts"
FaaSColdstarts is the metric conforming to the "faas.coldstarts" semantic
conventions. It represents the number of invocation cold starts.
Instrument: counter
Unit: {coldstart}
Stability: Experimental
const FaaSColdstartsUnit = "{coldstart}" const FaaSCPUUsageDescription = "Distribution of CPU usage per invocation"
FaaSCPUUsage is the metric conforming to the "faas.cpu_usage" semantic
conventions. It represents the distribution of CPU usage per invocation.
Instrument: histogram
Unit: s
Stability: Experimental
const FaaSCPUUsageUnit = "s"
FaaSCronKey is the attribute Key conforming to the "faas.cron" semantic
conventions. It represents a string containing the schedule period as
[Cron
Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://www.iso.org/iso-8601-date-and-time-format.html) format
expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '2020-01-23T13:47:06Z'
const FaaSErrorsDescription = "Number of invocation errors"
FaaSErrors is the metric conforming to the "faas.errors" semantic
conventions. It represents the number of invocation errors.
Instrument: counter
Unit: {error}
Stability: Experimental
const FaaSErrorsUnit = "{error}" const FaaSInitDurationDescription = "Measures the duration of the function's initialization, such as a co...
FaaSInitDuration is the metric conforming to the "faas.init_duration"
semantic conventions. It represents the measures the duration of the
function's initialization, such as a cold start.
Instrument: histogram
Unit: s
Stability: Experimental
const FaaSInitDurationUnit = "s"
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'af9d5aa4-a685-4c5f-a22b-444f80b3cc28'
const FaaSInvocationsDescription = "Number of successful invocations"
FaaSInvocations is the metric conforming to the "faas.invocations" semantic
conventions. It represents the number of successful invocations.
Instrument: counter
Unit: {invocation}
Stability: Experimental
const FaaSInvocationsUnit = "{invocation}"
FaaSInvokedNameKey is the attribute Key conforming to the
"faas.invoked_name" semantic conventions. It represents the name of the
invoked function.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'eu-central-1'
Note: SHOULD be equal to the `cloud.region` resource attribute of the
invoked function.
const FaaSInvokeDurationDescription = "Measures the duration of the function's logic execution"
FaaSInvokeDuration is the metric conforming to the "faas.invoke_duration"
semantic conventions. It represents the measures the duration of the
function's logic execution.
Instrument: histogram
Unit: s
Stability: Experimental
const FaaSInvokeDurationUnit = "s"
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: Optional
Stability: experimental
Examples: 134217728
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).
const FaaSMemUsageDescription = "Distribution of max memory usage per invocation"
FaaSMemUsage is the metric conforming to the "faas.mem_usage" semantic
conventions. It represents the distribution of max memory usage per
invocation.
Instrument: histogram
Unit: By
Stability: Experimental
const FaaSMemUsageUnit = "By"
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: Optional
Stability: experimental
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`](/docs/general/attributes.md#source-code-attributes)
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).
const FaaSNetIoDescription = "Distribution of net I/O usage per invocation"
FaaSNetIo is the metric conforming to the "faas.net_io" semantic
conventions. It represents the distribution of net I/O usage per invocation.
Instrument: histogram
Unit: By
Stability: Experimental
const FaaSNetIoUnit = "By"
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](https://www.iso.org/iso-8601-date-and-time-format.html) format
expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '2020-01-23T13:47:06Z'
const FaaSTimeoutsDescription = "Number of invocation timeouts"
FaaSTimeouts is the metric conforming to the "faas.timeouts" semantic
conventions. It represents the number of invocation timeouts.
Instrument: counter
Unit: {timeout}
Stability: Experimental
const FaaSTimeoutsUnit = "{timeout}"
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '26', 'pinkfroid-00002'
Note: Depending on the cloud provider and platform, use:
* **AWS Lambda:** The [function
version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
(an integer represented as a decimal string).
* **Google Cloud Run (Services):** The
[revision](https://cloud.google.com/run/docs/managing/revisions)
(i.e., the function name plus the revision suffix).
* **Google Cloud Functions:** The value of the
[`K_REVISION` environment
variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
* **Azure Functions:** Not applicable. Do not set this attribute.
FeatureFlagKeyKey is the attribute Key conforming to the
"feature_flag.key" semantic conventions. It represents the unique
identifier of the feature flag.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'logo-color'
FeatureFlagProviderNameKey is the attribute Key conforming to the
"feature_flag.provider_name" semantic conventions. It represents the
name of the service provider that performs the flag evaluation.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'Flag Manager'
FeatureFlagVariantKey is the attribute Key conforming to the
"feature_flag.variant" semantic conventions. It represents the sHOULD be
a semantic identifier for a value. If one is unavailable, a stringified
version of the value can be used.
Type: string
RequirementLevel: Optional
Stability: experimental
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`.
A stringified version of the value can be used in situations where a
semantic identifier is unavailable. String representation of the value
should be determined by the implementer.
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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").
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: Optional
Stability: experimental
Examples: 'example.png'
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: Optional
Stability: experimental
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: Optional
Stability: experimental
GCPCloudRunJobExecutionKey is the attribute Key conforming to the
"gcp.cloud_run.job.execution" semantic conventions. It represents the
name of the Cloud Run
[execution](https://cloud.google.com/run/docs/managing/job-executions)
being run for the Job, as set by the
[`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
environment variable.
Type: string
RequirementLevel: Optional
Stability: experimental
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`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars)
environment variable.
Type: int
RequirementLevel: Optional
Stability: experimental
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](https://cloud.google.com/compute/docs/instances/custom-hostname-vm).
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'instance-1', 'my-vm-name'
GenAiCompletionKey is the attribute Key conforming to the
"gen_ai.completion" semantic conventions. It represents the full
response received from the LLM.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: "[{'role': 'assistant', 'content': 'The capital of France is
Paris.'}]"
Note: It's RECOMMENDED to format completions as JSON string matching
[OpenAI messages
format](https://platform.openai.com/docs/guides/text-generation)
GenAiPromptKey is the attribute Key conforming to the "gen_ai.prompt"
semantic conventions. It represents the full prompt sent to an LLM.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: "[{'role': 'user', 'content': 'What is the capital of
France?'}]"
Note: It's RECOMMENDED to format prompts as JSON string matching [OpenAI
messages
format](https://platform.openai.com/docs/guides/text-generation)
GenAiRequestMaxTokensKey is the attribute Key conforming to the
"gen_ai.request.max_tokens" semantic conventions. It represents the
maximum number of tokens the LLM generates for a request.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 100
GenAiRequestModelKey is the attribute Key conforming to the
"gen_ai.request.model" semantic conventions. It represents the name of
the LLM a request is being made to.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'gpt-4'
GenAiRequestTemperatureKey is the attribute Key conforming to the
"gen_ai.request.temperature" semantic conventions. It represents the
temperature setting for the LLM request.
Type: double
RequirementLevel: Optional
Stability: experimental
Examples: 0.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 LLM request.
Type: double
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'stop'
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: Optional
Stability: experimental
Examples: 'chatcmpl-123'
GenAiResponseModelKey is the attribute Key conforming to the
"gen_ai.response.model" semantic conventions. It represents the name of
the LLM a response was generated from.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'gpt-4-0613'
GenAiSystemKey is the attribute Key conforming to the "gen_ai.system"
semantic conventions. It represents the Generative AI product as
identified by the client instrumentation.
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'openai'
Note: The actual GenAI product may differ from the one identified by the
client. For example, when using OpenAI client libraries to communicate
with Mistral, the `gen_ai.system` is set to `openai` based on the
instrumentation's best knowledge.
GenAiUsageCompletionTokensKey is the attribute Key conforming to the
"gen_ai.usage.completion_tokens" semantic conventions. It represents the
number of tokens used in the LLM response (completion).
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 180
GenAiUsagePromptTokensKey is the attribute Key conforming to the
"gen_ai.usage.prompt_tokens" semantic conventions. It represents the
number of tokens used in the LLM prompt.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 100
GraphqlDocumentKey is the attribute Key conforming to the
"graphql.document" semantic conventions. It represents the GraphQL
document being executed.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'GenuineIntel'
Note: [CPUID](https://wiki.osdev.org/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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](/docs/resource/README.md#version-attributes).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '0.1'
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: Optional
Stability: experimental
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](https://www.rfc-editor.org/rfc/rfc5952.html) 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: Optional
Stability: experimental
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](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf):
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'n1-standard-1'
const HTTPClientActiveRequestsDescription = "Number of active HTTP requests."
HTTPClientActiveRequests is the metric conforming to the
"http.client.active_requests" semantic conventions. It represents the number
of active HTTP requests.
Instrument: updowncounter
Unit: {request}
Stability: Experimental
const HTTPClientActiveRequestsUnit = "{request}" const HTTPClientConnectionDurationDescription = "The duration of the successfully established outbound HTTP connectio...
HTTPClientConnectionDuration is the metric conforming to the
"http.client.connection.duration" semantic conventions. It represents the
duration of the successfully established outbound HTTP connections.
Instrument: histogram
Unit: s
Stability: Experimental
const HTTPClientConnectionDurationUnit = "s" const HTTPClientOpenConnectionsDescription = "Number of outbound HTTP connections that are currently active or idl...
HTTPClientOpenConnections is the metric conforming to the
"http.client.open_connections" semantic conventions. It represents the
number of outbound HTTP connections that are currently active or idle on the
client.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
const HTTPClientOpenConnectionsUnit = "{connection}" const HTTPClientRequestBodySizeDescription = "Size of HTTP client request bodies."
HTTPClientRequestBodySize is the metric conforming to the
"http.client.request.body.size" semantic conventions. It represents the size
of HTTP client request bodies.
Instrument: histogram
Unit: By
Stability: Experimental
const HTTPClientRequestBodySizeUnit = "By" const HTTPClientRequestDurationDescription = "Duration of HTTP client requests."
HTTPClientRequestDuration is the metric conforming to the
"http.client.request.duration" semantic conventions. It represents the
duration of HTTP client requests.
Instrument: histogram
Unit: s
Stability: Stable
const HTTPClientRequestDurationUnit = "s" const HTTPClientResponseBodySizeDescription = "Size of HTTP client response bodies."
HTTPClientResponseBodySize is the metric conforming to the
"http.client.response.body.size" semantic conventions. It represents the
size of HTTP client response bodies.
Instrument: histogram
Unit: By
Stability: Experimental
const HTTPClientResponseBodySizeUnit = "By"
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: Optional
Stability: experimental
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](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length)
header. For requests using transport encoding, this should be the
compressed size.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 3495
HTTPRequestMethodKey is the attribute Key conforming to the
"http.request.method" semantic conventions. It represents the hTTP
request method.
Type: Enum
RequirementLevel: Optional
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](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
and the PATCH method defined in
[RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
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: Optional
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: Optional
Stability: stable
Examples: 3
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: Optional
Stability: experimental
Examples: 1437
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](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length)
header. For requests using transport encoding, this should be the
compressed size.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 3495
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: Optional
Stability: experimental
Examples: 1437
HTTPResponseStatusCodeKey is the attribute Key conforming to the
"http.response.status_code" semantic conventions. It represents the
[HTTP response status
code](https://tools.ietf.org/html/rfc7231#section-6).
Type: int
RequirementLevel: Optional
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: Optional
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](/docs/http/http-spans.md#http-server-definitions) if there is one.
const HTTPServerActiveRequestsDescription = "Number of active HTTP server requests."
HTTPServerActiveRequests is the metric conforming to the
"http.server.active_requests" semantic conventions. It represents the number
of active HTTP server requests.
Instrument: updowncounter
Unit: {request}
Stability: Experimental
const HTTPServerActiveRequestsUnit = "{request}" const HTTPServerRequestBodySizeDescription = "Size of HTTP server request bodies."
HTTPServerRequestBodySize is the metric conforming to the
"http.server.request.body.size" semantic conventions. It represents the size
of HTTP server request bodies.
Instrument: histogram
Unit: By
Stability: Experimental
const HTTPServerRequestBodySizeUnit = "By" const HTTPServerRequestDurationDescription = "Duration of HTTP server requests."
HTTPServerRequestDuration is the metric conforming to the
"http.server.request.duration" semantic conventions. It represents the
duration of HTTP server requests.
Instrument: histogram
Unit: s
Stability: Stable
const HTTPServerRequestDurationUnit = "s" const HTTPServerResponseBodySizeDescription = "Size of HTTP server response bodies."
HTTPServerResponseBodySize is the metric conforming to the
"http.server.response.body.size" semantic conventions. It represents the
size of HTTP server response bodies.
Instrument: histogram
Unit: By
Stability: Experimental
const HTTPServerResponseBodySizeUnit = "By" const JvmBufferCountDescription = "Number of buffers in the pool."
JvmBufferCount is the metric conforming to the "jvm.buffer.count" semantic
conventions. It represents the number of buffers in the pool.
Instrument: updowncounter
Unit: {buffer}
Stability: Experimental
const JvmBufferCountUnit = "{buffer}" const JvmBufferMemoryLimitDescription = "Measure of total memory capacity of buffers."
JvmBufferMemoryLimit is the metric conforming to the
"jvm.buffer.memory.limit" semantic conventions. It represents the measure of
total memory capacity of buffers.
Instrument: updowncounter
Unit: By
Stability: Experimental
const JvmBufferMemoryLimitUnit = "By" const JvmBufferMemoryUsageDescription = "Measure of memory used by buffers."
JvmBufferMemoryUsage is the metric conforming to the
"jvm.buffer.memory.usage" semantic conventions. It represents the measure of
memory used by buffers.
Instrument: updowncounter
Unit: By
Stability: Experimental
const JvmBufferMemoryUsageUnit = "By"
JvmBufferPoolNameKey is the attribute Key conforming to the
"jvm.buffer.pool.name" semantic conventions. It represents the name of
the buffer pool.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'mapped', 'direct'
Note: Pool names are generally obtained via
[BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()).
const JvmClassCountDescription = "Number of classes currently loaded."
JvmClassCount is the metric conforming to the "jvm.class.count" semantic
conventions. It represents the number of classes currently loaded.
Instrument: updowncounter
Unit: {class}
Stability: Stable
const JvmClassCountUnit = "{class}" const JvmClassLoadedDescription = "Number of classes loaded since JVM start."
JvmClassLoaded is the metric conforming to the "jvm.class.loaded" semantic
conventions. It represents the number of classes loaded since JVM start.
Instrument: counter
Unit: {class}
Stability: Stable
const JvmClassLoadedUnit = "{class}" const JvmClassUnloadedDescription = "Number of classes unloaded since JVM start."
JvmClassUnloaded is the metric conforming to the "jvm.class.unloaded"
semantic conventions. It represents the number of classes unloaded since JVM
start.
Instrument: counter
Unit: {class}
Stability: Stable
const JvmClassUnloadedUnit = "{class}" const JvmCPUCountDescription = "Number of processors available to the Java virtual machine."
JvmCPUCount is the metric conforming to the "jvm.cpu.count" semantic
conventions. It represents the number of processors available to the Java
virtual machine.
Instrument: updowncounter
Unit: {cpu}
Stability: Stable
const JvmCPUCountUnit = "{cpu}" const JvmCPURecentUtilizationDescription = "Recent CPU utilization for the process as reported by the JVM."
JvmCPURecentUtilization is the metric conforming to the
"jvm.cpu.recent_utilization" semantic conventions. It represents the recent
CPU utilization for the process as reported by the JVM.
Instrument: gauge
Unit: 1
Stability: Stable
const JvmCPURecentUtilizationUnit = "1" const JvmCPUTimeDescription = "CPU time used by the process as reported by the JVM."
JvmCPUTime is the metric conforming to the "jvm.cpu.time" semantic
conventions. It represents the cPU time used by the process as reported by
the JVM.
Instrument: counter
Unit: s
Stability: Stable
const JvmCPUTimeUnit = "s"
JvmGcActionKey is the attribute Key conforming to the "jvm.gc.action"
semantic conventions. It represents the name of the garbage collector
action.
Type: string
RequirementLevel: Optional
Stability: stable
Examples: 'end of minor GC', 'end of major GC'
Note: Garbage collector action is generally obtained via
[GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()).
const JvmGcDurationDescription = "Duration of JVM garbage collection actions."
JvmGcDuration is the metric conforming to the "jvm.gc.duration" semantic
conventions. It represents the duration of JVM garbage collection actions.
Instrument: histogram
Unit: s
Stability: Stable
const JvmGcDurationUnit = "s"
JvmGcNameKey is the attribute Key conforming to the "jvm.gc.name"
semantic conventions. It represents the name of the garbage collector.
Type: string
RequirementLevel: Optional
Stability: stable
Examples: 'G1 Young Generation', 'G1 Old Generation'
Note: Garbage collector name is generally obtained via
[GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()).
const JvmMemoryCommittedDescription = "Measure of memory committed."
JvmMemoryCommitted is the metric conforming to the "jvm.memory.committed"
semantic conventions. It represents the measure of memory committed.
Instrument: updowncounter
Unit: By
Stability: Stable
const JvmMemoryCommittedUnit = "By" const JvmMemoryInitDescription = "Measure of initial memory requested."
JvmMemoryInit is the metric conforming to the "jvm.memory.init" semantic
conventions. It represents the measure of initial memory requested.
Instrument: updowncounter
Unit: By
Stability: Experimental
const JvmMemoryInitUnit = "By" const JvmMemoryLimitDescription = "Measure of max obtainable memory."
JvmMemoryLimit is the metric conforming to the "jvm.memory.limit" semantic
conventions. It represents the measure of max obtainable memory.
Instrument: updowncounter
Unit: By
Stability: Stable
const JvmMemoryLimitUnit = "By"
JvmMemoryPoolNameKey is the attribute Key conforming to the
"jvm.memory.pool.name" semantic conventions. It represents the name of
the memory pool.
Type: string
RequirementLevel: Optional
Stability: stable
Examples: 'G1 Old Gen', 'G1 Eden space', 'G1 Survivor Space'
Note: Pool names are generally obtained via
[MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()).
JvmMemoryTypeKey is the attribute Key conforming to the
"jvm.memory.type" semantic conventions. It represents the type of
memory.
Type: Enum
RequirementLevel: Optional
Stability: stable
Examples: 'heap', 'non_heap'
const JvmMemoryUsedAfterLastGcDescription = "Measure of memory used, as measured after the most recent garbage co...
JvmMemoryUsedAfterLastGc is the metric conforming to the
"jvm.memory.used_after_last_gc" semantic conventions. It represents the
measure of memory used, as measured after the most recent garbage collection
event on this pool.
Instrument: updowncounter
Unit: By
Stability: Stable
const JvmMemoryUsedAfterLastGcUnit = "By" const JvmMemoryUsedDescription = "Measure of memory used."
JvmMemoryUsed is the metric conforming to the "jvm.memory.used" semantic
conventions. It represents the measure of memory used.
Instrument: updowncounter
Unit: By
Stability: Stable
const JvmMemoryUsedUnit = "By" const JvmSystemCPULoad1mDescription = "Average CPU load of the whole system for the last minute as reported...
JvmSystemCPULoad1m is the metric conforming to the "jvm.system.cpu.load_1m"
semantic conventions. It represents the average CPU load of the whole system
for the last minute as reported by the JVM.
Instrument: gauge
Unit: {run_queue_item}
Stability: Experimental
const JvmSystemCPULoad1mUnit = "{run_queue_item}" const JvmSystemCPUUtilizationDescription = "Recent CPU utilization for the whole system as reported by the JVM."
JvmSystemCPUUtilization is the metric conforming to the
"jvm.system.cpu.utilization" semantic conventions. It represents the recent
CPU utilization for the whole system as reported by the JVM.
Instrument: gauge
Unit: 1
Stability: Experimental
const JvmSystemCPUUtilizationUnit = "1" const JvmThreadCountDescription = "Number of executing platform threads."
JvmThreadCount is the metric conforming to the "jvm.thread.count" semantic
conventions. It represents the number of executing platform threads.
Instrument: updowncounter
Unit: {thread}
Stability: Stable
const JvmThreadCountUnit = "{thread}"
JvmThreadDaemonKey is the attribute Key conforming to the
"jvm.thread.daemon" semantic conventions. It represents the whether the
thread is daemon or not.
Type: boolean
RequirementLevel: Optional
Stability: stable
JvmThreadStateKey is the attribute Key conforming to the
"jvm.thread.state" semantic conventions. It represents the state of the
thread.
Type: Enum
RequirementLevel: Optional
Stability: stable
Examples: 'runnable', 'blocked'
K8SClusterNameKey is the attribute Key conforming to the
"k8s.cluster.name" semantic conventions. It represents the name of the
cluster.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://www.itu.int/ITU-T/studygroups/com17/oid.html).
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'Evicted', 'Error'
K8SCronJobNameKey is the attribute Key conforming to the
"k8s.cronjob.name" semantic conventions. It represents the name of the
CronJob.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
K8SJobNameKey is the attribute Key conforming to the "k8s.job.name"
semantic conventions. It represents the name of the Job.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'default'
K8SNodeNameKey is the attribute Key conforming to the "k8s.node.name"
semantic conventions. It represents the name of the Node.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
const KestrelActiveConnectionsDescription = "Number of connections that are currently active on the server."
KestrelActiveConnections is the metric conforming to the
"kestrel.active_connections" semantic conventions. It represents the number
of connections that are currently active on the server.
Instrument: updowncounter
Unit: {connection}
Stability: Stable
const KestrelActiveConnectionsUnit = "{connection}" const KestrelActiveTLSHandshakesDescription = "Number of TLS handshakes that are currently in progress on the server."
KestrelActiveTLSHandshakes is the metric conforming to the
"kestrel.active_tls_handshakes" semantic conventions. It represents the
number of TLS handshakes that are currently in progress on the server.
Instrument: updowncounter
Unit: {handshake}
Stability: Stable
const KestrelActiveTLSHandshakesUnit = "{handshake}" const KestrelConnectionDurationDescription = "The duration of connections on the server."
KestrelConnectionDuration is the metric conforming to the
"kestrel.connection.duration" semantic conventions. It represents the
duration of connections on the server.
Instrument: histogram
Unit: s
Stability: Stable
const KestrelConnectionDurationUnit = "s" const KestrelQueuedConnectionsDescription = "Number of connections that are currently queued and are waiting to s...
KestrelQueuedConnections is the metric conforming to the
"kestrel.queued_connections" semantic conventions. It represents the number
of connections that are currently queued and are waiting to start.
Instrument: updowncounter
Unit: {connection}
Stability: Stable
const KestrelQueuedConnectionsUnit = "{connection}" const KestrelQueuedRequestsDescription = "Number of HTTP requests on multiplexed connections (HTTP/2 and HTTP/...
KestrelQueuedRequests is the metric conforming to the
"kestrel.queued_requests" semantic conventions. It represents the number of
HTTP requests on multiplexed connections (HTTP/2 and HTTP/3) that are
currently queued and are waiting to start.
Instrument: updowncounter
Unit: {request}
Stability: Stable
const KestrelQueuedRequestsUnit = "{request}" const KestrelRejectedConnectionsDescription = "Number of connections rejected by the server."
KestrelRejectedConnections is the metric conforming to the
"kestrel.rejected_connections" semantic conventions. It represents the
number of connections rejected by the server.
Instrument: counter
Unit: {connection}
Stability: Stable
const KestrelRejectedConnectionsUnit = "{connection}" const KestrelTLSHandshakeDurationDescription = "The duration of TLS handshakes on the server."
KestrelTLSHandshakeDuration is the metric conforming to the
"kestrel.tls_handshake.duration" semantic conventions. It represents the
duration of TLS handshakes on the server.
Instrument: histogram
Unit: s
Stability: Stable
const KestrelTLSHandshakeDurationUnit = "s" const KestrelUpgradedConnectionsDescription = "Number of connections that are currently upgraded (WebSockets). ."
KestrelUpgradedConnections is the metric conforming to the
"kestrel.upgraded_connections" semantic conventions. It represents the
number of connections that are currently upgraded (WebSockets). .
Instrument: updowncounter
Unit: {connection}
Stability: Stable
const KestrelUpgradedConnectionsUnit = "{connection}"
LogFileNameKey is the attribute Key conforming to the "log.file.name"
semantic conventions. It represents the basename of the file.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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)](https://github.com/ulid/spec), but other identifiers
(e.g. UUID) may be used as needed.
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'client-5', 'myhost@8742@s8083jm'
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: Optional
Stability: experimental
MessagingDestinationNameKey is the attribute Key conforming to the
"messaging.destination.name" semantic conventions. It represents the
message destination name
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '1'
MessagingDestinationPublishAnonymousKey is the attribute Key conforming
to the "messaging.destination_publish.anonymous" semantic conventions.
It represents a boolean that is true if the publish message destination
is anonymous (could be unnamed or have auto-generated name).
Type: boolean
RequirementLevel: Optional
Stability: experimental
MessagingDestinationPublishNameKey is the attribute Key conforming to
the "messaging.destination_publish.name" semantic conventions. It
represents the name of the original destination the message was
published to
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'MyQueue', 'MyTopic'
Note: The name SHOULD uniquely identify a specific queue, topic, or
other entity within the broker. If
the broker doesn't have such notion, the original destination name
SHOULD uniquely identify the broker.
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: Optional
Stability: experimental
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: Optional
Stability: experimental
MessagingEventhubsConsumerGroupKey is the attribute Key conforming to
the "messaging.eventhubs.consumer.group" semantic conventions. It
represents the name of the consumer group the event consumer is
associated with.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'indexer'
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: Optional
Stability: experimental
Examples: 1701393730
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: Optional
Stability: experimental
Examples: 10
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 2
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: Optional
Stability: experimental
Examples: 'ordering_key'
MessagingKafkaConsumerGroupKey is the attribute Key conforming to the
"messaging.kafka.consumer.group" semantic conventions. It represents the
name of the Kafka Consumer Group that is handling the message. Only
applies to consumers, not producers.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'my-group'
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: Optional
Stability: experimental
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.
MessagingKafkaMessageOffsetKey is the attribute Key conforming to the
"messaging.kafka.message.offset" semantic conventions. It represents the
offset of a record in the corresponding Kafka partition.
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 42
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 1439
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 2738
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Note: If a custom value is used, it MUST be of low cardinality.
const MessagingProcessDurationDescription = "Measures the duration of process operation."
MessagingProcessDuration is the metric conforming to the
"messaging.process.duration" semantic conventions. It represents the
measures the duration of process operation.
Instrument: histogram
Unit: s
Stability: Experimental
const MessagingProcessDurationUnit = "s" const MessagingProcessMessagesDescription = "Measures the number of processed messages."
MessagingProcessMessages is the metric conforming to the
"messaging.process.messages" semantic conventions. It represents the
measures the number of processed messages.
Instrument: counter
Unit: {message}
Stability: Experimental
const MessagingProcessMessagesUnit = "{message}" const MessagingPublishDurationDescription = "Measures the duration of publish operation."
MessagingPublishDuration is the metric conforming to the
"messaging.publish.duration" semantic conventions. It represents the
measures the duration of publish operation.
Instrument: histogram
Unit: s
Stability: Experimental
const MessagingPublishDurationUnit = "s" const MessagingPublishMessagesDescription = "Measures the number of published messages."
MessagingPublishMessages is the metric conforming to the
"messaging.publish.messages" semantic conventions. It represents the
measures the number of published messages.
Instrument: counter
Unit: {message}
Stability: Experimental
const MessagingPublishMessagesUnit = "{message}"
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 123
const MessagingReceiveDurationDescription = "Measures the duration of receive operation."
MessagingReceiveDuration is the metric conforming to the
"messaging.receive.duration" semantic conventions. It represents the
measures the duration of receive operation.
Instrument: histogram
Unit: s
Stability: Experimental
const MessagingReceiveDurationUnit = "s" const MessagingReceiveMessagesDescription = "Measures the number of received messages."
MessagingReceiveMessages is the metric conforming to the
"messaging.receive.messages" semantic conventions. It represents the
measures the number of received messages.
Instrument: counter
Unit: {message}
Stability: Experimental
const MessagingReceiveMessagesUnit = "{message}"
MessagingRocketmqClientGroupKey is the attribute Key conforming to the
"messaging.rocketmq.client_group" semantic conventions. It represents
the name of the RocketMQ producer/consumer group that is handling the
message. The client type is identified by the SpanKind.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'myConsumerGroup'
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 3
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: Optional
Stability: experimental
Examples: 1665987217045
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'myNamespace'
MessagingServicebusDestinationSubscriptionNameKey is the attribute Key
conforming to the "messaging.servicebus.destination.subscription_name"
semantic conventions. It represents the name of the subscription in the
topic messages are received from.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'mySubscription'
MessagingServicebusDispositionStatusKey is the attribute Key conforming
to the "messaging.servicebus.disposition_status" semantic conventions.
It represents the describes the [settlement
type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock).
Type: Enum
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 2
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: Optional
Stability: experimental
Examples: 1701393730
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'sprint'
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: Optional
Stability: experimental
Examples: 'LTE'
NetworkConnectionTypeKey is the attribute Key conforming to the
"network.connection.type" semantic conventions. It represents the
internet connection type.
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'wifi'
NetworkIoDirectionKey is the attribute Key conforming to the
"network.io.direction" semantic conventions. It represents the network
IO operation direction.
Type: Enum
RequirementLevel: Optional
Stability: experimental
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: Optional
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: Optional
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: Optional
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: Optional
Stability: stable
Examples: 65123
NetworkProtocolNameKey is the attribute Key conforming to the
"network.protocol.name" semantic conventions. It represents the [OSI
application layer](https://osi-model.com/application-layer/) or non-OSI
equivalent.
Type: string
RequirementLevel: Optional
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: Optional
Stability: stable
Examples: '1.1', '2'
Note: If protocol version is subject to negotiation (for example using
[ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), 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](https://osi-model.com/transport-layer/) or
[inter-process communication
method](https://wikipedia.org/wiki/Inter-process_communication).
Type: Enum
RequirementLevel: Optional
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](https://osi-model.com/network-layer/) or non-OSI equivalent.
Type: Enum
RequirementLevel: Optional
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: Optional
Stability: experimental
Examples:
'sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4'
Note: Follows [OCI Image Manifest
Specification](https://github.com/opencontainers/image-spec/blob/main/manifest.md),
and specifically the [Digest
property](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests).
An example can be found in [Example Image
Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest).
OpentracingRefTypeKey is the attribute Key conforming to the
"opentracing.ref_type" semantic conventions. It represents the
parent-child Reference type
Type: Enum
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](/docs/resource/README.md#version-attributes).
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '14.2.1', '18.04.1'
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: Optional
Stability: stable
Examples: 'io.opentelemetry.contrib.mongodb'
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: Optional
Stability: stable
Examples: '1.0.0'
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: Optional
Stability: stable
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: Optional
Stability: stable
Examples: 'resource not found'
PeerServiceKey is the attribute Key conforming to the "peer.service"
semantic conventions. It represents the
[`service.name`](/docs/resource/README.md#service) of the remote
service. SHOULD be equal to the actual `service.name` resource attribute
of the remote service if any.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'AuthTokenCache'
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`.
Type: string[]
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'C:\\cmd\\otecol --config="my directory\\config.yaml"'
const ProcessContextSwitchesDescription = "Number of times the process has been context switched."
ProcessContextSwitches is the metric conforming to the
"process.context_switches" semantic conventions. It represents the number of
times the process has been context switched.
Instrument: counter
Unit: {count}
Stability: Experimental
const ProcessContextSwitchesUnit = "{count}"
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: Optional
Stability: experimental
ProcessCPUStateKey is the attribute Key conforming to the
"process.cpu.state" semantic conventions. It represents the CPU state of
the process.
Type: Enum
RequirementLevel: Optional
Stability: experimental
const ProcessCPUTimeDescription = "Total CPU seconds broken down by different states."
ProcessCPUTime is the metric conforming to the "process.cpu.time" semantic
conventions. It represents the total CPU seconds broken down by different
states.
Instrument: counter
Unit: s
Stability: Experimental
const ProcessCPUTimeUnit = "s" const ProcessCPUUtilizationDescription = "Difference in process.cpu.time since the last measurement, divided b...
ProcessCPUUtilization is the metric conforming to the
"process.cpu.utilization" semantic conventions. It represents the difference
in process.cpu.time since the last measurement, divided by the elapsed time
and number of CPUs available to the process.
Instrument: gauge
Unit: 1
Stability: Experimental
const ProcessCPUUtilizationUnit = "1"
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: Optional
Stability: experimental
Examples: '2023-11-21T09:25:34.853Z'
const ProcessDiskIoDescription = "Disk bytes transferred."
ProcessDiskIo is the metric conforming to the "process.disk.io" semantic
conventions. It represents the disk bytes transferred.
Instrument: counter
Unit: By
Stability: Experimental
const ProcessDiskIoUnit = "By"
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, can be set to the
`Name` in `proc/[pid]/status`. On Windows, can be set to the base name
of `GetProcessImageFileNameW`.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
const ProcessMemoryUsageDescription = "The amount of physical memory in use."
ProcessMemoryUsage is the metric conforming to the "process.memory.usage"
semantic conventions. It represents the amount of physical memory in use.
Instrument: updowncounter
Unit: By
Stability: Experimental
const ProcessMemoryUsageUnit = "By" const ProcessMemoryVirtualDescription = "The amount of committed virtual memory."
ProcessMemoryVirtual is the metric conforming to the
"process.memory.virtual" semantic conventions. It represents the amount of
committed virtual memory.
Instrument: updowncounter
Unit: By
Stability: Experimental
const ProcessMemoryVirtualUnit = "By" const ProcessNetworkIoDescription = "Network bytes transferred."
ProcessNetworkIo is the metric conforming to the "process.network.io"
semantic conventions. It represents the network bytes transferred.
Instrument: counter
Unit: By
Stability: Experimental
const ProcessNetworkIoUnit = "By" const ProcessOpenFileDescriptorCountDescription = "Number of file descriptors in use by the process."
ProcessOpenFileDescriptorCount is the metric conforming to the
"process.open_file_descriptor.count" semantic conventions. It represents the
number of file descriptors in use by the process.
Instrument: updowncounter
Unit: {count}
Stability: Experimental
const ProcessOpenFileDescriptorCountUnit = "{count}"
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: Optional
Stability: experimental
Examples: 'root'
const ProcessPagingFaultsDescription = "Number of page faults the process has made."
ProcessPagingFaults is the metric conforming to the "process.paging.faults"
semantic conventions. It represents the number of page faults the process
has made.
Instrument: counter
Unit: {fault}
Stability: Experimental
const ProcessPagingFaultsUnit = "{fault}"
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: Optional
Stability: experimental
ProcessParentPIDKey is the attribute Key conforming to the
"process.parent_pid" semantic conventions. It represents the parent
Process identifier (PPID).
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 111
ProcessPIDKey is the attribute Key conforming to the "process.pid"
semantic conventions. It represents the process identifier (PID).
Type: int
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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. For compiled native binaries, this SHOULD
be the name of the compiler.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 14
const ProcessThreadCountDescription = "Process threads count."
ProcessThreadCount is the metric conforming to the "process.thread.count"
semantic conventions. It represents the process threads count.
Instrument: updowncounter
Unit: {thread}
Stability: Experimental
const ProcessThreadCountUnit = "{thread}"
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'root'
ProcessVpidKey is the attribute Key conforming to the "process.vpid"
semantic conventions. It represents the virtual process identifier.
Type: int
RequirementLevel: Optional
Stability: experimental
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.
const RPCClientDurationDescription = "Measures the duration of outbound RPC."
RPCClientDuration is the metric conforming to the "rpc.client.duration"
semantic conventions. It represents the measures the duration of outbound
RPC.
Instrument: histogram
Unit: ms
Stability: Experimental
const RPCClientDurationUnit = "ms" const RPCClientRequestSizeDescription = "Measures the size of RPC request messages (uncompressed)."
RPCClientRequestSize is the metric conforming to the
"rpc.client.request.size" semantic conventions. It represents the measures
the size of RPC request messages (uncompressed).
Instrument: histogram
Unit: By
Stability: Experimental
const RPCClientRequestSizeUnit = "By" const RPCClientRequestsPerRPCDescription = "Measures the number of messages received per RPC."
RPCClientRequestsPerRPC is the metric conforming to the
"rpc.client.requests_per_rpc" semantic conventions. It represents the
measures the number of messages received per RPC.
Instrument: histogram
Unit: {count}
Stability: Experimental
const RPCClientRequestsPerRPCUnit = "{count}" const RPCClientResponseSizeDescription = "Measures the size of RPC response messages (uncompressed)."
RPCClientResponseSize is the metric conforming to the
"rpc.client.response.size" semantic conventions. It represents the measures
the size of RPC response messages (uncompressed).
Instrument: histogram
Unit: By
Stability: Experimental
const RPCClientResponseSizeUnit = "By" const RPCClientResponsesPerRPCDescription = "Measures the number of messages sent per RPC."
RPCClientResponsesPerRPC is the metric conforming to the
"rpc.client.responses_per_rpc" semantic conventions. It represents the
measures the number of messages sent per RPC.
Instrument: histogram
Unit: {count}
Stability: Experimental
const RPCClientResponsesPerRPCUnit = "{count}"
RPCConnectRPCErrorCodeKey is the attribute Key conforming to the
"rpc.connect_rpc.error_code" semantic conventions. It represents the
[error codes](https://connect.build/docs/protocol/#error-codes) of the
Connect request. Error codes are always string values.
Type: Enum
RequirementLevel: Optional
Stability: experimental
RPCGRPCStatusCodeKey is the attribute Key conforming to the
"rpc.grpc.status_code" semantic conventions. It represents the [numeric
status
code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of
the gRPC request.
Type: Enum
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
RPCMessageIDKey is the attribute Key conforming to the "rpc.message.id"
semantic conventions. It represents the mUST be calculated as two
different counters starting from `1` one for sent messages and one for
received message.
Type: int
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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` 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).
const RPCServerDurationDescription = "Measures the duration of inbound RPC."
RPCServerDuration is the metric conforming to the "rpc.server.duration"
semantic conventions. It represents the measures the duration of inbound
RPC.
Instrument: histogram
Unit: ms
Stability: Experimental
const RPCServerDurationUnit = "ms" const RPCServerRequestSizeDescription = "Measures the size of RPC request messages (uncompressed)."
RPCServerRequestSize is the metric conforming to the
"rpc.server.request.size" semantic conventions. It represents the measures
the size of RPC request messages (uncompressed).
Instrument: histogram
Unit: By
Stability: Experimental
const RPCServerRequestSizeUnit = "By" const RPCServerRequestsPerRPCDescription = "Measures the number of messages received per RPC."
RPCServerRequestsPerRPC is the metric conforming to the
"rpc.server.requests_per_rpc" semantic conventions. It represents the
measures the number of messages received per RPC.
Instrument: histogram
Unit: {count}
Stability: Experimental
const RPCServerRequestsPerRPCUnit = "{count}" const RPCServerResponseSizeDescription = "Measures the size of RPC response messages (uncompressed)."
RPCServerResponseSize is the metric conforming to the
"rpc.server.response.size" semantic conventions. It represents the measures
the size of RPC response messages (uncompressed).
Instrument: histogram
Unit: By
Stability: Experimental
const RPCServerResponseSizeUnit = "By" const RPCServerResponsesPerRPCDescription = "Measures the number of messages sent per RPC."
RPCServerResponsesPerRPC is the metric conforming to the
"rpc.server.responses_per_rpc" semantic conventions. It represents the
measures the number of messages sent per RPC.
Instrument: histogram
Unit: {count}
Stability: Experimental
const RPCServerResponsesPerRPCUnit = "{count}"
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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>
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: Optional
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: Optional
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: Optional
Stability: experimental
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](https://www.ietf.org/rfc/rfc4122.txt) 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`](https://www.freedesktop.org/software/systemd/man/machine-id.html)
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.
ServiceNameKey is the attribute Key conforming to the "service.name"
semantic conventions. It represents the logical name of the service.
Type: string
RequirementLevel: Optional
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`](process.md), e.g. `unknown_service:bash`. If
`process.executable.name` is not available, the value MUST be set to
`unknown_service`.
ServiceNamespaceKey is the attribute Key conforming to the
"service.namespace" semantic conventions. It represents a namespace for
`service.name`.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: stable
Examples: 'app_shutdown', 'timeout'
const SignalrServerActiveConnectionsDescription = "Number of connections that are currently active on the server."
SignalrServerActiveConnections is the metric conforming to the
"signalr.server.active_connections" semantic conventions. It represents the
number of connections that are currently active on the server.
Instrument: updowncounter
Unit: {connection}
Stability: Stable
const SignalrServerActiveConnectionsUnit = "{connection}" const SignalrServerConnectionDurationDescription = "The duration of connections on the server."
SignalrServerConnectionDuration is the metric conforming to the
"signalr.server.connection.duration" semantic conventions. It represents the
duration of connections on the server.
Instrument: histogram
Unit: s
Stability: Stable
const SignalrServerConnectionDurationUnit = "s"
SignalrTransportKey is the attribute Key conforming to the
"signalr.transport" semantic conventions. It represents the [SignalR
transport
type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md)
Type: Enum
RequirementLevel: Optional
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 3389, 2888
const SystemCPUFrequencyDescription = "Reports the current frequency of the CPU in Hz"
SystemCPUFrequency is the metric conforming to the "system.cpu.frequency"
semantic conventions. It represents the reports the current frequency of the
CPU in Hz.
Instrument: gauge
Unit: {Hz}
Stability: Experimental
const SystemCPUFrequencyUnit = "{Hz}" const SystemCPULogicalCountDescription = "Reports the number of logical (virtual) processor cores created by t...
SystemCPULogicalCount is the metric conforming to the
"system.cpu.logical.count" semantic conventions. It represents the reports
the number of logical (virtual) processor cores created by the operating
system to manage multitasking.
Instrument: updowncounter
Unit: {cpu}
Stability: Experimental
const SystemCPULogicalCountUnit = "{cpu}"
SystemCPULogicalNumberKey is the attribute Key conforming to the
"system.cpu.logical_number" semantic conventions. It represents the
logical CPU number [0..n-1]
Type: int
RequirementLevel: Optional
Stability: experimental
Examples: 1
const SystemCPUPhysicalCountDescription = "Reports the number of actual physical processor cores on the hardware"
SystemCPUPhysicalCount is the metric conforming to the
"system.cpu.physical.count" semantic conventions. It represents the reports
the number of actual physical processor cores on the hardware.
Instrument: updowncounter
Unit: {cpu}
Stability: Experimental
const SystemCPUPhysicalCountUnit = "{cpu}"
SystemCPUStateKey is the attribute Key conforming to the
"system.cpu.state" semantic conventions. It represents the state of the
CPU
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'idle', 'interrupt'
const SystemCPUTimeDescription = "Seconds each logical CPU spent on each mode"
SystemCPUTime is the metric conforming to the "system.cpu.time" semantic
conventions. It represents the seconds each logical CPU spent on each mode.
Instrument: counter
Unit: s
Stability: Experimental
const SystemCPUTimeUnit = "s" const SystemCPUUtilizationDescription = "Difference in system.cpu.time since the last measurement, divided by...
SystemCPUUtilization is the metric conforming to the
"system.cpu.utilization" semantic conventions. It represents the difference
in system.cpu.time since the last measurement, divided by the elapsed time
and number of logical CPUs.
Instrument: gauge
Unit: 1
Stability: Experimental
const SystemCPUUtilizationUnit = "1"
SystemDeviceKey is the attribute Key conforming to the "system.device"
semantic conventions. It represents the device identifier
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: '(identifier)'
SystemDiskIo is the metric conforming to the "system.disk.io" semantic
conventions.
Instrument: counter
Unit: By
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemDiskIoTimeDescription = "Time disk spent activated"
SystemDiskIoTime is the metric conforming to the "system.disk.io_time"
semantic conventions. It represents the time disk spent activated.
Instrument: counter
Unit: s
Stability: Experimental
const SystemDiskIoTimeUnit = "s" const SystemDiskIoUnit = "By"
SystemDiskMerged is the metric conforming to the "system.disk.merged"
semantic conventions.
Instrument: counter
Unit: {operation}
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemDiskMergedUnit = "{operation}"
SystemDiskOperations is the metric conforming to the
"system.disk.operations" semantic conventions.
Instrument: counter
Unit: {operation}
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemDiskOperationsUnit = "{operation}" const SystemDiskOperationTimeDescription = "Sum of the time each operation took to complete"
SystemDiskOperationTime is the metric conforming to the
"system.disk.operation_time" semantic conventions. It represents the sum of
the time each operation took to complete.
Instrument: counter
Unit: s
Stability: Experimental
const SystemDiskOperationTimeUnit = "s"
SystemFilesystemModeKey is the attribute Key conforming to the
"system.filesystem.mode" semantic conventions. It represents the
filesystem mode
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '/mnt/data'
SystemFilesystemStateKey is the attribute Key conforming to the
"system.filesystem.state" semantic conventions. It represents the
filesystem state
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'used'
SystemFilesystemTypeKey is the attribute Key conforming to the
"system.filesystem.type" semantic conventions. It represents the
filesystem type
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'ext4'
SystemFilesystemUsage is the metric conforming to the
"system.filesystem.usage" semantic conventions.
Instrument: updowncounter
Unit: By
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemFilesystemUsageUnit = "By"
SystemFilesystemUtilization is the metric conforming to the
"system.filesystem.utilization" semantic conventions.
Instrument: gauge
Unit: 1
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemFilesystemUtilizationUnit = "1" const SystemLinuxMemoryAvailableDescription = "An estimate of how much memory is available for starting new applica...
SystemLinuxMemoryAvailable is the metric conforming to the
"system.linux.memory.available" semantic conventions. It represents an
estimate of how much memory is available for starting new applications,
without causing swapping.
Instrument: updowncounter
Unit: By
Stability: Experimental
const SystemLinuxMemoryAvailableUnit = "By" const SystemMemoryLimitDescription = "Total memory available in the system."
SystemMemoryLimit is the metric conforming to the "system.memory.limit"
semantic conventions. It represents the total memory available in the
system.
Instrument: updowncounter
Unit: By
Stability: Experimental
const SystemMemoryLimitUnit = "By"
SystemMemoryStateKey is the attribute Key conforming to the
"system.memory.state" semantic conventions. It represents the memory
state
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'free', 'cached'
const SystemMemoryUsageDescription = "Reports memory in use by state."
SystemMemoryUsage is the metric conforming to the "system.memory.usage"
semantic conventions. It represents the reports memory in use by state.
Instrument: updowncounter
Unit: By
Stability: Experimental
const SystemMemoryUsageUnit = "By"
SystemMemoryUtilization is the metric conforming to the
"system.memory.utilization" semantic conventions.
Instrument: gauge
Unit: 1
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemMemoryUtilizationUnit = "1"
SystemNetworkConnections is the metric conforming to the
"system.network.connections" semantic conventions.
Instrument: updowncounter
Unit: {connection}
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemNetworkConnectionsUnit = "{connection}" const SystemNetworkDroppedDescription = "Count of packets that are dropped or discarded even though there was...
SystemNetworkDropped is the metric conforming to the
"system.network.dropped" semantic conventions. It represents the count of
packets that are dropped or discarded even though there was no error.
Instrument: counter
Unit: {packet}
Stability: Experimental
const SystemNetworkDroppedUnit = "{packet}" const SystemNetworkErrorsDescription = "Count of network errors detected"
SystemNetworkErrors is the metric conforming to the "system.network.errors"
semantic conventions. It represents the count of network errors detected.
Instrument: counter
Unit: {error}
Stability: Experimental
const SystemNetworkErrorsUnit = "{error}"
SystemNetworkIo is the metric conforming to the "system.network.io" semantic
conventions.
Instrument: counter
Unit: By
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemNetworkIoUnit = "By"
SystemNetworkPackets is the metric conforming to the
"system.network.packets" semantic conventions.
Instrument: counter
Unit: {packet}
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemNetworkPacketsUnit = "{packet}"
SystemNetworkStateKey is the attribute Key conforming to the
"system.network.state" semantic conventions. It represents a stateless
protocol MUST NOT set this attribute
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'close_wait'
SystemPagingDirectionKey is the attribute Key conforming to the
"system.paging.direction" semantic conventions. It represents the paging
access direction
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'in'
SystemPagingFaults is the metric conforming to the "system.paging.faults"
semantic conventions.
Instrument: counter
Unit: {fault}
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemPagingFaultsUnit = "{fault}"
SystemPagingOperations is the metric conforming to the
"system.paging.operations" semantic conventions.
Instrument: counter
Unit: {operation}
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemPagingOperationsUnit = "{operation}"
SystemPagingStateKey is the attribute Key conforming to the
"system.paging.state" semantic conventions. It represents the memory
paging state
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'free'
SystemPagingTypeKey is the attribute Key conforming to the
"system.paging.type" semantic conventions. It represents the memory
paging type
Type: Enum
RequirementLevel: Optional
Stability: experimental
Examples: 'minor'
const SystemPagingUsageDescription = "Unix swap or windows pagefile usage"
SystemPagingUsage is the metric conforming to the "system.paging.usage"
semantic conventions. It represents the unix swap or windows pagefile usage.
Instrument: updowncounter
Unit: By
Stability: Experimental
const SystemPagingUsageUnit = "By"
SystemPagingUtilization is the metric conforming to the
"system.paging.utilization" semantic conventions.
Instrument: gauge
Unit: 1
Stability: Experimental
NOTE: The description (brief) for this metric is not defined in the semantic-conventions repository.
const SystemPagingUtilizationUnit = "1" const SystemProcessCountDescription = "Total number of processes in each state"
SystemProcessCount is the metric conforming to the "system.process.count"
semantic conventions. It represents the total number of processes in each
state.
Instrument: updowncounter
Unit: {process}
Stability: Experimental
const SystemProcessCountUnit = "{process}" const SystemProcessCreatedDescription = "Total number of processes created over uptime of the host"
SystemProcessCreated is the metric conforming to the
"system.process.created" semantic conventions. It represents the total
number of processes created over uptime of the host.
Instrument: counter
Unit: {process}
Stability: Experimental
const SystemProcessCreatedUnit = "{process}"
SystemProcessStatusKey is the attribute Key conforming to the
"system.process.status" semantic conventions. It represents the process
state, e.g., [Linux Process State
Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES)
Type: Enum
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Required
Stability: stable
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: Required
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: Required
Stability: stable
Examples: '1.2.3'
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: Optional
Stability: experimental
Examples: 42
ThreadNameKey is the attribute Key conforming to the "thread.name"
semantic conventions. It represents the current thread name.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'main'
TLSCipherKey is the attribute Key conforming to the "tls.cipher"
semantic conventions. It represents the string indicating the
[cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5)
used during the current connection.
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4).
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples:
'0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0'
TLSClientIssuerKey is the attribute Key conforming to the
"tls.client.issuer" semantic conventions. It represents the
distinguished name of
[subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6)
of the issuer of the x.509 certificate presented by the client.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '1970-01-01T00:00:00.000Z'
TLSClientServerNameKey is the attribute Key conforming to the
"tls.client.server_name" semantic conventions. It represents the also
called an SNI, this tells the server which hostname to which the client
is attempting to connect to.
Type: string
RequirementLevel: Optional
Stability: experimental
Examples: 'opentelemetry.io'
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids),
this string should be lower case.
Type: string
RequirementLevel: Optional
Stability: experimental
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](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES)
Type: Enum
RequirementLevel: Optional
Stability: experimental
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](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES)
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples:
'0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0'
TLSServerIssuerKey is the attribute Key conforming to the
"tls.server.issuer" semantic conventions. It represents the
distinguished name of
[subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6)
of the issuer of the x.509 certificate presented by the client.
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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](https://www.rfc-editor.org/rfc/rfc2732#section-2) 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: Optional
Stability: experimental
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](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component
Type: string
RequirementLevel: Optional
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](https://www.rfc-editor.org/rfc/rfc3986)
Type: string
RequirementLevel: Optional
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.
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: Optional
Stability: experimental
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](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component
Type: string
RequirementLevel: Optional
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: Optional
Stability: experimental
Examples: 443
URLQueryKey is the attribute Key conforming to the "url.query" semantic
conventions. It represents the [URI
query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component
Type: string
RequirementLevel: Optional
Stability: stable
Examples: 'q=OpenTelemetry'
Note: Sensitive content provided in `url.query` SHOULD be scrubbed when
instrumentations can identify it.
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: Optional
Stability: experimental
Examples: 'example.com', 'foo.co.uk'
Note: This value can be determined precisely with the [public suffix
list](http://publicsuffix.org). 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](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component
identifying the used protocol.
Type: string
RequirementLevel: Optional
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: Optional
Stability: experimental
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](https://www.rfc-editor.org/rfc/rfc3986#section-4.2).
Type: string
RequirementLevel: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: 'com', 'co.uk'
Note: This value can be determined precisely with the [public suffix
list](http://publicsuffix.org).
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: Optional
Stability: experimental
Examples: 'Safari', 'YourApp'
Note: [Example](https://www.whatsmyua.info) 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](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent)
header sent by the client.
Type: string
RequirementLevel: Optional
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'
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: Optional
Stability: experimental
Examples: '14.1.2', '1.0.0'
Note: [Example](https://www.whatsmyua.info) 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`
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: Optional
Stability: experimental
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: Optional
Stability: experimental
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: Optional
Stability: experimental
Examples: '21.0.0'
 |
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. |