From 9dc00f2c4c31a7433bb6731012730e2443169868 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Fri, 19 Sep 2025 15:40:13 +1000 Subject: [PATCH 1/9] Automatically split attribute tables based on status --- docs/exceptions/exceptions-spans.md | 9 +- docs/registry/attributes/android.md | 22 +- docs/registry/attributes/app.md | 3 +- docs/registry/attributes/artifact.md | 3 +- docs/registry/attributes/aspnetcore.md | 3 +- docs/registry/attributes/aws.md | 123 +++--- docs/registry/attributes/azure.md | 18 +- docs/registry/attributes/browser.md | 3 +- docs/registry/attributes/cassandra.md | 3 +- docs/registry/attributes/cicd.md | 3 +- docs/registry/attributes/client.md | 3 +- docs/registry/attributes/cloud.md | 3 +- docs/registry/attributes/cloudevents.md | 3 +- docs/registry/attributes/cloudfoundry.md | 3 +- docs/registry/attributes/code.md | 37 +- docs/registry/attributes/container.md | 53 +-- docs/registry/attributes/cpu.md | 3 +- docs/registry/attributes/cpython.md | 3 +- docs/registry/attributes/db.md | 391 +++++++++--------- docs/registry/attributes/deployment.md | 29 +- docs/registry/attributes/destination.md | 3 +- docs/registry/attributes/device.md | 3 +- docs/registry/attributes/disk.md | 3 +- docs/registry/attributes/dns.md | 3 +- docs/registry/attributes/dotnet.md | 3 +- docs/registry/attributes/elasticsearch.md | 3 +- docs/registry/attributes/enduser.md | 31 +- docs/registry/attributes/error.md | 3 +- docs/registry/attributes/event.md | 10 +- docs/registry/attributes/exception.md | 13 +- docs/registry/attributes/faas.md | 3 +- docs/registry/attributes/feature-flag.md | 67 +-- docs/registry/attributes/file.md | 3 +- docs/registry/attributes/gcp.md | 73 ++-- docs/registry/attributes/gen-ai.md | 51 ++- docs/registry/attributes/geo.md | 3 +- docs/registry/attributes/go.md | 3 +- docs/registry/attributes/graphql.md | 3 +- docs/registry/attributes/hardware.md | 3 +- docs/registry/attributes/heroku.md | 3 +- docs/registry/attributes/host.md | 3 +- docs/registry/attributes/http.md | 81 ++-- docs/registry/attributes/ios.md | 15 +- docs/registry/attributes/jvm.md | 3 +- docs/registry/attributes/k8s.md | 13 +- docs/registry/attributes/linux.md | 3 +- docs/registry/attributes/log.md | 9 +- docs/registry/attributes/mainframe.md | 3 +- docs/registry/attributes/messaging.md | 97 +++-- docs/registry/attributes/network.md | 105 ++--- docs/registry/attributes/nfs.md | 3 +- docs/registry/attributes/nodejs.md | 3 +- docs/registry/attributes/oci.md | 3 +- docs/registry/attributes/onc-rpc.md | 3 +- docs/registry/attributes/openai.md | 3 +- docs/registry/attributes/openshift.md | 3 +- docs/registry/attributes/opentracing.md | 3 +- docs/registry/attributes/os.md | 3 +- docs/registry/attributes/otel.md | 59 +-- docs/registry/attributes/peer.md | 3 +- docs/registry/attributes/pprof.md | 3 +- docs/registry/attributes/process.md | 94 ++--- docs/registry/attributes/profile.md | 3 +- docs/registry/attributes/rpc.md | 19 +- docs/registry/attributes/security-rule.md | 3 +- docs/registry/attributes/server.md | 3 +- docs/registry/attributes/service.md | 3 +- docs/registry/attributes/session.md | 3 +- docs/registry/attributes/signalr.md | 3 +- docs/registry/attributes/source.md | 3 +- docs/registry/attributes/system.md | 102 ++--- docs/registry/attributes/telemetry.md | 3 +- docs/registry/attributes/test.md | 3 +- docs/registry/attributes/thread.md | 3 +- docs/registry/attributes/tls.md | 29 +- docs/registry/attributes/url.md | 3 +- docs/registry/attributes/user-agent.md | 6 +- docs/registry/attributes/user.md | 3 +- docs/registry/attributes/v8js.md | 3 +- docs/registry/attributes/vcs.md | 21 +- docs/registry/attributes/webengine.md | 3 +- docs/registry/attributes/zos.md | 3 +- .../deprecated/registry-deprecated.yaml | 33 -- model/android/registry.yaml | 30 ++ .../registry/markdown/attribute_macros.j2 | 2 + .../markdown/attribute_namespace.md.j2 | 24 +- .../registry/markdown/attribute_table.j2 | 15 +- 87 files changed, 916 insertions(+), 930 deletions(-) delete mode 100644 model/android/deprecated/registry-deprecated.yaml diff --git a/docs/exceptions/exceptions-spans.md b/docs/exceptions/exceptions-spans.md index 3fcc788a4a..c5b45c0b28 100644 --- a/docs/exceptions/exceptions-spans.md +++ b/docs/exceptions/exceptions-spans.md @@ -37,13 +37,20 @@ This event describes a single exception. |---|---|---|---|---|---| | [`exception.message`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [1] | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | | [`exception.type`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [2] | string | 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. | `java.net.ConnectException`; `OSError` | -| [`exception.escaped`](/docs/registry/attributes/exception.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | `Recommended` | boolean | Indicates that the exception is escaping the scope of the span. | | | [`exception.stacktrace`](/docs/registry/attributes/exception.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. | `Exception 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)` | **[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise. **[2] `exception.type`:** Required if `exception.message` is not set, recommended otherwise. +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | + +
diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index 687121360e..dd67229ba5 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -3,15 +3,11 @@ # Android -- [Android Attributes](#android-attributes) -- [Deprecated Android Attributes](#deprecated-android-attributes) - ## Android Attributes The Android platform on which the Android application is running. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `android.app.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | This attribute represents the state of the application. [1] | `created` | @@ -28,16 +24,14 @@ The Android platform on which the Android application is running. | `background` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | | `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) | | `foreground` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | +
+Past Attributes: -## Deprecated Android Attributes - -This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `android.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `android.app.state`. | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` | +| `android.state` | string | This attribute represents the state of the application. [1] | `created`; `background`; `foreground` | Use `android.app.state` instead. | + +**[1] `android.state`:** 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. --- @@ -48,3 +42,5 @@ This document defines attributes that represents an occurrence of a lifecycle tr | `background` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | | `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) | | `foreground` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/app.md b/docs/registry/attributes/app.md index d23b5d64d2..10c12a0fda 100644 --- a/docs/registry/attributes/app.md +++ b/docs/registry/attributes/app.md @@ -7,8 +7,7 @@ Describes attributes related to client-side applications (e.g. web apps or mobile apps). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `app.build_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for a particular build or compilation of the application. | `6cff0a7e-cefc-4668-96f5-1273d8b334d0`; `9f2b833506aa6973a92fde9733e6271f`; `my-app-1.0.0-code-123` | diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index c25ebf913d..e219b535e0 100644 --- a/docs/registry/attributes/artifact.md +++ b/docs/registry/attributes/artifact.md @@ -7,8 +7,7 @@ This group describes attributes specific to artifacts. Artifacts are files or other immutable objects that are intended for distribution. This definition aligns directly with the [SLSA](https://slsa.dev/spec/v1.0/terminology#package-model) package model. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `artifact.attestation.filename` | ![Development](https://img.shields.io/badge/-development-blue) | string | The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the [SLSA Relationship](https://slsa.dev/spec/v1.0/distributing-provenance#relationship-between-artifacts-and-attestations) specification for more information. | `golang-binary-amd64-v0.1.0.attestation`; `docker-image-amd64-v0.1.0.intoto.json1`; `release-1.tar.gz.attestation`; `file-name-package.tar.gz.intoto.json1` | diff --git a/docs/registry/attributes/aspnetcore.md b/docs/registry/attributes/aspnetcore.md index a70d2421a5..e06ed583cd 100644 --- a/docs/registry/attributes/aspnetcore.md +++ b/docs/registry/attributes/aspnetcore.md @@ -7,8 +7,7 @@ ASP.NET Core attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aspnetcore.authentication.result` | ![Development](https://img.shields.io/badge/-development-blue) | string | The result of the authentication operation. | `success`; `failure` | diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index 5d468e924b..1e3dc69e74 100644 --- a/docs/registry/attributes/aws.md +++ b/docs/registry/attributes/aws.md @@ -4,47 +4,34 @@ # AWS - [General AWS Attributes](#general-aws-attributes) -- [Amazon Bedrock Attributes](#amazon-bedrock-attributes) - [Amazon DynamoDB Attributes](#amazon-dynamodb-attributes) - [Amazon ECS Attributes](#amazon-ecs-attributes) - [Amazon EKS Attributes](#amazon-eks-attributes) -- [Amazon Kinesis Attributes](#amazon-kinesis-attributes) -- [Amazon Lambda Attributes](#amazon-lambda-attributes) - [Amazon Logs Attributes](#amazon-logs-attributes) +- [Amazon Lambda Attributes](#amazon-lambda-attributes) - [Amazon S3 Attributes](#amazon-s3-attributes) -- [Amazon Secrets Manager Attributes](#amazon-secrets-manager-attributes) -- [Amazon SNS Attributes](#amazon-sns-attributes) - [Amazon SQS Attributes](#amazon-sqs-attributes) +- [Amazon SNS Attributes](#amazon-sns-attributes) +- [Amazon Kinesis Attributes](#amazon-kinesis-attributes) - [Amazon Step Functions Attributes](#amazon-step-functions-attributes) +- [Amazon Secrets Manager Attributes](#amazon-secrets-manager-attributes) +- [Amazon Bedrock Attributes](#amazon-bedrock-attributes) ## General AWS Attributes This section defines generic attributes for AWS services. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.extended_request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | | `aws.request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | -## Amazon Bedrock Attributes - -This document defines attributes for AWS Bedrock. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `aws.bedrock.guardrail.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Guardrail. A [guardrail](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) helps safeguard and prevent unwanted behavior from model responses or user messages. | `sgi5gkybzqak` | -| `aws.bedrock.knowledge_base.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Knowledge base. A [knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) is a bank of information that can be queried by models to generate more relevant responses and augment prompts. | `XFWUPB9PAW` | - ## Amazon DynamoDB Attributes This document defines attributes for AWS DynamoDB. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.dynamodb.attribute_definitions` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]` | @@ -74,8 +61,7 @@ This document defines attributes for AWS DynamoDB. This document defines attributes for AWS Elastic Container Service (ECS). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.ecs.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | @@ -99,60 +85,46 @@ This document defines attributes for AWS Elastic Container Service (ECS). This document defines attributes for AWS Elastic Kubernetes Service (EKS). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.eks.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | -## Amazon Kinesis Attributes - -This document defines attributes for AWS Kinesis. +## Amazon Logs Attributes -**Attributes:** +This document defines attributes for AWS Logs. +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.kinesis.stream_name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the AWS Kinesis [stream](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) the request refers to. Corresponds to the `--stream-name` parameter of the Kinesis [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) operation. | `some-stream-name` | - -## Amazon Lambda Attributes - -This document defines attributes for AWS Lambda. - -**Attributes:** +| `aws.log.group.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The Amazon Resource Name(s) (ARN) of the AWS log group(s). [1] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]` | +| `aws.log.group.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log group(s) an application is writing to. [2] | `["/aws/lambda/my-function", "opentelemetry-service"]` | +| `aws.log.stream.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The ARN(s) of the AWS log stream(s). [3] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | +| `aws.log.stream.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `aws.lambda.invoked_arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). [1] | `arn:aws:lambda:us-east-1:123456:function:myfunction:myalias` | -| `aws.lambda.resource_mapping.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environtment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. | `587ad24b-03b9-4413-8202-bbd56b36e5b7` | +**[1] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). -**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. +**[2] `aws.log.group.names`:** 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. -## Amazon Logs Attributes +**[3] `aws.log.stream.arns`:** 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. -This document defines attributes for AWS Logs. +## Amazon Lambda Attributes -**Attributes:** +This document defines attributes for AWS Lambda. +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.log.group.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The Amazon Resource Name(s) (ARN) of the AWS log group(s). [2] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]` | -| `aws.log.group.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log group(s) an application is writing to. [3] | `["/aws/lambda/my-function", "opentelemetry-service"]` | -| `aws.log.stream.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The ARN(s) of the AWS log stream(s). [4] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | -| `aws.log.stream.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | - -**[2] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). - -**[3] `aws.log.group.names`:** 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. +| `aws.lambda.invoked_arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). [4] | `arn:aws:lambda:us-east-1:123456:function:myfunction:myalias` | +| `aws.lambda.resource_mapping.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environtment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. | `587ad24b-03b9-4413-8202-bbd56b36e5b7` | -**[4] `aws.log.stream.arns`:** 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. +**[4] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. ## Amazon S3 Attributes This document defines attributes for AWS S3. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.s3.bucket` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [5] | `some-bucket-name` | @@ -208,43 +180,58 @@ This applies in particular to the following operations: - [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) -## Amazon Secrets Manager Attributes - -This document defines attributes for AWS Secrets Manager. +## Amazon SQS Attributes -**Attributes:** +This document defines attributes for AWS SQS. +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | +| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | ## Amazon SNS Attributes This document defines attributes for AWS SNS. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.sns.topic.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS SNS Topic. An Amazon SNS [topic](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) is a logical access point that acts as a communication channel. | `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` | -## Amazon SQS Attributes - -This document defines attributes for AWS SQS. +## Amazon Kinesis Attributes -**Attributes:** +This document defines attributes for AWS Kinesis. +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | +| `aws.kinesis.stream_name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the AWS Kinesis [stream](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) the request refers to. Corresponds to the `--stream-name` parameter of the Kinesis [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) operation. | `some-stream-name` | ## Amazon Step Functions Attributes This document defines attributes for AWS Step Functions. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.step_functions.activity.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | | `aws.step_functions.state_machine.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | + +## Amazon Secrets Manager Attributes + +This document defines attributes for AWS Secrets Manager. + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | + +## Amazon Bedrock Attributes + +This document defines attributes for AWS Bedrock. + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `aws.bedrock.guardrail.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Guardrail. A [guardrail](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) helps safeguard and prevent unwanted behavior from model responses or user messages. | `sgi5gkybzqak` | +| `aws.bedrock.knowledge_base.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Knowledge base. A [knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) is a bank of information that can be queried by models to generate more relevant responses and augment prompts. | `XFWUPB9PAW` | diff --git a/docs/registry/attributes/azure.md b/docs/registry/attributes/azure.md index 2f681c3b8e..84d9fd5315 100644 --- a/docs/registry/attributes/azure.md +++ b/docs/registry/attributes/azure.md @@ -11,8 +11,7 @@ This section defines generic attributes used by Azure Client Libraries. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `azure.client.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | @@ -23,8 +22,7 @@ This section defines generic attributes used by Azure Client Libraries. This section defines attributes for Azure Cosmos DB. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `azure.cosmosdb.connection.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Cosmos client connection mode. | `gateway`; `direct` | @@ -61,9 +59,13 @@ This section defines attributes for Azure Cosmos DB. This section describes deprecated Azure attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `az.namespace` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.resource_provider.namespace`. | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | -| `az.service_request_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.service.request.id`. | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | +| `az.namespace` | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. | +| `az.service_request_id` | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. | + +
diff --git a/docs/registry/attributes/browser.md b/docs/registry/attributes/browser.md index cc8d235f4e..be1d713627 100644 --- a/docs/registry/attributes/browser.md +++ b/docs/registry/attributes/browser.md @@ -7,8 +7,7 @@ The web browser attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `browser.brands` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Array of brand name and version separated by a space [1] | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | diff --git a/docs/registry/attributes/cassandra.md b/docs/registry/attributes/cassandra.md index 640a98c36d..038cdc3334 100644 --- a/docs/registry/attributes/cassandra.md +++ b/docs/registry/attributes/cassandra.md @@ -7,8 +7,7 @@ This section defines attributes for Cassandra. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cassandra.consistency.level` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `all`; `each_quorum`; `quorum` | diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index 20a831180c..bccac7f638 100644 --- a/docs/registry/attributes/cicd.md +++ b/docs/registry/attributes/cicd.md @@ -7,8 +7,7 @@ This group describes attributes specific to pipelines within a Continuous Integration and Continuous Deployment (CI/CD) system. A [pipeline](https://wikipedia.org/wiki/Pipeline_(computing)) in this case is a series of steps that are performed in order to deliver a new version of software. This aligns with the [Britannica](https://www.britannica.com/dictionary/pipeline) definition of a pipeline where a **pipeline** is the system for developing and producing something. In the context of CI/CD, a pipeline produces or delivers software. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cicd.pipeline.action.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The kind of action a pipeline run is performing. | `BUILD`; `RUN`; `SYNC` | diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index 948ef0a5cc..c40af32f3b 100644 --- a/docs/registry/attributes/client.md +++ b/docs/registry/attributes/client.md @@ -7,8 +7,7 @@ These attributes may be used to describe the client in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `client.address` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/cloud.md b/docs/registry/attributes/cloud.md index adfb9fa7fe..a5b4ec7f8b 100644 --- a/docs/registry/attributes/cloud.md +++ b/docs/registry/attributes/cloud.md @@ -7,8 +7,7 @@ A cloud environment (e.g. GCP, Azure, AWS). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cloud.account.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | diff --git a/docs/registry/attributes/cloudevents.md b/docs/registry/attributes/cloudevents.md index a97116e500..ca6bdcc66c 100644 --- a/docs/registry/attributes/cloudevents.md +++ b/docs/registry/attributes/cloudevents.md @@ -7,8 +7,7 @@ This document defines attributes for CloudEvents. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cloudevents.event_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. | `123e4567-e89b-12d3-a456-426614174000`; `0001` | diff --git a/docs/registry/attributes/cloudfoundry.md b/docs/registry/attributes/cloudfoundry.md index 9e62fef3cb..6ce242a448 100644 --- a/docs/registry/attributes/cloudfoundry.md +++ b/docs/registry/attributes/cloudfoundry.md @@ -7,8 +7,7 @@ CloudFoundry resource attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cloudfoundry.app.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The guid of the application. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index 53402bd47b..0be30fbc05 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -3,15 +3,32 @@ # Code -- [Code Attributes](#code-attributes) - [Deprecated Code Attributes](#deprecated-code-attributes) +- [Code Attributes](#code-attributes) + +## Deprecated Code Attributes + +These deprecated attributes provide context about source code + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `code.column` | int | Deprecated, use `code.column.number` | `16` | Use `code.column.number` instead. | +| `code.filepath` | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | Use `code.file.path` instead. | +| `code.function` | string | Deprecated, use `code.function.name` instead | `serveRequest` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | +| `code.lineno` | int | Deprecated, use `code.line.number` instead | `42` | Use `code.line.number` instead. | +| `code.namespace` | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | + +
## Code Attributes These attributes provide context about source code -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `code.column.number` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | int | The column number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity. | `16` | @@ -35,17 +52,3 @@ Examples: * Erlang: `opentelemetry_ctx:new` * Rust: `playground::my_module::my_cool_func` * C function: `fopen` - -## Deprecated Code Attributes - -These deprecated attributes provide context about source code - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `code.column` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.column.number`. | int | Deprecated, use `code.column.number` | `16` | -| `code.filepath` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.file.path`. | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | -| `code.function` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `code.function.name` which is expected to be a fully-qualified name. | string | Deprecated, use `code.function.name` instead | `serveRequest` | -| `code.lineno` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.line.number`. | int | Deprecated, use `code.line.number` instead | `42` | -| `code.namespace` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `code.function.name` which is expected to be a fully-qualified name. | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index a3bee1557c..35cf7c37f7 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -3,15 +3,40 @@ # Container -- [Container Attributes](#container-attributes) - [Deprecated Container Attributes](#deprecated-container-attributes) +- [Container Attributes](#container-attributes) + +## Deprecated Container Attributes + +Describes deprecated container attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | Use `cpu.mode` instead. | +| `container.labels.` | string | Deprecated, use `container.label` instead. | `nginx` | Use `container.label` instead. | +| `container.runtime` | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | Use `container.runtime.name` instead. | + +--- + +`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | +| `system` | When CPU is used by the system (host OS) | ![Development](https://img.shields.io/badge/-development-blue) | +| `user` | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | + +
## Container Attributes A container instance. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `container.command` | ![Development](https://img.shields.io/badge/-development-blue) | string | The command used to run the container (i.e. the command name). [1] | `otelcontribcol` | @@ -43,25 +68,3 @@ The ID is assigned by the container runtime and can vary in different environmen **[5] `container.image.repo_digests`:** [Docker](https://docs.docker.com/reference/api/engine/version/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. **[6] `container.label.`:** For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`. - -## Deprecated Container Attributes - -Describes deprecated container attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `container.cpu.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | -| `container.labels.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.label`. | string | Deprecated, use `container.label` instead. | `nginx` | -| `container.runtime` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.runtime.name`. | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | - ---- - -`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | -| `system` | When CPU is used by the system (host OS) | ![Development](https://img.shields.io/badge/-development-blue) | -| `user` | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cpu.md b/docs/registry/attributes/cpu.md index 71429c0fd5..7590642c9b 100644 --- a/docs/registry/attributes/cpu.md +++ b/docs/registry/attributes/cpu.md @@ -7,8 +7,7 @@ Attributes specific to a cpu instance. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cpu.logical_number` | ![Development](https://img.shields.io/badge/-development-blue) | int | The logical CPU number [0..n-1] | `1` | diff --git a/docs/registry/attributes/cpython.md b/docs/registry/attributes/cpython.md index 7577056f9a..393bed1f30 100644 --- a/docs/registry/attributes/cpython.md +++ b/docs/registry/attributes/cpython.md @@ -7,8 +7,7 @@ This document defines CPython related attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cpython.gc.generation` | ![Development](https://img.shields.io/badge/-development-blue) | int | Value of the garbage collector collection generation. | `0`; `1`; `2` | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index a98f57e3c3..c7f3e61013 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -3,16 +3,212 @@ # DB -- [General Database Attributes](#general-database-attributes) - [Deprecated Database Attributes](#deprecated-database-attributes) - [Deprecated Database Metrics](#deprecated-database-metrics) +- [General Database Attributes](#general-database-attributes) + +## Deprecated Database Attributes + +Describes deprecated database attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `db.cassandra.consistency_level` | string | Deprecated, use `cassandra.consistency.level` instead. | `all`; `each_quorum`; `quorum` | Use `cassandra.consistency.level` instead. | +| `db.cassandra.coordinator.dc` | string | Deprecated, use `cassandra.coordinator.dc` instead. | `us-west-2` | Use `cassandra.coordinator.dc` instead. | +| `db.cassandra.coordinator.id` | string | Deprecated, use `cassandra.coordinator.id` instead. | `be13faa2-8574-4d71-926d-27f16cf8a7af` | Use `cassandra.coordinator.id` instead. | +| `db.cassandra.idempotence` | boolean | Deprecated, use `cassandra.query.idempotent` instead. | | Use `cassandra.query.idempotent` instead. | +| `db.cassandra.page_size` | int | Deprecated, use `cassandra.page.size` instead. | `5000` | Use `cassandra.page.size` instead. | +| `db.cassandra.speculative_execution_count` | int | Deprecated, use `cassandra.speculative_execution.count` instead. | `0`; `2` | Use `cassandra.speculative_execution.count` instead. | +| `db.cassandra.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | +| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | Replaced by `server.address` and `server.port`. | +| `db.cosmosdb.client_id` | string | Deprecated, use `azure.client.id` instead. | `3ba4827d-4422-483f-b59f-85b74211c11d` | Use `azure.client.id` instead. | +| `db.cosmosdb.connection_mode` | string | Deprecated, use `azure.cosmosdb.connection.mode` instead. | `gateway`; `direct` | Use `azure.cosmosdb.connection.mode` instead. | +| `db.cosmosdb.consistency_level` | string | Deprecated, use `cosmosdb.consistency.level` instead. | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | Use `azure.cosmosdb.consistency.level` instead. | +| `db.cosmosdb.container` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | +| `db.cosmosdb.operation_type` | string | Deprecated, no replacement at this time. | `batch`; `create`; `delete` | Removed, no replacement at this time. | +| `db.cosmosdb.regions_contacted` | string[] | Deprecated, use `azure.cosmosdb.operation.contacted_regions` instead. | `["North Central US", "Australia East", "Australia Southeast"]` | Use `azure.cosmosdb.operation.contacted_regions` instead. | +| `db.cosmosdb.request_charge` | double | Deprecated, use `azure.cosmosdb.operation.request_charge` instead. | `46.18`; `1.0` | Use `azure.cosmosdb.operation.request_charge` instead. | +| `db.cosmosdb.request_content_length` | int | Deprecated, use `azure.cosmosdb.request.body.size` instead. | | Use `azure.cosmosdb.request.body.size` instead. | +| `db.cosmosdb.status_code` | int | Deprecated, use `db.response.status_code` instead. | `200`; `201` | Use `db.response.status_code` instead. | +| `db.cosmosdb.sub_status_code` | int | Deprecated, use `azure.cosmosdb.response.sub_status_code` instead. | `1000`; `1002` | Use `azure.cosmosdb.response.sub_status_code` instead. | +| `db.elasticsearch.cluster.name` | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | Use `db.namespace` instead. | +| `db.elasticsearch.node.name` | string | Deprecated, use `elasticsearch.node.name` instead. | `instance-0000000001` | Use `elasticsearch.node.name` instead. | +| `db.elasticsearch.path_parts.` | string | Deprecated, use `db.operation.parameter` instead. | `test-index`; `123` | Use `db.operation.parameter` instead. | +| `db.instance.id` | string | Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | `mysql-e26b99z.example.com` | Removed, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | +| `db.jdbc.driver_classname` | string | Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | Removed, no replacement at this time. | +| `db.mongodb.collection` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | +| `db.mssql.instance_name` | string | Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. | `MSSQLSERVER` | Removed, no replacement at this time. | +| `db.name` | string | Deprecated, use `db.namespace` instead. | `customers`; `main` | Use `db.namespace` instead. | +| `db.operation` | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | Use `db.operation.name` instead. | +| `db.redis.database_index` | int | Deprecated, use `db.namespace` instead. | `0`; `1`; `15` | Uncategorized. | +| `db.sql.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Replaced by `db.collection.name`, but only if not extracting the value from `db.query.text`. | +| `db.statement` | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | Use `db.query.text` instead. | +| `db.system` | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | Use `db.system.name` instead. | +| `db.user` | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | Removed, no replacement at this time. | + +--- + +`db.cassandra.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `all` | all | ![Development](https://img.shields.io/badge/-development-blue) | +| `any` | any | ![Development](https://img.shields.io/badge/-development-blue) | +| `each_quorum` | each_quorum | ![Development](https://img.shields.io/badge/-development-blue) | +| `local_one` | local_one | ![Development](https://img.shields.io/badge/-development-blue) | +| `local_quorum` | local_quorum | ![Development](https://img.shields.io/badge/-development-blue) | +| `local_serial` | local_serial | ![Development](https://img.shields.io/badge/-development-blue) | +| `one` | one | ![Development](https://img.shields.io/badge/-development-blue) | +| `quorum` | quorum | ![Development](https://img.shields.io/badge/-development-blue) | +| `serial` | serial | ![Development](https://img.shields.io/badge/-development-blue) | +| `three` | three | ![Development](https://img.shields.io/badge/-development-blue) | +| `two` | two | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`db.cosmosdb.connection_mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `direct` | Direct connection. | ![Development](https://img.shields.io/badge/-development-blue) | +| `gateway` | Gateway (HTTP) connection. | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`db.cosmosdb.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `BoundedStaleness` | bounded_staleness | ![Development](https://img.shields.io/badge/-development-blue) | +| `ConsistentPrefix` | consistent_prefix | ![Development](https://img.shields.io/badge/-development-blue) | +| `Eventual` | eventual | ![Development](https://img.shields.io/badge/-development-blue) | +| `Session` | session | ![Development](https://img.shields.io/badge/-development-blue) | +| `Strong` | strong | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`db.cosmosdb.operation_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `batch` | batch | ![Development](https://img.shields.io/badge/-development-blue) | +| `create` | create | ![Development](https://img.shields.io/badge/-development-blue) | +| `delete` | delete | ![Development](https://img.shields.io/badge/-development-blue) | +| `execute` | execute | ![Development](https://img.shields.io/badge/-development-blue) | +| `execute_javascript` | execute_javascript | ![Development](https://img.shields.io/badge/-development-blue) | +| `head` | head | ![Development](https://img.shields.io/badge/-development-blue) | +| `head_feed` | head_feed | ![Development](https://img.shields.io/badge/-development-blue) | +| `invalid` | invalid | ![Development](https://img.shields.io/badge/-development-blue) | +| `patch` | patch | ![Development](https://img.shields.io/badge/-development-blue) | +| `query` | query | ![Development](https://img.shields.io/badge/-development-blue) | +| `query_plan` | query_plan | ![Development](https://img.shields.io/badge/-development-blue) | +| `read` | read | ![Development](https://img.shields.io/badge/-development-blue) | +| `read_feed` | read_feed | ![Development](https://img.shields.io/badge/-development-blue) | +| `replace` | replace | ![Development](https://img.shields.io/badge/-development-blue) | +| `upsert` | upsert | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `adabas` | Adabas (Adaptable Database System) | ![Development](https://img.shields.io/badge/-development-blue) | +| `cassandra` | Apache Cassandra | ![Development](https://img.shields.io/badge/-development-blue) | +| `clickhouse` | ClickHouse | ![Development](https://img.shields.io/badge/-development-blue) | +| `cockroachdb` | CockroachDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `cosmosdb` | Microsoft Azure Cosmos DB | ![Development](https://img.shields.io/badge/-development-blue) | +| `couchbase` | Couchbase | ![Development](https://img.shields.io/badge/-development-blue) | +| `couchdb` | CouchDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `db2` | IBM Db2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `derby` | Apache Derby | ![Development](https://img.shields.io/badge/-development-blue) | +| `dynamodb` | Amazon DynamoDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `edb` | EnterpriseDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `elasticsearch` | Elasticsearch | ![Development](https://img.shields.io/badge/-development-blue) | +| `filemaker` | FileMaker | ![Development](https://img.shields.io/badge/-development-blue) | +| `firebird` | Firebird | ![Development](https://img.shields.io/badge/-development-blue) | +| `geode` | Apache Geode | ![Development](https://img.shields.io/badge/-development-blue) | +| `h2` | H2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `hanadb` | SAP HANA | ![Development](https://img.shields.io/badge/-development-blue) | +| `hbase` | Apache HBase | ![Development](https://img.shields.io/badge/-development-blue) | +| `hive` | Apache Hive | ![Development](https://img.shields.io/badge/-development-blue) | +| `hsqldb` | HyperSQL DataBase | ![Development](https://img.shields.io/badge/-development-blue) | +| `influxdb` | InfluxDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `informix` | Informix | ![Development](https://img.shields.io/badge/-development-blue) | +| `ingres` | Ingres | ![Development](https://img.shields.io/badge/-development-blue) | +| `instantdb` | InstantDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `interbase` | InterBase | ![Development](https://img.shields.io/badge/-development-blue) | +| `intersystems_cache` | InterSystems Caché | ![Development](https://img.shields.io/badge/-development-blue) | +| `mariadb` | MariaDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `maxdb` | SAP MaxDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `memcached` | Memcached | ![Development](https://img.shields.io/badge/-development-blue) | +| `mongodb` | MongoDB | ![Development](https://img.shields.io/badge/-development-blue) | +| `mssql` | Microsoft SQL Server | ![Development](https://img.shields.io/badge/-development-blue) | +| `mysql` | MySQL | ![Development](https://img.shields.io/badge/-development-blue) | +| `neo4j` | Neo4j | ![Development](https://img.shields.io/badge/-development-blue) | +| `netezza` | Netezza | ![Development](https://img.shields.io/badge/-development-blue) | +| `opensearch` | OpenSearch | ![Development](https://img.shields.io/badge/-development-blue) | +| `oracle` | Oracle Database | ![Development](https://img.shields.io/badge/-development-blue) | +| `other_sql` | Some other SQL database. Fallback only. See notes. | ![Development](https://img.shields.io/badge/-development-blue) | +| `pervasive` | Pervasive PSQL | ![Development](https://img.shields.io/badge/-development-blue) | +| `pointbase` | PointBase | ![Development](https://img.shields.io/badge/-development-blue) | +| `postgresql` | PostgreSQL | ![Development](https://img.shields.io/badge/-development-blue) | +| `progress` | Progress Database | ![Development](https://img.shields.io/badge/-development-blue) | +| `redis` | Redis | ![Development](https://img.shields.io/badge/-development-blue) | +| `redshift` | Amazon Redshift | ![Development](https://img.shields.io/badge/-development-blue) | +| `spanner` | Cloud Spanner | ![Development](https://img.shields.io/badge/-development-blue) | +| `sqlite` | SQLite | ![Development](https://img.shields.io/badge/-development-blue) | +| `sybase` | Sybase | ![Development](https://img.shields.io/badge/-development-blue) | +| `teradata` | Teradata | ![Development](https://img.shields.io/badge/-development-blue) | +| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) | +| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) | + +
+ +## Deprecated Database Metrics + +Describes deprecated db metrics attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `db.client.connections.pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | +| `db.client.connections.state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | +| `pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | +| `state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | + +--- + +`db.client.connections.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +
## General Database Attributes This group defines the attributes used to describe telemetry in the context of databases. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `db.client.connection.pool.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes `server.address`, `server.port`, and `db.namespace`, formatted as `server.address:server.port/db.namespace`. Instrumentations that generate connection pool name following different patterns SHOULD document it. | `myDataSource` | @@ -167,192 +363,3 @@ stored procedure name then that stored procedure name SHOULD be used. | `sqlite` | [SQLite](https://www.sqlite.org/) | ![Development](https://img.shields.io/badge/-development-blue) | | `teradata` | [Teradata](https://www.teradata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | | `trino` | [Trino](https://trino.io/) | ![Development](https://img.shields.io/badge/-development-blue) | - -## Deprecated Database Attributes - -Describes deprecated database attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `db.cassandra.consistency_level` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.consistency.level`. | string | Deprecated, use `cassandra.consistency.level` instead. | `all`; `each_quorum`; `quorum` | -| `db.cassandra.coordinator.dc` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.coordinator.dc`. | string | Deprecated, use `cassandra.coordinator.dc` instead. | `us-west-2` | -| `db.cassandra.coordinator.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.coordinator.id`. | string | Deprecated, use `cassandra.coordinator.id` instead. | `be13faa2-8574-4d71-926d-27f16cf8a7af` | -| `db.cassandra.idempotence` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.query.idempotent`. | boolean | Deprecated, use `cassandra.query.idempotent` instead. | | -| `db.cassandra.page_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.page.size`. | int | Deprecated, use `cassandra.page.size` instead. | `5000` | -| `db.cassandra.speculative_execution_count` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.speculative_execution.count`. | int | Deprecated, use `cassandra.speculative_execution.count` instead. | `0`; `2` | -| `db.cassandra.table` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | -| `db.connection_string` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` and `server.port`. | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | -| `db.cosmosdb.client_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.client.id`. | string | Deprecated, use `azure.client.id` instead. | `3ba4827d-4422-483f-b59f-85b74211c11d` | -| `db.cosmosdb.connection_mode` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.connection.mode`. | string | Deprecated, use `azure.cosmosdb.connection.mode` instead. | `gateway`; `direct` | -| `db.cosmosdb.consistency_level` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.consistency.level`. | string | Deprecated, use `cosmosdb.consistency.level` instead. | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | -| `db.cosmosdb.container` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | -| `db.cosmosdb.operation_type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, no replacement at this time. | `batch`; `create`; `delete` | -| `db.cosmosdb.regions_contacted` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.operation.contacted_regions`. | string[] | Deprecated, use `azure.cosmosdb.operation.contacted_regions` instead. | `["North Central US", "Australia East", "Australia Southeast"]` | -| `db.cosmosdb.request_charge` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.operation.request_charge`. | double | Deprecated, use `azure.cosmosdb.operation.request_charge` instead. | `46.18`; `1.0` | -| `db.cosmosdb.request_content_length` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.request.body.size`. | int | Deprecated, use `azure.cosmosdb.request.body.size` instead. | | -| `db.cosmosdb.status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use `db.response.status_code` instead. | int | Deprecated, use `db.response.status_code` instead. | `200`; `201` | -| `db.cosmosdb.sub_status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.response.sub_status_code`. | int | Deprecated, use `azure.cosmosdb.response.sub_status_code` instead. | `1000`; `1002` | -| `db.elasticsearch.cluster.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | -| `db.elasticsearch.node.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `elasticsearch.node.name`. | string | Deprecated, use `elasticsearch.node.name` instead. | `instance-0000000001` | -| `db.elasticsearch.path_parts.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.operation.parameter`. | string | Deprecated, use `db.operation.parameter` instead. | `test-index`; `123` | -| `db.instance.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | string | Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | `mysql-e26b99z.example.com` | -| `db.jdbc.driver_classname` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | -| `db.mongodb.collection` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | -| `db.mssql.instance_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. | `MSSQLSERVER` | -| `db.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | string | Deprecated, use `db.namespace` instead. | `customers`; `main` | -| `db.operation` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.operation.name`. | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | -| `db.redis.database_index` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Uncategorized. | int | Deprecated, use `db.namespace` instead. | `0`; `1`; `15` | -| `db.sql.table` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`, but only if not extracting the value from `db.query.text`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | -| `db.statement` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.query.text`. | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | -| `db.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.system.name`. | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | -| `db.user` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | - ---- - -`db.cassandra.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `all` | all | ![Development](https://img.shields.io/badge/-development-blue) | -| `any` | any | ![Development](https://img.shields.io/badge/-development-blue) | -| `each_quorum` | each_quorum | ![Development](https://img.shields.io/badge/-development-blue) | -| `local_one` | local_one | ![Development](https://img.shields.io/badge/-development-blue) | -| `local_quorum` | local_quorum | ![Development](https://img.shields.io/badge/-development-blue) | -| `local_serial` | local_serial | ![Development](https://img.shields.io/badge/-development-blue) | -| `one` | one | ![Development](https://img.shields.io/badge/-development-blue) | -| `quorum` | quorum | ![Development](https://img.shields.io/badge/-development-blue) | -| `serial` | serial | ![Development](https://img.shields.io/badge/-development-blue) | -| `three` | three | ![Development](https://img.shields.io/badge/-development-blue) | -| `two` | two | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`db.cosmosdb.connection_mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `direct` | Direct connection. | ![Development](https://img.shields.io/badge/-development-blue) | -| `gateway` | Gateway (HTTP) connection. | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`db.cosmosdb.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `BoundedStaleness` | bounded_staleness | ![Development](https://img.shields.io/badge/-development-blue) | -| `ConsistentPrefix` | consistent_prefix | ![Development](https://img.shields.io/badge/-development-blue) | -| `Eventual` | eventual | ![Development](https://img.shields.io/badge/-development-blue) | -| `Session` | session | ![Development](https://img.shields.io/badge/-development-blue) | -| `Strong` | strong | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`db.cosmosdb.operation_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `batch` | batch | ![Development](https://img.shields.io/badge/-development-blue) | -| `create` | create | ![Development](https://img.shields.io/badge/-development-blue) | -| `delete` | delete | ![Development](https://img.shields.io/badge/-development-blue) | -| `execute` | execute | ![Development](https://img.shields.io/badge/-development-blue) | -| `execute_javascript` | execute_javascript | ![Development](https://img.shields.io/badge/-development-blue) | -| `head` | head | ![Development](https://img.shields.io/badge/-development-blue) | -| `head_feed` | head_feed | ![Development](https://img.shields.io/badge/-development-blue) | -| `invalid` | invalid | ![Development](https://img.shields.io/badge/-development-blue) | -| `patch` | patch | ![Development](https://img.shields.io/badge/-development-blue) | -| `query` | query | ![Development](https://img.shields.io/badge/-development-blue) | -| `query_plan` | query_plan | ![Development](https://img.shields.io/badge/-development-blue) | -| `read` | read | ![Development](https://img.shields.io/badge/-development-blue) | -| `read_feed` | read_feed | ![Development](https://img.shields.io/badge/-development-blue) | -| `replace` | replace | ![Development](https://img.shields.io/badge/-development-blue) | -| `upsert` | upsert | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `adabas` | Adabas (Adaptable Database System) | ![Development](https://img.shields.io/badge/-development-blue) | -| `cassandra` | Apache Cassandra | ![Development](https://img.shields.io/badge/-development-blue) | -| `clickhouse` | ClickHouse | ![Development](https://img.shields.io/badge/-development-blue) | -| `cockroachdb` | CockroachDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `cosmosdb` | Microsoft Azure Cosmos DB | ![Development](https://img.shields.io/badge/-development-blue) | -| `couchbase` | Couchbase | ![Development](https://img.shields.io/badge/-development-blue) | -| `couchdb` | CouchDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `db2` | IBM Db2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `derby` | Apache Derby | ![Development](https://img.shields.io/badge/-development-blue) | -| `dynamodb` | Amazon DynamoDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `edb` | EnterpriseDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `elasticsearch` | Elasticsearch | ![Development](https://img.shields.io/badge/-development-blue) | -| `filemaker` | FileMaker | ![Development](https://img.shields.io/badge/-development-blue) | -| `firebird` | Firebird | ![Development](https://img.shields.io/badge/-development-blue) | -| `geode` | Apache Geode | ![Development](https://img.shields.io/badge/-development-blue) | -| `h2` | H2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `hanadb` | SAP HANA | ![Development](https://img.shields.io/badge/-development-blue) | -| `hbase` | Apache HBase | ![Development](https://img.shields.io/badge/-development-blue) | -| `hive` | Apache Hive | ![Development](https://img.shields.io/badge/-development-blue) | -| `hsqldb` | HyperSQL DataBase | ![Development](https://img.shields.io/badge/-development-blue) | -| `influxdb` | InfluxDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `informix` | Informix | ![Development](https://img.shields.io/badge/-development-blue) | -| `ingres` | Ingres | ![Development](https://img.shields.io/badge/-development-blue) | -| `instantdb` | InstantDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `interbase` | InterBase | ![Development](https://img.shields.io/badge/-development-blue) | -| `intersystems_cache` | InterSystems Caché | ![Development](https://img.shields.io/badge/-development-blue) | -| `mariadb` | MariaDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `maxdb` | SAP MaxDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `memcached` | Memcached | ![Development](https://img.shields.io/badge/-development-blue) | -| `mongodb` | MongoDB | ![Development](https://img.shields.io/badge/-development-blue) | -| `mssql` | Microsoft SQL Server | ![Development](https://img.shields.io/badge/-development-blue) | -| `mysql` | MySQL | ![Development](https://img.shields.io/badge/-development-blue) | -| `neo4j` | Neo4j | ![Development](https://img.shields.io/badge/-development-blue) | -| `netezza` | Netezza | ![Development](https://img.shields.io/badge/-development-blue) | -| `opensearch` | OpenSearch | ![Development](https://img.shields.io/badge/-development-blue) | -| `oracle` | Oracle Database | ![Development](https://img.shields.io/badge/-development-blue) | -| `other_sql` | Some other SQL database. Fallback only. See notes. | ![Development](https://img.shields.io/badge/-development-blue) | -| `pervasive` | Pervasive PSQL | ![Development](https://img.shields.io/badge/-development-blue) | -| `pointbase` | PointBase | ![Development](https://img.shields.io/badge/-development-blue) | -| `postgresql` | PostgreSQL | ![Development](https://img.shields.io/badge/-development-blue) | -| `progress` | Progress Database | ![Development](https://img.shields.io/badge/-development-blue) | -| `redis` | Redis | ![Development](https://img.shields.io/badge/-development-blue) | -| `redshift` | Amazon Redshift | ![Development](https://img.shields.io/badge/-development-blue) | -| `spanner` | Cloud Spanner | ![Development](https://img.shields.io/badge/-development-blue) | -| `sqlite` | SQLite | ![Development](https://img.shields.io/badge/-development-blue) | -| `sybase` | Sybase | ![Development](https://img.shields.io/badge/-development-blue) | -| `teradata` | Teradata | ![Development](https://img.shields.io/badge/-development-blue) | -| `trino` | Trino | ![Development](https://img.shields.io/badge/-development-blue) | -| `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) | - -## Deprecated Database Metrics - -Describes deprecated db metrics attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `db.client.connections.pool.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | -| `db.client.connections.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | string | Deprecated, use `db.client.connection.state` instead. | `idle` | -| `pool.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | -| `state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | string | Deprecated, use `db.client.connection.state` instead. | `idle` | - ---- - -`db.client.connections.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index f97892c010..7b4fa66bdb 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -3,15 +3,28 @@ # Deployment -- [Deployment Attributes](#deployment-attributes) - [Deployment Deprecated Attributes](#deployment-deprecated-attributes) +- [Deployment Attributes](#deployment-attributes) + +## Deployment Deprecated Attributes + +Describes deprecated deployment attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `deployment.environment` | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | Use `deployment.environment.name` instead. | + +
## Deployment Attributes This document defines attributes for software deployments. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `deployment.environment.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` | @@ -35,13 +48,3 @@ considered to be identifying the same service: |---|---|---| | `failed` | failed | ![Development](https://img.shields.io/badge/-development-blue) | | `succeeded` | succeeded | ![Development](https://img.shields.io/badge/-development-blue) | - -## Deployment Deprecated Attributes - -Describes deprecated deployment attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `deployment.environment` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `deployment.environment.name`. | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | diff --git a/docs/registry/attributes/destination.md b/docs/registry/attributes/destination.md index 8065a3c8a8..07c8deb942 100644 --- a/docs/registry/attributes/destination.md +++ b/docs/registry/attributes/destination.md @@ -7,8 +7,7 @@ These attributes may be used to describe the receiver of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `destination.address` | ![Development](https://img.shields.io/badge/-development-blue) | string | Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `destination.example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/device.md b/docs/registry/attributes/device.md index 6f09ad862b..5f14a3d31d 100644 --- a/docs/registry/attributes/device.md +++ b/docs/registry/attributes/device.md @@ -7,8 +7,7 @@ Describes device attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `device.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | A unique identifier representing the device [1] | `123456789012345`; `01:23:45:67:89:AB` | diff --git a/docs/registry/attributes/disk.md b/docs/registry/attributes/disk.md index cc5e272c3a..cc4c5ec00c 100644 --- a/docs/registry/attributes/disk.md +++ b/docs/registry/attributes/disk.md @@ -7,8 +7,7 @@ These attributes may be used for any disk related operation. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `disk.io.direction` | ![Development](https://img.shields.io/badge/-development-blue) | string | The disk IO operation direction. | `read` | diff --git a/docs/registry/attributes/dns.md b/docs/registry/attributes/dns.md index 70239a22b6..09365f47e5 100644 --- a/docs/registry/attributes/dns.md +++ b/docs/registry/attributes/dns.md @@ -7,8 +7,7 @@ This document defines the shared attributes used to report a DNS query. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `dns.answers` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The list of IPv4 or IPv6 addresses resolved during DNS lookup. | `["10.0.0.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"]` | diff --git a/docs/registry/attributes/dotnet.md b/docs/registry/attributes/dotnet.md index 6143466484..9fbeb0a241 100644 --- a/docs/registry/attributes/dotnet.md +++ b/docs/registry/attributes/dotnet.md @@ -7,8 +7,7 @@ This document defines .NET related attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `dotnet.gc.heap.generation` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | diff --git a/docs/registry/attributes/elasticsearch.md b/docs/registry/attributes/elasticsearch.md index d7f490dca3..49748525c5 100644 --- a/docs/registry/attributes/elasticsearch.md +++ b/docs/registry/attributes/elasticsearch.md @@ -7,8 +7,7 @@ This section defines attributes for Elasticsearch. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `elasticsearch.node.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001` | diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index d747446233..71e48669ca 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -3,15 +3,29 @@ # Enduser -- [End User Attributes](#end-user-attributes) - [Deprecated End User Attributes](#deprecated-end-user-attributes) +- [End User Attributes](#end-user-attributes) + +## Deprecated End User Attributes + +Describes deprecated enduser attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | Use `user.roles` instead. | +| `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | Removed, no replacement at this time. | + +
## End User Attributes Describes the end user. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `enduser.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier of an end user in the system. It maybe a username, email address, or other identifier. [1] | `username` | @@ -26,14 +40,3 @@ Describes the end user. > [!Warning] > This field contains sensitive (linkable PII) information. - -## Deprecated End User Attributes - -Describes deprecated enduser attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `enduser.role` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use `user.roles` instead. | string | Deprecated, use `user.roles` instead. | `admin` | -| `enduser.scope` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, no replacement at this time. | `read:message, write:files` | diff --git a/docs/registry/attributes/error.md b/docs/registry/attributes/error.md index 91adcc5897..3bf6395605 100644 --- a/docs/registry/attributes/error.md +++ b/docs/registry/attributes/error.md @@ -7,8 +7,7 @@ This document defines the shared attributes used to report an error. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `error.message` | ![Development](https://img.shields.io/badge/-development-blue) | string | A message providing more detail about an error in human-readable form. [1] | `Unexpected input type: string`; `The user has exceeded their storage quota` | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 75083c2acb..e02ec49382 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -7,8 +7,12 @@ Attributes for Events represented using Log Records. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `event.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event. | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` | +| `event.name` | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` | The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event. | + +
diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index a960f2f09d..8f02002acf 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -10,8 +10,7 @@ This document defines the shared attributes used to report a single exception associated with a span or log. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `exception.message` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | @@ -22,8 +21,12 @@ This document defines the shared attributes used to report a single exception as Deprecated exception attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `exception.escaped` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | boolean | Indicates that the exception is escaping the scope of the span. | | +| `exception.escaped` | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | + +
diff --git a/docs/registry/attributes/faas.md b/docs/registry/attributes/faas.md index 0ef8e8da25..21156b4176 100644 --- a/docs/registry/attributes/faas.md +++ b/docs/registry/attributes/faas.md @@ -7,8 +7,7 @@ FaaS attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `faas.coldstart` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | | diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index 979da587cb..f4a36d34b5 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -3,15 +3,47 @@ # Feature flag -- [Feature Flag Attributes](#feature-flag-attributes) - [Deprecated Feature Flag Attributes](#deprecated-feature-flag-attributes) +- [Feature Flag Attributes](#feature-flag-attributes) + +## Deprecated Feature Flag Attributes + +Describes deprecated feature flag attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `feature_flag.evaluation.error.message` | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | Use `error.message` instead. | +| `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | Use `feature_flag.result.reason` instead. | +| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | Use `feature_flag.provider.name` instead. | +| `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | Use `feature_flag.result.variant` instead. | + +--- + +`feature_flag.evaluation.reason` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `cached` | The resolved value was retrieved from cache. | ![Development](https://img.shields.io/badge/-development-blue) | +| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). | ![Development](https://img.shields.io/badge/-development-blue) | +| `disabled` | The resolved value was the result of the flag being disabled in the management system. | ![Development](https://img.shields.io/badge/-development-blue) | +| `error` | The resolved value was the result of an error. | ![Development](https://img.shields.io/badge/-development-blue) | +| `split` | The resolved value was the result of pseudorandom assignment. | ![Development](https://img.shields.io/badge/-development-blue) | +| `stale` | The resolved value is non-authoritative or possibly out of date | ![Development](https://img.shields.io/badge/-development-blue) | +| `static` | The resolved value is static (no dynamic evaluation). | ![Development](https://img.shields.io/badge/-development-blue) | +| `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Development](https://img.shields.io/badge/-development-blue) | +| `unknown` | The reason for the resolved value could not be determined. | ![Development](https://img.shields.io/badge/-development-blue) | + +
## Feature Flag Attributes This document defines attributes for Feature Flags. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `feature_flag.context.id` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | @@ -49,32 +81,3 @@ For example, the variant `red` maybe be used for the value `#c05543`. | `static` | The resolved value is static (no dynamic evaluation). | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `unknown` | The reason for the resolved value could not be determined. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | - -## Deprecated Feature Flag Attributes - -Describes deprecated feature flag attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `feature_flag.evaluation.error.message` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `error.message`. | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | -| `feature_flag.evaluation.reason` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.reason`. | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | -| `feature_flag.provider_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.provider.name`. | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | -| `feature_flag.variant` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.variant`. | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | - ---- - -`feature_flag.evaluation.reason` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `cached` | The resolved value was retrieved from cache. | ![Development](https://img.shields.io/badge/-development-blue) | -| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). | ![Development](https://img.shields.io/badge/-development-blue) | -| `disabled` | The resolved value was the result of the flag being disabled in the management system. | ![Development](https://img.shields.io/badge/-development-blue) | -| `error` | The resolved value was the result of an error. | ![Development](https://img.shields.io/badge/-development-blue) | -| `split` | The resolved value was the result of pseudorandom assignment. | ![Development](https://img.shields.io/badge/-development-blue) | -| `stale` | The resolved value is non-authoritative or possibly out of date | ![Development](https://img.shields.io/badge/-development-blue) | -| `static` | The resolved value is static (no dynamic evaluation). | ![Development](https://img.shields.io/badge/-development-blue) | -| `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Development](https://img.shields.io/badge/-development-blue) | -| `unknown` | The reason for the resolved value could not be determined. | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/file.md b/docs/registry/attributes/file.md index f614e726e3..73b9f4f198 100644 --- a/docs/registry/attributes/file.md +++ b/docs/registry/attributes/file.md @@ -7,8 +7,7 @@ Describes file attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `file.accessed` | ![Development](https://img.shields.io/badge/-development-blue) | string | Time when the file was last accessed, in ISO 8601 format. [1] | `2021-01-01T12:00:00Z` | diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 35df0a5981..42f6306ed8 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -3,37 +3,57 @@ # GCP -- [GCP - AppHub Attributes](#gcp---apphub-attributes) -- [GCP - AppHub Destination Attributes](#gcp---apphub-destination-attributes) - [GCP Client Attributes](#gcp-client-attributes) - [GCP - Google Cloud Run Attributes](#gcp---google-cloud-run-attributes) +- [GCP - AppHub Attributes](#gcp---apphub-attributes) +- [GCP - AppHub Destination Attributes](#gcp---apphub-destination-attributes) - [GCP - Google Compute Engine (GCE) Attributes](#gcp---google-compute-engine-gce-attributes) +## GCP Client Attributes + +Attributes for Google Cloud client libraries. + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [1] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | + +**[1] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. + +## GCP - Google Cloud Run Attributes + +This document defines attributes for Google Cloud Run. + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | +| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | + ## GCP - AppHub Attributes This document defines attributes AppHub will apply to resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gcp.apphub.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` | | `gcp.apphub.application.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the application as configured in AppHub. | `my-application` | | `gcp.apphub.application.location` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GCP zone or region where the application is defined. | `us-central1` | -| `gcp.apphub.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a service indicates its importance to the business. [1] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a service is the stage of a software lifecycle. [2] | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a service indicates its importance to the business. [2] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a service is the stage of a software lifecycle. [3] | `PRODUCTION`; `STAGING`; `TEST` | | `gcp.apphub.service.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the service as configured in AppHub. | `my-service` | -| `gcp.apphub.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a workload indicates its importance to the business. [3] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a workload is the stage of a software lifecycle. [4] | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a workload indicates its importance to the business. [4] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a workload is the stage of a software lifecycle. [5] | `PRODUCTION`; `STAGING`; `TEST` | | `gcp.apphub.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the workload as configured in AppHub. | `my-workload` | -**[1] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) +**[2] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) -**[2] `gcp.apphub.service.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) +**[3] `gcp.apphub.service.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) -**[3] `gcp.apphub.workload.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) +**[4] `gcp.apphub.workload.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) -**[4] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) +**[5] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) --- @@ -83,8 +103,7 @@ This document defines attributes AppHub will apply to resources in GCP. See [App This document defines attributes AppHub will apply to destination resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gcp.apphub_destination.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | @@ -141,35 +160,11 @@ This document defines attributes AppHub will apply to destination resources in G | `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) | -## GCP Client Attributes - -Attributes for Google Cloud client libraries. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | - -**[5] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. - -## GCP - Google Cloud Run Attributes - -This document defines attributes for Google Cloud Run. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | -| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | - ## GCP - Google Compute Engine (GCE) Attributes This document defines attributes for Google Compute Engine (GCE). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gcp.gce.instance.hostname` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index af894ef526..90509093dc 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -11,8 +11,7 @@ This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gen_ai.agent.description` | ![Development](https://img.shields.io/badge/-development-blue) | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | @@ -239,15 +238,17 @@ Datastore: A tool used by the agent to access and query structured or unstructur Describes deprecated `gen_ai` attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `gen_ai.completion` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | -| `gen_ai.prompt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | -| `gen_ai.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.provider.name`. | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | -| `gen_ai.usage.completion_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.output_tokens`. | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | -| `gen_ai.usage.prompt_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.input_tokens`. | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | +| `gen_ai.completion` | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | Removed, no replacement at this time. | +| `gen_ai.prompt` | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | Removed, no replacement at this time. | +| `gen_ai.system` | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | Use `gen_ai.provider.name` instead. | +| `gen_ai.usage.completion_tokens` | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | Use `gen_ai.usage.output_tokens` instead. | +| `gen_ai.usage.prompt_tokens` | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | Use `gen_ai.usage.input_tokens` instead. | --- @@ -261,9 +262,9 @@ Describes deprecated `gen_ai` attributes. | `azure.ai.openai` | Azure OpenAI | ![Development](https://img.shields.io/badge/-development-blue) | | `cohere` | Cohere | ![Development](https://img.shields.io/badge/-development-blue) | | `deepseek` | DeepSeek | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.gemini` | Gemini [17] | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.gen_ai` | Any Google generative AI endpoint [18] | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.vertex_ai` | Vertex AI [19] | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.gemini` | Gemini [1] | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.gen_ai` | Any Google generative AI endpoint [2] | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.vertex_ai` | Vertex AI [3] | ![Development](https://img.shields.io/badge/-development-blue) | | `groq` | Groq | ![Development](https://img.shields.io/badge/-development-blue) | | `ibm.watsonx.ai` | IBM Watsonx AI | ![Development](https://img.shields.io/badge/-development-blue) | | `mistral_ai` | Mistral AI | ![Development](https://img.shields.io/badge/-development-blue) | @@ -271,25 +272,29 @@ Describes deprecated `gen_ai` attributes. | `perplexity` | Perplexity | ![Development](https://img.shields.io/badge/-development-blue) | | `xai` | xAI | ![Development](https://img.shields.io/badge/-development-blue) | -**[17]:** This refers to the 'generativelanguage.googleapis.com' endpoint. Also known as the AI Studio API. May use common attributes prefixed with 'gcp.gen_ai.'. +**[1]:** This refers to the 'generativelanguage.googleapis.com' endpoint. Also known as the AI Studio API. May use common attributes prefixed with 'gcp.gen_ai.'. + +**[2]:** May be used when specific backend is unknown. May use common attributes prefixed with 'gcp.gen_ai.'. -**[18]:** May be used when specific backend is unknown. May use common attributes prefixed with 'gcp.gen_ai.'. +**[3]:** This refers to the 'aiplatform.googleapis.com' endpoint. May use common attributes prefixed with 'gcp.gen_ai.'. -**[19]:** This refers to the 'aiplatform.googleapis.com' endpoint. May use common attributes prefixed with 'gcp.gen_ai.'. +
## Deprecated OpenAI GenAI Attributes Describes deprecated `gen_ai.openai` attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `gen_ai.openai.request.response_format` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.output.type`. | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | -| `gen_ai.openai.request.seed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.request.seed`. | int | Deprecated, use `gen_ai.request.seed`. | `100` | -| `gen_ai.openai.request.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.request.service_tier`. | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | -| `gen_ai.openai.response.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.service_tier`. | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | -| `gen_ai.openai.response.system_fingerprint` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.system_fingerprint`. | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | +| `gen_ai.openai.request.response_format` | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | Use `gen_ai.output.type` instead. | +| `gen_ai.openai.request.seed` | int | Deprecated, use `gen_ai.request.seed`. | `100` | Use `gen_ai.request.seed` instead. | +| `gen_ai.openai.request.service_tier` | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | Use `openai.request.service_tier` instead. | +| `gen_ai.openai.response.service_tier` | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | Use `openai.response.service_tier` instead. | +| `gen_ai.openai.response.system_fingerprint` | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | Use `openai.response.system_fingerprint` instead. | --- @@ -309,3 +314,5 @@ Describes deprecated `gen_ai.openai` attributes. |---|---|---| | `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | | `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index c02cbc9a98..d5867c3185 100644 --- a/docs/registry/attributes/geo.md +++ b/docs/registry/attributes/geo.md @@ -8,8 +8,7 @@ Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note: Geo attributes are typically used under another namespace, such as client.* and describe the location of the corresponding entity (device, end-user, etc). Semantic conventions that reference geo attributes (as a root namespace) or embed them (under their own namespace) SHOULD document what geo attributes describe in the scope of that convention. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `geo.continent.code` | ![Development](https://img.shields.io/badge/-development-blue) | string | Two-letter code representing continent’s name. | `AF`; `AN`; `AS` | diff --git a/docs/registry/attributes/go.md b/docs/registry/attributes/go.md index a7b65ba67a..7d06ef747a 100644 --- a/docs/registry/attributes/go.md +++ b/docs/registry/attributes/go.md @@ -7,8 +7,7 @@ This document defines Go related attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `go.memory.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The type of memory. | `other`; `stack` | diff --git a/docs/registry/attributes/graphql.md b/docs/registry/attributes/graphql.md index 0dc0ea0e59..db68c09f71 100644 --- a/docs/registry/attributes/graphql.md +++ b/docs/registry/attributes/graphql.md @@ -7,8 +7,7 @@ This document defines attributes for GraphQL. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `graphql.document` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | diff --git a/docs/registry/attributes/hardware.md b/docs/registry/attributes/hardware.md index ba74bb6d96..200440e8b6 100644 --- a/docs/registry/attributes/hardware.md +++ b/docs/registry/attributes/hardware.md @@ -7,8 +7,7 @@ Attributes for hardware. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `hw.battery.capacity` | ![Development](https://img.shields.io/badge/-development-blue) | string | Design capacity in Watts-hours or Amper-hours | `9.3Ah`; `50Wh` | diff --git a/docs/registry/attributes/heroku.md b/docs/registry/attributes/heroku.md index 337454061d..5ce81769db 100644 --- a/docs/registry/attributes/heroku.md +++ b/docs/registry/attributes/heroku.md @@ -7,8 +7,7 @@ This document defines attributes for the Heroku platform on which application/s are running. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `heroku.app.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for the application | `2daa2797-e42b-4624-9322-ec3f968df4da` | diff --git a/docs/registry/attributes/host.md b/docs/registry/attributes/host.md index d2662e7b1a..ea2751ce16 100644 --- a/docs/registry/attributes/host.md +++ b/docs/registry/attributes/host.md @@ -7,8 +7,7 @@ A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `host.arch` | ![Development](https://img.shields.io/badge/-development-blue) | string | The CPU architecture the host system is running on. | `amd64`; `arm32`; `arm64` | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 673cd51359..66b29fb6dd 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -3,15 +3,54 @@ # HTTP -- [HTTP Attributes](#http-attributes) - [Deprecated HTTP Attributes](#deprecated-http-attributes) +- [HTTP Attributes](#http-attributes) + +## Deprecated HTTP Attributes + +Describes deprecated HTTP attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `http.client_ip` | string | Deprecated, use `client.address` instead. | `83.164.160.102` | Use `client.address` instead. | +| `http.flavor` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | Split into `network.protocol.name` and `network.protocol.version` | +| `http.host` | string | Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. | `www.example.org` | Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. | +| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | Use `http.request.method` instead. | +| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | Replaced by `http.request.header.content-length`. | +| `http.request_content_length_uncompressed` | int | Deprecated, use `http.request.body.size` instead. | `5493` | Use `http.request.body.size` instead. | +| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | Replaced by `http.response.header.content-length`. | +| `http.response_content_length_uncompressed` | int | Deprecated, use `http.response.body.size` instead. | `5493` | Use `http.response.body.size` instead. | +| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` | Use `url.scheme` instead. | +| `http.server_name` | string | Deprecated, use `server.address` instead. | `example.com` | Use `server.address` instead. | +| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` | Use `http.response.status_code` instead. | +| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | Split to `url.path` and `url.query`. | +| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | Use `url.full` instead. | +| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `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` | Use `user_agent.original` instead. | + +--- + +`http.flavor` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `1.0` | HTTP/1.0 | ![Development](https://img.shields.io/badge/-development-blue) | +| `1.1` | HTTP/1.1 | ![Development](https://img.shields.io/badge/-development-blue) | +| `2.0` | HTTP/2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `3.0` | HTTP/3 | ![Development](https://img.shields.io/badge/-development-blue) | +| `QUIC` | QUIC protocol. | ![Development](https://img.shields.io/badge/-development-blue) | +| `SPDY` | SPDY protocol. | ![Development](https://img.shields.io/badge/-development-blue) | + +
## HTTP Attributes This document defines semantic convention attributes in the HTTP namespace. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `http.connection.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | State of the HTTP connection in the HTTP connection pool. | `active`; `idle` | @@ -115,39 +154,3 @@ support custom route formatting. Instrumentations SHOULD document the format and | `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) | | `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - -## Deprecated HTTP Attributes - -Describes deprecated HTTP attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `http.client_ip` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `client.address`. | string | Deprecated, use `client.address` instead. | `83.164.160.102` | -| `http.flavor` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split into `network.protocol.name` and `network.protocol.version` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | -| `http.host` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. | string | Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. | `www.example.org` | -| `http.method` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.method`. | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | -| `http.request_content_length` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.header.content-length`. | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | -| `http.request_content_length_uncompressed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.body.size`. | int | Deprecated, use `http.request.body.size` instead. | `5493` | -| `http.response_content_length` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.header.content-length`. | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | -| `http.response_content_length_uncompressed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.body.size`. | int | Deprecated, use `http.response.body.size` instead. | `5493` | -| `http.scheme` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.scheme`. | string | Deprecated, use `url.scheme` instead. | `http`; `https` | -| `http.server_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | string | Deprecated, use `server.address` instead. | `example.com` | -| `http.status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.status_code`. | int | Deprecated, use `http.response.status_code` instead. | `200` | -| `http.target` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split to `url.path` and `url.query`. | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | -| `http.url` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.full`. | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | -| `http.user_agent` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `user_agent.original`. | string | Deprecated, use `user_agent.original` instead. | `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` | - ---- - -`http.flavor` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `1.0` | HTTP/1.0 | ![Development](https://img.shields.io/badge/-development-blue) | -| `1.1` | HTTP/1.1 | ![Development](https://img.shields.io/badge/-development-blue) | -| `2.0` | HTTP/2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `3.0` | HTTP/3 | ![Development](https://img.shields.io/badge/-development-blue) | -| `QUIC` | QUIC protocol. | ![Development](https://img.shields.io/badge/-development-blue) | -| `SPDY` | SPDY protocol. | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index f946e34115..1cff53c9f2 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -10,8 +10,7 @@ This group describes iOS-specific attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `ios.app.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | This attribute represents the state of the application. [1] | `active`; `inactive`; `background` | @@ -34,13 +33,15 @@ This group describes iOS-specific attributes. The iOS platform on which the iOS application is running. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `ios.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `ios.app.state`. | string | Deprecated. Use the `ios.app.state` attribute. [2] | `active`; `inactive`; `background` | +| `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [1] | `active`; `inactive`; `background` | Use `ios.app.state` instead. | -**[2] `ios.state`:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate), and from which the `OS terminology` column values are derived. +**[1] `ios.state`:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate), and from which the `OS terminology` column values are derived. --- @@ -53,3 +54,5 @@ The iOS platform on which the iOS application is running. | `foreground` | The app is now in the foreground. This value is associated with UIKit notification `applicationWillEnterForeground`. | ![Development](https://img.shields.io/badge/-development-blue) | | `inactive` | The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ![Development](https://img.shields.io/badge/-development-blue) | | `terminate` | The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/jvm.md b/docs/registry/attributes/jvm.md index 05166994d2..8f34e9ef75 100644 --- a/docs/registry/attributes/jvm.md +++ b/docs/registry/attributes/jvm.md @@ -7,8 +7,7 @@ This document defines Java Virtual machine related attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `jvm.buffer.pool.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the buffer pool. [1] | `mapped`; `direct` | diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index 5eb9c77867..5af85d2db3 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -10,8 +10,7 @@ Kubernetes resource attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `k8s.cluster.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the cluster. | `opentelemetry-cluster` | @@ -354,8 +353,12 @@ When this occurs, the exact value as reported by the Kubernetes API SHOULD be us Describes deprecated k8s attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `k8s.pod.labels.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `k8s.pod.label`. | string | Deprecated, use `k8s.pod.label` instead. | `my-app` | +| `k8s.pod.labels.` | string | Deprecated, use `k8s.pod.label` instead. | `my-app` | Use `k8s.pod.label` instead. | + +
diff --git a/docs/registry/attributes/linux.md b/docs/registry/attributes/linux.md index 5848ad3226..5df97ed874 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -7,8 +7,7 @@ Describes Linux Memory attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `linux.memory.slab.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | diff --git a/docs/registry/attributes/log.md b/docs/registry/attributes/log.md index f1649ae4b5..21bf86a9a7 100644 --- a/docs/registry/attributes/log.md +++ b/docs/registry/attributes/log.md @@ -11,8 +11,7 @@ This document defines log attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `log.iostream` | ![Development](https://img.shields.io/badge/-development-blue) | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | @@ -30,8 +29,7 @@ This document defines log attributes Attributes for a file to which log was emitted. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `log.file.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The basename of the file. | `audit.log` | @@ -43,8 +41,7 @@ Attributes for a file to which log was emitted. This document defines the generic attributes that may be used in any Log Record. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `log.record.original` | ![Development](https://img.shields.io/badge/-development-blue) | string | The complete original Log Record. [1] | `77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - - Something happened`; `[INFO] 8/3/24 12:34:56 Something happened` | diff --git a/docs/registry/attributes/mainframe.md b/docs/registry/attributes/mainframe.md index dab5e3d9de..083cefe3da 100644 --- a/docs/registry/attributes/mainframe.md +++ b/docs/registry/attributes/mainframe.md @@ -7,8 +7,7 @@ This document defines attributes of a Mainframe Logical Partition (LPAR). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `mainframe.lpar.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the logical partition that hosts a systems with a mainframe operating system. | `LPAR01` | diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 3edc75896b..5ebf01967a 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -3,21 +3,43 @@ # Messaging +- [Deprecated Messaging Attributes](#deprecated-messaging-attributes) - [General Messaging Attributes](#general-messaging-attributes) -- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) -- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) - [Kafka Attributes](#kafka-attributes) - [RabbitMQ Attributes](#rabbitmq-attributes) - [RocketMQ Attributes](#rocketmq-attributes) +- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) - [Azure Service Bus Attributes](#azure-service-bus-attributes) -- [Deprecated Messaging Attributes](#deprecated-messaging-attributes) +- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) + +## Deprecated Messaging Attributes + +Describes deprecated messaging attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | +| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | +| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | +| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | +| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | Use `messaging.consumer.group.name` instead. | +| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | Record string representation of the partition id in `messaging.destination.partition.id` attribute. | +| `messaging.kafka.message.offset` | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | Use `messaging.kafka.offset` instead. | +| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | Use `messaging.operation.type` instead. | +| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | +| `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. | + +
## General Messaging Attributes Attributes describing telemetry around messaging systems and messaging activities. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.batch.message_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | The number of messages sent, received, or processed in the scope of the batching operation. [1] | `0`; `1`; `2` | @@ -89,35 +111,11 @@ size should be used. | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | -## Azure Event Hubs Attributes - -This group describes attributes specific to Azure Event Hubs. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `messaging.eventhubs.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | - -## GCP Pub/Sub Attributes - -This group describes attributes specific to GCP Pub/Sub. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `messaging.gcp_pubsub.message.ack_deadline` | ![Development](https://img.shields.io/badge/-development-blue) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | -| `messaging.gcp_pubsub.message.ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ack id for a given message. | `ack_id` | -| `messaging.gcp_pubsub.message.delivery_attempt` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delivery attempt for a given message. | `2` | -| `messaging.gcp_pubsub.message.ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | - ## Kafka Attributes This group describes attributes specific to Apache Kafka. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.kafka.message.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [10] | `myKey` | @@ -130,8 +128,7 @@ This group describes attributes specific to Apache Kafka. This group describes attributes specific to RabbitMQ. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.rabbitmq.destination.routing_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | RabbitMQ message routing key. | `myKey` | @@ -141,8 +138,7 @@ This group describes attributes specific to RabbitMQ. This group describes attributes specific to RocketMQ. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.rocketmq.consumption_model` | ![Development](https://img.shields.io/badge/-development-blue) | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | @@ -174,12 +170,23 @@ This group describes attributes specific to RocketMQ. | `normal` | Normal message | ![Development](https://img.shields.io/badge/-development-blue) | | `transaction` | Transaction message | ![Development](https://img.shields.io/badge/-development-blue) | +## GCP Pub/Sub Attributes + +This group describes attributes specific to GCP Pub/Sub. + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `messaging.gcp_pubsub.message.ack_deadline` | ![Development](https://img.shields.io/badge/-development-blue) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | +| `messaging.gcp_pubsub.message.ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ack id for a given message. | `ack_id` | +| `messaging.gcp_pubsub.message.delivery_attempt` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delivery attempt for a given message. | `2` | +| `messaging.gcp_pubsub.message.ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | + ## Azure Service Bus Attributes This group describes attributes specific to Azure Service Bus. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.servicebus.disposition_status` | ![Development](https://img.shields.io/badge/-development-blue) | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | @@ -197,21 +204,11 @@ This group describes attributes specific to Azure Service Bus. | `dead_letter` | Message is sent to dead letter queue | ![Development](https://img.shields.io/badge/-development-blue) | | `defer` | Message is deferred | ![Development](https://img.shields.io/badge/-development-blue) | -## Deprecated Messaging Attributes - -Describes deprecated messaging attributes. +## Azure Event Hubs Attributes -**Attributes:** +This group describes attributes specific to Azure Event Hubs. +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `messaging.client_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.client.id`. | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | -| `messaging.destination_publish.anonymous` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | boolean | Deprecated, no replacement at this time. | | -| `messaging.destination_publish.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | -| `messaging.eventhubs.consumer.group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name`. | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | -| `messaging.kafka.consumer.group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name`. | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | -| `messaging.kafka.destination.partition` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Record string representation of the partition id in `messaging.destination.partition.id` attribute. | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | -| `messaging.kafka.message.offset` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.kafka.offset`. | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | -| `messaging.operation` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.operation.type`. | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | -| `messaging.rocketmq.client_group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | -| `messaging.servicebus.destination.subscription_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.destination.subscription.name`. | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | +| `messaging.eventhubs.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | diff --git a/docs/registry/attributes/network.md b/docs/registry/attributes/network.md index debd9e2894..e6755aac5a 100644 --- a/docs/registry/attributes/network.md +++ b/docs/registry/attributes/network.md @@ -3,15 +3,66 @@ # Network -- [Network Attributes](#network-attributes) - [Deprecated Network Attributes](#deprecated-network-attributes) +- [Network Attributes](#network-attributes) -## Network Attributes +## Deprecated Network Attributes These attributes may be used for any network related operation. -**Attributes:** +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | +| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | +| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | Use `server.port` instead. | +| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | Use `network.peer.address` instead. | +| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | Replaced by `server.address` on client spans and `client.address` on server spans. | +| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | Replaced by `server.port` on client spans and `client.port` on server spans. | +| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | Use `network.protocol.name` instead. | +| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | Use `network.protocol.version` instead. | +| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | Split to `network.transport` and `network.type`. | +| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | Use `network.local.address` instead. | +| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | Use `network.local.port` instead. | +| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | Use `network.peer.address` instead. | +| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | Removed. No replacement at this time. | +| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | Use `network.peer.port` instead. | +| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | Use `network.transport` instead. | + +--- + +`net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `inet` | IPv4 address | ![Development](https://img.shields.io/badge/-development-blue) | +| `inet6` | IPv6 address | ![Development](https://img.shields.io/badge/-development-blue) | +| `unix` | Unix domain socket path | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `inproc` | In-process communication. [1] | ![Development](https://img.shields.io/badge/-development-blue) | +| `ip_tcp` | ip_tcp | ![Development](https://img.shields.io/badge/-development-blue) | +| `ip_udp` | ip_udp | ![Development](https://img.shields.io/badge/-development-blue) | +| `other` | Something else (non IP-based). | ![Development](https://img.shields.io/badge/-development-blue) | +| `pipe` | Named or anonymous pipe. | ![Development](https://img.shields.io/badge/-development-blue) | + +**[1]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case. +
+ +## Network Attributes + +These attributes may be used for any network related operation. + +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `network.carrier.icc` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. | `DE` | @@ -133,51 +184,3 @@ different processes could be listening on TCP port 12345 and UDP port 12345. |---|---|---| | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - -## Deprecated Network Attributes - -These attributes may be used for any network related operation. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `net.host.ip` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | string | Deprecated, use `network.local.address`. | `192.168.0.1` | -| `net.host.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | string | Deprecated, use `server.address`. | `example.com` | -| `net.host.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port`. | int | Deprecated, use `server.port`. | `8080` | -| `net.peer.ip` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | -| `net.peer.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` on client spans and `client.address` on server spans. | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | -| `net.peer.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port` on client spans and `client.port` on server spans. | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | -| `net.protocol.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.name`. | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | -| `net.protocol.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.version`. | string | Deprecated, use `network.protocol.version`. | `3.1.1` | -| `net.sock.family` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split to `network.transport` and `network.type`. | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | -| `net.sock.host.addr` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | string | Deprecated, use `network.local.address`. | `/var/my.sock` | -| `net.sock.host.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.port`. | int | Deprecated, use `network.local.port`. | `8080` | -| `net.sock.peer.addr` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | -| `net.sock.peer.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | string | Deprecated, no replacement at this time. | `/var/my.sock` | -| `net.sock.peer.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.port`. | int | Deprecated, use `network.peer.port`. | `65531` | -| `net.transport` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.transport`. | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | - ---- - -`net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `inet` | IPv4 address | ![Development](https://img.shields.io/badge/-development-blue) | -| `inet6` | IPv6 address | ![Development](https://img.shields.io/badge/-development-blue) | -| `unix` | Unix domain socket path | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `inproc` | In-process communication. [6] | ![Development](https://img.shields.io/badge/-development-blue) | -| `ip_tcp` | ip_tcp | ![Development](https://img.shields.io/badge/-development-blue) | -| `ip_udp` | ip_udp | ![Development](https://img.shields.io/badge/-development-blue) | -| `other` | Something else (non IP-based). | ![Development](https://img.shields.io/badge/-development-blue) | -| `pipe` | Named or anonymous pipe. | ![Development](https://img.shields.io/badge/-development-blue) | - -**[6]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case. diff --git a/docs/registry/attributes/nfs.md b/docs/registry/attributes/nfs.md index 014e403a62..2cc719e278 100644 --- a/docs/registry/attributes/nfs.md +++ b/docs/registry/attributes/nfs.md @@ -7,8 +7,7 @@ Describes NFS Attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `nfs.operation.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | NFSv4+ operation name. | `OPEN`; `READ`; `GETATTR` | diff --git a/docs/registry/attributes/nodejs.md b/docs/registry/attributes/nodejs.md index 5aee7ff19d..bc2c11464d 100644 --- a/docs/registry/attributes/nodejs.md +++ b/docs/registry/attributes/nodejs.md @@ -7,8 +7,7 @@ Describes Node.js related attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `nodejs.eventloop.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The state of event loop time. | `active`; `idle` | diff --git a/docs/registry/attributes/oci.md b/docs/registry/attributes/oci.md index 3644f842d1..f842bc9782 100644 --- a/docs/registry/attributes/oci.md +++ b/docs/registry/attributes/oci.md @@ -7,8 +7,7 @@ An OCI image manifest. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `oci.manifest.digest` | ![Development](https://img.shields.io/badge/-development-blue) | string | The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. [1] | `sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4` | diff --git a/docs/registry/attributes/onc-rpc.md b/docs/registry/attributes/onc-rpc.md index 67d3b7085f..34152a3854 100644 --- a/docs/registry/attributes/onc-rpc.md +++ b/docs/registry/attributes/onc-rpc.md @@ -7,8 +7,7 @@ This document defines attributes for [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `onc_rpc.procedure.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | ONC/Sun RPC procedure name. | `OPEN`; `READ`; `GETATTR` | diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 3e916ddbe5..145727ff88 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -7,8 +7,7 @@ This group defines attributes for OpenAI. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `openai.request.service_tier` | ![Development](https://img.shields.io/badge/-development-blue) | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` | diff --git a/docs/registry/attributes/openshift.md b/docs/registry/attributes/openshift.md index 27573a167c..f11ed9c677 100644 --- a/docs/registry/attributes/openshift.md +++ b/docs/registry/attributes/openshift.md @@ -7,8 +7,7 @@ OpenShift resource attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `openshift.clusterquota.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the cluster quota. | `opentelemetry` | diff --git a/docs/registry/attributes/opentracing.md b/docs/registry/attributes/opentracing.md index 18a6aa5538..69105b4633 100644 --- a/docs/registry/attributes/opentracing.md +++ b/docs/registry/attributes/opentracing.md @@ -7,8 +7,7 @@ Attributes used by the OpenTracing Shim layer. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `opentracing.ref_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Parent-child Reference type [1] | `child_of`; `follows_from` | diff --git a/docs/registry/attributes/os.md b/docs/registry/attributes/os.md index 97e4171433..dd0314aa77 100644 --- a/docs/registry/attributes/os.md +++ b/docs/registry/attributes/os.md @@ -7,8 +7,7 @@ The operating system (OS) on which the process represented by this resource is running. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `os.build_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index 4f8d7e45fd..ff6f31a71c 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -3,17 +3,31 @@ # OTel +- [Deprecated OTel Library Attributes](#deprecated-otel-library-attributes) - [OTel Attributes](#otel-attributes) -- [OTel Component Attributes](#otel-component-attributes) - [OTel Scope Attributes](#otel-scope-attributes) -- [Deprecated OTel Library Attributes](#deprecated-otel-library-attributes) +- [OTel Component Attributes](#otel-component-attributes) + +## Deprecated OTel Library Attributes + +Describes deprecated otel.library attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | Use `otel.scope.name` instead. | +| `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | Use `otel.scope.version` instead. | + +
## OTel Attributes Attributes reserved for OpenTelemetry -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `otel.span.parent.origin` | ![Development](https://img.shields.io/badge/-development-blue) | string | Determines whether the span has a parent span, and if so, [whether it is a remote parent](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) | `none`; `local`; `remote` | @@ -50,12 +64,22 @@ Attributes reserved for OpenTelemetry | `ERROR` | The operation contains an error. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +## OTel Scope Attributes + +Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `otel.scope.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | +| `otel.scope.schema_url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | +| `otel.scope.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | + ## OTel Component Attributes Attributes used for OpenTelemetry component self-monitoring -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `otel.component.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | @@ -100,26 +124,3 @@ E.g. for Java the fully qualified classname SHOULD be used in this case. | `simple_log_processor` | The builtin SDK simple log record processor | ![Development](https://img.shields.io/badge/-development-blue) | | `simple_span_processor` | The builtin SDK simple span processor | ![Development](https://img.shields.io/badge/-development-blue) | | `zipkin_http_span_exporter` | Zipkin span exporter over HTTP | ![Development](https://img.shields.io/badge/-development-blue) | - -## OTel Scope Attributes - -Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `otel.scope.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | -| `otel.scope.schema_url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | -| `otel.scope.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | - -## Deprecated OTel Library Attributes - -Describes deprecated otel.library attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `otel.library.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `otel.scope.name`. | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | -| `otel.library.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `otel.scope.version`. | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | diff --git a/docs/registry/attributes/peer.md b/docs/registry/attributes/peer.md index a60c32056c..e571c378bb 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -7,8 +7,7 @@ These attribute may be used for any operation that accesses some remote service. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `peer.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [1] | `AuthTokenCache` | diff --git a/docs/registry/attributes/pprof.md b/docs/registry/attributes/pprof.md index e080eb6e29..bc6e991d63 100644 --- a/docs/registry/attributes/pprof.md +++ b/docs/registry/attributes/pprof.md @@ -7,8 +7,7 @@ Attributes specific to pprof that help convert from pprof to Profiling signal. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `pprof.location.is_folded` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes. | | diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 9bab50ce2f..16a1633d8b 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -3,16 +3,60 @@ # Process +- [Deprecated Process Attributes](#deprecated-process-attributes) - [Process Attributes](#process-attributes) - [Process Linux Attributes](#process-linux-attributes) -- [Deprecated Process Attributes](#deprecated-process-attributes) + +## Deprecated Process Attributes + +Deprecated process attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `process.context_switch_type` | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | Use `process.context_switch.type` instead. | +| `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | Use `cpu.mode` instead. | +| `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | Use `process.executable.build_id.htlhash` instead. | +| `process.paging.fault_type` | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | Use `system.paging.fault.type` instead. | + +--- + +`process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `involuntary` | involuntary | ![Development](https://img.shields.io/badge/-development-blue) | +| `voluntary` | voluntary | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`process.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | +| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | +| `wait` | wait | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`process.paging.fault_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | +| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | + +
## Process Attributes An operating system process. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `process.args_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | Length of the process.command_args array [1] | `4` | @@ -88,51 +132,9 @@ with value `"/usr/local/bin:/usr/bin"`. Describes Linux Process attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `process.linux.cgroup` | ![Development](https://img.shields.io/badge/-development-blue) | string | The control group associated with the process. [5] | `1:name=systemd:/user.slice/user-1000.slice/session-3.scope`; `0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope` | **[5] `process.linux.cgroup`:** Control groups (cgroups) are a kernel feature used to organize and manage process resources. This attribute provides the path(s) to the cgroup(s) associated with the process, which should match the contents of the [/proc/\[PID\]/cgroup](https://man7.org/linux/man-pages/man7/cgroups.7.html) file. - -## Deprecated Process Attributes - -Deprecated process attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `process.context_switch_type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.context_switch.type`. | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | -| `process.cpu.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | -| `process.executable.build_id.profiling` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.executable.build_id.htlhash`. | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | -| `process.paging.fault_type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.paging.fault.type`. | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | - ---- - -`process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `involuntary` | involuntary | ![Development](https://img.shields.io/badge/-development-blue) | -| `voluntary` | voluntary | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`process.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | -| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | -| `wait` | wait | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`process.paging.fault_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | -| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/profile.md b/docs/registry/attributes/profile.md index bd30717817..b2ad3c9575 100644 --- a/docs/registry/attributes/profile.md +++ b/docs/registry/attributes/profile.md @@ -7,8 +7,7 @@ Describes the origin of a single frame in a Profile. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `profile.frame.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Describes the interpreter or compiler of a single frame. | `cpython` | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 3a917a9092..85776c3895 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -10,8 +10,7 @@ This document defines attributes for remote procedure calls. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `rpc.connect_rpc.error_code` | ![Development](https://img.shields.io/badge/-development-blue) | string | The [error codes](https://connectrpc.com//docs/protocol/#error-codes) of the Connect request. Error codes are always string values. | `cancelled`; `unknown`; `invalid_argument` | @@ -132,14 +131,16 @@ the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute Deprecated rpc message attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `message.compressed_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.compressed_size`. | int | Deprecated, use `rpc.message.compressed_size` instead. | | -| `message.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.id`. | int | Deprecated, use `rpc.message.id` instead. | | -| `message.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.type`. | string | Deprecated, use `rpc.message.type` instead. | `SENT`; `RECEIVED` | -| `message.uncompressed_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.uncompressed_size`. | int | Deprecated, use `rpc.message.uncompressed_size` instead. | | +| `message.compressed_size` | int | Deprecated, use `rpc.message.compressed_size` instead. | | Use `rpc.message.compressed_size` instead. | +| `message.id` | int | Deprecated, use `rpc.message.id` instead. | | Use `rpc.message.id` instead. | +| `message.type` | string | Deprecated, use `rpc.message.type` instead. | `SENT`; `RECEIVED` | Use `rpc.message.type` instead. | +| `message.uncompressed_size` | int | Deprecated, use `rpc.message.uncompressed_size` instead. | | Use `rpc.message.uncompressed_size` instead. | --- @@ -149,3 +150,5 @@ Deprecated rpc message attributes. |---|---|---| | `RECEIVED` | received | ![Development](https://img.shields.io/badge/-development-blue) | | `SENT` | sent | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/security-rule.md b/docs/registry/attributes/security-rule.md index 98476a8f3e..d5c9a8a61d 100644 --- a/docs/registry/attributes/security-rule.md +++ b/docs/registry/attributes/security-rule.md @@ -7,8 +7,7 @@ Describes security rule attributes. Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `security_rule.category` | ![Development](https://img.shields.io/badge/-development-blue) | string | A categorization value keyword used by the entity using the rule for detection of this event | `Attempted Information Leak` | diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index 74bdd6eb3b..e31c0a8378 100644 --- a/docs/registry/attributes/server.md +++ b/docs/registry/attributes/server.md @@ -7,8 +7,7 @@ These attributes may be used to describe the server in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `server.address` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/service.md b/docs/registry/attributes/service.md index a5d3f6be08..aa32abf468 100644 --- a/docs/registry/attributes/service.md +++ b/docs/registry/attributes/service.md @@ -7,8 +7,7 @@ A service instance. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `service.instance.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The string ID of the service instance. [1] | `627cc493-f310-47de-96bd-71410b7dec09` | diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index e4b7997aa6..6e8de01269 100644 --- a/docs/registry/attributes/session.md +++ b/docs/registry/attributes/session.md @@ -9,8 +9,7 @@ Session is defined as the period of time encompassing all activities performed b Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in the Logs, Events, and Spans generated during the Session's lifecycle. When a session reaches end of life, typically due to user inactivity or session timeout, a new session identifier will be assigned. The previous session identifier may be provided by the instrumentation so that telemetry backends can link the two sessions. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `session.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | diff --git a/docs/registry/attributes/signalr.md b/docs/registry/attributes/signalr.md index 3022688f59..840a3bacd7 100644 --- a/docs/registry/attributes/signalr.md +++ b/docs/registry/attributes/signalr.md @@ -7,8 +7,7 @@ SignalR attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `signalr.connection.status` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index 79c674ffce..712f668b6f 100644 --- a/docs/registry/attributes/source.md +++ b/docs/registry/attributes/source.md @@ -7,8 +7,7 @@ These attributes may be used to describe the sender of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `source.address` | ![Development](https://img.shields.io/badge/-development-blue) | string | Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `source.example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index 44534b304c..543b4af500 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -4,63 +4,25 @@ # System - [General System Attributes](#general-system-attributes) -- [Filesystem Attributes](#filesystem-attributes) - [System Memory Attributes](#system-memory-attributes) - [System Paging Attributes](#system-paging-attributes) +- [Filesystem Attributes](#filesystem-attributes) - [Deprecated System Attributes](#deprecated-system-attributes) ## General System Attributes Describes System attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `system.device` | ![Development](https://img.shields.io/badge/-development-blue) | string | The device identifier | `(identifier)` | -## Filesystem Attributes - -Describes Filesystem attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `system.filesystem.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mode | `rw, ro` | -| `system.filesystem.mountpoint` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mount path | `/mnt/data` | -| `system.filesystem.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem state | `used` | -| `system.filesystem.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem type | `ext4` | - ---- - -`system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | -| `reserved` | reserved | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `exfat` | exfat | ![Development](https://img.shields.io/badge/-development-blue) | -| `ext4` | ext4 | ![Development](https://img.shields.io/badge/-development-blue) | -| `fat32` | fat32 | ![Development](https://img.shields.io/badge/-development-blue) | -| `hfsplus` | hfsplus | ![Development](https://img.shields.io/badge/-development-blue) | -| `ntfs` | ntfs | ![Development](https://img.shields.io/badge/-development-blue) | -| `refs` | refs | ![Development](https://img.shields.io/badge/-development-blue) | - ## System Memory Attributes Describes System Memory attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `system.memory.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The memory state | `free`; `cached` | @@ -82,8 +44,7 @@ Describes System Memory attributes Describes System Memory Paging attributes -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `system.paging.direction` | ![Development](https://img.shields.io/badge/-development-blue) | string | The paging access direction | `in` | @@ -117,20 +78,57 @@ Describes System Memory Paging attributes | `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | +## Filesystem Attributes + +Describes Filesystem attributes + +**Current Attributes:** +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `system.filesystem.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mode | `rw, ro` | +| `system.filesystem.mountpoint` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mount path | `/mnt/data` | +| `system.filesystem.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem state | `used` | +| `system.filesystem.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem type | `ext4` | + +--- + +`system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | +| `reserved` | reserved | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `exfat` | exfat | ![Development](https://img.shields.io/badge/-development-blue) | +| `ext4` | ext4 | ![Development](https://img.shields.io/badge/-development-blue) | +| `fat32` | fat32 | ![Development](https://img.shields.io/badge/-development-blue) | +| `hfsplus` | hfsplus | ![Development](https://img.shields.io/badge/-development-blue) | +| `ntfs` | ntfs | ![Development](https://img.shields.io/badge/-development-blue) | +| `refs` | refs | ![Development](https://img.shields.io/badge/-development-blue) | + ## Deprecated System Attributes Deprecated system attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `system.cpu.logical_number` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.logical_number`. | int | Deprecated, use `cpu.logical_number` instead. | `1` | -| `system.cpu.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | -| `system.network.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.connection.state`. | string | Deprecated, use `network.connection.state` instead. | `close_wait` | -| `system.paging.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.paging.fault.type`. | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | -| `system.process.status` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.state`. | string | Deprecated, use `process.state` instead. | `running` | -| `system.processes.status` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.state`. | string | Deprecated, use `process.state` instead. | `running` | +| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | +| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | +| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | Use `network.connection.state` instead. | +| `system.paging.type` | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | Use `system.paging.fault.type` instead. | +| `system.process.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | +| `system.processes.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | --- @@ -195,3 +193,5 @@ Deprecated system attributes. | `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | | `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | | `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/telemetry.md b/docs/registry/attributes/telemetry.md index 0350ceccbb..9f783225d1 100644 --- a/docs/registry/attributes/telemetry.md +++ b/docs/registry/attributes/telemetry.md @@ -7,8 +7,7 @@ This document defines attributes for telemetry SDK. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `telemetry.distro.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the auto instrumentation agent or distribution, if used. [1] | `parts-unlimited-java` | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 41a1ef2c88..7234f62c22 100644 --- a/docs/registry/attributes/test.md +++ b/docs/registry/attributes/test.md @@ -7,8 +7,7 @@ This group describes attributes specific to [software tests](https://wikipedia.org/wiki/Software_testing). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `test.case.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The fully qualified human readable name of the [test case](https://wikipedia.org/wiki/Test_case). | `org.example.TestCase1.test1`; `example/tests/TestCase1.test1`; `ExampleTestCase1_test1` | diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index 32bb61bde5..e5e0b8f3e2 100644 --- a/docs/registry/attributes/thread.md +++ b/docs/registry/attributes/thread.md @@ -7,8 +7,7 @@ These attributes may be used for any operation to store information about a thread that started a span. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `thread.id` | ![Development](https://img.shields.io/badge/-development-blue) | int | Current "managed" thread ID (as opposed to OS thread ID). [1] | `42` | diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index 8038a425a2..5e90eadc09 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -3,15 +3,28 @@ # TLS -- [TLS Attributes](#tls-attributes) - [TLS Deprecated Attributes](#tls-deprecated-attributes) +- [TLS Attributes](#tls-attributes) + +## TLS Deprecated Attributes + +Describes deprecated `tls` attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | Use `server.address` instead. | + +
## TLS Attributes This document defines semantic convention attributes in the TLS namespace. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `tls.cipher` | ![Development](https://img.shields.io/badge/-development-blue) | string | String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection. [1] | `TLS_RSA_WITH_3DES_EDE_CBC_SHA`; `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` | @@ -53,13 +66,3 @@ This document defines semantic convention attributes in the TLS namespace. |---|---|---| | `ssl` | ssl | ![Development](https://img.shields.io/badge/-development-blue) | | `tls` | tls | ![Development](https://img.shields.io/badge/-development-blue) | - -## TLS Deprecated Attributes - -Describes deprecated `tls` attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `tls.client.server_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | diff --git a/docs/registry/attributes/url.md b/docs/registry/attributes/url.md index d4b7d7087a..ef7b4f3eb9 100644 --- a/docs/registry/attributes/url.md +++ b/docs/registry/attributes/url.md @@ -7,8 +7,7 @@ Attributes describing URL. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `url.domain` | ![Development](https://img.shields.io/badge/-development-blue) | string | Domain extracted from the `url.full`, such as "opentelemetry.io". [1] | `www.foo.bar`; `opentelemetry.io`; `3.12.167.2`; `[1080:0:0:0:8:800:200C:417A]` | diff --git a/docs/registry/attributes/user-agent.md b/docs/registry/attributes/user-agent.md index d8cc33d365..2b93fa9cce 100644 --- a/docs/registry/attributes/user-agent.md +++ b/docs/registry/attributes/user-agent.md @@ -10,8 +10,7 @@ Describes user-agent attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `user_agent.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the user-agent extracted from original. Usually refers to the browser's name. [1] | `Safari`; `YourApp` | @@ -26,8 +25,7 @@ Describes user-agent attributes. Describes the OS user-agent attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `user_agent.os.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Human readable operating system name. [3] | `iOS`; `Android`; `Ubuntu` | diff --git a/docs/registry/attributes/user.md b/docs/registry/attributes/user.md index 831f59178b..c30e5550b8 100644 --- a/docs/registry/attributes/user.md +++ b/docs/registry/attributes/user.md @@ -7,8 +7,7 @@ Describes information about the user. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `user.email` | ![Development](https://img.shields.io/badge/-development-blue) | string | User email address. | `a.einstein@example.com` | diff --git a/docs/registry/attributes/v8js.md b/docs/registry/attributes/v8js.md index 8fb8248b9e..947f4afd34 100644 --- a/docs/registry/attributes/v8js.md +++ b/docs/registry/attributes/v8js.md @@ -7,8 +7,7 @@ Describes V8 JS Engine Runtime related attributes. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `v8js.gc.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The type of garbage collection. | `major`; `minor`; `incremental` | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index ad4d01ab6b..f5bea4962e 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -10,8 +10,7 @@ This group defines the attributes for [Version Control Systems (VCS)](https://wikipedia.org/wiki/Version_control). -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `vcs.change.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | `123` | @@ -149,15 +148,17 @@ the `.git` extension. Describes deprecated vcs attributes. -**Attributes:** +**Current Attributes:** +
+Past Attributes: -| Key | Stability | Value Type | Description | Example Values | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `vcs.repository.change.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.change.id`. | string | Deprecated, use `vcs.change.id` instead. | `123` | -| `vcs.repository.change.title` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.change.title`. | string | Deprecated, use `vcs.change.title` instead. | `Fixes broken thing`; `feat: add my new feature`; `[chore] update dependency` | -| `vcs.repository.ref.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.name`. | string | Deprecated, use `vcs.ref.head.name` instead. | `my-feature-branch`; `tag-1-test` | -| `vcs.repository.ref.revision` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.revision`. | string | Deprecated, use `vcs.ref.head.revision` instead. | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | -| `vcs.repository.ref.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.type`. | string | Deprecated, use `vcs.ref.head.type` instead. | `branch`; `tag` | +| `vcs.repository.change.id` | string | Deprecated, use `vcs.change.id` instead. | `123` | Use `vcs.change.id` instead. | +| `vcs.repository.change.title` | string | Deprecated, use `vcs.change.title` instead. | `Fixes broken thing`; `feat: add my new feature`; `[chore] update dependency` | Use `vcs.change.title` instead. | +| `vcs.repository.ref.name` | string | Deprecated, use `vcs.ref.head.name` instead. | `my-feature-branch`; `tag-1-test` | Use `vcs.ref.head.name` instead. | +| `vcs.repository.ref.revision` | string | Deprecated, use `vcs.ref.head.revision` instead. | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | Use `vcs.ref.head.revision` instead. | +| `vcs.repository.ref.type` | string | Deprecated, use `vcs.ref.head.type` instead. | `branch`; `tag` | Use `vcs.ref.head.type` instead. | --- @@ -167,3 +168,5 @@ Describes deprecated vcs attributes. |---|---|---| | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Development](https://img.shields.io/badge/-development-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/webengine.md b/docs/registry/attributes/webengine.md index 53af1193a1..8108ead08c 100644 --- a/docs/registry/attributes/webengine.md +++ b/docs/registry/attributes/webengine.md @@ -7,8 +7,7 @@ This document defines the attributes used to describe the packaged software running the application code. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `webengine.description` | ![Development](https://img.shields.io/badge/-development-blue) | string | Additional description of the web engine (e.g. detailed version and edition information). | `WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final` | diff --git a/docs/registry/attributes/zos.md b/docs/registry/attributes/zos.md index 5cc34f079b..1247b68b1d 100644 --- a/docs/registry/attributes/zos.md +++ b/docs/registry/attributes/zos.md @@ -7,8 +7,7 @@ This document defines attributes of a z/OS resource. -**Attributes:** - +**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `zos.smf.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The System Management Facility (SMF) Identifier uniquely identified a z/OS system within a SYSPLEX or mainframe environment and is used for system and performance analysis. | `SYS1` | diff --git a/model/android/deprecated/registry-deprecated.yaml b/model/android/deprecated/registry-deprecated.yaml deleted file mode 100644 index fe3c815489..0000000000 --- a/model/android/deprecated/registry-deprecated.yaml +++ /dev/null @@ -1,33 +0,0 @@ -groups: - - id: registry.android.deprecated - type: attribute_group - display_name: Deprecated Android Attributes - brief: > - This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform. - attributes: - - id: android.state - stability: development - brief: Deprecated. Use `android.app.state` attribute instead. - deprecated: - reason: renamed - renamed_to: android.app.state - type: - members: - - id: created - value: 'created' - brief: > - Any time before Activity.onResume() or, if the app has no Activity, Context.startService() - has been called in the app for the first time. - stability: development - - id: background - value: 'background' - brief: > - Any time after Activity.onPause() or, if the app has no Activity, - Context.stopService() has been called when the app was in the foreground state. - stability: development - - id: foreground - value: 'foreground' - brief: > - Any time after Activity.onResume() or, if the app has no Activity, - Context.startService() has been called when the app was in either the created or background states. - stability: development diff --git a/model/android/registry.yaml b/model/android/registry.yaml index 65633879b9..5146aafe87 100644 --- a/model/android/registry.yaml +++ b/model/android/registry.yaml @@ -13,6 +13,36 @@ groups: (`os.version`) of the android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). examples: ['33', '32'] + - id: android.state + stability: development + brief: > + This attribute represents the state of the application. + 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. + deprecated: + reason: renamed + renamed_to: android.app.state + type: + members: + - id: created + value: 'created' + brief: > + Any time before Activity.onResume() or, if the app has no Activity, Context.startService() + has been called in the app for the first time. + stability: development + - id: background + value: 'background' + brief: > + Any time after Activity.onPause() or, if the app has no Activity, + Context.stopService() has been called when the app was in the foreground state. + stability: development + - id: foreground + value: 'foreground' + brief: > + Any time after Activity.onResume() or, if the app has no Activity, + Context.startService() has been called when the app was in either the created or background states. + stability: development - id: android.app.state stability: development brief: > diff --git a/templates/registry/markdown/attribute_macros.j2 b/templates/registry/markdown/attribute_macros.j2 index cc05fcb679..b9884ffe08 100644 --- a/templates/registry/markdown/attribute_macros.j2 +++ b/templates/registry/markdown/attribute_macros.j2 @@ -20,6 +20,8 @@ {% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[`{{name(attribute)}}`]({{attribute_registry_base_url}}/{{ find_lineage(attribute.name, lineage_attributes) | split_id | list | reject("eq", "registry")| first | kebab_case }}.md){% endmacro %} +{% macro renamed_to_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[`{{attribute}}`]({{attribute_registry_base_url}}/{{ find_lineage(attribute, lineage_attributes) | split_id | list | reject("eq", "registry")| first | kebab_case }}.md){% endmacro %} + {% macro display_name(group) %} {%- if 'display_name' in group %}{{ group.display_name }} {%- else %}{{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 479bb23b8c..385d88eb6e 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -6,17 +6,10 @@ {%- import 'stability.j2' as stability -%} {%- import 'notes.j2' as notes -%} {%- import 'enum_macros.j2' as enums -%} +{%- import 'attribute_table.j2' as at -%} {%- import 'attribute_macros.j2' as attrs -%} {%- import 'examples_macros.j2' as examples -%} -{%- set groups = namespace(deprecated=[], non_deprecated=[]) -%} -{%- for group in ctx.groups | sort(attribute="id") -%} -{%- if group.id[-10:] == "deprecated" -%} -{%- set groups.deprecated = groups.deprecated + [group] -%} -{%- else -%} -{%- set groups.non_deprecated = groups.non_deprecated + [group] -%} -{%- endif -%} -{%- endfor -%} -{%- set attr_groups = groups.non_deprecated + groups.deprecated -%} +{%- set attr_groups = ctx.groups | sort(attribute="name") -%} @@ -36,16 +29,15 @@ {% else -%} {{ group.brief }} {{"\n"}} -{%- endif -%} -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | +{%- endif -%} **Current Attributes:** +{% set filtered_attributes = group.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}| Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -{%- for attribute in group.attributes | sort(attribute="name") %}{% set attr_anchor = attribute.name | kebab_case %} +{%- for attribute in filtered_attributes %}{% set attr_anchor = attribute.name | kebab_case %} | `{{ attrs.name(attribute) }}` | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {%- endfor %} {{ notes.render() }} -{%- for enum in group.attributes | sort(attribute="name") %} +{%- for enum in filtered_attributes | sort(attribute="name") %} {%- if enum.type is mapping -%}{{ enums.table(enum, notes) }}{% endif %} -{%- endfor -%} +{%- endfor -%}{% endif %}{{ at.generate_deprecated(group.attributes, "", "", "") | trim }}{% if filtered_attributes | length != group.attributes | length %}{{"\n"}}{%endif%} + {%- endfor -%} diff --git a/templates/registry/markdown/attribute_table.j2 b/templates/registry/markdown/attribute_table.j2 index b3bc133a86..dcd23ec602 100644 --- a/templates/registry/markdown/attribute_table.j2 +++ b/templates/registry/markdown/attribute_table.j2 @@ -6,10 +6,21 @@ {% import 'sampling_macros.j2' as sampling %} {% import 'examples_macros.j2' as examples %} {#- Macro for creating attribute table -#} -{% macro generate(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, title) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}{% if title and title != "Other" and title != "" %}**{{title}}:**{% elif title is undefined or title != "Other" %}**Attributes:**{%endif%} +{% macro generate(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, title) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | rejectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | rejectattr("deprecated") | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}{% if title and title != "Other" and title != "" %}**{{title}}:**{% elif title is undefined or title != "Other" %}**Attributes:**{%endif%} | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -{% for attribute in filtered_attributes | attribute_sort %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute)}, notes) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | +{% for attribute in filtered_attributes if attribute.deprecated is not defined or attribute.deprecated is none %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute), "deprecated": attribute.deprecated}, notes) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} +{% endif %}{{ generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes)}}{% endmacro %} + +{#- Macro for creating deprecated attribute table -#} +{% macro generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | selectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +{% for attribute in filtered_attributes %}| {% if attribute_registry_base_url != "" %}{{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }}{% else %}{% set attr_anchor = attribute.name | kebab_case %}`{{ attrs.name(attribute) }}`{%endif%} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {% if attribute.deprecated.reason == "renamed" %} Use {% if attribute_registry_base_url != "" %}{{ attrs.renamed_to_with_link(attribute.deprecated.renamed_to, attribute_registry_base_url, lineage_attributes) }}{% else %}`{{attribute.deprecated.renamed_to}}`{%endif%} instead. {% else %} {{attribute.deprecated.note | trim}} {% endif %} | +{% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} +
{% endif %}{% endmacro %} From 5ebfe96eae5fbeaf7d6d9bb29f044d9ac4b4ef91 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Mon, 29 Sep 2025 13:15:53 +1000 Subject: [PATCH 2/9] Lint document --- docs/registry/attributes/android.md | 4 +- docs/registry/attributes/app.md | 3 +- docs/registry/attributes/artifact.md | 3 +- docs/registry/attributes/aspnetcore.md | 3 +- docs/registry/attributes/aws.md | 123 ++++--- docs/registry/attributes/azure.md | 7 +- docs/registry/attributes/browser.md | 3 +- docs/registry/attributes/cassandra.md | 3 +- docs/registry/attributes/cicd.md | 3 +- docs/registry/attributes/client.md | 3 +- docs/registry/attributes/cloud.md | 3 +- docs/registry/attributes/cloudevents.md | 3 +- docs/registry/attributes/cloudfoundry.md | 3 +- docs/registry/attributes/code.md | 40 +-- docs/registry/attributes/container.md | 56 +-- docs/registry/attributes/cpu.md | 3 +- docs/registry/attributes/cpython.md | 3 +- docs/registry/attributes/db.md | 325 +++++++++--------- docs/registry/attributes/deployment.md | 32 +- docs/registry/attributes/destination.md | 3 +- docs/registry/attributes/device.md | 3 +- docs/registry/attributes/disk.md | 3 +- docs/registry/attributes/dns.md | 3 +- docs/registry/attributes/dotnet.md | 3 +- docs/registry/attributes/elasticsearch.md | 3 +- docs/registry/attributes/enduser.md | 34 +- docs/registry/attributes/error.md | 3 +- docs/registry/attributes/event.md | 1 - docs/registry/attributes/exception.md | 4 +- docs/registry/attributes/faas.md | 3 +- docs/registry/attributes/feature-flag.md | 70 ++-- docs/registry/attributes/file.md | 3 +- docs/registry/attributes/gcp.md | 73 ++-- docs/registry/attributes/gen-ai.md | 5 +- docs/registry/attributes/geo.md | 3 +- docs/registry/attributes/go.md | 3 +- docs/registry/attributes/graphql.md | 3 +- docs/registry/attributes/hardware.md | 3 +- docs/registry/attributes/heroku.md | 3 +- docs/registry/attributes/host.md | 3 +- docs/registry/attributes/http.md | 84 ++--- docs/registry/attributes/ios.md | 4 +- docs/registry/attributes/jvm.md | 3 +- docs/registry/attributes/k8s.md | 4 +- docs/registry/attributes/linux.md | 3 +- docs/registry/attributes/log.md | 9 +- docs/registry/attributes/mainframe.md | 3 +- docs/registry/attributes/messaging.md | 102 +++--- docs/registry/attributes/network.md | 108 +++--- docs/registry/attributes/nfs.md | 3 +- docs/registry/attributes/nodejs.md | 3 +- docs/registry/attributes/oci.md | 3 +- docs/registry/attributes/onc-rpc.md | 3 +- docs/registry/attributes/openai.md | 3 +- docs/registry/attributes/openshift.md | 3 +- docs/registry/attributes/opentracing.md | 3 +- docs/registry/attributes/os.md | 3 +- docs/registry/attributes/otel.md | 62 ++-- docs/registry/attributes/peer.md | 3 +- docs/registry/attributes/pprof.md | 3 +- docs/registry/attributes/process.md | 97 +++--- docs/registry/attributes/profile.md | 3 +- docs/registry/attributes/rpc.md | 4 +- docs/registry/attributes/security-rule.md | 3 +- docs/registry/attributes/server.md | 3 +- docs/registry/attributes/service.md | 3 +- docs/registry/attributes/session.md | 3 +- docs/registry/attributes/signalr.md | 3 +- docs/registry/attributes/source.md | 3 +- docs/registry/attributes/system.md | 83 ++--- docs/registry/attributes/telemetry.md | 3 +- docs/registry/attributes/test.md | 3 +- docs/registry/attributes/thread.md | 3 +- docs/registry/attributes/tls.md | 32 +- docs/registry/attributes/url.md | 3 +- docs/registry/attributes/user-agent.md | 6 +- docs/registry/attributes/user.md | 3 +- docs/registry/attributes/v8js.md | 3 +- docs/registry/attributes/vcs.md | 4 +- docs/registry/attributes/webengine.md | 3 +- docs/registry/attributes/zos.md | 3 +- .../markdown/attribute_namespace.md.j2 | 19 +- 82 files changed, 829 insertions(+), 728 deletions(-) diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index dd67229ba5..70ad544ddb 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -7,7 +7,8 @@ The Android platform on which the Android application is running. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `android.app.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | This attribute represents the state of the application. [1] | `created` | @@ -24,6 +25,7 @@ The Android platform on which the Android application is running. | `background` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | | `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) | | `foreground` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | +
Past Attributes: diff --git a/docs/registry/attributes/app.md b/docs/registry/attributes/app.md index 10c12a0fda..d23b5d64d2 100644 --- a/docs/registry/attributes/app.md +++ b/docs/registry/attributes/app.md @@ -7,7 +7,8 @@ Describes attributes related to client-side applications (e.g. web apps or mobile apps). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `app.build_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for a particular build or compilation of the application. | `6cff0a7e-cefc-4668-96f5-1273d8b334d0`; `9f2b833506aa6973a92fde9733e6271f`; `my-app-1.0.0-code-123` | diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index e219b535e0..c25ebf913d 100644 --- a/docs/registry/attributes/artifact.md +++ b/docs/registry/attributes/artifact.md @@ -7,7 +7,8 @@ This group describes attributes specific to artifacts. Artifacts are files or other immutable objects that are intended for distribution. This definition aligns directly with the [SLSA](https://slsa.dev/spec/v1.0/terminology#package-model) package model. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `artifact.attestation.filename` | ![Development](https://img.shields.io/badge/-development-blue) | string | The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the [SLSA Relationship](https://slsa.dev/spec/v1.0/distributing-provenance#relationship-between-artifacts-and-attestations) specification for more information. | `golang-binary-amd64-v0.1.0.attestation`; `docker-image-amd64-v0.1.0.intoto.json1`; `release-1.tar.gz.attestation`; `file-name-package.tar.gz.intoto.json1` | diff --git a/docs/registry/attributes/aspnetcore.md b/docs/registry/attributes/aspnetcore.md index e06ed583cd..a70d2421a5 100644 --- a/docs/registry/attributes/aspnetcore.md +++ b/docs/registry/attributes/aspnetcore.md @@ -7,7 +7,8 @@ ASP.NET Core attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aspnetcore.authentication.result` | ![Development](https://img.shields.io/badge/-development-blue) | string | The result of the authentication operation. | `success`; `failure` | diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index 1e3dc69e74..5d468e924b 100644 --- a/docs/registry/attributes/aws.md +++ b/docs/registry/attributes/aws.md @@ -4,34 +4,47 @@ # AWS - [General AWS Attributes](#general-aws-attributes) +- [Amazon Bedrock Attributes](#amazon-bedrock-attributes) - [Amazon DynamoDB Attributes](#amazon-dynamodb-attributes) - [Amazon ECS Attributes](#amazon-ecs-attributes) - [Amazon EKS Attributes](#amazon-eks-attributes) -- [Amazon Logs Attributes](#amazon-logs-attributes) +- [Amazon Kinesis Attributes](#amazon-kinesis-attributes) - [Amazon Lambda Attributes](#amazon-lambda-attributes) +- [Amazon Logs Attributes](#amazon-logs-attributes) - [Amazon S3 Attributes](#amazon-s3-attributes) -- [Amazon SQS Attributes](#amazon-sqs-attributes) +- [Amazon Secrets Manager Attributes](#amazon-secrets-manager-attributes) - [Amazon SNS Attributes](#amazon-sns-attributes) -- [Amazon Kinesis Attributes](#amazon-kinesis-attributes) +- [Amazon SQS Attributes](#amazon-sqs-attributes) - [Amazon Step Functions Attributes](#amazon-step-functions-attributes) -- [Amazon Secrets Manager Attributes](#amazon-secrets-manager-attributes) -- [Amazon Bedrock Attributes](#amazon-bedrock-attributes) ## General AWS Attributes This section defines generic attributes for AWS services. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.extended_request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | | `aws.request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | +## Amazon Bedrock Attributes + +This document defines attributes for AWS Bedrock. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `aws.bedrock.guardrail.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Guardrail. A [guardrail](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) helps safeguard and prevent unwanted behavior from model responses or user messages. | `sgi5gkybzqak` | +| `aws.bedrock.knowledge_base.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Knowledge base. A [knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) is a bank of information that can be queried by models to generate more relevant responses and augment prompts. | `XFWUPB9PAW` | + ## Amazon DynamoDB Attributes This document defines attributes for AWS DynamoDB. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.dynamodb.attribute_definitions` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]` | @@ -61,7 +74,8 @@ This document defines attributes for AWS DynamoDB. This document defines attributes for AWS Elastic Container Service (ECS). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.ecs.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | @@ -85,46 +99,60 @@ This document defines attributes for AWS Elastic Container Service (ECS). This document defines attributes for AWS Elastic Kubernetes Service (EKS). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.eks.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | -## Amazon Logs Attributes +## Amazon Kinesis Attributes -This document defines attributes for AWS Logs. +This document defines attributes for AWS Kinesis. + +**Attributes:** -**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.log.group.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The Amazon Resource Name(s) (ARN) of the AWS log group(s). [1] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]` | -| `aws.log.group.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log group(s) an application is writing to. [2] | `["/aws/lambda/my-function", "opentelemetry-service"]` | -| `aws.log.stream.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The ARN(s) of the AWS log stream(s). [3] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | -| `aws.log.stream.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | - -**[1] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). - -**[2] `aws.log.group.names`:** 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. - -**[3] `aws.log.stream.arns`:** 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. +| `aws.kinesis.stream_name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the AWS Kinesis [stream](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) the request refers to. Corresponds to the `--stream-name` parameter of the Kinesis [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) operation. | `some-stream-name` | ## Amazon Lambda Attributes This document defines attributes for AWS Lambda. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.lambda.invoked_arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). [4] | `arn:aws:lambda:us-east-1:123456:function:myfunction:myalias` | +| `aws.lambda.invoked_arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). [1] | `arn:aws:lambda:us-east-1:123456:function:myfunction:myalias` | | `aws.lambda.resource_mapping.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environtment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. | `587ad24b-03b9-4413-8202-bbd56b36e5b7` | -**[4] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. +**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. + +## Amazon Logs Attributes + +This document defines attributes for AWS Logs. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `aws.log.group.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The Amazon Resource Name(s) (ARN) of the AWS log group(s). [2] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]` | +| `aws.log.group.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log group(s) an application is writing to. [3] | `["/aws/lambda/my-function", "opentelemetry-service"]` | +| `aws.log.stream.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The ARN(s) of the AWS log stream(s). [4] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | +| `aws.log.stream.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | + +**[2] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). + +**[3] `aws.log.group.names`:** 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. + +**[4] `aws.log.stream.arns`:** 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. ## Amazon S3 Attributes This document defines attributes for AWS S3. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.s3.bucket` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [5] | `some-bucket-name` | @@ -180,58 +208,43 @@ This applies in particular to the following operations: - [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) -## Amazon SQS Attributes +## Amazon Secrets Manager Attributes -This document defines attributes for AWS SQS. +This document defines attributes for AWS Secrets Manager. + +**Attributes:** -**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | +| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | ## Amazon SNS Attributes This document defines attributes for AWS SNS. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.sns.topic.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS SNS Topic. An Amazon SNS [topic](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) is a logical access point that acts as a communication channel. | `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` | -## Amazon Kinesis Attributes +## Amazon SQS Attributes -This document defines attributes for AWS Kinesis. +This document defines attributes for AWS SQS. + +**Attributes:** -**Current Attributes:** | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| -| `aws.kinesis.stream_name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the AWS Kinesis [stream](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) the request refers to. Corresponds to the `--stream-name` parameter of the Kinesis [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) operation. | `some-stream-name` | +| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | ## Amazon Step Functions Attributes This document defines attributes for AWS Step Functions. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `aws.step_functions.activity.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | | `aws.step_functions.state_machine.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | - -## Amazon Secrets Manager Attributes - -This document defines attributes for AWS Secrets Manager. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | - -## Amazon Bedrock Attributes - -This document defines attributes for AWS Bedrock. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `aws.bedrock.guardrail.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Guardrail. A [guardrail](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) helps safeguard and prevent unwanted behavior from model responses or user messages. | `sgi5gkybzqak` | -| `aws.bedrock.knowledge_base.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Knowledge base. A [knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) is a bank of information that can be queried by models to generate more relevant responses and augment prompts. | `XFWUPB9PAW` | diff --git a/docs/registry/attributes/azure.md b/docs/registry/attributes/azure.md index 84d9fd5315..51e40a2d10 100644 --- a/docs/registry/attributes/azure.md +++ b/docs/registry/attributes/azure.md @@ -11,7 +11,8 @@ This section defines generic attributes used by Azure Client Libraries. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `azure.client.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | @@ -22,7 +23,8 @@ This section defines generic attributes used by Azure Client Libraries. This section defines attributes for Azure Cosmos DB. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `azure.cosmosdb.connection.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Cosmos client connection mode. | `gateway`; `direct` | @@ -59,7 +61,6 @@ This section defines attributes for Azure Cosmos DB. This section describes deprecated Azure attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/browser.md b/docs/registry/attributes/browser.md index be1d713627..cc8d235f4e 100644 --- a/docs/registry/attributes/browser.md +++ b/docs/registry/attributes/browser.md @@ -7,7 +7,8 @@ The web browser attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `browser.brands` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Array of brand name and version separated by a space [1] | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | diff --git a/docs/registry/attributes/cassandra.md b/docs/registry/attributes/cassandra.md index 038cdc3334..640a98c36d 100644 --- a/docs/registry/attributes/cassandra.md +++ b/docs/registry/attributes/cassandra.md @@ -7,7 +7,8 @@ This section defines attributes for Cassandra. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cassandra.consistency.level` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `all`; `each_quorum`; `quorum` | diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index bccac7f638..20a831180c 100644 --- a/docs/registry/attributes/cicd.md +++ b/docs/registry/attributes/cicd.md @@ -7,7 +7,8 @@ This group describes attributes specific to pipelines within a Continuous Integration and Continuous Deployment (CI/CD) system. A [pipeline](https://wikipedia.org/wiki/Pipeline_(computing)) in this case is a series of steps that are performed in order to deliver a new version of software. This aligns with the [Britannica](https://www.britannica.com/dictionary/pipeline) definition of a pipeline where a **pipeline** is the system for developing and producing something. In the context of CI/CD, a pipeline produces or delivers software. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cicd.pipeline.action.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The kind of action a pipeline run is performing. | `BUILD`; `RUN`; `SYNC` | diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index c40af32f3b..948ef0a5cc 100644 --- a/docs/registry/attributes/client.md +++ b/docs/registry/attributes/client.md @@ -7,7 +7,8 @@ These attributes may be used to describe the client in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `client.address` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/cloud.md b/docs/registry/attributes/cloud.md index a5b4ec7f8b..adfb9fa7fe 100644 --- a/docs/registry/attributes/cloud.md +++ b/docs/registry/attributes/cloud.md @@ -7,7 +7,8 @@ A cloud environment (e.g. GCP, Azure, AWS). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cloud.account.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | diff --git a/docs/registry/attributes/cloudevents.md b/docs/registry/attributes/cloudevents.md index ca6bdcc66c..a97116e500 100644 --- a/docs/registry/attributes/cloudevents.md +++ b/docs/registry/attributes/cloudevents.md @@ -7,7 +7,8 @@ This document defines attributes for CloudEvents. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cloudevents.event_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. | `123e4567-e89b-12d3-a456-426614174000`; `0001` | diff --git a/docs/registry/attributes/cloudfoundry.md b/docs/registry/attributes/cloudfoundry.md index 6ce242a448..9e62fef3cb 100644 --- a/docs/registry/attributes/cloudfoundry.md +++ b/docs/registry/attributes/cloudfoundry.md @@ -7,7 +7,8 @@ CloudFoundry resource attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cloudfoundry.app.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The guid of the application. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index 0be30fbc05..0e8a598eaa 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -3,32 +3,15 @@ # Code -- [Deprecated Code Attributes](#deprecated-code-attributes) - [Code Attributes](#code-attributes) - -## Deprecated Code Attributes - -These deprecated attributes provide context about source code - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `code.column` | int | Deprecated, use `code.column.number` | `16` | Use `code.column.number` instead. | -| `code.filepath` | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | Use `code.file.path` instead. | -| `code.function` | string | Deprecated, use `code.function.name` instead | `serveRequest` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | -| `code.lineno` | int | Deprecated, use `code.line.number` instead | `42` | Use `code.line.number` instead. | -| `code.namespace` | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | - -
+- [Deprecated Code Attributes](#deprecated-code-attributes) ## Code Attributes These attributes provide context about source code -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `code.column.number` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | int | The column number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity. | `16` | @@ -52,3 +35,20 @@ Examples: * Erlang: `opentelemetry_ctx:new` * Rust: `playground::my_module::my_cool_func` * C function: `fopen` + +## Deprecated Code Attributes + +These deprecated attributes provide context about source code + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `code.column` | int | Deprecated, use `code.column.number` | `16` | Use `code.column.number` instead. | +| `code.filepath` | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | Use `code.file.path` instead. | +| `code.function` | string | Deprecated, use `code.function.name` instead | `serveRequest` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | +| `code.lineno` | int | Deprecated, use `code.line.number` instead | `42` | Use `code.line.number` instead. | +| `code.namespace` | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | + +
diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index 35cf7c37f7..bcb539f861 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -3,40 +3,15 @@ # Container -- [Deprecated Container Attributes](#deprecated-container-attributes) - [Container Attributes](#container-attributes) - -## Deprecated Container Attributes - -Describes deprecated container attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | Use `cpu.mode` instead. | -| `container.labels.` | string | Deprecated, use `container.label` instead. | `nginx` | Use `container.label` instead. | -| `container.runtime` | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | Use `container.runtime.name` instead. | - ---- - -`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | -| `system` | When CPU is used by the system (host OS) | ![Development](https://img.shields.io/badge/-development-blue) | -| `user` | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | - -
+- [Deprecated Container Attributes](#deprecated-container-attributes) ## Container Attributes A container instance. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `container.command` | ![Development](https://img.shields.io/badge/-development-blue) | string | The command used to run the container (i.e. the command name). [1] | `otelcontribcol` | @@ -68,3 +43,28 @@ The ID is assigned by the container runtime and can vary in different environmen **[5] `container.image.repo_digests`:** [Docker](https://docs.docker.com/reference/api/engine/version/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. **[6] `container.label.`:** For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`. + +## Deprecated Container Attributes + +Describes deprecated container attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | Use `cpu.mode` instead. | +| `container.labels.` | string | Deprecated, use `container.label` instead. | `nginx` | Use `container.label` instead. | +| `container.runtime` | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | Use `container.runtime.name` instead. | + +--- + +`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | +| `system` | When CPU is used by the system (host OS) | ![Development](https://img.shields.io/badge/-development-blue) | +| `user` | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/cpu.md b/docs/registry/attributes/cpu.md index 7590642c9b..71429c0fd5 100644 --- a/docs/registry/attributes/cpu.md +++ b/docs/registry/attributes/cpu.md @@ -7,7 +7,8 @@ Attributes specific to a cpu instance. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cpu.logical_number` | ![Development](https://img.shields.io/badge/-development-blue) | int | The logical CPU number [0..n-1] | `1` | diff --git a/docs/registry/attributes/cpython.md b/docs/registry/attributes/cpython.md index 393bed1f30..7577056f9a 100644 --- a/docs/registry/attributes/cpython.md +++ b/docs/registry/attributes/cpython.md @@ -7,7 +7,8 @@ This document defines CPython related attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `cpython.gc.generation` | ![Development](https://img.shields.io/badge/-development-blue) | int | Value of the garbage collector collection generation. | `0`; `1`; `2` | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index c7f3e61013..431c36f205 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -3,15 +3,175 @@ # DB +- [General Database Attributes](#general-database-attributes) - [Deprecated Database Attributes](#deprecated-database-attributes) - [Deprecated Database Metrics](#deprecated-database-metrics) -- [General Database Attributes](#general-database-attributes) + +## General Database Attributes + +This group defines the attributes used to describe telemetry in the context of databases. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `db.client.connection.pool.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes `server.address`, `server.port`, and `db.namespace`, formatted as `server.address:server.port/db.namespace`. Instrumentations that generate connection pool name following different patterns SHOULD document it. | `myDataSource` | +| `db.client.connection.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The state of a connection in the pool | `idle` | +| `db.collection.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of a collection (table, container) within the database. [1] | `public.users`; `customers` | +| `db.namespace` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the database, fully qualified within the server address and port. [2] | `customers`; `test.users` | +| `db.operation.batch.size` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | int | The number of queries included in a batch operation. [3] | `2`; `3`; `4` | +| `db.operation.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the operation or command being executed. [4] | `findAndModify`; `HMSET`; `SELECT` | +| `db.operation.parameter.` | ![Development](https://img.shields.io/badge/-development-blue) | string | A database operation parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [5] | `someval`; `55` | +| `db.query.parameter.` | ![Development](https://img.shields.io/badge/-development-blue) | string | A database query parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [6] | `someval`; `55` | +| `db.query.summary` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Low cardinality summary of a database query. [7] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | +| `db.query.text` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The database query being executed. [8] | `SELECT * FROM wuser_table where username = ?`; `SET mykey ?` | +| `db.response.returned_rows` | ![Development](https://img.shields.io/badge/-development-blue) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | +| `db.response.status_code` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Database response status code. [9] | `102`; `ORA-17002`; `08P01`; `404` | +| `db.stored_procedure.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of a stored procedure within the database. [10] | `GetCustomer` | +| `db.system.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The database management system (DBMS) product as identified by the client instrumentation. [11] | `other_sql`; `softwareag.adabas`; `actian.ingres` | + +**[1] `db.collection.name`:** It is RECOMMENDED to capture the value as provided by the application +without attempting to do any case normalization. + +The collection name SHOULD NOT be extracted from `db.query.text`, +when the database system supports query text with multiple collections +in non-batch operations. + +For batch operations, if the individual operations are known to have the same +collection name then that collection name SHOULD be used. + +**[2] `db.namespace`:** If a database system has multiple namespace components, they SHOULD be concatenated from the most general to the most specific namespace component, using `|` as a separator between the components. Any missing components (and their associated separators) SHOULD be omitted. +Semantic conventions for individual database systems SHOULD document what `db.namespace` means in the context of that system. +It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. + +**[3] `db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`. + +**[4] `db.operation.name`:** It is RECOMMENDED to capture the value as provided by the application +without attempting to do any case normalization. + +The operation name SHOULD NOT be extracted from `db.query.text`, +when the database system supports query text with multiple operations +in non-batch operations. + +If spaces can occur in the operation name, multiple consecutive spaces +SHOULD be normalized to a single space. + +For batch operations, if the individual operations are known to have the same operation name +then that operation name SHOULD be used prepended by `BATCH `, +otherwise `db.operation.name` SHOULD be `BATCH` or some other database +system specific term if more applicable. + +**[5] `db.operation.parameter.`:** For example, a client-side maximum number of rows to read from the database +MAY be recorded as the `db.operation.parameter.max_rows` attribute. + +`db.query.text` parameters SHOULD be captured using `db.query.parameter.` +instead of `db.operation.parameter.`. + +**[6] `db.query.parameter.`:** If a query parameter has no name and instead is referenced only by index, +then `` SHOULD be the 0-based index. + +`db.query.parameter.` SHOULD match +up with the parameterized placeholders present in `db.query.text`. + +It is RECOMMENDED to capture the value as provided by the application +without attempting to do any case normalization. + +`db.query.parameter.` SHOULD NOT be captured on batch operations. + +Examples: + +- For a query `SELECT * FROM users where username = %s` with the parameter `"jdoe"`, + the attribute `db.query.parameter.0` SHOULD be set to `"jdoe"`. + +- For a query `"SELECT * FROM users WHERE username = %(userName)s;` with parameter + `userName = "jdoe"`, the attribute `db.query.parameter.userName` SHOULD be set to `"jdoe"`. + +**[7] `db.query.summary`:** The query summary describes a class of database queries and is useful +as a grouping key, especially when analyzing telemetry for database +calls involving complex queries. + +Summary may be available to the instrumentation through +instrumentation hooks or other means. If it is not available, instrumentations +that support query parsing SHOULD generate a summary following +[Generating query summary](/docs/database/database-spans.md#generating-a-summary-of-the-query) +section. + +**[8] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext). +For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable. +Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk. + +**[9] `db.response.status_code`:** The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. +Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system. + +**[10] `db.stored_procedure.name`:** It is RECOMMENDED to capture the value as provided by the application +without attempting to do any case normalization. + +For batch operations, if the individual operations are known to have the same +stored procedure name then that stored procedure name SHOULD be used. + +**[11] `db.system.name`:** The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system.name` is set to `postgresql` based on the instrumentation's best knowledge. + +--- + +`db.client.connection.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`db.system.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `actian.ingres` | [Actian Ingres](https://www.actian.com/databases/ingres/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.dynamodb` | [Amazon DynamoDB](https://aws.amazon.com/pm/dynamodb/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.redshift` | [Amazon Redshift](https://aws.amazon.com/redshift/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `azure.cosmosdb` | [Azure Cosmos DB](https://learn.microsoft.com/azure/cosmos-db) | ![Development](https://img.shields.io/badge/-development-blue) | +| `cassandra` | [Apache Cassandra](https://cassandra.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `clickhouse` | [ClickHouse](https://clickhouse.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `cockroachdb` | [CockroachDB](https://www.cockroachlabs.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `couchbase` | [Couchbase](https://www.couchbase.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `couchdb` | [Apache CouchDB](https://couchdb.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `derby` | [Apache Derby](https://db.apache.org/derby/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `elasticsearch` | [Elasticsearch](https://www.elastic.co/elasticsearch) | ![Development](https://img.shields.io/badge/-development-blue) | +| `firebirdsql` | [Firebird](https://www.firebirdsql.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.spanner` | [Google Cloud Spanner](https://cloud.google.com/spanner) | ![Development](https://img.shields.io/badge/-development-blue) | +| `geode` | [Apache Geode](https://geode.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `h2database` | [H2 Database](https://h2database.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `hbase` | [Apache HBase](https://hbase.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `hive` | [Apache Hive](https://hive.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `hsqldb` | [HyperSQL Database](https://hsqldb.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `ibm.db2` | [IBM Db2](https://www.ibm.com/db2) | ![Development](https://img.shields.io/badge/-development-blue) | +| `ibm.informix` | [IBM Informix](https://www.ibm.com/products/informix) | ![Development](https://img.shields.io/badge/-development-blue) | +| `ibm.netezza` | [IBM Netezza](https://www.ibm.com/products/netezza) | ![Development](https://img.shields.io/badge/-development-blue) | +| `influxdb` | [InfluxDB](https://www.influxdata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `instantdb` | [Instant](https://www.instantdb.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `intersystems.cache` | [InterSystems Caché](https://www.intersystems.com/products/cache/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `mariadb` | [MariaDB](https://mariadb.org/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `memcached` | [Memcached](https://memcached.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `microsoft.sql_server` | [Microsoft SQL Server](https://www.microsoft.com/sql-server) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `mongodb` | [MongoDB](https://www.mongodb.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `mysql` | [MySQL](https://www.mysql.com/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `neo4j` | [Neo4j](https://neo4j.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `opensearch` | [OpenSearch](https://opensearch.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `oracle.db` | [Oracle Database](https://www.oracle.com/database/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `other_sql` | Some other SQL database. Fallback only. | ![Development](https://img.shields.io/badge/-development-blue) | +| `postgresql` | [PostgreSQL](https://www.postgresql.org/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `redis` | [Redis](https://redis.io/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `sap.hana` | [SAP HANA](https://www.sap.com/products/technology-platform/hana/what-is-sap-hana.html) | ![Development](https://img.shields.io/badge/-development-blue) | +| `sap.maxdb` | [SAP MaxDB](https://maxdb.sap.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `softwareag.adabas` | [Adabas (Adaptable Database System)](https://documentation.softwareag.com/?pf=adabas) | ![Development](https://img.shields.io/badge/-development-blue) | +| `sqlite` | [SQLite](https://www.sqlite.org/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `teradata` | [Teradata](https://www.teradata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | +| `trino` | [Trino](https://trino.io/) | ![Development](https://img.shields.io/badge/-development-blue) | ## Deprecated Database Attributes Describes deprecated database attributes. -**Current Attributes:**
Past Attributes: @@ -173,7 +333,6 @@ Describes deprecated database attributes. Describes deprecated db metrics attributes. -**Current Attributes:**
Past Attributes: @@ -203,163 +362,3 @@ Describes deprecated db metrics attributes. | `used` | used | ![Development](https://img.shields.io/badge/-development-blue) |
- -## General Database Attributes - -This group defines the attributes used to describe telemetry in the context of databases. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `db.client.connection.pool.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes `server.address`, `server.port`, and `db.namespace`, formatted as `server.address:server.port/db.namespace`. Instrumentations that generate connection pool name following different patterns SHOULD document it. | `myDataSource` | -| `db.client.connection.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The state of a connection in the pool | `idle` | -| `db.collection.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of a collection (table, container) within the database. [1] | `public.users`; `customers` | -| `db.namespace` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the database, fully qualified within the server address and port. [2] | `customers`; `test.users` | -| `db.operation.batch.size` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | int | The number of queries included in a batch operation. [3] | `2`; `3`; `4` | -| `db.operation.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the operation or command being executed. [4] | `findAndModify`; `HMSET`; `SELECT` | -| `db.operation.parameter.` | ![Development](https://img.shields.io/badge/-development-blue) | string | A database operation parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [5] | `someval`; `55` | -| `db.query.parameter.` | ![Development](https://img.shields.io/badge/-development-blue) | string | A database query parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [6] | `someval`; `55` | -| `db.query.summary` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Low cardinality summary of a database query. [7] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | -| `db.query.text` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The database query being executed. [8] | `SELECT * FROM wuser_table where username = ?`; `SET mykey ?` | -| `db.response.returned_rows` | ![Development](https://img.shields.io/badge/-development-blue) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | -| `db.response.status_code` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Database response status code. [9] | `102`; `ORA-17002`; `08P01`; `404` | -| `db.stored_procedure.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of a stored procedure within the database. [10] | `GetCustomer` | -| `db.system.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The database management system (DBMS) product as identified by the client instrumentation. [11] | `other_sql`; `softwareag.adabas`; `actian.ingres` | - -**[1] `db.collection.name`:** It is RECOMMENDED to capture the value as provided by the application -without attempting to do any case normalization. - -The collection name SHOULD NOT be extracted from `db.query.text`, -when the database system supports query text with multiple collections -in non-batch operations. - -For batch operations, if the individual operations are known to have the same -collection name then that collection name SHOULD be used. - -**[2] `db.namespace`:** If a database system has multiple namespace components, they SHOULD be concatenated from the most general to the most specific namespace component, using `|` as a separator between the components. Any missing components (and their associated separators) SHOULD be omitted. -Semantic conventions for individual database systems SHOULD document what `db.namespace` means in the context of that system. -It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. - -**[3] `db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`. - -**[4] `db.operation.name`:** It is RECOMMENDED to capture the value as provided by the application -without attempting to do any case normalization. - -The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports query text with multiple operations -in non-batch operations. - -If spaces can occur in the operation name, multiple consecutive spaces -SHOULD be normalized to a single space. - -For batch operations, if the individual operations are known to have the same operation name -then that operation name SHOULD be used prepended by `BATCH `, -otherwise `db.operation.name` SHOULD be `BATCH` or some other database -system specific term if more applicable. - -**[5] `db.operation.parameter.`:** For example, a client-side maximum number of rows to read from the database -MAY be recorded as the `db.operation.parameter.max_rows` attribute. - -`db.query.text` parameters SHOULD be captured using `db.query.parameter.` -instead of `db.operation.parameter.`. - -**[6] `db.query.parameter.`:** If a query parameter has no name and instead is referenced only by index, -then `` SHOULD be the 0-based index. - -`db.query.parameter.` SHOULD match -up with the parameterized placeholders present in `db.query.text`. - -It is RECOMMENDED to capture the value as provided by the application -without attempting to do any case normalization. - -`db.query.parameter.` SHOULD NOT be captured on batch operations. - -Examples: - -- For a query `SELECT * FROM users where username = %s` with the parameter `"jdoe"`, - the attribute `db.query.parameter.0` SHOULD be set to `"jdoe"`. - -- For a query `"SELECT * FROM users WHERE username = %(userName)s;` with parameter - `userName = "jdoe"`, the attribute `db.query.parameter.userName` SHOULD be set to `"jdoe"`. - -**[7] `db.query.summary`:** The query summary describes a class of database queries and is useful -as a grouping key, especially when analyzing telemetry for database -calls involving complex queries. - -Summary may be available to the instrumentation through -instrumentation hooks or other means. If it is not available, instrumentations -that support query parsing SHOULD generate a summary following -[Generating query summary](/docs/database/database-spans.md#generating-a-summary-of-the-query) -section. - -**[8] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext). -For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable. -Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk. - -**[9] `db.response.status_code`:** The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. -Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system. - -**[10] `db.stored_procedure.name`:** It is RECOMMENDED to capture the value as provided by the application -without attempting to do any case normalization. - -For batch operations, if the individual operations are known to have the same -stored procedure name then that stored procedure name SHOULD be used. - -**[11] `db.system.name`:** The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system.name` is set to `postgresql` based on the instrumentation's best knowledge. - ---- - -`db.client.connection.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`db.system.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `actian.ingres` | [Actian Ingres](https://www.actian.com/databases/ingres/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.dynamodb` | [Amazon DynamoDB](https://aws.amazon.com/pm/dynamodb/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.redshift` | [Amazon Redshift](https://aws.amazon.com/redshift/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `azure.cosmosdb` | [Azure Cosmos DB](https://learn.microsoft.com/azure/cosmos-db) | ![Development](https://img.shields.io/badge/-development-blue) | -| `cassandra` | [Apache Cassandra](https://cassandra.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `clickhouse` | [ClickHouse](https://clickhouse.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `cockroachdb` | [CockroachDB](https://www.cockroachlabs.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `couchbase` | [Couchbase](https://www.couchbase.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `couchdb` | [Apache CouchDB](https://couchdb.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `derby` | [Apache Derby](https://db.apache.org/derby/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `elasticsearch` | [Elasticsearch](https://www.elastic.co/elasticsearch) | ![Development](https://img.shields.io/badge/-development-blue) | -| `firebirdsql` | [Firebird](https://www.firebirdsql.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.spanner` | [Google Cloud Spanner](https://cloud.google.com/spanner) | ![Development](https://img.shields.io/badge/-development-blue) | -| `geode` | [Apache Geode](https://geode.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `h2database` | [H2 Database](https://h2database.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `hbase` | [Apache HBase](https://hbase.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `hive` | [Apache Hive](https://hive.apache.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `hsqldb` | [HyperSQL Database](https://hsqldb.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `ibm.db2` | [IBM Db2](https://www.ibm.com/db2) | ![Development](https://img.shields.io/badge/-development-blue) | -| `ibm.informix` | [IBM Informix](https://www.ibm.com/products/informix) | ![Development](https://img.shields.io/badge/-development-blue) | -| `ibm.netezza` | [IBM Netezza](https://www.ibm.com/products/netezza) | ![Development](https://img.shields.io/badge/-development-blue) | -| `influxdb` | [InfluxDB](https://www.influxdata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `instantdb` | [Instant](https://www.instantdb.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `intersystems.cache` | [InterSystems Caché](https://www.intersystems.com/products/cache/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `mariadb` | [MariaDB](https://mariadb.org/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `memcached` | [Memcached](https://memcached.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `microsoft.sql_server` | [Microsoft SQL Server](https://www.microsoft.com/sql-server) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `mongodb` | [MongoDB](https://www.mongodb.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `mysql` | [MySQL](https://www.mysql.com/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `neo4j` | [Neo4j](https://neo4j.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `opensearch` | [OpenSearch](https://opensearch.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `oracle.db` | [Oracle Database](https://www.oracle.com/database/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `other_sql` | Some other SQL database. Fallback only. | ![Development](https://img.shields.io/badge/-development-blue) | -| `postgresql` | [PostgreSQL](https://www.postgresql.org/) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `redis` | [Redis](https://redis.io/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `sap.hana` | [SAP HANA](https://www.sap.com/products/technology-platform/hana/what-is-sap-hana.html) | ![Development](https://img.shields.io/badge/-development-blue) | -| `sap.maxdb` | [SAP MaxDB](https://maxdb.sap.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `softwareag.adabas` | [Adabas (Adaptable Database System)](https://documentation.softwareag.com/?pf=adabas) | ![Development](https://img.shields.io/badge/-development-blue) | -| `sqlite` | [SQLite](https://www.sqlite.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `teradata` | [Teradata](https://www.teradata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | -| `trino` | [Trino](https://trino.io/) | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index 7b4fa66bdb..51d4f19e3a 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -3,28 +3,15 @@ # Deployment -- [Deployment Deprecated Attributes](#deployment-deprecated-attributes) - [Deployment Attributes](#deployment-attributes) - -## Deployment Deprecated Attributes - -Describes deprecated deployment attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `deployment.environment` | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | Use `deployment.environment.name` instead. | - -
+- [Deployment Deprecated Attributes](#deployment-deprecated-attributes) ## Deployment Attributes This document defines attributes for software deployments. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `deployment.environment.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` | @@ -48,3 +35,16 @@ considered to be identifying the same service: |---|---|---| | `failed` | failed | ![Development](https://img.shields.io/badge/-development-blue) | | `succeeded` | succeeded | ![Development](https://img.shields.io/badge/-development-blue) | + +## Deployment Deprecated Attributes + +Describes deprecated deployment attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `deployment.environment` | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | Use `deployment.environment.name` instead. | + +
diff --git a/docs/registry/attributes/destination.md b/docs/registry/attributes/destination.md index 07c8deb942..8065a3c8a8 100644 --- a/docs/registry/attributes/destination.md +++ b/docs/registry/attributes/destination.md @@ -7,7 +7,8 @@ These attributes may be used to describe the receiver of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `destination.address` | ![Development](https://img.shields.io/badge/-development-blue) | string | Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `destination.example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/device.md b/docs/registry/attributes/device.md index 5f14a3d31d..6f09ad862b 100644 --- a/docs/registry/attributes/device.md +++ b/docs/registry/attributes/device.md @@ -7,7 +7,8 @@ Describes device attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `device.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | A unique identifier representing the device [1] | `123456789012345`; `01:23:45:67:89:AB` | diff --git a/docs/registry/attributes/disk.md b/docs/registry/attributes/disk.md index cc4c5ec00c..cc5e272c3a 100644 --- a/docs/registry/attributes/disk.md +++ b/docs/registry/attributes/disk.md @@ -7,7 +7,8 @@ These attributes may be used for any disk related operation. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `disk.io.direction` | ![Development](https://img.shields.io/badge/-development-blue) | string | The disk IO operation direction. | `read` | diff --git a/docs/registry/attributes/dns.md b/docs/registry/attributes/dns.md index 09365f47e5..70239a22b6 100644 --- a/docs/registry/attributes/dns.md +++ b/docs/registry/attributes/dns.md @@ -7,7 +7,8 @@ This document defines the shared attributes used to report a DNS query. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `dns.answers` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The list of IPv4 or IPv6 addresses resolved during DNS lookup. | `["10.0.0.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"]` | diff --git a/docs/registry/attributes/dotnet.md b/docs/registry/attributes/dotnet.md index 9fbeb0a241..6143466484 100644 --- a/docs/registry/attributes/dotnet.md +++ b/docs/registry/attributes/dotnet.md @@ -7,7 +7,8 @@ This document defines .NET related attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `dotnet.gc.heap.generation` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | diff --git a/docs/registry/attributes/elasticsearch.md b/docs/registry/attributes/elasticsearch.md index 49748525c5..d7f490dca3 100644 --- a/docs/registry/attributes/elasticsearch.md +++ b/docs/registry/attributes/elasticsearch.md @@ -7,7 +7,8 @@ This section defines attributes for Elasticsearch. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `elasticsearch.node.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001` | diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index 71e48669ca..bbb4c8d1e3 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -3,29 +3,15 @@ # Enduser -- [Deprecated End User Attributes](#deprecated-end-user-attributes) - [End User Attributes](#end-user-attributes) - -## Deprecated End User Attributes - -Describes deprecated enduser attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | Use `user.roles` instead. | -| `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | Removed, no replacement at this time. | - -
+- [Deprecated End User Attributes](#deprecated-end-user-attributes) ## End User Attributes Describes the end user. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `enduser.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier of an end user in the system. It maybe a username, email address, or other identifier. [1] | `username` | @@ -40,3 +26,17 @@ Describes the end user. > [!Warning] > This field contains sensitive (linkable PII) information. + +## Deprecated End User Attributes + +Describes deprecated enduser attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | Use `user.roles` instead. | +| `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | Removed, no replacement at this time. | + +
diff --git a/docs/registry/attributes/error.md b/docs/registry/attributes/error.md index 3bf6395605..91adcc5897 100644 --- a/docs/registry/attributes/error.md +++ b/docs/registry/attributes/error.md @@ -7,7 +7,8 @@ This document defines the shared attributes used to report an error. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `error.message` | ![Development](https://img.shields.io/badge/-development-blue) | string | A message providing more detail about an error in human-readable form. [1] | `Unexpected input type: string`; `The user has exceeded their storage quota` | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index e02ec49382..e8469eba6d 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -7,7 +7,6 @@ Attributes for Events represented using Log Records. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index 8f02002acf..eb67a365b4 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -10,7 +10,8 @@ This document defines the shared attributes used to report a single exception associated with a span or log. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `exception.message` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | @@ -21,7 +22,6 @@ This document defines the shared attributes used to report a single exception as Deprecated exception attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/faas.md b/docs/registry/attributes/faas.md index 21156b4176..0ef8e8da25 100644 --- a/docs/registry/attributes/faas.md +++ b/docs/registry/attributes/faas.md @@ -7,7 +7,8 @@ FaaS attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `faas.coldstart` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | | diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index f4a36d34b5..eb5d32deee 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -3,47 +3,15 @@ # Feature flag -- [Deprecated Feature Flag Attributes](#deprecated-feature-flag-attributes) - [Feature Flag Attributes](#feature-flag-attributes) - -## Deprecated Feature Flag Attributes - -Describes deprecated feature flag attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `feature_flag.evaluation.error.message` | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | Use `error.message` instead. | -| `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | Use `feature_flag.result.reason` instead. | -| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | Use `feature_flag.provider.name` instead. | -| `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | Use `feature_flag.result.variant` instead. | - ---- - -`feature_flag.evaluation.reason` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `cached` | The resolved value was retrieved from cache. | ![Development](https://img.shields.io/badge/-development-blue) | -| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). | ![Development](https://img.shields.io/badge/-development-blue) | -| `disabled` | The resolved value was the result of the flag being disabled in the management system. | ![Development](https://img.shields.io/badge/-development-blue) | -| `error` | The resolved value was the result of an error. | ![Development](https://img.shields.io/badge/-development-blue) | -| `split` | The resolved value was the result of pseudorandom assignment. | ![Development](https://img.shields.io/badge/-development-blue) | -| `stale` | The resolved value is non-authoritative or possibly out of date | ![Development](https://img.shields.io/badge/-development-blue) | -| `static` | The resolved value is static (no dynamic evaluation). | ![Development](https://img.shields.io/badge/-development-blue) | -| `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Development](https://img.shields.io/badge/-development-blue) | -| `unknown` | The reason for the resolved value could not be determined. | ![Development](https://img.shields.io/badge/-development-blue) | - -
+- [Deprecated Feature Flag Attributes](#deprecated-feature-flag-attributes) ## Feature Flag Attributes This document defines attributes for Feature Flags. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `feature_flag.context.id` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | @@ -81,3 +49,35 @@ For example, the variant `red` maybe be used for the value `#c05543`. | `static` | The resolved value is static (no dynamic evaluation). | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `unknown` | The reason for the resolved value could not be determined. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | + +## Deprecated Feature Flag Attributes + +Describes deprecated feature flag attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `feature_flag.evaluation.error.message` | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | Use `error.message` instead. | +| `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | Use `feature_flag.result.reason` instead. | +| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | Use `feature_flag.provider.name` instead. | +| `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | Use `feature_flag.result.variant` instead. | + +--- + +`feature_flag.evaluation.reason` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `cached` | The resolved value was retrieved from cache. | ![Development](https://img.shields.io/badge/-development-blue) | +| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). | ![Development](https://img.shields.io/badge/-development-blue) | +| `disabled` | The resolved value was the result of the flag being disabled in the management system. | ![Development](https://img.shields.io/badge/-development-blue) | +| `error` | The resolved value was the result of an error. | ![Development](https://img.shields.io/badge/-development-blue) | +| `split` | The resolved value was the result of pseudorandom assignment. | ![Development](https://img.shields.io/badge/-development-blue) | +| `stale` | The resolved value is non-authoritative or possibly out of date | ![Development](https://img.shields.io/badge/-development-blue) | +| `static` | The resolved value is static (no dynamic evaluation). | ![Development](https://img.shields.io/badge/-development-blue) | +| `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Development](https://img.shields.io/badge/-development-blue) | +| `unknown` | The reason for the resolved value could not be determined. | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/file.md b/docs/registry/attributes/file.md index 73b9f4f198..f614e726e3 100644 --- a/docs/registry/attributes/file.md +++ b/docs/registry/attributes/file.md @@ -7,7 +7,8 @@ Describes file attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `file.accessed` | ![Development](https://img.shields.io/badge/-development-blue) | string | Time when the file was last accessed, in ISO 8601 format. [1] | `2021-01-01T12:00:00Z` | diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 42f6306ed8..35df0a5981 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -3,57 +3,37 @@ # GCP -- [GCP Client Attributes](#gcp-client-attributes) -- [GCP - Google Cloud Run Attributes](#gcp---google-cloud-run-attributes) - [GCP - AppHub Attributes](#gcp---apphub-attributes) - [GCP - AppHub Destination Attributes](#gcp---apphub-destination-attributes) +- [GCP Client Attributes](#gcp-client-attributes) +- [GCP - Google Cloud Run Attributes](#gcp---google-cloud-run-attributes) - [GCP - Google Compute Engine (GCE) Attributes](#gcp---google-compute-engine-gce-attributes) -## GCP Client Attributes - -Attributes for Google Cloud client libraries. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [1] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | - -**[1] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. - -## GCP - Google Cloud Run Attributes - -This document defines attributes for Google Cloud Run. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | -| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | - ## GCP - AppHub Attributes This document defines attributes AppHub will apply to resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gcp.apphub.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` | | `gcp.apphub.application.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the application as configured in AppHub. | `my-application` | | `gcp.apphub.application.location` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GCP zone or region where the application is defined. | `us-central1` | -| `gcp.apphub.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a service indicates its importance to the business. [2] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a service is the stage of a software lifecycle. [3] | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a service indicates its importance to the business. [1] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a service is the stage of a software lifecycle. [2] | `PRODUCTION`; `STAGING`; `TEST` | | `gcp.apphub.service.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the service as configured in AppHub. | `my-service` | -| `gcp.apphub.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a workload indicates its importance to the business. [4] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a workload is the stage of a software lifecycle. [5] | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a workload indicates its importance to the business. [3] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a workload is the stage of a software lifecycle. [4] | `PRODUCTION`; `STAGING`; `TEST` | | `gcp.apphub.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the workload as configured in AppHub. | `my-workload` | -**[2] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) +**[1] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) -**[3] `gcp.apphub.service.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) +**[2] `gcp.apphub.service.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) -**[4] `gcp.apphub.workload.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) +**[3] `gcp.apphub.workload.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) -**[5] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) +**[4] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) --- @@ -103,7 +83,8 @@ This document defines attributes AppHub will apply to resources in GCP. See [App This document defines attributes AppHub will apply to destination resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gcp.apphub_destination.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | @@ -160,11 +141,35 @@ This document defines attributes AppHub will apply to destination resources in G | `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) | +## GCP Client Attributes + +Attributes for Google Cloud client libraries. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | + +**[5] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. + +## GCP - Google Cloud Run Attributes + +This document defines attributes for Google Cloud Run. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | +| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | + ## GCP - Google Compute Engine (GCE) Attributes This document defines attributes for Google Compute Engine (GCE). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gcp.gce.instance.hostname` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 90509093dc..6ac20f4f5c 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -11,7 +11,8 @@ This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `gen_ai.agent.description` | ![Development](https://img.shields.io/badge/-development-blue) | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | @@ -238,7 +239,6 @@ Datastore: A tool used by the agent to access and query structured or unstructur Describes deprecated `gen_ai` attributes. -**Current Attributes:**
Past Attributes: @@ -284,7 +284,6 @@ Describes deprecated `gen_ai` attributes. Describes deprecated `gen_ai.openai` attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index d5867c3185..c02cbc9a98 100644 --- a/docs/registry/attributes/geo.md +++ b/docs/registry/attributes/geo.md @@ -8,7 +8,8 @@ Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. Note: Geo attributes are typically used under another namespace, such as client.* and describe the location of the corresponding entity (device, end-user, etc). Semantic conventions that reference geo attributes (as a root namespace) or embed them (under their own namespace) SHOULD document what geo attributes describe in the scope of that convention. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `geo.continent.code` | ![Development](https://img.shields.io/badge/-development-blue) | string | Two-letter code representing continent’s name. | `AF`; `AN`; `AS` | diff --git a/docs/registry/attributes/go.md b/docs/registry/attributes/go.md index 7d06ef747a..a7b65ba67a 100644 --- a/docs/registry/attributes/go.md +++ b/docs/registry/attributes/go.md @@ -7,7 +7,8 @@ This document defines Go related attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `go.memory.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The type of memory. | `other`; `stack` | diff --git a/docs/registry/attributes/graphql.md b/docs/registry/attributes/graphql.md index db68c09f71..0dc0ea0e59 100644 --- a/docs/registry/attributes/graphql.md +++ b/docs/registry/attributes/graphql.md @@ -7,7 +7,8 @@ This document defines attributes for GraphQL. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `graphql.document` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | diff --git a/docs/registry/attributes/hardware.md b/docs/registry/attributes/hardware.md index 200440e8b6..ba74bb6d96 100644 --- a/docs/registry/attributes/hardware.md +++ b/docs/registry/attributes/hardware.md @@ -7,7 +7,8 @@ Attributes for hardware. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `hw.battery.capacity` | ![Development](https://img.shields.io/badge/-development-blue) | string | Design capacity in Watts-hours or Amper-hours | `9.3Ah`; `50Wh` | diff --git a/docs/registry/attributes/heroku.md b/docs/registry/attributes/heroku.md index 5ce81769db..337454061d 100644 --- a/docs/registry/attributes/heroku.md +++ b/docs/registry/attributes/heroku.md @@ -7,7 +7,8 @@ This document defines attributes for the Heroku platform on which application/s are running. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `heroku.app.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for the application | `2daa2797-e42b-4624-9322-ec3f968df4da` | diff --git a/docs/registry/attributes/host.md b/docs/registry/attributes/host.md index ea2751ce16..d2662e7b1a 100644 --- a/docs/registry/attributes/host.md +++ b/docs/registry/attributes/host.md @@ -7,7 +7,8 @@ A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `host.arch` | ![Development](https://img.shields.io/badge/-development-blue) | string | The CPU architecture the host system is running on. | `amd64`; `arm32`; `arm64` | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 66b29fb6dd..852989051b 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -3,54 +3,15 @@ # HTTP -- [Deprecated HTTP Attributes](#deprecated-http-attributes) - [HTTP Attributes](#http-attributes) - -## Deprecated HTTP Attributes - -Describes deprecated HTTP attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `http.client_ip` | string | Deprecated, use `client.address` instead. | `83.164.160.102` | Use `client.address` instead. | -| `http.flavor` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | Split into `network.protocol.name` and `network.protocol.version` | -| `http.host` | string | Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. | `www.example.org` | Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. | -| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | Use `http.request.method` instead. | -| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | Replaced by `http.request.header.content-length`. | -| `http.request_content_length_uncompressed` | int | Deprecated, use `http.request.body.size` instead. | `5493` | Use `http.request.body.size` instead. | -| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | Replaced by `http.response.header.content-length`. | -| `http.response_content_length_uncompressed` | int | Deprecated, use `http.response.body.size` instead. | `5493` | Use `http.response.body.size` instead. | -| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` | Use `url.scheme` instead. | -| `http.server_name` | string | Deprecated, use `server.address` instead. | `example.com` | Use `server.address` instead. | -| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` | Use `http.response.status_code` instead. | -| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | Split to `url.path` and `url.query`. | -| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | Use `url.full` instead. | -| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `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` | Use `user_agent.original` instead. | - ---- - -`http.flavor` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `1.0` | HTTP/1.0 | ![Development](https://img.shields.io/badge/-development-blue) | -| `1.1` | HTTP/1.1 | ![Development](https://img.shields.io/badge/-development-blue) | -| `2.0` | HTTP/2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `3.0` | HTTP/3 | ![Development](https://img.shields.io/badge/-development-blue) | -| `QUIC` | QUIC protocol. | ![Development](https://img.shields.io/badge/-development-blue) | -| `SPDY` | SPDY protocol. | ![Development](https://img.shields.io/badge/-development-blue) | - -
+- [Deprecated HTTP Attributes](#deprecated-http-attributes) ## HTTP Attributes This document defines semantic convention attributes in the HTTP namespace. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `http.connection.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | State of the HTTP connection in the HTTP connection pool. | `active`; `idle` | @@ -154,3 +115,42 @@ support custom route formatting. Instrumentations SHOULD document the format and | `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) | | `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + +## Deprecated HTTP Attributes + +Describes deprecated HTTP attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `http.client_ip` | string | Deprecated, use `client.address` instead. | `83.164.160.102` | Use `client.address` instead. | +| `http.flavor` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | Split into `network.protocol.name` and `network.protocol.version` | +| `http.host` | string | Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. | `www.example.org` | Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. | +| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | Use `http.request.method` instead. | +| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | Replaced by `http.request.header.content-length`. | +| `http.request_content_length_uncompressed` | int | Deprecated, use `http.request.body.size` instead. | `5493` | Use `http.request.body.size` instead. | +| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | Replaced by `http.response.header.content-length`. | +| `http.response_content_length_uncompressed` | int | Deprecated, use `http.response.body.size` instead. | `5493` | Use `http.response.body.size` instead. | +| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` | Use `url.scheme` instead. | +| `http.server_name` | string | Deprecated, use `server.address` instead. | `example.com` | Use `server.address` instead. | +| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` | Use `http.response.status_code` instead. | +| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | Split to `url.path` and `url.query`. | +| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | Use `url.full` instead. | +| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `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` | Use `user_agent.original` instead. | + +--- + +`http.flavor` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `1.0` | HTTP/1.0 | ![Development](https://img.shields.io/badge/-development-blue) | +| `1.1` | HTTP/1.1 | ![Development](https://img.shields.io/badge/-development-blue) | +| `2.0` | HTTP/2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `3.0` | HTTP/3 | ![Development](https://img.shields.io/badge/-development-blue) | +| `QUIC` | QUIC protocol. | ![Development](https://img.shields.io/badge/-development-blue) | +| `SPDY` | SPDY protocol. | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index 1cff53c9f2..9104efaeca 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -10,7 +10,8 @@ This group describes iOS-specific attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `ios.app.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | This attribute represents the state of the application. [1] | `active`; `inactive`; `background` | @@ -33,7 +34,6 @@ This group describes iOS-specific attributes. The iOS platform on which the iOS application is running. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/jvm.md b/docs/registry/attributes/jvm.md index 8f34e9ef75..05166994d2 100644 --- a/docs/registry/attributes/jvm.md +++ b/docs/registry/attributes/jvm.md @@ -7,7 +7,8 @@ This document defines Java Virtual machine related attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `jvm.buffer.pool.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the buffer pool. [1] | `mapped`; `direct` | diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index 5af85d2db3..e987977e8f 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -10,7 +10,8 @@ Kubernetes resource attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `k8s.cluster.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the cluster. | `opentelemetry-cluster` | @@ -353,7 +354,6 @@ When this occurs, the exact value as reported by the Kubernetes API SHOULD be us Describes deprecated k8s attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/linux.md b/docs/registry/attributes/linux.md index 5df97ed874..5848ad3226 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -7,7 +7,8 @@ Describes Linux Memory attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `linux.memory.slab.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | diff --git a/docs/registry/attributes/log.md b/docs/registry/attributes/log.md index 21bf86a9a7..f1649ae4b5 100644 --- a/docs/registry/attributes/log.md +++ b/docs/registry/attributes/log.md @@ -11,7 +11,8 @@ This document defines log attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `log.iostream` | ![Development](https://img.shields.io/badge/-development-blue) | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | @@ -29,7 +30,8 @@ This document defines log attributes Attributes for a file to which log was emitted. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `log.file.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The basename of the file. | `audit.log` | @@ -41,7 +43,8 @@ Attributes for a file to which log was emitted. This document defines the generic attributes that may be used in any Log Record. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `log.record.original` | ![Development](https://img.shields.io/badge/-development-blue) | string | The complete original Log Record. [1] | `77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - - Something happened`; `[INFO] 8/3/24 12:34:56 Something happened` | diff --git a/docs/registry/attributes/mainframe.md b/docs/registry/attributes/mainframe.md index 083cefe3da..dab5e3d9de 100644 --- a/docs/registry/attributes/mainframe.md +++ b/docs/registry/attributes/mainframe.md @@ -7,7 +7,8 @@ This document defines attributes of a Mainframe Logical Partition (LPAR). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `mainframe.lpar.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the logical partition that hosts a systems with a mainframe operating system. | `LPAR01` | diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 5ebf01967a..49c9512be7 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -3,43 +3,21 @@ # Messaging -- [Deprecated Messaging Attributes](#deprecated-messaging-attributes) - [General Messaging Attributes](#general-messaging-attributes) +- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) +- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) - [Kafka Attributes](#kafka-attributes) - [RabbitMQ Attributes](#rabbitmq-attributes) - [RocketMQ Attributes](#rocketmq-attributes) -- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) - [Azure Service Bus Attributes](#azure-service-bus-attributes) -- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) - -## Deprecated Messaging Attributes - -Describes deprecated messaging attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | -| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | -| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | -| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | -| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | Use `messaging.consumer.group.name` instead. | -| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | Record string representation of the partition id in `messaging.destination.partition.id` attribute. | -| `messaging.kafka.message.offset` | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | Use `messaging.kafka.offset` instead. | -| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | Use `messaging.operation.type` instead. | -| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | -| `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. | - -
+- [Deprecated Messaging Attributes](#deprecated-messaging-attributes) ## General Messaging Attributes Attributes describing telemetry around messaging systems and messaging activities. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.batch.message_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | The number of messages sent, received, or processed in the scope of the batching operation. [1] | `0`; `1`; `2` | @@ -111,11 +89,35 @@ size should be used. | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | +## Azure Event Hubs Attributes + +This group describes attributes specific to Azure Event Hubs. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `messaging.eventhubs.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | + +## GCP Pub/Sub Attributes + +This group describes attributes specific to GCP Pub/Sub. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `messaging.gcp_pubsub.message.ack_deadline` | ![Development](https://img.shields.io/badge/-development-blue) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | +| `messaging.gcp_pubsub.message.ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ack id for a given message. | `ack_id` | +| `messaging.gcp_pubsub.message.delivery_attempt` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delivery attempt for a given message. | `2` | +| `messaging.gcp_pubsub.message.ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | + ## Kafka Attributes This group describes attributes specific to Apache Kafka. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.kafka.message.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [10] | `myKey` | @@ -128,7 +130,8 @@ This group describes attributes specific to Apache Kafka. This group describes attributes specific to RabbitMQ. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.rabbitmq.destination.routing_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | RabbitMQ message routing key. | `myKey` | @@ -138,7 +141,8 @@ This group describes attributes specific to RabbitMQ. This group describes attributes specific to RocketMQ. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.rocketmq.consumption_model` | ![Development](https://img.shields.io/badge/-development-blue) | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | @@ -170,23 +174,12 @@ This group describes attributes specific to RocketMQ. | `normal` | Normal message | ![Development](https://img.shields.io/badge/-development-blue) | | `transaction` | Transaction message | ![Development](https://img.shields.io/badge/-development-blue) | -## GCP Pub/Sub Attributes - -This group describes attributes specific to GCP Pub/Sub. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `messaging.gcp_pubsub.message.ack_deadline` | ![Development](https://img.shields.io/badge/-development-blue) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | -| `messaging.gcp_pubsub.message.ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ack id for a given message. | `ack_id` | -| `messaging.gcp_pubsub.message.delivery_attempt` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delivery attempt for a given message. | `2` | -| `messaging.gcp_pubsub.message.ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | - ## Azure Service Bus Attributes This group describes attributes specific to Azure Service Bus. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `messaging.servicebus.disposition_status` | ![Development](https://img.shields.io/badge/-development-blue) | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | @@ -204,11 +197,24 @@ This group describes attributes specific to Azure Service Bus. | `dead_letter` | Message is sent to dead letter queue | ![Development](https://img.shields.io/badge/-development-blue) | | `defer` | Message is deferred | ![Development](https://img.shields.io/badge/-development-blue) | -## Azure Event Hubs Attributes +## Deprecated Messaging Attributes -This group describes attributes specific to Azure Event Hubs. +Describes deprecated messaging attributes. -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `messaging.eventhubs.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | +| `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | +| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | +| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | +| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | +| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | Use `messaging.consumer.group.name` instead. | +| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | Record string representation of the partition id in `messaging.destination.partition.id` attribute. | +| `messaging.kafka.message.offset` | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | Use `messaging.kafka.offset` instead. | +| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | Use `messaging.operation.type` instead. | +| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | +| `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. | + +
diff --git a/docs/registry/attributes/network.md b/docs/registry/attributes/network.md index e6755aac5a..fa7e88534b 100644 --- a/docs/registry/attributes/network.md +++ b/docs/registry/attributes/network.md @@ -3,66 +3,15 @@ # Network -- [Deprecated Network Attributes](#deprecated-network-attributes) - [Network Attributes](#network-attributes) - -## Deprecated Network Attributes - -These attributes may be used for any network related operation. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | -| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | -| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | Use `server.port` instead. | -| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | Use `network.peer.address` instead. | -| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | Replaced by `server.address` on client spans and `client.address` on server spans. | -| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | Replaced by `server.port` on client spans and `client.port` on server spans. | -| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | Use `network.protocol.name` instead. | -| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | Use `network.protocol.version` instead. | -| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | Split to `network.transport` and `network.type`. | -| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | Use `network.local.address` instead. | -| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | Use `network.local.port` instead. | -| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | Use `network.peer.address` instead. | -| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | Removed. No replacement at this time. | -| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | Use `network.peer.port` instead. | -| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | Use `network.transport` instead. | - ---- - -`net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `inet` | IPv4 address | ![Development](https://img.shields.io/badge/-development-blue) | -| `inet6` | IPv6 address | ![Development](https://img.shields.io/badge/-development-blue) | -| `unix` | Unix domain socket path | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `inproc` | In-process communication. [1] | ![Development](https://img.shields.io/badge/-development-blue) | -| `ip_tcp` | ip_tcp | ![Development](https://img.shields.io/badge/-development-blue) | -| `ip_udp` | ip_udp | ![Development](https://img.shields.io/badge/-development-blue) | -| `other` | Something else (non IP-based). | ![Development](https://img.shields.io/badge/-development-blue) | -| `pipe` | Named or anonymous pipe. | ![Development](https://img.shields.io/badge/-development-blue) | - -**[1]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case. - -
+- [Deprecated Network Attributes](#deprecated-network-attributes) ## Network Attributes These attributes may be used for any network related operation. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `network.carrier.icc` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. | `DE` | @@ -184,3 +133,54 @@ different processes could be listening on TCP port 12345 and UDP port 12345. |---|---|---| | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + +## Deprecated Network Attributes + +These attributes may be used for any network related operation. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | +| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | +| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | Use `server.port` instead. | +| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | Use `network.peer.address` instead. | +| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | Replaced by `server.address` on client spans and `client.address` on server spans. | +| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | Replaced by `server.port` on client spans and `client.port` on server spans. | +| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | Use `network.protocol.name` instead. | +| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | Use `network.protocol.version` instead. | +| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | Split to `network.transport` and `network.type`. | +| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | Use `network.local.address` instead. | +| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | Use `network.local.port` instead. | +| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | Use `network.peer.address` instead. | +| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | Removed. No replacement at this time. | +| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | Use `network.peer.port` instead. | +| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | Use `network.transport` instead. | + +--- + +`net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `inet` | IPv4 address | ![Development](https://img.shields.io/badge/-development-blue) | +| `inet6` | IPv6 address | ![Development](https://img.shields.io/badge/-development-blue) | +| `unix` | Unix domain socket path | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `inproc` | In-process communication. [1] | ![Development](https://img.shields.io/badge/-development-blue) | +| `ip_tcp` | ip_tcp | ![Development](https://img.shields.io/badge/-development-blue) | +| `ip_udp` | ip_udp | ![Development](https://img.shields.io/badge/-development-blue) | +| `other` | Something else (non IP-based). | ![Development](https://img.shields.io/badge/-development-blue) | +| `pipe` | Named or anonymous pipe. | ![Development](https://img.shields.io/badge/-development-blue) | + +**[1]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case. + +
diff --git a/docs/registry/attributes/nfs.md b/docs/registry/attributes/nfs.md index 2cc719e278..014e403a62 100644 --- a/docs/registry/attributes/nfs.md +++ b/docs/registry/attributes/nfs.md @@ -7,7 +7,8 @@ Describes NFS Attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `nfs.operation.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | NFSv4+ operation name. | `OPEN`; `READ`; `GETATTR` | diff --git a/docs/registry/attributes/nodejs.md b/docs/registry/attributes/nodejs.md index bc2c11464d..5aee7ff19d 100644 --- a/docs/registry/attributes/nodejs.md +++ b/docs/registry/attributes/nodejs.md @@ -7,7 +7,8 @@ Describes Node.js related attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `nodejs.eventloop.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The state of event loop time. | `active`; `idle` | diff --git a/docs/registry/attributes/oci.md b/docs/registry/attributes/oci.md index f842bc9782..3644f842d1 100644 --- a/docs/registry/attributes/oci.md +++ b/docs/registry/attributes/oci.md @@ -7,7 +7,8 @@ An OCI image manifest. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `oci.manifest.digest` | ![Development](https://img.shields.io/badge/-development-blue) | string | The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. [1] | `sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4` | diff --git a/docs/registry/attributes/onc-rpc.md b/docs/registry/attributes/onc-rpc.md index 34152a3854..67d3b7085f 100644 --- a/docs/registry/attributes/onc-rpc.md +++ b/docs/registry/attributes/onc-rpc.md @@ -7,7 +7,8 @@ This document defines attributes for [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `onc_rpc.procedure.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | ONC/Sun RPC procedure name. | `OPEN`; `READ`; `GETATTR` | diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 145727ff88..3e916ddbe5 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -7,7 +7,8 @@ This group defines attributes for OpenAI. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `openai.request.service_tier` | ![Development](https://img.shields.io/badge/-development-blue) | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` | diff --git a/docs/registry/attributes/openshift.md b/docs/registry/attributes/openshift.md index f11ed9c677..27573a167c 100644 --- a/docs/registry/attributes/openshift.md +++ b/docs/registry/attributes/openshift.md @@ -7,7 +7,8 @@ OpenShift resource attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `openshift.clusterquota.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the cluster quota. | `opentelemetry` | diff --git a/docs/registry/attributes/opentracing.md b/docs/registry/attributes/opentracing.md index 69105b4633..18a6aa5538 100644 --- a/docs/registry/attributes/opentracing.md +++ b/docs/registry/attributes/opentracing.md @@ -7,7 +7,8 @@ Attributes used by the OpenTracing Shim layer. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `opentracing.ref_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Parent-child Reference type [1] | `child_of`; `follows_from` | diff --git a/docs/registry/attributes/os.md b/docs/registry/attributes/os.md index dd0314aa77..97e4171433 100644 --- a/docs/registry/attributes/os.md +++ b/docs/registry/attributes/os.md @@ -7,7 +7,8 @@ The operating system (OS) on which the process represented by this resource is running. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `os.build_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index ff6f31a71c..a116f13b89 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -3,31 +3,17 @@ # OTel -- [Deprecated OTel Library Attributes](#deprecated-otel-library-attributes) - [OTel Attributes](#otel-attributes) -- [OTel Scope Attributes](#otel-scope-attributes) - [OTel Component Attributes](#otel-component-attributes) - -## Deprecated OTel Library Attributes - -Describes deprecated otel.library attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | Use `otel.scope.name` instead. | -| `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | Use `otel.scope.version` instead. | - -
+- [OTel Scope Attributes](#otel-scope-attributes) +- [Deprecated OTel Library Attributes](#deprecated-otel-library-attributes) ## OTel Attributes Attributes reserved for OpenTelemetry -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `otel.span.parent.origin` | ![Development](https://img.shields.io/badge/-development-blue) | string | Determines whether the span has a parent span, and if so, [whether it is a remote parent](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) | `none`; `local`; `remote` | @@ -64,22 +50,12 @@ Attributes reserved for OpenTelemetry | `ERROR` | The operation contains an error. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -## OTel Scope Attributes - -Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `otel.scope.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | -| `otel.scope.schema_url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | -| `otel.scope.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | - ## OTel Component Attributes Attributes used for OpenTelemetry component self-monitoring -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `otel.component.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | @@ -124,3 +100,29 @@ E.g. for Java the fully qualified classname SHOULD be used in this case. | `simple_log_processor` | The builtin SDK simple log record processor | ![Development](https://img.shields.io/badge/-development-blue) | | `simple_span_processor` | The builtin SDK simple span processor | ![Development](https://img.shields.io/badge/-development-blue) | | `zipkin_http_span_exporter` | Zipkin span exporter over HTTP | ![Development](https://img.shields.io/badge/-development-blue) | + +## OTel Scope Attributes + +Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `otel.scope.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | +| `otel.scope.schema_url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | +| `otel.scope.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | + +## Deprecated OTel Library Attributes + +Describes deprecated otel.library attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | Use `otel.scope.name` instead. | +| `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | Use `otel.scope.version` instead. | + +
diff --git a/docs/registry/attributes/peer.md b/docs/registry/attributes/peer.md index e571c378bb..a60c32056c 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -7,7 +7,8 @@ These attribute may be used for any operation that accesses some remote service. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `peer.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [1] | `AuthTokenCache` | diff --git a/docs/registry/attributes/pprof.md b/docs/registry/attributes/pprof.md index bc6e991d63..e080eb6e29 100644 --- a/docs/registry/attributes/pprof.md +++ b/docs/registry/attributes/pprof.md @@ -7,7 +7,8 @@ Attributes specific to pprof that help convert from pprof to Profiling signal. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `pprof.location.is_folded` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes. | | diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 16a1633d8b..9abe872e79 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -3,60 +3,16 @@ # Process -- [Deprecated Process Attributes](#deprecated-process-attributes) - [Process Attributes](#process-attributes) - [Process Linux Attributes](#process-linux-attributes) - -## Deprecated Process Attributes - -Deprecated process attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `process.context_switch_type` | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | Use `process.context_switch.type` instead. | -| `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | Use `cpu.mode` instead. | -| `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | Use `process.executable.build_id.htlhash` instead. | -| `process.paging.fault_type` | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | Use `system.paging.fault.type` instead. | - ---- - -`process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `involuntary` | involuntary | ![Development](https://img.shields.io/badge/-development-blue) | -| `voluntary` | voluntary | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`process.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | -| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | -| `wait` | wait | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`process.paging.fault_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | -| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | - -
+- [Deprecated Process Attributes](#deprecated-process-attributes) ## Process Attributes An operating system process. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `process.args_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | Length of the process.command_args array [1] | `4` | @@ -132,9 +88,54 @@ with value `"/usr/local/bin:/usr/bin"`. Describes Linux Process attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `process.linux.cgroup` | ![Development](https://img.shields.io/badge/-development-blue) | string | The control group associated with the process. [5] | `1:name=systemd:/user.slice/user-1000.slice/session-3.scope`; `0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope` | **[5] `process.linux.cgroup`:** Control groups (cgroups) are a kernel feature used to organize and manage process resources. This attribute provides the path(s) to the cgroup(s) associated with the process, which should match the contents of the [/proc/\[PID\]/cgroup](https://man7.org/linux/man-pages/man7/cgroups.7.html) file. + +## Deprecated Process Attributes + +Deprecated process attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `process.context_switch_type` | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | Use `process.context_switch.type` instead. | +| `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | Use `cpu.mode` instead. | +| `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | Use `process.executable.build_id.htlhash` instead. | +| `process.paging.fault_type` | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | Use `system.paging.fault.type` instead. | + +--- + +`process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `involuntary` | involuntary | ![Development](https://img.shields.io/badge/-development-blue) | +| `voluntary` | voluntary | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`process.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | +| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | +| `wait` | wait | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`process.paging.fault_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | +| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/profile.md b/docs/registry/attributes/profile.md index b2ad3c9575..bd30717817 100644 --- a/docs/registry/attributes/profile.md +++ b/docs/registry/attributes/profile.md @@ -7,7 +7,8 @@ Describes the origin of a single frame in a Profile. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `profile.frame.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Describes the interpreter or compiler of a single frame. | `cpython` | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 85776c3895..839c896c65 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -10,7 +10,8 @@ This document defines attributes for remote procedure calls. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `rpc.connect_rpc.error_code` | ![Development](https://img.shields.io/badge/-development-blue) | string | The [error codes](https://connectrpc.com//docs/protocol/#error-codes) of the Connect request. Error codes are always string values. | `cancelled`; `unknown`; `invalid_argument` | @@ -131,7 +132,6 @@ the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute Deprecated rpc message attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/security-rule.md b/docs/registry/attributes/security-rule.md index d5c9a8a61d..98476a8f3e 100644 --- a/docs/registry/attributes/security-rule.md +++ b/docs/registry/attributes/security-rule.md @@ -7,7 +7,8 @@ Describes security rule attributes. Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `security_rule.category` | ![Development](https://img.shields.io/badge/-development-blue) | string | A categorization value keyword used by the entity using the rule for detection of this event | `Attempted Information Leak` | diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index e31c0a8378..74bdd6eb3b 100644 --- a/docs/registry/attributes/server.md +++ b/docs/registry/attributes/server.md @@ -7,7 +7,8 @@ These attributes may be used to describe the server in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `server.address` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/service.md b/docs/registry/attributes/service.md index aa32abf468..a5d3f6be08 100644 --- a/docs/registry/attributes/service.md +++ b/docs/registry/attributes/service.md @@ -7,7 +7,8 @@ A service instance. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `service.instance.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The string ID of the service instance. [1] | `627cc493-f310-47de-96bd-71410b7dec09` | diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index 6e8de01269..e4b7997aa6 100644 --- a/docs/registry/attributes/session.md +++ b/docs/registry/attributes/session.md @@ -9,7 +9,8 @@ Session is defined as the period of time encompassing all activities performed b Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in the Logs, Events, and Spans generated during the Session's lifecycle. When a session reaches end of life, typically due to user inactivity or session timeout, a new session identifier will be assigned. The previous session identifier may be provided by the instrumentation so that telemetry backends can link the two sessions. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `session.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | diff --git a/docs/registry/attributes/signalr.md b/docs/registry/attributes/signalr.md index 840a3bacd7..3022688f59 100644 --- a/docs/registry/attributes/signalr.md +++ b/docs/registry/attributes/signalr.md @@ -7,7 +7,8 @@ SignalR attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `signalr.connection.status` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index 712f668b6f..79c674ffce 100644 --- a/docs/registry/attributes/source.md +++ b/docs/registry/attributes/source.md @@ -7,7 +7,8 @@ These attributes may be used to describe the sender of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `source.address` | ![Development](https://img.shields.io/badge/-development-blue) | string | Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `source.example.com`; `10.1.2.80`; `/tmp/my.sock` | diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index 543b4af500..a41019d433 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -4,25 +4,63 @@ # System - [General System Attributes](#general-system-attributes) +- [Filesystem Attributes](#filesystem-attributes) - [System Memory Attributes](#system-memory-attributes) - [System Paging Attributes](#system-paging-attributes) -- [Filesystem Attributes](#filesystem-attributes) - [Deprecated System Attributes](#deprecated-system-attributes) ## General System Attributes Describes System attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `system.device` | ![Development](https://img.shields.io/badge/-development-blue) | string | The device identifier | `(identifier)` | +## Filesystem Attributes + +Describes Filesystem attributes + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `system.filesystem.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mode | `rw, ro` | +| `system.filesystem.mountpoint` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mount path | `/mnt/data` | +| `system.filesystem.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem state | `used` | +| `system.filesystem.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem type | `ext4` | + +--- + +`system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | +| `reserved` | reserved | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `exfat` | exfat | ![Development](https://img.shields.io/badge/-development-blue) | +| `ext4` | ext4 | ![Development](https://img.shields.io/badge/-development-blue) | +| `fat32` | fat32 | ![Development](https://img.shields.io/badge/-development-blue) | +| `hfsplus` | hfsplus | ![Development](https://img.shields.io/badge/-development-blue) | +| `ntfs` | ntfs | ![Development](https://img.shields.io/badge/-development-blue) | +| `refs` | refs | ![Development](https://img.shields.io/badge/-development-blue) | + ## System Memory Attributes Describes System Memory attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `system.memory.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The memory state | `free`; `cached` | @@ -44,7 +82,8 @@ Describes System Memory attributes Describes System Memory Paging attributes -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `system.paging.direction` | ![Development](https://img.shields.io/badge/-development-blue) | string | The paging access direction | `in` | @@ -78,46 +117,10 @@ Describes System Memory Paging attributes | `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | -## Filesystem Attributes - -Describes Filesystem attributes - -**Current Attributes:** -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `system.filesystem.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mode | `rw, ro` | -| `system.filesystem.mountpoint` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mount path | `/mnt/data` | -| `system.filesystem.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem state | `used` | -| `system.filesystem.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem type | `ext4` | - ---- - -`system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | -| `reserved` | reserved | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `exfat` | exfat | ![Development](https://img.shields.io/badge/-development-blue) | -| `ext4` | ext4 | ![Development](https://img.shields.io/badge/-development-blue) | -| `fat32` | fat32 | ![Development](https://img.shields.io/badge/-development-blue) | -| `hfsplus` | hfsplus | ![Development](https://img.shields.io/badge/-development-blue) | -| `ntfs` | ntfs | ![Development](https://img.shields.io/badge/-development-blue) | -| `refs` | refs | ![Development](https://img.shields.io/badge/-development-blue) | - ## Deprecated System Attributes Deprecated system attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/telemetry.md b/docs/registry/attributes/telemetry.md index 9f783225d1..0350ceccbb 100644 --- a/docs/registry/attributes/telemetry.md +++ b/docs/registry/attributes/telemetry.md @@ -7,7 +7,8 @@ This document defines attributes for telemetry SDK. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `telemetry.distro.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the auto instrumentation agent or distribution, if used. [1] | `parts-unlimited-java` | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 7234f62c22..41a1ef2c88 100644 --- a/docs/registry/attributes/test.md +++ b/docs/registry/attributes/test.md @@ -7,7 +7,8 @@ This group describes attributes specific to [software tests](https://wikipedia.org/wiki/Software_testing). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `test.case.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The fully qualified human readable name of the [test case](https://wikipedia.org/wiki/Test_case). | `org.example.TestCase1.test1`; `example/tests/TestCase1.test1`; `ExampleTestCase1_test1` | diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index e5e0b8f3e2..32bb61bde5 100644 --- a/docs/registry/attributes/thread.md +++ b/docs/registry/attributes/thread.md @@ -7,7 +7,8 @@ These attributes may be used for any operation to store information about a thread that started a span. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `thread.id` | ![Development](https://img.shields.io/badge/-development-blue) | int | Current "managed" thread ID (as opposed to OS thread ID). [1] | `42` | diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index 5e90eadc09..4a5fce2f8f 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -3,28 +3,15 @@ # TLS -- [TLS Deprecated Attributes](#tls-deprecated-attributes) - [TLS Attributes](#tls-attributes) - -## TLS Deprecated Attributes - -Describes deprecated `tls` attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | Use `server.address` instead. | - -
+- [TLS Deprecated Attributes](#tls-deprecated-attributes) ## TLS Attributes This document defines semantic convention attributes in the TLS namespace. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `tls.cipher` | ![Development](https://img.shields.io/badge/-development-blue) | string | String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection. [1] | `TLS_RSA_WITH_3DES_EDE_CBC_SHA`; `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` | @@ -66,3 +53,16 @@ This document defines semantic convention attributes in the TLS namespace. |---|---|---| | `ssl` | ssl | ![Development](https://img.shields.io/badge/-development-blue) | | `tls` | tls | ![Development](https://img.shields.io/badge/-development-blue) | + +## TLS Deprecated Attributes + +Describes deprecated `tls` attributes. + +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | Use `server.address` instead. | + +
diff --git a/docs/registry/attributes/url.md b/docs/registry/attributes/url.md index ef7b4f3eb9..d4b7d7087a 100644 --- a/docs/registry/attributes/url.md +++ b/docs/registry/attributes/url.md @@ -7,7 +7,8 @@ Attributes describing URL. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `url.domain` | ![Development](https://img.shields.io/badge/-development-blue) | string | Domain extracted from the `url.full`, such as "opentelemetry.io". [1] | `www.foo.bar`; `opentelemetry.io`; `3.12.167.2`; `[1080:0:0:0:8:800:200C:417A]` | diff --git a/docs/registry/attributes/user-agent.md b/docs/registry/attributes/user-agent.md index 2b93fa9cce..d8cc33d365 100644 --- a/docs/registry/attributes/user-agent.md +++ b/docs/registry/attributes/user-agent.md @@ -10,7 +10,8 @@ Describes user-agent attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `user_agent.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the user-agent extracted from original. Usually refers to the browser's name. [1] | `Safari`; `YourApp` | @@ -25,7 +26,8 @@ Describes user-agent attributes. Describes the OS user-agent attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `user_agent.os.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Human readable operating system name. [3] | `iOS`; `Android`; `Ubuntu` | diff --git a/docs/registry/attributes/user.md b/docs/registry/attributes/user.md index c30e5550b8..831f59178b 100644 --- a/docs/registry/attributes/user.md +++ b/docs/registry/attributes/user.md @@ -7,7 +7,8 @@ Describes information about the user. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `user.email` | ![Development](https://img.shields.io/badge/-development-blue) | string | User email address. | `a.einstein@example.com` | diff --git a/docs/registry/attributes/v8js.md b/docs/registry/attributes/v8js.md index 947f4afd34..8fb8248b9e 100644 --- a/docs/registry/attributes/v8js.md +++ b/docs/registry/attributes/v8js.md @@ -7,7 +7,8 @@ Describes V8 JS Engine Runtime related attributes. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `v8js.gc.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The type of garbage collection. | `major`; `minor`; `incremental` | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index f5bea4962e..aa58315f96 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -10,7 +10,8 @@ This group defines the attributes for [Version Control Systems (VCS)](https://wikipedia.org/wiki/Version_control). -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `vcs.change.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | `123` | @@ -148,7 +149,6 @@ the `.git` extension. Describes deprecated vcs attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/webengine.md b/docs/registry/attributes/webengine.md index 8108ead08c..53af1193a1 100644 --- a/docs/registry/attributes/webengine.md +++ b/docs/registry/attributes/webengine.md @@ -7,7 +7,8 @@ This document defines the attributes used to describe the packaged software running the application code. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `webengine.description` | ![Development](https://img.shields.io/badge/-development-blue) | string | Additional description of the web engine (e.g. detailed version and edition information). | `WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final` | diff --git a/docs/registry/attributes/zos.md b/docs/registry/attributes/zos.md index 1247b68b1d..5cc34f079b 100644 --- a/docs/registry/attributes/zos.md +++ b/docs/registry/attributes/zos.md @@ -7,7 +7,8 @@ This document defines attributes of a z/OS resource. -**Current Attributes:** +**Attributes:** + | Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| | `zos.smf.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The System Management Facility (SMF) Identifier uniquely identified a z/OS system within a SYSPLEX or mainframe environment and is used for system and performance analysis. | `SYS1` | diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 385d88eb6e..a6f69c516f 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -9,7 +9,15 @@ {%- import 'attribute_table.j2' as at -%} {%- import 'attribute_macros.j2' as attrs -%} {%- import 'examples_macros.j2' as examples -%} -{%- set attr_groups = ctx.groups | sort(attribute="name") -%} +{%- set groups = namespace(deprecated=[], non_deprecated=[]) -%} +{%- for group in ctx.groups | sort(attribute="id") -%} +{%- if group.id[-10:] == "deprecated" -%} +{%- set groups.deprecated = groups.deprecated + [group] -%} +{%- else -%} +{%- set groups.non_deprecated = groups.non_deprecated + [group] -%} +{%- endif -%} +{%- endfor -%} +{%- set attr_groups = groups.non_deprecated + groups.deprecated -%} @@ -29,8 +37,11 @@ {% else -%} {{ group.brief }} {{"\n"}} -{%- endif -%} **Current Attributes:** -{% set filtered_attributes = group.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}| Key | Stability | Value Type | Description | Example Values | +{%- endif -%} + +{% set filtered_attributes = group.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | |---|---|---|---|---| {%- for attribute in filtered_attributes %}{% set attr_anchor = attribute.name | kebab_case %} | `{{ attrs.name(attribute) }}` | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | @@ -38,6 +49,6 @@ {{ notes.render() }} {%- for enum in filtered_attributes | sort(attribute="name") %} {%- if enum.type is mapping -%}{{ enums.table(enum, notes) }}{% endif %} -{%- endfor -%}{% endif %}{{ at.generate_deprecated(group.attributes, "", "", "") | trim }}{% if filtered_attributes | length != group.attributes | length %}{{"\n"}}{%endif%} +{%- endfor -%}{% endif %}{% if (group.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(group.attributes, "", "", "") | trim }}{% if filtered_attributes | length != group.attributes | length %}{{"\n"}}{%endif%} {%- endfor -%} From d11bd6dd408a912765b0f2d241487e152727ed72 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Sat, 4 Oct 2025 19:11:57 +1000 Subject: [PATCH 3/9] Scope reduction --- docs/exceptions/exceptions-spans.md | 4 ++-- docs/registry/attributes/android.md | 4 ++-- docs/registry/attributes/azure.md | 4 ++-- docs/registry/attributes/code.md | 4 ++-- docs/registry/attributes/container.md | 4 ++-- docs/registry/attributes/db.md | 8 ++++---- docs/registry/attributes/deployment.md | 4 ++-- docs/registry/attributes/enduser.md | 4 ++-- docs/registry/attributes/event.md | 4 ++-- docs/registry/attributes/exception.md | 4 ++-- docs/registry/attributes/feature-flag.md | 4 ++-- docs/registry/attributes/gen-ai.md | 8 ++++---- docs/registry/attributes/http.md | 4 ++-- docs/registry/attributes/ios.md | 4 ++-- docs/registry/attributes/k8s.md | 4 ++-- docs/registry/attributes/messaging.md | 4 ++-- docs/registry/attributes/network.md | 4 ++-- docs/registry/attributes/otel.md | 4 ++-- docs/registry/attributes/process.md | 4 ++-- docs/registry/attributes/rpc.md | 4 ++-- docs/registry/attributes/system.md | 4 ++-- docs/registry/attributes/tls.md | 4 ++-- docs/registry/attributes/vcs.md | 4 ++-- templates/registry/markdown/attribute_table.j2 | 4 ++-- 24 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/exceptions/exceptions-spans.md b/docs/exceptions/exceptions-spans.md index c5b45c0b28..89bbb9fb96 100644 --- a/docs/exceptions/exceptions-spans.md +++ b/docs/exceptions/exceptions-spans.md @@ -44,9 +44,9 @@ This event describes a single exception. **[2] `exception.type`:** Required if `exception.message` is not set, recommended otherwise.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index 70ad544ddb..a601fa2357 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -27,9 +27,9 @@ The Android platform on which the Android application is running. | `foreground` | 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. | ![Development](https://img.shields.io/badge/-development-blue) |
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `android.state` | string | This attribute represents the state of the application. [1] | `created`; `background`; `foreground` | Use `android.app.state` instead. | diff --git a/docs/registry/attributes/azure.md b/docs/registry/attributes/azure.md index 51e40a2d10..42e4a84b72 100644 --- a/docs/registry/attributes/azure.md +++ b/docs/registry/attributes/azure.md @@ -62,9 +62,9 @@ This section defines attributes for Azure Cosmos DB. This section describes deprecated Azure attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `az.namespace` | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. | | `az.service_request_id` | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. | diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index 0e8a598eaa..96fc2d0b8f 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -41,9 +41,9 @@ Examples: These deprecated attributes provide context about source code
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `code.column` | int | Deprecated, use `code.column.number` | `16` | Use `code.column.number` instead. | | `code.filepath` | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | Use `code.file.path` instead. | diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index bcb539f861..cfe33a7024 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -49,9 +49,9 @@ The ID is assigned by the container runtime and can vary in different environmen Describes deprecated container attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | Use `cpu.mode` instead. | | `container.labels.` | string | Deprecated, use `container.label` instead. | `nginx` | Use `container.label` instead. | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index 431c36f205..1e5918ee4a 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -173,9 +173,9 @@ stored procedure name then that stored procedure name SHOULD be used. Describes deprecated database attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `db.cassandra.consistency_level` | string | Deprecated, use `cassandra.consistency.level` instead. | `all`; `each_quorum`; `quorum` | Use `cassandra.consistency.level` instead. | | `db.cassandra.coordinator.dc` | string | Deprecated, use `cassandra.coordinator.dc` instead. | `us-west-2` | Use `cassandra.coordinator.dc` instead. | @@ -334,9 +334,9 @@ Describes deprecated database attributes. Describes deprecated db metrics attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `db.client.connections.pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | | `db.client.connections.state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index 51d4f19e3a..87fe28fb36 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -41,9 +41,9 @@ considered to be identifying the same service: Describes deprecated deployment attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `deployment.environment` | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | Use `deployment.environment.name` instead. | diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index bbb4c8d1e3..b106ad88a6 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -32,9 +32,9 @@ Describes the end user. Describes deprecated enduser attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | Use `user.roles` instead. | | `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | Removed, no replacement at this time. | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index e8469eba6d..2109be7e97 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -8,9 +8,9 @@ Attributes for Events represented using Log Records.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `event.name` | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` | The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event. | diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index eb67a365b4..04c7dd6f57 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -23,9 +23,9 @@ This document defines the shared attributes used to report a single exception as Deprecated exception attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `exception.escaped` | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index eb5d32deee..0b55d0a9bc 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -55,9 +55,9 @@ For example, the variant `red` maybe be used for the value `#c05543`. Describes deprecated feature flag attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `feature_flag.evaluation.error.message` | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | Use `error.message` instead. | | `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | Use `feature_flag.result.reason` instead. | diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 6ac20f4f5c..54f7b07398 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -240,9 +240,9 @@ Datastore: A tool used by the agent to access and query structured or unstructur Describes deprecated `gen_ai` attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `gen_ai.completion` | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | Removed, no replacement at this time. | | `gen_ai.prompt` | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | Removed, no replacement at this time. | @@ -285,9 +285,9 @@ Describes deprecated `gen_ai` attributes. Describes deprecated `gen_ai.openai` attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `gen_ai.openai.request.response_format` | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | Use `gen_ai.output.type` instead. | | `gen_ai.openai.request.seed` | int | Deprecated, use `gen_ai.request.seed`. | `100` | Use `gen_ai.request.seed` instead. | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 852989051b..6e03b6bfee 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -121,9 +121,9 @@ support custom route formatting. Instrumentations SHOULD document the format and Describes deprecated HTTP attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `http.client_ip` | string | Deprecated, use `client.address` instead. | `83.164.160.102` | Use `client.address` instead. | | `http.flavor` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | Split into `network.protocol.name` and `network.protocol.version` | diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index 9104efaeca..0487e4cc0c 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -35,9 +35,9 @@ This group describes iOS-specific attributes. The iOS platform on which the iOS application is running.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [1] | `active`; `inactive`; `background` | Use `ios.app.state` instead. | diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index e987977e8f..58557d7a57 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -355,9 +355,9 @@ When this occurs, the exact value as reported by the Kubernetes API SHOULD be us Describes deprecated k8s attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `k8s.pod.labels.` | string | Deprecated, use `k8s.pod.label` instead. | `my-app` | Use `k8s.pod.label` instead. | diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 49c9512be7..e0be43a5a3 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -202,9 +202,9 @@ This group describes attributes specific to Azure Service Bus. Describes deprecated messaging attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | | `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | diff --git a/docs/registry/attributes/network.md b/docs/registry/attributes/network.md index fa7e88534b..954c3b740c 100644 --- a/docs/registry/attributes/network.md +++ b/docs/registry/attributes/network.md @@ -139,9 +139,9 @@ different processes could be listening on TCP port 12345 and UDP port 12345. These attributes may be used for any network related operation.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | | `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index a116f13b89..d82fef6f17 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -118,9 +118,9 @@ Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concept Describes deprecated otel.library attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | Use `otel.scope.name` instead. | | `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | Use `otel.scope.version` instead. | diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 9abe872e79..57d6b27e4c 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -101,9 +101,9 @@ Describes Linux Process attributes Deprecated process attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `process.context_switch_type` | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | Use `process.context_switch.type` instead. | | `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | Use `cpu.mode` instead. | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 839c896c65..98a7ba5b9c 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -133,9 +133,9 @@ the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute Deprecated rpc message attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `message.compressed_size` | int | Deprecated, use `rpc.message.compressed_size` instead. | | Use `rpc.message.compressed_size` instead. | | `message.id` | int | Deprecated, use `rpc.message.id` instead. | | Use `rpc.message.id` instead. | diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index a41019d433..9590c4a2b5 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -122,9 +122,9 @@ Describes System Memory Paging attributes Deprecated system attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | | `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index 4a5fce2f8f..dae4e9ba4c 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -59,9 +59,9 @@ This document defines semantic convention attributes in the TLS namespace. Describes deprecated `tls` attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | Use `server.address` instead. | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index aa58315f96..f22332ce08 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -150,9 +150,9 @@ the `.git` extension. Describes deprecated vcs attributes.
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| | `vcs.repository.change.id` | string | Deprecated, use `vcs.change.id` instead. | `123` | Use `vcs.change.id` instead. | | `vcs.repository.change.title` | string | Deprecated, use `vcs.change.title` instead. | `Fixes broken thing`; `feat: add my new feature`; `[chore] update dependency` | Use `vcs.change.title` instead. | diff --git a/templates/registry/markdown/attribute_table.j2 b/templates/registry/markdown/attribute_table.j2 index dcd23ec602..8f5d4ef383 100644 --- a/templates/registry/markdown/attribute_table.j2 +++ b/templates/registry/markdown/attribute_table.j2 @@ -16,9 +16,9 @@ {#- Macro for creating deprecated attribute table -#} {% macro generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | selectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}
-Past Attributes: +Deprecated Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| {% for attribute in filtered_attributes %}| {% if attribute_registry_base_url != "" %}{{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }}{% else %}{% set attr_anchor = attribute.name | kebab_case %}`{{ attrs.name(attribute) }}`{%endif%} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {% if attribute.deprecated.reason == "renamed" %} Use {% if attribute_registry_base_url != "" %}{{ attrs.renamed_to_with_link(attribute.deprecated.renamed_to, attribute_registry_base_url, lineage_attributes) }}{% else %}`{{attribute.deprecated.renamed_to}}`{%endif%} instead. {% else %} {{attribute.deprecated.note | trim}} {% endif %} | {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} From c74e3e0dad11fb5f5137db8f494ad6c074cb7fbc Mon Sep 17 00:00:00 2001 From: James Thompson Date: Thu, 30 Oct 2025 15:23:50 +1100 Subject: [PATCH 4/9] Combine groups in templates --- docs/registry/attributes/android.md | 4 +- docs/registry/attributes/code.md | 7 - docs/registry/attributes/container.md | 7 - docs/registry/attributes/db.md | 5 - docs/registry/attributes/deployment.md | 7 - docs/registry/attributes/enduser.md | 7 - docs/registry/attributes/exception.md | 7 - docs/registry/attributes/feature-flag.md | 7 - docs/registry/attributes/gen-ai.md | 5 - docs/registry/attributes/http.md | 7 - docs/registry/attributes/ios.md | 7 - docs/registry/attributes/k8s.md | 7 - docs/registry/attributes/messaging.md | 41 ++--- docs/registry/attributes/network.md | 7 - docs/registry/attributes/process.md | 29 ++-- docs/registry/attributes/rpc.md | 7 - docs/registry/attributes/system.md | 161 +++++++++--------- docs/registry/attributes/tls.md | 7 - .../deprecated/registry-deprecated.yaml | 33 ++++ model/android/registry.yaml | 30 ---- .../markdown/attribute_namespace.md.j2 | 12 ++ .../registry/markdown/attribute_table.j2 | 2 +- 22 files changed, 155 insertions(+), 251 deletions(-) create mode 100644 model/android/deprecated/registry-deprecated.yaml diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index a601fa2357..04960505e6 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -31,9 +31,7 @@ The Android platform on which the Android application is running. | Key | Value Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `android.state` | string | This attribute represents the state of the application. [1] | `created`; `background`; `foreground` | Use `android.app.state` instead. | - -**[1] `android.state`:** 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. +| `android.state` | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` | Use `android.app.state` instead. | --- diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index 96fc2d0b8f..b3c8ee0815 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -3,9 +3,6 @@ # Code -- [Code Attributes](#code-attributes) -- [Deprecated Code Attributes](#deprecated-code-attributes) - ## Code Attributes These attributes provide context about source code @@ -36,10 +33,6 @@ Examples: * Rust: `playground::my_module::my_cool_func` * C function: `fopen` -## Deprecated Code Attributes - -These deprecated attributes provide context about source code -
Deprecated Attributes: diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index cfe33a7024..387cecd485 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -3,9 +3,6 @@ # Container -- [Container Attributes](#container-attributes) -- [Deprecated Container Attributes](#deprecated-container-attributes) - ## Container Attributes A container instance. @@ -44,10 +41,6 @@ The ID is assigned by the container runtime and can vary in different environmen **[6] `container.label.`:** For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`. -## Deprecated Container Attributes - -Describes deprecated container attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index 1e5918ee4a..b98982cba3 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -4,7 +4,6 @@ # DB - [General Database Attributes](#general-database-attributes) -- [Deprecated Database Attributes](#deprecated-database-attributes) - [Deprecated Database Metrics](#deprecated-database-metrics) ## General Database Attributes @@ -168,10 +167,6 @@ stored procedure name then that stored procedure name SHOULD be used. | `teradata` | [Teradata](https://www.teradata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | | `trino` | [Trino](https://trino.io/) | ![Development](https://img.shields.io/badge/-development-blue) | -## Deprecated Database Attributes - -Describes deprecated database attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index 87fe28fb36..fa6e75555a 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -3,9 +3,6 @@ # Deployment -- [Deployment Attributes](#deployment-attributes) -- [Deployment Deprecated Attributes](#deployment-deprecated-attributes) - ## Deployment Attributes This document defines attributes for software deployments. @@ -36,10 +33,6 @@ considered to be identifying the same service: | `failed` | failed | ![Development](https://img.shields.io/badge/-development-blue) | | `succeeded` | succeeded | ![Development](https://img.shields.io/badge/-development-blue) | -## Deployment Deprecated Attributes - -Describes deprecated deployment attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index b106ad88a6..728997ab4b 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -3,9 +3,6 @@ # Enduser -- [End User Attributes](#end-user-attributes) -- [Deprecated End User Attributes](#deprecated-end-user-attributes) - ## End User Attributes Describes the end user. @@ -27,10 +24,6 @@ Describes the end user. > [!Warning] > This field contains sensitive (linkable PII) information. -## Deprecated End User Attributes - -Describes deprecated enduser attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index 04c7dd6f57..88b547f93c 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -3,9 +3,6 @@ # Exception -- [Exception Attributes](#exception-attributes) -- [Deprecated Exception Attributes](#deprecated-exception-attributes) - ## Exception Attributes This document defines the shared attributes used to report a single exception associated with a span or log. @@ -18,10 +15,6 @@ This document defines the shared attributes used to report a single exception as | `exception.stacktrace` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. | `Exception 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)` | | `exception.type` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | 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. | `java.net.ConnectException`; `OSError` | -## Deprecated Exception Attributes - -Deprecated exception attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index 0b55d0a9bc..a030636676 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -3,9 +3,6 @@ # Feature flag -- [Feature Flag Attributes](#feature-flag-attributes) -- [Deprecated Feature Flag Attributes](#deprecated-feature-flag-attributes) - ## Feature Flag Attributes This document defines attributes for Feature Flags. @@ -50,10 +47,6 @@ For example, the variant `red` maybe be used for the value `#c05543`. | `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `unknown` | The reason for the resolved value could not be determined. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | -## Deprecated Feature Flag Attributes - -Describes deprecated feature flag attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 54f7b07398..ec1b4a8c45 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -4,7 +4,6 @@ # Gen AI - [GenAI Attributes](#genai-attributes) -- [Deprecated GenAI Attributes](#deprecated-genai-attributes) - [Deprecated OpenAI GenAI Attributes](#deprecated-openai-genai-attributes) ## GenAI Attributes @@ -235,10 +234,6 @@ Datastore: A tool used by the agent to access and query structured or unstructur | `input` | Input tokens (prompt, input, etc.) | ![Development](https://img.shields.io/badge/-development-blue) | | `output` | Output tokens (completion, response, etc.) | ![Development](https://img.shields.io/badge/-development-blue) | -## Deprecated GenAI Attributes - -Describes deprecated `gen_ai` attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 6e03b6bfee..49cde8ea58 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -3,9 +3,6 @@ # HTTP -- [HTTP Attributes](#http-attributes) -- [Deprecated HTTP Attributes](#deprecated-http-attributes) - ## HTTP Attributes This document defines semantic convention attributes in the HTTP namespace. @@ -116,10 +113,6 @@ support custom route formatting. Instrumentations SHOULD document the format and | `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) | | `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -## Deprecated HTTP Attributes - -Describes deprecated HTTP attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index 0487e4cc0c..1c5c9ef841 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -3,9 +3,6 @@ # iOS -- [iOS Attributes](#ios-attributes) -- [Deprecated iOS Attributes](#deprecated-ios-attributes) - ## iOS Attributes This group describes iOS-specific attributes. @@ -30,10 +27,6 @@ This group describes iOS-specific attributes. | `inactive` | The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ![Development](https://img.shields.io/badge/-development-blue) | | `terminate` | The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ![Development](https://img.shields.io/badge/-development-blue) | -## Deprecated iOS Attributes - -The iOS platform on which the iOS application is running. -
Deprecated Attributes: diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index 58557d7a57..a387d78310 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -3,9 +3,6 @@ # K8s -- [Kubernetes Attributes](#kubernetes-attributes) -- [Deprecated Kubernetes Attributes](#deprecated-kubernetes-attributes) - ## Kubernetes Attributes Kubernetes resource attributes. @@ -350,10 +347,6 @@ When this occurs, the exact value as reported by the Kubernetes API SHOULD be us | `persistentVolumeClaim` | A [persistentVolumeClaim](https://v1-30.docs.kubernetes.io/docs/concepts/storage/volumes/#persistentvolumeclaim) volume | ![Development](https://img.shields.io/badge/-development-blue) | | `secret` | A [secret](https://v1-30.docs.kubernetes.io/docs/concepts/storage/volumes/#secret) volume | ![Development](https://img.shields.io/badge/-development-blue) | -## Deprecated Kubernetes Attributes - -Describes deprecated k8s attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index e0be43a5a3..2f5363c8d4 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -10,7 +10,6 @@ - [RabbitMQ Attributes](#rabbitmq-attributes) - [RocketMQ Attributes](#rocketmq-attributes) - [Azure Service Bus Attributes](#azure-service-bus-attributes) -- [Deprecated Messaging Attributes](#deprecated-messaging-attributes) ## General Messaging Attributes @@ -89,6 +88,24 @@ size should be used. | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | +
+Deprecated Attributes: + +| Key | Value Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | +| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | +| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | +| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | +| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | Use `messaging.consumer.group.name` instead. | +| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | Record string representation of the partition id in `messaging.destination.partition.id` attribute. | +| `messaging.kafka.message.offset` | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | Use `messaging.kafka.offset` instead. | +| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | Use `messaging.operation.type` instead. | +| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | +| `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. | + +
+ ## Azure Event Hubs Attributes This group describes attributes specific to Azure Event Hubs. @@ -196,25 +213,3 @@ This group describes attributes specific to Azure Service Bus. | `complete` | Message is completed | ![Development](https://img.shields.io/badge/-development-blue) | | `dead_letter` | Message is sent to dead letter queue | ![Development](https://img.shields.io/badge/-development-blue) | | `defer` | Message is deferred | ![Development](https://img.shields.io/badge/-development-blue) | - -## Deprecated Messaging Attributes - -Describes deprecated messaging attributes. - -
-Deprecated Attributes: - -| Key | Value Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | -| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | -| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | -| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | -| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | Use `messaging.consumer.group.name` instead. | -| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | Record string representation of the partition id in `messaging.destination.partition.id` attribute. | -| `messaging.kafka.message.offset` | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | Use `messaging.kafka.offset` instead. | -| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | Use `messaging.operation.type` instead. | -| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | -| `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. | - -
diff --git a/docs/registry/attributes/network.md b/docs/registry/attributes/network.md index 954c3b740c..4f1579380a 100644 --- a/docs/registry/attributes/network.md +++ b/docs/registry/attributes/network.md @@ -3,9 +3,6 @@ # Network -- [Network Attributes](#network-attributes) -- [Deprecated Network Attributes](#deprecated-network-attributes) - ## Network Attributes These attributes may be used for any network related operation. @@ -134,10 +131,6 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -## Deprecated Network Attributes - -These attributes may be used for any network related operation. -
Deprecated Attributes: diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 57d6b27e4c..ad8d4e2660 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -5,7 +5,6 @@ - [Process Attributes](#process-attributes) - [Process Linux Attributes](#process-linux-attributes) -- [Deprecated Process Attributes](#deprecated-process-attributes) ## Process Attributes @@ -84,22 +83,6 @@ with value `"/usr/local/bin:/usr/bin"`. | `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | | `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | -## Process Linux Attributes - -Describes Linux Process attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -|---|---|---|---|---| -| `process.linux.cgroup` | ![Development](https://img.shields.io/badge/-development-blue) | string | The control group associated with the process. [5] | `1:name=systemd:/user.slice/user-1000.slice/session-3.scope`; `0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope` | - -**[5] `process.linux.cgroup`:** Control groups (cgroups) are a kernel feature used to organize and manage process resources. This attribute provides the path(s) to the cgroup(s) associated with the process, which should match the contents of the [/proc/\[PID\]/cgroup](https://man7.org/linux/man-pages/man7/cgroups.7.html) file. - -## Deprecated Process Attributes - -Deprecated process attributes. -
Deprecated Attributes: @@ -139,3 +122,15 @@ Deprecated process attributes. | `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) |
+ +## Process Linux Attributes + +Describes Linux Process attributes + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +|---|---|---|---|---| +| `process.linux.cgroup` | ![Development](https://img.shields.io/badge/-development-blue) | string | The control group associated with the process. [5] | `1:name=systemd:/user.slice/user-1000.slice/session-3.scope`; `0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope` | + +**[5] `process.linux.cgroup`:** Control groups (cgroups) are a kernel feature used to organize and manage process resources. This attribute provides the path(s) to the cgroup(s) associated with the process, which should match the contents of the [/proc/\[PID\]/cgroup](https://man7.org/linux/man-pages/man7/cgroups.7.html) file. diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 98a7ba5b9c..de2726da61 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -3,9 +3,6 @@ # RPC -- [Remote Procedure Call (RPC) Attributes](#remote-procedure-call-rpc-attributes) -- [Deprecated RPC Attributes](#deprecated-rpc-attributes) - ## Remote Procedure Call (RPC) Attributes This document defines attributes for remote procedure calls. @@ -128,10 +125,6 @@ the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute | `jsonrpc` | JSON-RPC | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc` | [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) | ![Development](https://img.shields.io/badge/-development-blue) | -## Deprecated RPC Attributes - -Deprecated rpc message attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index 9590c4a2b5..faa565ad2a 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -7,7 +7,6 @@ - [Filesystem Attributes](#filesystem-attributes) - [System Memory Attributes](#system-memory-attributes) - [System Paging Attributes](#system-paging-attributes) -- [Deprecated System Attributes](#deprecated-system-attributes) ## General System Attributes @@ -19,6 +18,84 @@ Describes System attributes |---|---|---|---|---| | `system.device` | ![Development](https://img.shields.io/badge/-development-blue) | string | The device identifier | `(identifier)` | +
+Deprecated Attributes: + +| Key | Value Type | Summary | Example Values | Deprecation Explanation | +|---|---|---|---|---| +| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | +| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | +| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | Use `network.connection.state` instead. | +| `system.paging.type` | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | Use `system.paging.fault.type` instead. | +| `system.process.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | +| `system.processes.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | + +--- + +`system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `interrupt` | interrupt | ![Development](https://img.shields.io/badge/-development-blue) | +| `iowait` | iowait | ![Development](https://img.shields.io/badge/-development-blue) | +| `nice` | nice | ![Development](https://img.shields.io/badge/-development-blue) | +| `steal` | steal | ![Development](https://img.shields.io/badge/-development-blue) | +| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | +| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.network.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `close` | close | ![Development](https://img.shields.io/badge/-development-blue) | +| `close_wait` | close_wait | ![Development](https://img.shields.io/badge/-development-blue) | +| `closing` | closing | ![Development](https://img.shields.io/badge/-development-blue) | +| `delete` | delete | ![Development](https://img.shields.io/badge/-development-blue) | +| `established` | established | ![Development](https://img.shields.io/badge/-development-blue) | +| `fin_wait_1` | fin_wait_1 | ![Development](https://img.shields.io/badge/-development-blue) | +| `fin_wait_2` | fin_wait_2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `last_ack` | last_ack | ![Development](https://img.shields.io/badge/-development-blue) | +| `listen` | listen | ![Development](https://img.shields.io/badge/-development-blue) | +| `syn_recv` | syn_recv | ![Development](https://img.shields.io/badge/-development-blue) | +| `syn_sent` | syn_sent | ![Development](https://img.shields.io/badge/-development-blue) | +| `time_wait` | time_wait | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | +| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.process.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | +| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | +| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | +| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | +| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | +| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | +| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | + +
+ ## Filesystem Attributes Describes Filesystem attributes @@ -116,85 +193,3 @@ Describes System Memory Paging attributes |---|---|---| | `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - -## Deprecated System Attributes - -Deprecated system attributes. - -
-Deprecated Attributes: - -| Key | Value Type | Summary | Example Values | Deprecation Explanation | -|---|---|---|---|---| -| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | -| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | -| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | Use `network.connection.state` instead. | -| `system.paging.type` | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | Use `system.paging.fault.type` instead. | -| `system.process.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | -| `system.processes.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | - ---- - -`system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `interrupt` | interrupt | ![Development](https://img.shields.io/badge/-development-blue) | -| `iowait` | iowait | ![Development](https://img.shields.io/badge/-development-blue) | -| `nice` | nice | ![Development](https://img.shields.io/badge/-development-blue) | -| `steal` | steal | ![Development](https://img.shields.io/badge/-development-blue) | -| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | -| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.network.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `close` | close | ![Development](https://img.shields.io/badge/-development-blue) | -| `close_wait` | close_wait | ![Development](https://img.shields.io/badge/-development-blue) | -| `closing` | closing | ![Development](https://img.shields.io/badge/-development-blue) | -| `delete` | delete | ![Development](https://img.shields.io/badge/-development-blue) | -| `established` | established | ![Development](https://img.shields.io/badge/-development-blue) | -| `fin_wait_1` | fin_wait_1 | ![Development](https://img.shields.io/badge/-development-blue) | -| `fin_wait_2` | fin_wait_2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `last_ack` | last_ack | ![Development](https://img.shields.io/badge/-development-blue) | -| `listen` | listen | ![Development](https://img.shields.io/badge/-development-blue) | -| `syn_recv` | syn_recv | ![Development](https://img.shields.io/badge/-development-blue) | -| `syn_sent` | syn_sent | ![Development](https://img.shields.io/badge/-development-blue) | -| `time_wait` | time_wait | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | -| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.process.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | -| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | -| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | -| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | -| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | -| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | -| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | - -
diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index dae4e9ba4c..8935731207 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -3,9 +3,6 @@ # TLS -- [TLS Attributes](#tls-attributes) -- [TLS Deprecated Attributes](#tls-deprecated-attributes) - ## TLS Attributes This document defines semantic convention attributes in the TLS namespace. @@ -54,10 +51,6 @@ This document defines semantic convention attributes in the TLS namespace. | `ssl` | ssl | ![Development](https://img.shields.io/badge/-development-blue) | | `tls` | tls | ![Development](https://img.shields.io/badge/-development-blue) | -## TLS Deprecated Attributes - -Describes deprecated `tls` attributes. -
Deprecated Attributes: diff --git a/model/android/deprecated/registry-deprecated.yaml b/model/android/deprecated/registry-deprecated.yaml new file mode 100644 index 0000000000..fe3c815489 --- /dev/null +++ b/model/android/deprecated/registry-deprecated.yaml @@ -0,0 +1,33 @@ +groups: + - id: registry.android.deprecated + type: attribute_group + display_name: Deprecated Android Attributes + brief: > + This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform. + attributes: + - id: android.state + stability: development + brief: Deprecated. Use `android.app.state` attribute instead. + deprecated: + reason: renamed + renamed_to: android.app.state + type: + members: + - id: created + value: 'created' + brief: > + Any time before Activity.onResume() or, if the app has no Activity, Context.startService() + has been called in the app for the first time. + stability: development + - id: background + value: 'background' + brief: > + Any time after Activity.onPause() or, if the app has no Activity, + Context.stopService() has been called when the app was in the foreground state. + stability: development + - id: foreground + value: 'foreground' + brief: > + Any time after Activity.onResume() or, if the app has no Activity, + Context.startService() has been called when the app was in either the created or background states. + stability: development diff --git a/model/android/registry.yaml b/model/android/registry.yaml index 5146aafe87..65633879b9 100644 --- a/model/android/registry.yaml +++ b/model/android/registry.yaml @@ -13,36 +13,6 @@ groups: (`os.version`) of the android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). examples: ['33', '32'] - - id: android.state - stability: development - brief: > - This attribute represents the state of the application. - 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. - deprecated: - reason: renamed - renamed_to: android.app.state - type: - members: - - id: created - value: 'created' - brief: > - Any time before Activity.onResume() or, if the app has no Activity, Context.startService() - has been called in the app for the first time. - stability: development - - id: background - value: 'background' - brief: > - Any time after Activity.onPause() or, if the app has no Activity, - Context.stopService() has been called when the app was in the foreground state. - stability: development - - id: foreground - value: 'foreground' - brief: > - Any time after Activity.onResume() or, if the app has no Activity, - Context.startService() has been called when the app was in either the created or background states. - stability: development - id: android.app.state stability: development brief: > diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index a6f69c516f..65214394c0 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -12,9 +12,21 @@ {%- set groups = namespace(deprecated=[], non_deprecated=[]) -%} {%- for group in ctx.groups | sort(attribute="id") -%} {%- if group.id[-10:] == "deprecated" -%} +{% if ctx.groups | selectattr("id", "eq", group.id[:-11]) | length != 1 %} {%- set groups.deprecated = groups.deprecated + [group] -%} +{% endif %} {%- else -%} +{% set deprecatedAttrs = ctx.groups | selectattr("id", "eq", group.id + ".deprecated") %}{% if deprecatedAttrs | length > 0 %}{% set combined = { + "brief": group.brief, + "note": group.note, + "id": group.id, + "attributes": group.attributes + deprecatedAttrs[0].attributes, + "display_name": group.display_name + } %} +{%- set groups.non_deprecated = groups.non_deprecated + [combined] -%} +{% else %} {%- set groups.non_deprecated = groups.non_deprecated + [group] -%} +{% endif %} {%- endif -%} {%- endfor -%} {%- set attr_groups = groups.non_deprecated + groups.deprecated -%} diff --git a/templates/registry/markdown/attribute_table.j2 b/templates/registry/markdown/attribute_table.j2 index 8f5d4ef383..d1d2075d0d 100644 --- a/templates/registry/markdown/attribute_table.j2 +++ b/templates/registry/markdown/attribute_table.j2 @@ -10,7 +10,7 @@ | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -{% for attribute in filtered_attributes if attribute.deprecated is not defined or attribute.deprecated is none %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute), "deprecated": attribute.deprecated}, notes) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | +{% for attribute in filtered_attributes %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute), "deprecated": attribute.deprecated}, notes) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} {% endif %}{{ generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes)}}{% endmacro %} From f70b6ce27d24909228675978da42001911e047ae Mon Sep 17 00:00:00 2001 From: James Thompson Date: Tue, 30 Jun 2026 15:27:10 +1000 Subject: [PATCH 5/9] Use standard filters so v2 can be supported --- docs/registry/attributes/README.md | 9 +- docs/registry/attributes/android.md | 2 - docs/registry/attributes/app.md | 4 +- docs/registry/attributes/artifact.md | 2 - docs/registry/attributes/aspnetcore.md | 4 +- docs/registry/attributes/aws.md | 168 ++------------- docs/registry/attributes/az.md | 16 ++ docs/registry/attributes/azure.md | 42 +--- docs/registry/attributes/browser.md | 2 - docs/registry/attributes/cassandra.md | 2 - docs/registry/attributes/cicd.md | 4 +- docs/registry/attributes/client.md | 2 - docs/registry/attributes/cloud.md | 2 - docs/registry/attributes/cloudevents.md | 2 - docs/registry/attributes/cloudfoundry.md | 2 - docs/registry/attributes/code.md | 2 - docs/registry/attributes/container.md | 2 - docs/registry/attributes/cpu.md | 2 - docs/registry/attributes/cpython.md | 4 +- docs/registry/attributes/db.md | 52 ++--- docs/registry/attributes/deployment.md | 2 - docs/registry/attributes/destination.md | 2 - docs/registry/attributes/device.md | 2 - docs/registry/attributes/disk.md | 2 - docs/registry/attributes/dns.md | 2 - docs/registry/attributes/dotnet.md | 4 +- docs/registry/attributes/elasticsearch.md | 2 - docs/registry/attributes/enduser.md | 4 +- docs/registry/attributes/error.md | 2 - docs/registry/attributes/event.md | 2 - docs/registry/attributes/exception.md | 2 - docs/registry/attributes/faas.md | 4 +- docs/registry/attributes/feature-flag.md | 3 - docs/registry/attributes/file.md | 20 +- docs/registry/attributes/gcp.md | 90 ++------ docs/registry/attributes/gen-ai.md | 67 +++--- docs/registry/attributes/geo.md | 3 - docs/registry/attributes/go.md | 2 - docs/registry/attributes/graphql.md | 2 - docs/registry/attributes/heroku.md | 2 - docs/registry/attributes/host.md | 2 - docs/registry/attributes/http.md | 2 - docs/registry/attributes/hw.md | 135 ++++++++++++ docs/registry/attributes/ios.md | 2 - docs/registry/attributes/jsonrpc.md | 4 +- docs/registry/attributes/jvm.md | 4 +- docs/registry/attributes/k8s.md | 4 +- docs/registry/attributes/linux.md | 4 +- docs/registry/attributes/log.md | 46 +--- docs/registry/attributes/mainframe.md | 4 +- docs/registry/attributes/mcp.md | 4 +- docs/registry/attributes/message.md | 27 +++ docs/registry/attributes/messaging.md | 191 ++++++---------- docs/registry/attributes/net.md | 53 +++++ docs/registry/attributes/network.md | 49 ----- docs/registry/attributes/nfs.md | 2 - docs/registry/attributes/nodejs.md | 4 +- docs/registry/attributes/oci.md | 4 +- docs/registry/attributes/onc-rpc.md | 4 +- docs/registry/attributes/openai.md | 4 +- docs/registry/attributes/openshift.md | 2 - docs/registry/attributes/opentracing.md | 2 - docs/registry/attributes/oracle-cloud.md | 4 +- docs/registry/attributes/oracle.md | 39 ++++ docs/registry/attributes/os.md | 4 +- docs/registry/attributes/otel.md | 95 +++----- docs/registry/attributes/other.md | 24 +++ docs/registry/attributes/peer.md | 2 - docs/registry/attributes/pool.md | 15 ++ docs/registry/attributes/pprof.md | 4 +- docs/registry/attributes/process.md | 38 +--- docs/registry/attributes/profile.md | 4 +- docs/registry/attributes/rpc.md | 17 +- docs/registry/attributes/security-rule.md | 4 +- docs/registry/attributes/server.md | 2 - docs/registry/attributes/service.md | 18 +- docs/registry/attributes/session.md | 4 - docs/registry/attributes/signalr.md | 2 - docs/registry/attributes/source.md | 2 - docs/registry/attributes/system.md | 204 ++++++++---------- docs/registry/attributes/telemetry.md | 2 - docs/registry/attributes/test.md | 2 - docs/registry/attributes/thread.md | 2 - docs/registry/attributes/tls.md | 2 - docs/registry/attributes/url.md | 2 - docs/registry/attributes/user-agent.md | 32 +-- docs/registry/attributes/user.md | 2 - docs/registry/attributes/v8js.md | 4 +- docs/registry/attributes/vcs.md | 11 +- docs/registry/attributes/webengine.md | 4 +- docs/registry/attributes/zos.md | 4 +- .../registry/markdown/attribute_macros.j2 | 6 +- .../markdown/attribute_namespace.md.j2 | 45 +--- .../registry/markdown/attributes_readme.md.j2 | 4 +- templates/registry/markdown/weaver.yaml | 6 +- 95 files changed, 648 insertions(+), 1059 deletions(-) create mode 100644 docs/registry/attributes/az.md create mode 100644 docs/registry/attributes/hw.md create mode 100644 docs/registry/attributes/message.md create mode 100644 docs/registry/attributes/net.md create mode 100644 docs/registry/attributes/oracle.md create mode 100644 docs/registry/attributes/other.md create mode 100644 docs/registry/attributes/pool.md diff --git a/docs/registry/attributes/README.md b/docs/registry/attributes/README.md index 64c71e2869..3abf83bc94 100644 --- a/docs/registry/attributes/README.md +++ b/docs/registry/attributes/README.md @@ -36,6 +36,7 @@ Currently, the following namespaces exist: - [Artifact](artifact.md) - [Aspnetcore](aspnetcore.md) - [AWS](aws.md) +- [Az](az.md) - [Azure](azure.md) - [Browser](browser.md) - [Cassandra](cassandra.md) @@ -68,10 +69,10 @@ Currently, the following namespaces exist: - [Geo](geo.md) - [Go](go.md) - [GraphQL](graphql.md) -- [Hardware](hardware.md) - [Heroku](heroku.md) - [Host](host.md) - [HTTP](http.md) +- [Hw](hw.md) - [iOS](ios.md) - [JSONRPC](jsonrpc.md) - [JVM](jvm.md) @@ -80,7 +81,9 @@ Currently, the following namespaces exist: - [Log](log.md) - [Mainframe](mainframe.md) - [MCP](mcp.md) +- [Message](message.md) - [Messaging](messaging.md) +- [Net](net.md) - [Network](network.md) - [NFS](nfs.md) - [NodeJS](nodejs.md) @@ -89,11 +92,13 @@ Currently, the following namespaces exist: - [OpenAI](openai.md) - [Openshift](openshift.md) - [OpenTracing](opentracing.md) +- [Oracle](oracle.md) - [Oracle Cloud](oracle-cloud.md) -- [OracleDB](oracledb.md) - [OS](os.md) - [OTel](otel.md) +- [Other](other.md) - [Peer](peer.md) +- [Pool](pool.md) - [Pprof](pprof.md) - [Process](process.md) - [Profile](profile.md) diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index b595aa56f5..52ba095475 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -5,8 +5,6 @@ ## Android Attributes -The Android platform on which the Android application is running. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/app.md b/docs/registry/attributes/app.md index c665ba55d2..319a29ee97 100644 --- a/docs/registry/attributes/app.md +++ b/docs/registry/attributes/app.md @@ -3,9 +3,7 @@ # App -## Application Attributes - -Describes attributes related to client-side applications (e.g. web apps or mobile apps). +## App Attributes **Attributes:** diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index 4c357385a3..3de39093a8 100644 --- a/docs/registry/attributes/artifact.md +++ b/docs/registry/attributes/artifact.md @@ -5,8 +5,6 @@ ## Artifact Attributes -This group describes attributes specific to artifacts. Artifacts are files or other immutable objects that are intended for distribution. This definition aligns directly with the [SLSA](https://slsa.dev/spec/v1.0/terminology#package-model) package model. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/aspnetcore.md b/docs/registry/attributes/aspnetcore.md index 9887b692ac..3fe626e818 100644 --- a/docs/registry/attributes/aspnetcore.md +++ b/docs/registry/attributes/aspnetcore.md @@ -3,9 +3,7 @@ # Aspnetcore -## ASP.NET Core Attributes - -ASP.NET Core attributes +## Aspnetcore Attributes **Attributes:** diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index 9571539e3f..c6bddec116 100644 --- a/docs/registry/attributes/aws.md +++ b/docs/registry/attributes/aws.md @@ -3,34 +3,7 @@ # AWS -- [General AWS Attributes](#general-aws-attributes) -- [Amazon Bedrock Attributes](#amazon-bedrock-attributes) -- [Amazon DynamoDB Attributes](#amazon-dynamodb-attributes) -- [Amazon ECS Attributes](#amazon-ecs-attributes) -- [Amazon EKS Attributes](#amazon-eks-attributes) -- [Amazon Kinesis Attributes](#amazon-kinesis-attributes) -- [Amazon Lambda Attributes](#amazon-lambda-attributes) -- [Amazon Logs Attributes](#amazon-logs-attributes) -- [Amazon S3 Attributes](#amazon-s3-attributes) -- [Amazon Secrets Manager Attributes](#amazon-secrets-manager-attributes) -- [Amazon SNS Attributes](#amazon-sns-attributes) -- [Amazon SQS Attributes](#amazon-sqs-attributes) -- [Amazon Step Functions Attributes](#amazon-step-functions-attributes) - -## General AWS Attributes - -This section defines generic attributes for AWS services. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `aws.extended_request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | -| `aws.request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | - -## Amazon Bedrock Attributes - -This document defines attributes for AWS Bedrock. +## AWS Attributes **Attributes:** @@ -38,15 +11,6 @@ This document defines attributes for AWS Bedrock. | --- | --- | --- | --- | --- | | `aws.bedrock.guardrail.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Guardrail. A [guardrail](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) helps safeguard and prevent unwanted behavior from model responses or user messages. | `sgi5gkybzqak` | | `aws.bedrock.knowledge_base.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Knowledge base. A [knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) is a bank of information that can be queried by models to generate more relevant responses and augment prompts. | `XFWUPB9PAW` | - -## Amazon DynamoDB Attributes - -This document defines attributes for AWS DynamoDB. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `aws.dynamodb.attribute_definitions` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]` | | `aws.dynamodb.attributes_to_get` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The value of the `AttributesToGet` request parameter. | `["lives", "id"]` | | `aws.dynamodb.consistent_read` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | The value of the `ConsistentRead` request parameter. | | @@ -69,15 +33,6 @@ This document defines attributes for AWS DynamoDB. | `aws.dynamodb.table_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | The number of items in the `TableNames` response parameter. | `20` | | `aws.dynamodb.table_names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The keys in the `RequestItems` object field. | `["Users", "Cats"]` | | `aws.dynamodb.total_segments` | ![Development](https://img.shields.io/badge/-development-blue) | int | The value of the `TotalSegments` request parameter. | `100` | - -## Amazon ECS Attributes - -This document defines attributes for AWS Elastic Container Service (ECS). - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `aws.ecs.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | | `aws.ecs.container.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). | `arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9` | | `aws.ecs.launchtype` | ![Development](https://img.shields.io/badge/-development-blue) | string | The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task. | `ec2`; `fargate` | @@ -85,82 +40,35 @@ This document defines attributes for AWS Elastic Container Service (ECS). | `aws.ecs.task.family` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `opentelemetry-family` | | `aws.ecs.task.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ID of a running ECS task. The ID MUST be extracted from `task.arn`. | `10838bed-421f-43ef-870a-f43feacbbb5b`; `23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd` | | `aws.ecs.task.revision` | ![Development](https://img.shields.io/badge/-development-blue) | string | The revision for the task definition used to create the ECS task. | `8`; `26` | - ---- - -`aws.ecs.launchtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `ec2` | Amazon EC2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `fargate` | Amazon Fargate | ![Development](https://img.shields.io/badge/-development-blue) | - -## Amazon EKS Attributes - -This document defines attributes for AWS Elastic Kubernetes Service (EKS). - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `aws.eks.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | - -## Amazon Kinesis Attributes - -This document defines attributes for AWS Kinesis. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | +| `aws.extended_request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | | `aws.kinesis.stream_name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the AWS Kinesis [stream](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) the request refers to. Corresponds to the `--stream-name` parameter of the Kinesis [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) operation. | `some-stream-name` | - -## Amazon Lambda Attributes - -This document defines attributes for AWS Lambda. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `aws.lambda.invoked_arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). [1] | `arn:aws:lambda:us-east-1:123456:function:myfunction:myalias` | | `aws.lambda.resource_mapping.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. | `587ad24b-03b9-4413-8202-bbd56b36e5b7` | - -**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. - -## Amazon Logs Attributes - -This document defines attributes for AWS Logs. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `aws.log.group.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The Amazon Resource Name(s) (ARN) of the AWS log group(s). [2] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]` | | `aws.log.group.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log group(s) an application is writing to. [3] | `["/aws/lambda/my-function", "opentelemetry-service"]` | | `aws.log.stream.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The ARN(s) of the AWS log stream(s). [4] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | | `aws.log.stream.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | - -**[2] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). - -**[3] `aws.log.group.names`:** 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. - -**[4] `aws.log.stream.arns`:** 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. - -## Amazon S3 Attributes - -This document defines attributes for AWS S3. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | +| `aws.request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | | `aws.s3.bucket` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [5] | `some-bucket-name` | | `aws.s3.copy_source` | ![Development](https://img.shields.io/badge/-development-blue) | string | The source object (in the form `bucket`/`key`) for the copy operation. [6] | `someFile.yml` | | `aws.s3.delete` | ![Development](https://img.shields.io/badge/-development-blue) | string | The delete request container that specifies the objects to be deleted. [7] | `Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean` | | `aws.s3.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [8] | `someFile.yml` | | `aws.s3.part_number` | ![Development](https://img.shields.io/badge/-development-blue) | int | The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. [9] | `3456` | | `aws.s3.upload_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Upload ID that identifies the multipart upload. [10] | `dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ` | +| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Manager | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | +| `aws.sns.topic.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS SNS Topic. An Amazon SNS [topic](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) is a logical access point that acts as a communication channel. | `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` | +| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | +| `aws.step_functions.activity.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | +| `aws.step_functions.state_machine.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | + +**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. + +**[2] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). + +**[3] `aws.log.group.names`:** 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. + +**[4] `aws.log.stream.arns`:** 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. **[5] `aws.s3.bucket`:** 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`. @@ -208,43 +116,11 @@ This applies in particular to the following operations: - [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) -## Amazon Secrets Manager Attributes - -This document defines attributes for AWS Secrets Manager. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Manager | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | - -## Amazon SNS Attributes - -This document defines attributes for AWS SNS. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `aws.sns.topic.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS SNS Topic. An Amazon SNS [topic](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) is a logical access point that acts as a communication channel. | `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` | - -## Amazon SQS Attributes - -This document defines attributes for AWS SQS. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | - -## Amazon Step Functions Attributes - -This document defines attributes for AWS Step Functions. +--- -**Attributes:** +`aws.ecs.launchtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `aws.step_functions.activity.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | -| `aws.step_functions.state_machine.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | +| Value | Description | Stability | +| --- | --- | --- | +| `ec2` | Amazon EC2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `fargate` | Amazon Fargate | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/az.md b/docs/registry/attributes/az.md new file mode 100644 index 0000000000..c488c4780e --- /dev/null +++ b/docs/registry/attributes/az.md @@ -0,0 +1,16 @@ + + + +# Az + +## Az Attributes + +
+Deprecated Attributes: + +| Key | Value Type | Description | Example Values | Deprecation Explanation | +| --- | --- | --- | --- | --- | +| `az.namespace` | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. | +| `az.service_request_id` | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. | + +
diff --git a/docs/registry/attributes/azure.md b/docs/registry/attributes/azure.md index fe025c5d21..44b8b5f281 100644 --- a/docs/registry/attributes/azure.md +++ b/docs/registry/attributes/azure.md @@ -3,56 +3,22 @@ # Azure -- [General Azure Attributes](#general-azure-attributes) -- [Azure Client Library Attributes](#azure-client-library-attributes) -- [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes) - -## General Azure Attributes - -This section defines generic attributes for Azure services. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `azure.resource_group.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the Azure [resource group](https://learn.microsoft.com/azure/azure-resource-manager/management/manage-resource-groups-portal) the resource belongs to. | `my-resource-group`; `rg-myapp-prod` | - -
-Deprecated Attributes: - -| Key | Value Type | Description | Example Values | Deprecation Explanation | -| --- | --- | --- | --- | --- | -| `az.namespace` | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. | -| `az.service_request_id` | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. | - -
- -## Azure Client Library Attributes - -This section defines generic attributes used by Azure Client Libraries. +## Azure Attributes **Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | | `azure.client.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | -| `azure.resource_provider.namespace` | ![Development](https://img.shields.io/badge/-development-blue) | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | -| `azure.service.request.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | - -## Azure Cosmos DB Attributes - -This section defines attributes for Azure Cosmos DB. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `azure.cosmosdb.connection.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Cosmos client connection mode. | `gateway`; `direct` | | `azure.cosmosdb.consistency.level` | ![Development](https://img.shields.io/badge/-development-blue) | string | Account or request [consistency level](https://learn.microsoft.com/azure/cosmos-db/consistency-levels). | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | | `azure.cosmosdb.operation.contacted_regions` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | List of regions contacted during operation in the order that they were contacted. If there is more than one region listed, it indicates that the operation was performed on multiple regions i.e. cross-regional call. [1] | `["North Central US", "Australia East", "Australia Southeast"]` | | `azure.cosmosdb.operation.request_charge` | ![Development](https://img.shields.io/badge/-development-blue) | double | The number of request units consumed by the operation. | `46.18`; `1.0` | | `azure.cosmosdb.request.body.size` | ![Development](https://img.shields.io/badge/-development-blue) | int | Request payload size in bytes. | | | `azure.cosmosdb.response.sub_status_code` | ![Development](https://img.shields.io/badge/-development-blue) | int | Cosmos DB sub status code. | `1000`; `1002` | +| `azure.resource_group.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the Azure [resource group](https://learn.microsoft.com/azure/azure-resource-manager/management/manage-resource-groups-portal) the resource belongs to. | `my-resource-group`; `rg-myapp-prod` | +| `azure.resource_provider.namespace` | ![Development](https://img.shields.io/badge/-development-blue) | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | +| `azure.service.request.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | **[1] `azure.cosmosdb.operation.contacted_regions`:** Region name matches the format of `displayName` in [Azure Location API](https://learn.microsoft.com/rest/api/resources/subscriptions/list-locations) diff --git a/docs/registry/attributes/browser.md b/docs/registry/attributes/browser.md index 98de5853f7..0b7063991a 100644 --- a/docs/registry/attributes/browser.md +++ b/docs/registry/attributes/browser.md @@ -5,8 +5,6 @@ ## Browser Attributes -The web browser attributes - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cassandra.md b/docs/registry/attributes/cassandra.md index 21d4bc49cf..5d99ea9a52 100644 --- a/docs/registry/attributes/cassandra.md +++ b/docs/registry/attributes/cassandra.md @@ -5,8 +5,6 @@ ## Cassandra Attributes -This section defines attributes for Cassandra. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index 3df0e04111..24c384f200 100644 --- a/docs/registry/attributes/cicd.md +++ b/docs/registry/attributes/cicd.md @@ -3,9 +3,7 @@ # CI/CD -## CI/CD Pipeline Attributes - -This group describes attributes specific to pipelines within a Continuous Integration and Continuous Deployment (CI/CD) system. A [pipeline](https://wikipedia.org/wiki/Pipeline_(computing)) in this case is a series of steps that are performed in order to deliver a new version of software. This aligns with the [Britannica](https://www.britannica.com/dictionary/pipeline) definition of a pipeline where a **pipeline** is the system for developing and producing something. In the context of CI/CD, a pipeline produces or delivers software. +## CICD Attributes **Attributes:** diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index 31975814ea..fdaa61b96d 100644 --- a/docs/registry/attributes/client.md +++ b/docs/registry/attributes/client.md @@ -5,8 +5,6 @@ ## Client Attributes -These attributes may be used to describe the client in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cloud.md b/docs/registry/attributes/cloud.md index 7912d751ac..3a1d75a12b 100644 --- a/docs/registry/attributes/cloud.md +++ b/docs/registry/attributes/cloud.md @@ -5,8 +5,6 @@ ## Cloud Attributes -A cloud environment (e.g. GCP, Azure, AWS). - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cloudevents.md b/docs/registry/attributes/cloudevents.md index 5374254854..efd1f45318 100644 --- a/docs/registry/attributes/cloudevents.md +++ b/docs/registry/attributes/cloudevents.md @@ -5,8 +5,6 @@ ## CloudEvents Attributes -This document defines attributes for CloudEvents. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cloudfoundry.md b/docs/registry/attributes/cloudfoundry.md index b859cea99a..442949e029 100644 --- a/docs/registry/attributes/cloudfoundry.md +++ b/docs/registry/attributes/cloudfoundry.md @@ -5,8 +5,6 @@ ## CloudFoundry Attributes -CloudFoundry resource attributes. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index 5b2cf7cf26..c8317b78dd 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -5,8 +5,6 @@ ## Code Attributes -These attributes provide context about source code - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index 3f8b6f9162..0b0abe0e5e 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -5,8 +5,6 @@ ## Container Attributes -A container instance. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cpu.md b/docs/registry/attributes/cpu.md index d0dc63a85c..5e08a92b35 100644 --- a/docs/registry/attributes/cpu.md +++ b/docs/registry/attributes/cpu.md @@ -5,8 +5,6 @@ ## CPU Attributes -Attributes specific to a cpu instance. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cpython.md b/docs/registry/attributes/cpython.md index 406f2d0048..770c6f25f0 100644 --- a/docs/registry/attributes/cpython.md +++ b/docs/registry/attributes/cpython.md @@ -3,9 +3,7 @@ # CPython -## CPython attributes - -This document defines CPython related attributes. +## CPython Attributes **Attributes:** diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index fe40615b8f..4e72088221 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -3,12 +3,7 @@ # DB -- [General Database Attributes](#general-database-attributes) -- [Deprecated Database Metrics](#deprecated-database-metrics) - -## General Database Attributes - -This group defines the attributes used to describe telemetry in the context of databases. +## DB Attributes **Attributes:** @@ -205,6 +200,8 @@ stored procedure name then that stored procedure name SHOULD be used. | `db.cassandra.page_size` | int | Deprecated, use `cassandra.page.size` instead. | `5000` | Use `cassandra.page.size` instead. | | `db.cassandra.speculative_execution_count` | int | Deprecated, use `cassandra.speculative_execution.count` instead. | `0`; `2` | Use `cassandra.speculative_execution.count` instead. | | `db.cassandra.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | +| `db.client.connections.pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | +| `db.client.connections.state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | | `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | Replaced by `server.address` and `server.port`. | | `db.cosmosdb.client_id` | string | Deprecated, use `azure.client.id` instead. | `3ba4827d-4422-483f-b59f-85b74211c11d` | Use `azure.client.id` instead. | | `db.cosmosdb.connection_mode` | string | Deprecated, use `azure.cosmosdb.connection.mode` instead. | `gateway`; `direct` | Use `azure.cosmosdb.connection.mode` instead. | @@ -251,6 +248,15 @@ stored procedure name then that stored procedure name SHOULD be used. --- +`db.client.connections.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + `db.cosmosdb.connection_mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -349,37 +355,3 @@ stored procedure name then that stored procedure name SHOULD be used. | `vertica` | Vertica | ![Development](https://img.shields.io/badge/-development-blue) |
- -## Deprecated Database Metrics - -Describes deprecated db metrics attributes. - -
-Deprecated Attributes: - -| Key | Value Type | Description | Example Values | Deprecation Explanation | -| --- | --- | --- | --- | --- | -| `db.client.connections.pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | -| `db.client.connections.state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | -| `pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | -| `state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | - ---- - -`db.client.connections.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | - -
diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index 4d73a90820..3bd81e3d28 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -5,8 +5,6 @@ ## Deployment Attributes -This document defines attributes for software deployments. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/destination.md b/docs/registry/attributes/destination.md index 3c17d469c3..3d3c3341e3 100644 --- a/docs/registry/attributes/destination.md +++ b/docs/registry/attributes/destination.md @@ -5,8 +5,6 @@ ## Destination Attributes -These attributes may be used to describe the receiver of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/device.md b/docs/registry/attributes/device.md index 57e31f5f48..55b5dbf52d 100644 --- a/docs/registry/attributes/device.md +++ b/docs/registry/attributes/device.md @@ -5,8 +5,6 @@ ## Device Attributes -Describes device attributes. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/disk.md b/docs/registry/attributes/disk.md index 84b7db2bbf..855ff90007 100644 --- a/docs/registry/attributes/disk.md +++ b/docs/registry/attributes/disk.md @@ -5,8 +5,6 @@ ## Disk Attributes -These attributes may be used for any disk related operation. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/dns.md b/docs/registry/attributes/dns.md index c8e22f6390..65f01cb5c6 100644 --- a/docs/registry/attributes/dns.md +++ b/docs/registry/attributes/dns.md @@ -5,8 +5,6 @@ ## DNS Attributes -This document defines the shared attributes used to report a DNS query. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/dotnet.md b/docs/registry/attributes/dotnet.md index 501fe5e63e..0ae427e980 100644 --- a/docs/registry/attributes/dotnet.md +++ b/docs/registry/attributes/dotnet.md @@ -3,9 +3,7 @@ # Dotnet -## .NET Attributes - -This document defines .NET related attributes. +## Dotnet Attributes **Attributes:** diff --git a/docs/registry/attributes/elasticsearch.md b/docs/registry/attributes/elasticsearch.md index f227e33007..bef6d101f2 100644 --- a/docs/registry/attributes/elasticsearch.md +++ b/docs/registry/attributes/elasticsearch.md @@ -5,8 +5,6 @@ ## Elasticsearch Attributes -This section defines attributes for Elasticsearch. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index 19b2cef144..df71c7ea9f 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -3,9 +3,7 @@ # Enduser -## End User Attributes - -Describes the end user. +## Enduser Attributes **Attributes:** diff --git a/docs/registry/attributes/error.md b/docs/registry/attributes/error.md index 100c2a0bd6..63e0916bab 100644 --- a/docs/registry/attributes/error.md +++ b/docs/registry/attributes/error.md @@ -5,8 +5,6 @@ ## Error Attributes -This document defines the shared attributes used to report an error. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 10e05d8cfd..3c339ab91a 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -5,8 +5,6 @@ ## Event Attributes -Attributes for Events represented using Log Records. -
Deprecated Attributes: diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index 9507f727c8..1b93c212d5 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -5,8 +5,6 @@ ## Exception Attributes -This document defines the shared attributes used to report a single exception associated with a span or log. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/faas.md b/docs/registry/attributes/faas.md index 55dd921edd..30cadc9f81 100644 --- a/docs/registry/attributes/faas.md +++ b/docs/registry/attributes/faas.md @@ -3,9 +3,7 @@ # Faas -## Function as a Service Attributes - -FaaS attributes +## Faas Attributes **Attributes:** diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index fcdff2e62c..21e675cb38 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -5,8 +5,6 @@ ## Feature Flag Attributes -This document defines attributes for Feature Flags. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | @@ -55,7 +53,6 @@ For example, the variant `red` maybe be used for the value `#c05543`. | --- | --- | --- | --- | --- | | `feature_flag.evaluation.error.message` | string | Deprecated, use `feature_flag.error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | Use `feature_flag.error.message` instead. | | `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | Use `feature_flag.result.reason` instead. | -| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | Use `feature_flag.provider.name` instead. | | `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | Use `feature_flag.result.variant` instead. | --- diff --git a/docs/registry/attributes/file.md b/docs/registry/attributes/file.md index 27b5b8a134..a09298d9df 100644 --- a/docs/registry/attributes/file.md +++ b/docs/registry/attributes/file.md @@ -3,13 +3,8 @@ # File -- [File Attributes](#file-attributes) -- [File Lock Attributes](#file-lock-attributes) - ## File Attributes -Describes file attributes. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | @@ -24,6 +19,9 @@ Describes file attributes. | `file.group.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Primary Group ID (GID) of the file. | `1000` | | `file.group.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Primary group name of the file. | `users` | | `file.inode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Inode representing the file in the filesystem. | `256383` | +| `file.lock.mechanism` | ![Development](https://img.shields.io/badge/-development-blue) | string | The lock mechanism such as noted by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html) | `POSIX`; `FLOCK`; `DELEG`; `LEASE` | +| `file.lock.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Mode of lock or operation such as documented by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html) | `ADVISORY`; `MANDATORY`; `BREAKING`; `ACTIVE`; `BREAKER` | +| `file.lock.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The lock type as represented by i.e. [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html)'s l_type. | `read` | | `file.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Mode of the file in octal representation. | `0640` | | `file.modified` | ![Development](https://img.shields.io/badge/-development-blue) | string | Time when the file content was last modified, in ISO 8601 format. | `2021-01-01T12:00:00Z` | | `file.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the file including the extension, without the directory. | `example.png` | @@ -48,18 +46,6 @@ On NTFS, this is analogous to an Alternate Data Stream (ADS), and the default da **[7] `file.symbolic_link.target_path`:** This attribute is only applicable to symbolic links. -## File Lock Attributes - -These attributes may be used for any filesystem lock or related operation - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `file.lock.mechanism` | ![Development](https://img.shields.io/badge/-development-blue) | string | The lock mechanism such as noted by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html) | `POSIX`; `FLOCK`; `DELEG`; `LEASE` | -| `file.lock.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | Mode of lock or operation such as documented by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html) | `ADVISORY`; `MANDATORY`; `BREAKING`; `ACTIVE`; `BREAKER` | -| `file.lock.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The lock type as represented by i.e. [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html)'s l_type. | `read` | - --- `file.lock.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 137c134e5d..38d9b271e4 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -3,15 +3,7 @@ # GCP -- [GCP - AppHub Attributes](#gcp---apphub-attributes) -- [GCP - AppHub Destination Attributes](#gcp---apphub-destination-attributes) -- [GCP Client Attributes](#gcp-client-attributes) -- [GCP - Google Cloud Run Attributes](#gcp---google-cloud-run-attributes) -- [GCP - Google Compute Engine (GCE) Attributes](#gcp---google-compute-engine-gce-attributes) - -## GCP - AppHub Attributes - -This document defines attributes AppHub will apply to resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). +## GCP Attributes **Attributes:** @@ -26,6 +18,24 @@ This document defines attributes AppHub will apply to resources in GCP. See [App | `gcp.apphub.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a workload indicates its importance to the business. [3] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | | `gcp.apphub.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a workload is the stage of a software lifecycle. [4] | `PRODUCTION`; `STAGING`; `TEST` | | `gcp.apphub.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the workload as configured in AppHub. | `my-workload` | +| `gcp.apphub_destination.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | +| `gcp.apphub_destination.application.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination application as configured in AppHub. | `my-application` | +| `gcp.apphub_destination.application.location` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GCP zone or region where the destination application is defined. | `us-central1` | +| `gcp.apphub_destination.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub_destination.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub_destination.service.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination service as configured in AppHub. | `my-service` | +| `gcp.apphub_destination.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub_destination.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a destination workload is the stage of a software lifecycle as provided in the [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub_destination.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination workload as configured in AppHub. | `my-workload` | +| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | +| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | +| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | +| `gcp.gce.instance.hostname` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | +| `gcp.gce.instance.labels.` | ![Development](https://img.shields.io/badge/-development-blue) | string | GCE instance labels, `` being the label name and the value being the label value. [6] | `observability` | +| `gcp.gce.instance.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `instance-1`; `my-vm-name` | +| `gcp.gce.instance_group_manager.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the Instance Group Manager (IGM) that manages this VM, if any. | `web-igm`; `my-managed-group` | +| `gcp.gce.instance_group_manager.region` | ![Development](https://img.shields.io/badge/-development-blue) | string | The region of a **regional** Instance Group Manager (e.g., `us-central1`). Set this **only** when the IGM is regional. | `us-central1`; `europe-west1` | +| `gcp.gce.instance_group_manager.zone` | ![Development](https://img.shields.io/badge/-development-blue) | string | The zone of a **zonal** Instance Group Manager (e.g., `us-central1-a`). Set this **only** when the IGM is zonal. | `us-central1-a`; `europe-west1-b` | **[1] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) @@ -35,6 +45,10 @@ This document defines attributes AppHub will apply to resources in GCP. See [App **[4] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) +**[5] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. + +**[6] `gcp.gce.instance.labels.`:** For example, a GCE instance label `team` with value `observability` SHOULD be recorded as the `gcp.gce.instance.labels.team` attribute with value `"observability"`. The `` MUST be the exact GCE instance label key. + --- `gcp.apphub.service.criticality_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -79,24 +93,6 @@ This document defines attributes AppHub will apply to resources in GCP. See [App | `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) | -## GCP - AppHub Destination Attributes - -This document defines attributes AppHub will apply to destination resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `gcp.apphub_destination.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | -| `gcp.apphub_destination.application.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination application as configured in AppHub. | `my-application` | -| `gcp.apphub_destination.application.location` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GCP zone or region where the destination application is defined. | `us-central1` | -| `gcp.apphub_destination.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub_destination.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | -| `gcp.apphub_destination.service.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination service as configured in AppHub. | `my-service` | -| `gcp.apphub_destination.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub_destination.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a destination workload is the stage of a software lifecycle as provided in the [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | -| `gcp.apphub_destination.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination workload as configured in AppHub. | `my-workload` | - --- `gcp.apphub_destination.service.criticality_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -140,43 +136,3 @@ This document defines attributes AppHub will apply to destination resources in G | `PRODUCTION` | Production environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) | - -## GCP Client Attributes - -Attributes for Google Cloud client libraries. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | - -**[5] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. - -## GCP - Google Cloud Run Attributes - -This document defines attributes for Google Cloud Run. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | -| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | - -## GCP - Google Compute Engine (GCE) Attributes - -This document defines attributes for Google Compute Engine (GCE). - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `gcp.gce.instance.hostname` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | -| `gcp.gce.instance.labels.` | ![Development](https://img.shields.io/badge/-development-blue) | string | GCE instance labels, `` being the label name and the value being the label value. [6] | `observability` | -| `gcp.gce.instance.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `instance-1`; `my-vm-name` | -| `gcp.gce.instance_group_manager.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the Instance Group Manager (IGM) that manages this VM, if any. | `web-igm`; `my-managed-group` | -| `gcp.gce.instance_group_manager.region` | ![Development](https://img.shields.io/badge/-development-blue) | string | The region of a **regional** Instance Group Manager (e.g., `us-central1`). Set this **only** when the IGM is regional. | `us-central1`; `europe-west1` | -| `gcp.gce.instance_group_manager.zone` | ![Development](https://img.shields.io/badge/-development-blue) | string | The zone of a **zonal** Instance Group Manager (e.g., `us-central1-a`). Set this **only** when the IGM is zonal. | `us-central1-a`; `europe-west1-b` | - -**[6] `gcp.gce.instance.labels.`:** For example, a GCE instance label `team` with value `observability` SHOULD be recorded as the `gcp.gce.instance.labels.team` attribute with value `"observability"`. The `` MUST be the exact GCE instance label key. diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 8c5678b02e..155d9e2ef5 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -3,12 +3,7 @@ # Gen AI -- [GenAI Attributes (Moved)](#genai-attributes-moved) -- [Deprecated OpenAI GenAI Attributes](#deprecated-openai-genai-attributes) - -## GenAI Attributes (Moved) - -Generative AI (GenAI) attributes have moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). +## Gen AI Attributes
Deprecated Attributes: @@ -28,6 +23,11 @@ Generative AI (GenAI) attributes have moved to the [OpenTelemetry GenAI semantic | `gen_ai.evaluation.score.label` | string | Human readable label for evaluation. [2] | `relevant`; `not_relevant`; `correct`; `incorrect`; `pass`; `fail` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | | `gen_ai.evaluation.score.value` | double | The evaluation score returned by the evaluator. | `4.0` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | | `gen_ai.input.messages` | any | The chat history provided to the model as an input. [3] | [
  {
    "role": "user",
    "parts": [
      {
        "type": "text",
        "content": "Weather in Paris?"
      }
    ]
  },
  {
    "role": "assistant",
    "parts": [
      {
        "type": "tool_call",
        "id": "call_VSPygqKTWdrhaFErNvMV18Yl",
        "name": "get_weather",
        "arguments": {
          "location": "Paris"
        }
      }
    ]
  },
  {
    "role": "tool",
    "parts": [
      {
        "type": "tool_call_response",
        "id": " call_VSPygqKTWdrhaFErNvMV18Yl",
        "result": "rainy, 57°F"
      }
    ]
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `gen_ai.openai.request.response_format` | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | Replaced by `gen_ai.output.type`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `gen_ai.openai.request.seed` | int | Deprecated, use `gen_ai.request.seed`. | `100` | Replaced by `gen_ai.request.seed`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `gen_ai.openai.request.service_tier` | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | Replaced by `openai.request.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `gen_ai.openai.response.service_tier` | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | Replaced by `openai.response.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `gen_ai.openai.response.system_fingerprint` | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | Replaced by `openai.response.system_fingerprint`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | | `gen_ai.operation.name` | string | The name of the operation being performed. [4] | `chat`; `generate_content`; `text_completion` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | | `gen_ai.output.messages` | any | Messages returned by the model where each message represents a specific model response (choice, candidate). [5] | [
  {
    "role": "assistant",
    "parts": [
      {
        "type": "text",
        "content": "The weather in Paris is currently rainy with a temperature of 57°F."
      }
    ],
    "finish_reason": "stop"
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | | `gen_ai.output.type` | string | Represents the content type requested by the client. [6] | `text`; `json`; `image` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | @@ -220,6 +220,25 @@ by summing different token types parsed from the provider output. --- +`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | +| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -311,39 +330,3 @@ by summing different token types parsed from the provider output. | `output` | Output tokens (completion, response, etc.) | ![Development](https://img.shields.io/badge/-development-blue) |
- -## Deprecated OpenAI GenAI Attributes - -Describes deprecated `gen_ai.openai` attributes. - -
-Deprecated Attributes: - -| Key | Value Type | Description | Example Values | Deprecation Explanation | -| --- | --- | --- | --- | --- | -| `gen_ai.openai.request.response_format` | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | Replaced by `gen_ai.output.type`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.request.seed` | int | Deprecated, use `gen_ai.request.seed`. | `100` | Replaced by `gen_ai.request.seed`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.request.service_tier` | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | Replaced by `openai.request.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.response.service_tier` | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | Replaced by `openai.response.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.response.system_fingerprint` | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | Replaced by `openai.response.system_fingerprint`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | - ---- - -`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | -| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | - -
diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index dce0873d70..91ceb5ab36 100644 --- a/docs/registry/attributes/geo.md +++ b/docs/registry/attributes/geo.md @@ -5,9 +5,6 @@ ## Geo Attributes -Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. -Note: Geo attributes are typically used under another namespace, such as client.* and describe the location of the corresponding entity (device, end-user, etc). Semantic conventions that reference geo attributes (as a root namespace) or embed them (under their own namespace) SHOULD document what geo attributes describe in the scope of that convention. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/go.md b/docs/registry/attributes/go.md index 1fc98e772d..c113d21e08 100644 --- a/docs/registry/attributes/go.md +++ b/docs/registry/attributes/go.md @@ -5,8 +5,6 @@ ## Go Attributes -This document defines Go related attributes. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/graphql.md b/docs/registry/attributes/graphql.md index d5b010ba21..3f8eab0b67 100644 --- a/docs/registry/attributes/graphql.md +++ b/docs/registry/attributes/graphql.md @@ -5,8 +5,6 @@ ## GraphQL Attributes -This document defines attributes for GraphQL. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/heroku.md b/docs/registry/attributes/heroku.md index 5c48540911..5a92e0b372 100644 --- a/docs/registry/attributes/heroku.md +++ b/docs/registry/attributes/heroku.md @@ -5,8 +5,6 @@ ## Heroku Attributes -This document defines attributes for the Heroku platform on which application/s are running. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/host.md b/docs/registry/attributes/host.md index 48b3a419ef..da6c63f1d0 100644 --- a/docs/registry/attributes/host.md +++ b/docs/registry/attributes/host.md @@ -5,8 +5,6 @@ ## Host Attributes -A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 7a81a78102..4f890869eb 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -5,8 +5,6 @@ ## HTTP Attributes -This document defines semantic convention attributes in the HTTP namespace. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/hw.md b/docs/registry/attributes/hw.md new file mode 100644 index 0000000000..e3279bf815 --- /dev/null +++ b/docs/registry/attributes/hw.md @@ -0,0 +1,135 @@ + + + +# Hw + +## Hw Attributes + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `hw.battery.capacity` | ![Development](https://img.shields.io/badge/-development-blue) | string | Design capacity in Watts-hours or Ampere-hours | `9.3Ah`; `50Wh` | +| `hw.battery.chemistry` | ![Development](https://img.shields.io/badge/-development-blue) | string | Battery [chemistry](https://schemas.dmtf.org/wbem/cim-html/2.31.0/CIM_Battery.html), e.g. Lithium-Ion, Nickel-Cadmium, etc. | `Li-ion`; `NiMH` | +| `hw.battery.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The current state of the battery | `charging`; `discharging` | +| `hw.bios_version` | ![Development](https://img.shields.io/badge/-development-blue) | string | BIOS version of the hardware component | `1.2.3` | +| `hw.driver_version` | ![Development](https://img.shields.io/badge/-development-blue) | string | Driver version for the hardware component | `10.2.1-3` | +| `hw.enclosure.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the enclosure (useful for modular systems) | `Computer`; `Storage`; `Switch` | +| `hw.firmware_version` | ![Development](https://img.shields.io/badge/-development-blue) | string | Firmware version of the hardware component | `2.0.1` | +| `hw.gpu.task` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of task the GPU is performing | `decoder`; `encoder`; `general` | +| `hw.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | +| `hw.limit_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of limit for hardware components | `critical`; `degraded`; `high.critical` | +| `hw.logical_disk.raid_level` | ![Development](https://img.shields.io/badge/-development-blue) | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | +| `hw.logical_disk.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | State of the logical disk space usage | `used`; `free` | +| `hw.memory.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the memory module | `DDR4`; `DDR5`; `LPDDR5` | +| `hw.model` | ![Development](https://img.shields.io/badge/-development-blue) | string | Descriptive model name of the hardware component | `PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery` | +| `hw.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | An easily-recognizable name for the hardware component | `eth0` | +| `hw.network.logical_addresses` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Logical addresses of the adapter (e.g. IP address, or WWPN) | `["172.16.8.21", "57.11.193.42"]` | +| `hw.network.physical_address` | ![Development](https://img.shields.io/badge/-development-blue) | string | Physical address of the adapter (e.g. MAC address, or WWNN) | `00-90-F5-E9-7B-36` | +| `hw.parent` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) | `dellStorage_perc_0` | +| `hw.physical_disk.smart_attribute` | ![Development](https://img.shields.io/badge/-development-blue) | string | [S.M.A.R.T.](https://wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis, and Reporting Technology) attribute of the physical disk | `Spin Retry Count`; `Seek Error Rate`; `Raw Read Error Rate` | +| `hw.physical_disk.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | State of the physical disk endurance utilization | `remaining` | +| `hw.physical_disk.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the physical disk | `HDD`; `SSD`; `10K` | +| `hw.sensor_location` | ![Development](https://img.shields.io/badge/-development-blue) | string | Location of the sensor | `cpu0`; `ps1`; `INLET`; `CPU0_DIE`; `AMBIENT`; `MOTHERBOARD`; `PS0 V3_3`; `MAIN_12V`; `CPU_VCORE` | +| `hw.serial_number` | ![Development](https://img.shields.io/badge/-development-blue) | string | Serial number of the hardware component | `CNFCP0123456789` | +| `hw.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The current state of the component | `degraded`; `failed`; `needs_cleaning` | +| `hw.tape_drive.operation_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of tape drive operation | `mount`; `unmount`; `clean` | +| `hw.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | +| `hw.vendor` | ![Development](https://img.shields.io/badge/-development-blue) | string | Vendor name of the hardware component | `Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo` | + +**[1] `hw.type`:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. + +--- + +`hw.battery.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `charging` | Charging | ![Development](https://img.shields.io/badge/-development-blue) | +| `discharging` | Discharging | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.gpu.task` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `decoder` | Decoder | ![Development](https://img.shields.io/badge/-development-blue) | +| `encoder` | Encoder | ![Development](https://img.shields.io/badge/-development-blue) | +| `general` | General | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.limit_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `critical` | Critical | ![Development](https://img.shields.io/badge/-development-blue) | +| `degraded` | Degraded | ![Development](https://img.shields.io/badge/-development-blue) | +| `high.critical` | High Critical | ![Development](https://img.shields.io/badge/-development-blue) | +| `high.degraded` | High Degraded | ![Development](https://img.shields.io/badge/-development-blue) | +| `low.critical` | Low Critical | ![Development](https://img.shields.io/badge/-development-blue) | +| `low.degraded` | Low Degraded | ![Development](https://img.shields.io/badge/-development-blue) | +| `max` | Maximum | ![Development](https://img.shields.io/badge/-development-blue) | +| `throttled` | Throttled | ![Development](https://img.shields.io/badge/-development-blue) | +| `turbo` | Turbo | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.logical_disk.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `free` | Free | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | Used | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.physical_disk.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `remaining` | Remaining | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `degraded` | Degraded | ![Development](https://img.shields.io/badge/-development-blue) | +| `failed` | Failed | ![Development](https://img.shields.io/badge/-development-blue) | +| `needs_cleaning` | Needs Cleaning | ![Development](https://img.shields.io/badge/-development-blue) | +| `ok` | OK | ![Development](https://img.shields.io/badge/-development-blue) | +| `predicted_failure` | Predicted Failure | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.tape_drive.operation_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `clean` | Clean | ![Development](https://img.shields.io/badge/-development-blue) | +| `mount` | Mount | ![Development](https://img.shields.io/badge/-development-blue) | +| `unmount` | Unmount | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `battery` | Battery | ![Development](https://img.shields.io/badge/-development-blue) | +| `cpu` | CPU | ![Development](https://img.shields.io/badge/-development-blue) | +| `disk_controller` | Disk controller | ![Development](https://img.shields.io/badge/-development-blue) | +| `enclosure` | Enclosure | ![Development](https://img.shields.io/badge/-development-blue) | +| `fan` | Fan | ![Development](https://img.shields.io/badge/-development-blue) | +| `gpu` | GPU | ![Development](https://img.shields.io/badge/-development-blue) | +| `logical_disk` | Logical disk | ![Development](https://img.shields.io/badge/-development-blue) | +| `memory` | Memory | ![Development](https://img.shields.io/badge/-development-blue) | +| `network` | Network | ![Development](https://img.shields.io/badge/-development-blue) | +| `physical_disk` | Physical disk | ![Development](https://img.shields.io/badge/-development-blue) | +| `power_supply` | Power supply | ![Development](https://img.shields.io/badge/-development-blue) | +| `tape_drive` | Tape drive | ![Development](https://img.shields.io/badge/-development-blue) | +| `temperature` | Temperature | ![Development](https://img.shields.io/badge/-development-blue) | +| `voltage` | Voltage | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index fb10d79f23..5cc6289ffc 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -5,8 +5,6 @@ ## iOS Attributes -This group describes iOS-specific attributes. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/jsonrpc.md b/docs/registry/attributes/jsonrpc.md index 913af5567f..422a216451 100644 --- a/docs/registry/attributes/jsonrpc.md +++ b/docs/registry/attributes/jsonrpc.md @@ -3,9 +3,7 @@ # JSONRPC -## JSON-RPC Attributes - -This document defines attributes for JSON-RPC. +## JSONRPC Attributes **Attributes:** diff --git a/docs/registry/attributes/jvm.md b/docs/registry/attributes/jvm.md index 5e44099ed0..23e01726a5 100644 --- a/docs/registry/attributes/jvm.md +++ b/docs/registry/attributes/jvm.md @@ -3,9 +3,7 @@ # JVM -## Java Virtual Machine (JVM) Attributes - -This document defines Java Virtual machine related attributes. +## JVM Attributes **Attributes:** diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index c0f4940675..ff36adf032 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -3,9 +3,7 @@ # K8s -## Kubernetes Attributes - -Kubernetes resource attributes. +## K8s Attributes **Attributes:** diff --git a/docs/registry/attributes/linux.md b/docs/registry/attributes/linux.md index e05458a93e..1029a7e5e1 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -3,9 +3,7 @@ # Linux -## Deprecated Linux Attributes - -Deprecated Linux attributes. +## Linux Attributes
Deprecated Attributes: diff --git a/docs/registry/attributes/log.md b/docs/registry/attributes/log.md index c4e59774a4..d03bdff2e8 100644 --- a/docs/registry/attributes/log.md +++ b/docs/registry/attributes/log.md @@ -3,32 +3,7 @@ # Log -- [General Log Attributes](#general-log-attributes) -- [Log File Attributes](#log-file-attributes) -- [Log Record Attributes](#log-record-attributes) - -## General Log Attributes - -This document defines log attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `log.iostream` | ![Development](https://img.shields.io/badge/-development-blue) | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | - ---- - -`log.iostream` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `stderr` | Events from stderr stream | ![Development](https://img.shields.io/badge/-development-blue) | -| `stdout` | Logs from stdout stream | ![Development](https://img.shields.io/badge/-development-blue) | - -## Log File Attributes - -Attributes for a file to which log was emitted. +## Log Attributes **Attributes:** @@ -38,15 +13,7 @@ Attributes for a file to which log was emitted. | `log.file.name_resolved` | ![Development](https://img.shields.io/badge/-development-blue) | string | The basename of the file, with symlinks resolved. | `uuid.log` | | `log.file.path` | ![Development](https://img.shields.io/badge/-development-blue) | string | The full path to the file. | `/var/log/mysql/audit.log` | | `log.file.path_resolved` | ![Development](https://img.shields.io/badge/-development-blue) | string | The full path to the file, with symlinks resolved. | `/var/lib/docker/uuid.log` | - -## Log Record Attributes - -This document defines the generic attributes that may be used in any Log Record. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | +| `log.iostream` | ![Development](https://img.shields.io/badge/-development-blue) | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | | `log.record.original` | ![Development](https://img.shields.io/badge/-development-blue) | string | The complete original Log Record. [1] | `77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - - Something happened`; `[INFO] 8/3/24 12:34:56 Something happened` | | `log.record.uid` | ![Development](https://img.shields.io/badge/-development-blue) | string | A unique identifier for the Log Record. [2] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | @@ -54,3 +21,12 @@ This document defines the generic attributes that may be used in any Log Record. **[2] `log.record.uid`:** 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. + +--- + +`log.iostream` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `stderr` | Events from stderr stream | ![Development](https://img.shields.io/badge/-development-blue) | +| `stdout` | Logs from stdout stream | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/mainframe.md b/docs/registry/attributes/mainframe.md index ef2153a794..033ff5efb4 100644 --- a/docs/registry/attributes/mainframe.md +++ b/docs/registry/attributes/mainframe.md @@ -3,9 +3,7 @@ # Mainframe -## Mainframe LPAR attributes - -This document defines attributes of a Mainframe Logical Partition (LPAR). +## Mainframe Attributes **Attributes:** diff --git a/docs/registry/attributes/mcp.md b/docs/registry/attributes/mcp.md index b497677fa0..9fedf7ec66 100644 --- a/docs/registry/attributes/mcp.md +++ b/docs/registry/attributes/mcp.md @@ -3,9 +3,7 @@ # MCP -## MCP Attributes (Moved) - -[Model Context Protocol (MCP)](https://modelcontextprotocol.io) attributes have moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). +## MCP Attributes
Deprecated Attributes: diff --git a/docs/registry/attributes/message.md b/docs/registry/attributes/message.md new file mode 100644 index 0000000000..ed12472246 --- /dev/null +++ b/docs/registry/attributes/message.md @@ -0,0 +1,27 @@ + + + +# Message + +## Message Attributes + +
+Deprecated Attributes: + +| Key | Value Type | Description | Example Values | Deprecation Explanation | +| --- | --- | --- | --- | --- | +| `message.compressed_size` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | +| `message.id` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | +| `message.type` | string | Deprecated, no replacement at this time. | `SENT`; `RECEIVED` | Deprecated, no replacement at this time. | +| `message.uncompressed_size` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | + +--- + +`message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `RECEIVED` | received | ![Development](https://img.shields.io/badge/-development-blue) | +| `SENT` | sent | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 6cfe1be7ad..b32bf4658f 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -3,17 +3,7 @@ # Messaging -- [General Messaging Attributes](#general-messaging-attributes) -- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) -- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) -- [Kafka Attributes](#kafka-attributes) -- [RabbitMQ Attributes](#rabbitmq-attributes) -- [RocketMQ Attributes](#rocketmq-attributes) -- [Azure Service Bus Attributes](#azure-service-bus-attributes) - -## General Messaging Attributes - -Attributes describing telemetry around messaging systems and messaging activities. +## Messaging Attributes **Attributes:** @@ -28,13 +18,34 @@ Attributes describing telemetry around messaging systems and messaging activitie | `messaging.destination.subscription.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination subscription from which a message is consumed. [4] | `subscription-a` | | `messaging.destination.template` | ![Development](https://img.shields.io/badge/-development-blue) | string | Low cardinality representation of the messaging destination name [5] | `/customers/{customerId}` | | `messaging.destination.temporary` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | | -| `messaging.message.body.size` | ![Development](https://img.shields.io/badge/-development-blue) | int | The size of the message body in bytes. [6] | `1439` | +| `messaging.eventhubs.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | +| `messaging.gcp_pubsub.message.ack_deadline` | ![Development](https://img.shields.io/badge/-development-blue) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | +| `messaging.gcp_pubsub.message.ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ack id for a given message. | `ack_id` | +| `messaging.gcp_pubsub.message.delivery_attempt` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delivery attempt for a given message. | `2` | +| `messaging.gcp_pubsub.message.ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | +| `messaging.kafka.message.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [6] | `myKey` | +| `messaging.kafka.message.tombstone` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | A boolean that is true if the message is a tombstone. | | +| `messaging.kafka.offset` | ![Development](https://img.shields.io/badge/-development-blue) | int | The offset of a record in the corresponding Kafka partition. | `42` | +| `messaging.message.body.size` | ![Development](https://img.shields.io/badge/-development-blue) | int | The size of the message body in bytes. [7] | `1439` | | `messaging.message.conversation_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | -| `messaging.message.envelope.size` | ![Development](https://img.shields.io/badge/-development-blue) | int | The size of the message body and metadata in bytes. [7] | `2738` | +| `messaging.message.envelope.size` | ![Development](https://img.shields.io/badge/-development-blue) | int | The size of the message body and metadata in bytes. [8] | `2738` | | `messaging.message.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | `messaging.operation.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | -| `messaging.operation.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | A string identifying the type of the messaging operation. [8] | `create`; `send`; `receive` | -| `messaging.system` | ![Development](https://img.shields.io/badge/-development-blue) | string | The messaging system as identified by the client instrumentation. [9] | `activemq`; `aws.sns`; `aws_sqs` | +| `messaging.operation.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | A string identifying the type of the messaging operation. [9] | `create`; `send`; `receive` | +| `messaging.rabbitmq.destination.routing_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | RabbitMQ message routing key. | `myKey` | +| `messaging.rabbitmq.message.delivery_tag` | ![Development](https://img.shields.io/badge/-development-blue) | int | RabbitMQ message delivery tag | `123` | +| `messaging.rocketmq.consumption_model` | ![Development](https://img.shields.io/badge/-development-blue) | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | +| `messaging.rocketmq.message.delay_time_level` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delay time level for delay message, which determines the message delay time. | `3` | +| `messaging.rocketmq.message.delivery_timestamp` | ![Development](https://img.shields.io/badge/-development-blue) | int | The timestamp in milliseconds that the delay message is expected to be delivered to consumer. | `1665987217045` | +| `messaging.rocketmq.message.group` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `myMessageGroup` | +| `messaging.rocketmq.message.keys` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Key(s) of message, another way to mark message besides message id. | `["keyA", "keyB"]` | +| `messaging.rocketmq.message.tag` | ![Development](https://img.shields.io/badge/-development-blue) | string | The secondary classifier of message besides topic. | `tagA` | +| `messaging.rocketmq.message.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of message. | `normal`; `fifo`; `delay` | +| `messaging.rocketmq.namespace` | ![Development](https://img.shields.io/badge/-development-blue) | string | Namespace of RocketMQ resources, resources in different namespaces are individual. | `myNamespace` | +| `messaging.servicebus.disposition_status` | ![Development](https://img.shields.io/badge/-development-blue) | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | +| `messaging.servicebus.message.delivery_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | Number of deliveries that have been attempted for this message. | `2` | +| `messaging.servicebus.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | +| `messaging.system` | ![Development](https://img.shields.io/badge/-development-blue) | string | The messaging system as identified by the client instrumentation. [10] | `activemq`; `aws.sns`; `aws_sqs` | **[1] `messaging.batch.message_count`:** 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. @@ -47,15 +58,17 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi **[5] `messaging.destination.template`:** 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. -**[6] `messaging.message.body.size`:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed +**[6] `messaging.kafka.message.key`:** 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. + +**[7] `messaging.message.body.size`:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed body size should be used. -**[7] `messaging.message.envelope.size`:** This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed +**[8] `messaging.message.envelope.size`:** This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed size should be used. -**[8] `messaging.operation.type`:** If a custom value is used, it MUST be of low cardinality. +**[9] `messaging.operation.type`:** If a custom value is used, it MUST be of low cardinality. -**[9] `messaging.system`:** 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. +**[10] `messaging.system`:** 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. --- @@ -71,6 +84,37 @@ size should be used. --- +`messaging.rocketmq.consumption_model` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `broadcasting` | Broadcasting consumption model | ![Development](https://img.shields.io/badge/-development-blue) | +| `clustering` | Clustering consumption model | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`messaging.rocketmq.message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `delay` | Delay message | ![Development](https://img.shields.io/badge/-development-blue) | +| `fifo` | FIFO message | ![Development](https://img.shields.io/badge/-development-blue) | +| `normal` | Normal message | ![Development](https://img.shields.io/badge/-development-blue) | +| `transaction` | Transaction message | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`messaging.servicebus.disposition_status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `abandon` | Message is abandoned | ![Development](https://img.shields.io/badge/-development-blue) | +| `complete` | Message is completed | ![Development](https://img.shields.io/badge/-development-blue) | +| `dead_letter` | Message is sent to dead letter queue | ![Development](https://img.shields.io/badge/-development-blue) | +| `defer` | Message is deferred | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -93,7 +137,6 @@ size should be used. | Key | Value Type | Description | Example Values | Deprecation Explanation | | --- | --- | --- | --- | --- | -| `messaging.client_id` | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | Use `messaging.client.id` instead. | | `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | | `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | | `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | @@ -105,111 +148,3 @@ size should be used. | `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. |
- -## Azure Event Hubs Attributes - -This group describes attributes specific to Azure Event Hubs. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `messaging.eventhubs.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | - -## GCP Pub/Sub Attributes - -This group describes attributes specific to GCP Pub/Sub. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `messaging.gcp_pubsub.message.ack_deadline` | ![Development](https://img.shields.io/badge/-development-blue) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | -| `messaging.gcp_pubsub.message.ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ack id for a given message. | `ack_id` | -| `messaging.gcp_pubsub.message.delivery_attempt` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delivery attempt for a given message. | `2` | -| `messaging.gcp_pubsub.message.ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | - -## Kafka Attributes - -This group describes attributes specific to Apache Kafka. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `messaging.kafka.message.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [10] | `myKey` | -| `messaging.kafka.message.tombstone` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | A boolean that is true if the message is a tombstone. | | -| `messaging.kafka.offset` | ![Development](https://img.shields.io/badge/-development-blue) | int | The offset of a record in the corresponding Kafka partition. | `42` | - -**[10] `messaging.kafka.message.key`:** 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. - -## RabbitMQ Attributes - -This group describes attributes specific to RabbitMQ. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `messaging.rabbitmq.destination.routing_key` | ![Development](https://img.shields.io/badge/-development-blue) | string | RabbitMQ message routing key. | `myKey` | -| `messaging.rabbitmq.message.delivery_tag` | ![Development](https://img.shields.io/badge/-development-blue) | int | RabbitMQ message delivery tag | `123` | - -## RocketMQ Attributes - -This group describes attributes specific to RocketMQ. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `messaging.rocketmq.consumption_model` | ![Development](https://img.shields.io/badge/-development-blue) | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | -| `messaging.rocketmq.message.delay_time_level` | ![Development](https://img.shields.io/badge/-development-blue) | int | The delay time level for delay message, which determines the message delay time. | `3` | -| `messaging.rocketmq.message.delivery_timestamp` | ![Development](https://img.shields.io/badge/-development-blue) | int | The timestamp in milliseconds that the delay message is expected to be delivered to consumer. | `1665987217045` | -| `messaging.rocketmq.message.group` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `myMessageGroup` | -| `messaging.rocketmq.message.keys` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Key(s) of message, another way to mark message besides message id. | `["keyA", "keyB"]` | -| `messaging.rocketmq.message.tag` | ![Development](https://img.shields.io/badge/-development-blue) | string | The secondary classifier of message besides topic. | `tagA` | -| `messaging.rocketmq.message.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of message. | `normal`; `fifo`; `delay` | -| `messaging.rocketmq.namespace` | ![Development](https://img.shields.io/badge/-development-blue) | string | Namespace of RocketMQ resources, resources in different namespaces are individual. | `myNamespace` | - ---- - -`messaging.rocketmq.consumption_model` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `broadcasting` | Broadcasting consumption model | ![Development](https://img.shields.io/badge/-development-blue) | -| `clustering` | Clustering consumption model | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`messaging.rocketmq.message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `delay` | Delay message | ![Development](https://img.shields.io/badge/-development-blue) | -| `fifo` | FIFO message | ![Development](https://img.shields.io/badge/-development-blue) | -| `normal` | Normal message | ![Development](https://img.shields.io/badge/-development-blue) | -| `transaction` | Transaction message | ![Development](https://img.shields.io/badge/-development-blue) | - -## Azure Service Bus Attributes - -This group describes attributes specific to Azure Service Bus. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `messaging.servicebus.disposition_status` | ![Development](https://img.shields.io/badge/-development-blue) | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | -| `messaging.servicebus.message.delivery_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | Number of deliveries that have been attempted for this message. | `2` | -| `messaging.servicebus.message.enqueued_time` | ![Development](https://img.shields.io/badge/-development-blue) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | - ---- - -`messaging.servicebus.disposition_status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `abandon` | Message is abandoned | ![Development](https://img.shields.io/badge/-development-blue) | -| `complete` | Message is completed | ![Development](https://img.shields.io/badge/-development-blue) | -| `dead_letter` | Message is sent to dead letter queue | ![Development](https://img.shields.io/badge/-development-blue) | -| `defer` | Message is deferred | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/net.md b/docs/registry/attributes/net.md new file mode 100644 index 0000000000..846300ea5f --- /dev/null +++ b/docs/registry/attributes/net.md @@ -0,0 +1,53 @@ + + + +# Net + +## Net Attributes + +
+Deprecated Attributes: + +| Key | Value Type | Description | Example Values | Deprecation Explanation | +| --- | --- | --- | --- | --- | +| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | +| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | +| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | Use `server.port` instead. | +| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | Use `network.peer.address` instead. | +| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | Replaced by `server.address` on client spans and `client.address` on server spans. | +| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | Replaced by `server.port` on client spans and `client.port` on server spans. | +| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | Use `network.protocol.name` instead. | +| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | Use `network.protocol.version` instead. | +| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | Split to `network.transport` and `network.type`. | +| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | Use `network.local.address` instead. | +| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | Use `network.local.port` instead. | +| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | Use `network.peer.address` instead. | +| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | Removed. No replacement at this time. | +| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | Use `network.peer.port` instead. | +| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | Use `network.transport` instead. | + +--- + +`net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `inet` | IPv4 address | ![Development](https://img.shields.io/badge/-development-blue) | +| `inet6` | IPv6 address | ![Development](https://img.shields.io/badge/-development-blue) | +| `unix` | Unix domain socket path | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `inproc` | In-process communication. [1] | ![Development](https://img.shields.io/badge/-development-blue) | +| `ip_tcp` | ip_tcp | ![Development](https://img.shields.io/badge/-development-blue) | +| `ip_udp` | ip_udp | ![Development](https://img.shields.io/badge/-development-blue) | +| `other` | Something else (non IP-based). | ![Development](https://img.shields.io/badge/-development-blue) | +| `pipe` | Named or anonymous pipe. | ![Development](https://img.shields.io/badge/-development-blue) | + +**[1]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case. + +
diff --git a/docs/registry/attributes/network.md b/docs/registry/attributes/network.md index dd6dcc59f7..1d61b30241 100644 --- a/docs/registry/attributes/network.md +++ b/docs/registry/attributes/network.md @@ -5,8 +5,6 @@ ## Network Attributes -These attributes may be used for any network related operation. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | @@ -130,50 +128,3 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | --- | --- | --- | | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - -
-Deprecated Attributes: - -| Key | Value Type | Description | Example Values | Deprecation Explanation | -| --- | --- | --- | --- | --- | -| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | -| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | -| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | Use `server.port` instead. | -| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | Use `network.peer.address` instead. | -| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | Replaced by `server.address` on client spans and `client.address` on server spans. | -| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | Replaced by `server.port` on client spans and `client.port` on server spans. | -| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | Use `network.protocol.name` instead. | -| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | Use `network.protocol.version` instead. | -| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | Split to `network.transport` and `network.type`. | -| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | Use `network.local.address` instead. | -| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | Use `network.local.port` instead. | -| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | Use `network.peer.address` instead. | -| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | Removed. No replacement at this time. | -| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | Use `network.peer.port` instead. | -| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | Use `network.transport` instead. | - ---- - -`net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `inet` | IPv4 address | ![Development](https://img.shields.io/badge/-development-blue) | -| `inet6` | IPv6 address | ![Development](https://img.shields.io/badge/-development-blue) | -| `unix` | Unix domain socket path | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `inproc` | In-process communication. [1] | ![Development](https://img.shields.io/badge/-development-blue) | -| `ip_tcp` | ip_tcp | ![Development](https://img.shields.io/badge/-development-blue) | -| `ip_udp` | ip_udp | ![Development](https://img.shields.io/badge/-development-blue) | -| `other` | Something else (non IP-based). | ![Development](https://img.shields.io/badge/-development-blue) | -| `pipe` | Named or anonymous pipe. | ![Development](https://img.shields.io/badge/-development-blue) | - -**[1]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case. - -
diff --git a/docs/registry/attributes/nfs.md b/docs/registry/attributes/nfs.md index c937f03040..4472fcbc69 100644 --- a/docs/registry/attributes/nfs.md +++ b/docs/registry/attributes/nfs.md @@ -5,8 +5,6 @@ ## NFS Attributes -Describes NFS Attributes - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/nodejs.md b/docs/registry/attributes/nodejs.md index 701764eb0b..21a4ff10d2 100644 --- a/docs/registry/attributes/nodejs.md +++ b/docs/registry/attributes/nodejs.md @@ -3,9 +3,7 @@ # NodeJS -## Node.js Attributes - -Describes Node.js related attributes. +## NodeJS Attributes **Attributes:** diff --git a/docs/registry/attributes/oci.md b/docs/registry/attributes/oci.md index d7ed43c3e2..f5a955912e 100644 --- a/docs/registry/attributes/oci.md +++ b/docs/registry/attributes/oci.md @@ -3,9 +3,7 @@ # OCI -## Open Container Initiative (OCI) Attributes - -An OCI image manifest. +## OCI Attributes **Attributes:** diff --git a/docs/registry/attributes/onc-rpc.md b/docs/registry/attributes/onc-rpc.md index fb04afa82c..fd223bab20 100644 --- a/docs/registry/attributes/onc-rpc.md +++ b/docs/registry/attributes/onc-rpc.md @@ -3,9 +3,7 @@ # ONC RPC -## ONC RPC (Sun RPC) attributes - -This document defines attributes for [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) +## ONC RPC Attributes **Attributes:** diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index f7343c0680..7fd81ff867 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -3,9 +3,7 @@ # OpenAI -## OpenAI Attributes (Moved) - -OpenAI attributes have moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). +## OpenAI Attributes
Deprecated Attributes: diff --git a/docs/registry/attributes/openshift.md b/docs/registry/attributes/openshift.md index 927b4af3e0..065f40ecf7 100644 --- a/docs/registry/attributes/openshift.md +++ b/docs/registry/attributes/openshift.md @@ -5,8 +5,6 @@ ## Openshift Attributes -OpenShift resource attributes. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/opentracing.md b/docs/registry/attributes/opentracing.md index 93fde5c7cc..bf37018b83 100644 --- a/docs/registry/attributes/opentracing.md +++ b/docs/registry/attributes/opentracing.md @@ -5,8 +5,6 @@ ## OpenTracing Attributes -Attributes used by the OpenTracing Shim layer. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/oracle-cloud.md b/docs/registry/attributes/oracle-cloud.md index c2e8bdf719..736eb87720 100644 --- a/docs/registry/attributes/oracle-cloud.md +++ b/docs/registry/attributes/oracle-cloud.md @@ -3,9 +3,7 @@ # Oracle cloud -## General Oracle Cloud Attributes - -This section defines generic attributes for Oracle Cloud Infrastructure (OCI). +## Oracle Cloud Attributes **Attributes:** diff --git a/docs/registry/attributes/oracle.md b/docs/registry/attributes/oracle.md new file mode 100644 index 0000000000..55fcd1687d --- /dev/null +++ b/docs/registry/attributes/oracle.md @@ -0,0 +1,39 @@ + + + +# Oracle + +## Oracle Attributes + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `oracle.db.domain` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The database domain associated with the connection. [1] | `example.com`; `corp.internal`; `prod.db.local` | +| `oracle.db.instance.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [2] | `ORCL1`; `ORCL2`; `ORCL3` | +| `oracle.db.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The database name associated with the connection. [3] | `ORCL1`; `FREE` | +| `oracle.db.pdb` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The pluggable database (PDB) name associated with the connection. [4] | `PDB1`; `FREEPDB` | +| `oracle.db.service` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The service name currently associated with the database connection. [5] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | + +**[1] `oracle.db.domain`:** This attribute SHOULD be set to the value of the `DB_DOMAIN` initialization parameter, +as exposed in `v$parameter`. `DB_DOMAIN` defines the domain portion of the global +database name and SHOULD be configured when a database is, or may become, part of a +distributed environment. Its value consists of one or more valid identifiers +(alphanumeric ASCII characters) separated by periods. + +**[2] `oracle.db.instance.name`:** There can be multiple instances associated with a single database service. It indicates the +unique instance name to which the connection is currently bound. For non-RAC databases, this value +defaults to the `oracle.db.name`. + +**[3] `oracle.db.name`:** This attribute SHOULD be set to the value of the parameter `DB_NAME` exposed in `v$parameter`. + +**[4] `oracle.db.pdb`:** This attribute SHOULD reflect the PDB that the session is currently connected to. +If instrumentation cannot reliably obtain the active PDB name for each operation +without issuing an additional query (such as `SELECT SYS_CONTEXT`), it is +RECOMMENDED to fall back to the PDB name specified at connection establishment. + +**[5] `oracle.db.service`:** The effective service name for a connection can change during its lifetime, +for example after executing sql, `ALTER SESSION`. If an instrumentation cannot reliably +obtain the current service name for each operation without issuing an additional +query (such as `SELECT SYS_CONTEXT`), it is RECOMMENDED to fall back to the +service name originally provided at connection establishment. diff --git a/docs/registry/attributes/os.md b/docs/registry/attributes/os.md index 0f42a5487a..20c5120cad 100644 --- a/docs/registry/attributes/os.md +++ b/docs/registry/attributes/os.md @@ -3,9 +3,7 @@ # OS -## Operating System Attributes - -The operating system (OS) on which the process represented by this resource is running. +## OS Attributes **Attributes:** diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index 5831d97b96..af28cffc7d 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -3,65 +3,23 @@ # OTel -- [OTel Attributes](#otel-attributes) -- [OTel Component Attributes](#otel-component-attributes) -- [OTel Event Attributes](#otel-event-attributes) -- [OTel Scope Attributes](#otel-scope-attributes) -- [Deprecated OTel Library Attributes](#deprecated-otel-library-attributes) - ## OTel Attributes -Attributes reserved for OpenTelemetry - **Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | +| `otel.component.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | +| `otel.component.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | A name identifying the type of the OpenTelemetry component. [2] | `batching_span_processor`; `com.example.MySpanExporter` | +| `otel.event.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Identifies the class / type of event. [3] | `browser.mouse.click`; `device.app.lifecycle` | +| `otel.scope.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | +| `otel.scope.schema_url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | +| `otel.scope.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | | `otel.span.parent.origin` | ![Development](https://img.shields.io/badge/-development-blue) | string | Determines whether the span has a parent span, and if so, [whether it is a remote parent](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) | `none`; `local`; `remote` | | `otel.span.sampling_result` | ![Development](https://img.shields.io/badge/-development-blue) | string | The result value of the sampler for this span | `DROP`; `RECORD_ONLY`; `RECORD_AND_SAMPLE` | | `otel.status_code` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. | `OK`; `ERROR` | | `otel.status_description` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Description of the Status if it has a value, otherwise not set. | `resource not found` | ---- - -`otel.span.parent.origin` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `local` | The span has a parent and the parent's span context [isRemote()](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) is false | ![Development](https://img.shields.io/badge/-development-blue) | -| `none` | The span does not have a parent, it is a root span | ![Development](https://img.shields.io/badge/-development-blue) | -| `remote` | The span has a parent and the parent's span context [isRemote()](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) is true | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`otel.span.sampling_result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `DROP` | The span is not sampled and not recording | ![Development](https://img.shields.io/badge/-development-blue) | -| `RECORD_AND_SAMPLE` | The span is sampled and recording | ![Development](https://img.shields.io/badge/-development-blue) | -| `RECORD_ONLY` | The span is not sampled, but recording | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`otel.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `ERROR` | The operation contains an error. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - -## OTel Component Attributes - -Attributes used for OpenTelemetry component self-monitoring - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `otel.component.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | -| `otel.component.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | A name identifying the type of the OpenTelemetry component. [2] | `batching_span_processor`; `com.example.MySpanExporter` | - **[1] `otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts. E.g. implementations MUST NOT use UUIDs as values for this attribute. @@ -79,6 +37,8 @@ These values will therefore be reused in the case of an application restart. **[2] `otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type. E.g. for Java the fully qualified classname SHOULD be used in this case. +**[3] `otel.event.name`:** This attribute SHOULD be used by non-OTLP exporters when destination does not support `EventName` or equivalent field. This attribute MAY be used by applications using existing logging libraries so that it can be used to set the `EventName` field by Collector or SDK components. + --- `otel.component.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -102,33 +62,34 @@ E.g. for Java the fully qualified classname SHOULD be used in this case. | `simple_span_processor` | The builtin SDK simple span processor | ![Development](https://img.shields.io/badge/-development-blue) | | `zipkin_http_span_exporter` | Zipkin span exporter over HTTP | ![Development](https://img.shields.io/badge/-development-blue) | -## OTel Event Attributes - -Attributes used by non-OTLP exporters to represent OpenTelemetry Event's concepts. - -**Attributes:** +--- -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `otel.event.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Identifies the class / type of event. [3] | `browser.mouse.click`; `device.app.lifecycle` | +`otel.span.parent.origin` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. -**[3] `otel.event.name`:** This attribute SHOULD be used by non-OTLP exporters when destination does not support `EventName` or equivalent field. This attribute MAY be used by applications using existing logging libraries so that it can be used to set the `EventName` field by Collector or SDK components. +| Value | Description | Stability | +| --- | --- | --- | +| `local` | The span has a parent and the parent's span context [isRemote()](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) is false | ![Development](https://img.shields.io/badge/-development-blue) | +| `none` | The span does not have a parent, it is a root span | ![Development](https://img.shields.io/badge/-development-blue) | +| `remote` | The span has a parent and the parent's span context [isRemote()](https://opentelemetry.io/docs/specs/otel/trace/api/#isremote) is true | ![Development](https://img.shields.io/badge/-development-blue) | -## OTel Scope Attributes +--- -Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. +`otel.span.sampling_result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. -**Attributes:** +| Value | Description | Stability | +| --- | --- | --- | +| `DROP` | The span is not sampled and not recording | ![Development](https://img.shields.io/badge/-development-blue) | +| `RECORD_AND_SAMPLE` | The span is sampled and recording | ![Development](https://img.shields.io/badge/-development-blue) | +| `RECORD_ONLY` | The span is not sampled, but recording | ![Development](https://img.shields.io/badge/-development-blue) | -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `otel.scope.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | -| `otel.scope.schema_url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | -| `otel.scope.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | +--- -## Deprecated OTel Library Attributes +`otel.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. -Describes deprecated otel.library attributes. +| Value | Description | Stability | +| --- | --- | --- | +| `ERROR` | The operation contains an error. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
Deprecated Attributes: diff --git a/docs/registry/attributes/other.md b/docs/registry/attributes/other.md new file mode 100644 index 0000000000..5382661bf5 --- /dev/null +++ b/docs/registry/attributes/other.md @@ -0,0 +1,24 @@ + + + +# Other + +## Other Attributes + +
+Deprecated Attributes: + +| Key | Value Type | Description | Example Values | Deprecation Explanation | +| --- | --- | --- | --- | --- | +| `state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | + +--- + +`state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/peer.md b/docs/registry/attributes/peer.md index 49ffeb9fb3..c330c7583f 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -5,8 +5,6 @@ ## Peer Attributes -These attribute may be used for any operation that accesses some remote service. -
Deprecated Attributes: diff --git a/docs/registry/attributes/pool.md b/docs/registry/attributes/pool.md new file mode 100644 index 0000000000..bd28a40dea --- /dev/null +++ b/docs/registry/attributes/pool.md @@ -0,0 +1,15 @@ + + + +# Pool + +## Pool Attributes + +
+Deprecated Attributes: + +| Key | Value Type | Description | Example Values | Deprecation Explanation | +| --- | --- | --- | --- | --- | +| `pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | + +
diff --git a/docs/registry/attributes/pprof.md b/docs/registry/attributes/pprof.md index 41698de201..0d67709106 100644 --- a/docs/registry/attributes/pprof.md +++ b/docs/registry/attributes/pprof.md @@ -3,9 +3,7 @@ # Pprof -## Pprof specific attributes for the Profiling signal - -Attributes specific to pprof that help convert from pprof to Profiling signal. +## Pprof Attributes **Attributes:** diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 27559d2991..692b9ae764 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -3,13 +3,8 @@ # Process -- [Process Attributes](#process-attributes) -- [Process Linux Attributes](#process-linux-attributes) - ## Process Attributes -An operating system process. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | @@ -30,6 +25,7 @@ An operating system process. | `process.exit.time` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The date and time the process exited, in ISO 8601 format. | `2023-11-21T09:26:12.315Z` | | `process.group_leader.pid` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | The PID of the process's group leader. This is also the process group ID (PGID) of the process. | `23` | | `process.interactive` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | boolean | Whether the process is connected to an interactive shell. | | +| `process.linux.cgroup` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The control group associated with the process. [4] | `1:name=systemd:/user.slice/user-1000.slice/session-3.scope`; `0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope` | | `process.owner` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The username of the user that owns the process. | `root` | | `process.parent_pid` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | Parent Process identifier (PPID). | `111` | | `process.pid` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | Process identifier (PID). | `1234` | @@ -42,10 +38,10 @@ An operating system process. | `process.saved_user.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The username of the saved user. | `operator` | | `process.session_leader.pid` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | The PID of the process's session leader. This is also the session ID (SID) of the process. | `14` | | `process.state` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | -| `process.title` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | Process title (proctitle) [4] | `cat /etc/hostname`; `xfce4-session`; `bash` | +| `process.title` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | Process title (proctitle) [5] | `cat /etc/hostname`; `xfce4-session`; `bash` | | `process.user.id` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | The effective user ID (EUID) of the process. | `1001` | | `process.user.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The username of the effective user of the process. | `root` | -| `process.vpid` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | Virtual process identifier. [5] | `12` | +| `process.vpid` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | int | Virtual process identifier. [6] | `12` | | `process.working_directory` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The working directory of the process. | `/root` | **[1] `process.args_count`:** This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. @@ -73,9 +69,11 @@ BuildID ← Digest[:16] The result is the first 16 bytes (128 bits) of the SHA256 digest, represented as a hex string. -**[4] `process.title`:** In many Unix-like systems, process title (proctitle), is the string that represents the name or command line of a running process, displayed by system monitoring tools like ps, top, and htop. +**[4] `process.linux.cgroup`:** Control groups (cgroups) are a kernel feature used to organize and manage process resources. This attribute provides the path(s) to the cgroup(s) associated with the process, which should match the contents of the [/proc/\[PID\]/cgroup](https://man7.org/linux/man-pages/man7/cgroups.7.html) file. + +**[5] `process.title`:** In many Unix-like systems, process title (proctitle), is the string that represents the name or command line of a running process, displayed by system monitoring tools like ps, top, and htop. -**[5] `process.vpid`:** 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. +**[6] `process.vpid`:** 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. --- @@ -102,22 +100,12 @@ represented as a hex string. | Key | Value Type | Description | Example Values | Deprecation Explanation | | --- | --- | --- | --- | --- | -| `process.context_switch_type` | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | Use `process.context_switch.type` instead. | | `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | Use `cpu.mode` instead. | | `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | Use `process.executable.build_id.htlhash` instead. | | `process.paging.fault_type` | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | Use `system.paging.fault.type` instead. | --- -`process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `involuntary` | involuntary | ![Development](https://img.shields.io/badge/-development-blue) | -| `voluntary` | voluntary | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - `process.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -136,15 +124,3 @@ represented as a hex string. | `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) |
- -## Process Linux Attributes - -Describes Linux Process attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `process.linux.cgroup` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The control group associated with the process. [6] | `1:name=systemd:/user.slice/user-1000.slice/session-3.scope`; `0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope` | - -**[6] `process.linux.cgroup`:** Control groups (cgroups) are a kernel feature used to organize and manage process resources. This attribute provides the path(s) to the cgroup(s) associated with the process, which should match the contents of the [/proc/\[PID\]/cgroup](https://man7.org/linux/man-pages/man7/cgroups.7.html) file. diff --git a/docs/registry/attributes/profile.md b/docs/registry/attributes/profile.md index 94bdfc85e3..2ac28d3de0 100644 --- a/docs/registry/attributes/profile.md +++ b/docs/registry/attributes/profile.md @@ -3,9 +3,7 @@ # Profile -## Profile Frame Attributes - -Describes the origin of a single frame in a Profile. +## Profile Attributes **Attributes:** diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 8226cd989f..1b79bc7a5d 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -3,9 +3,7 @@ # RPC -## Remote Procedure Call (RPC) Attributes - -This document defines attributes for remote procedure calls. +## RPC Attributes **Attributes:** @@ -75,10 +73,6 @@ Semantic conventions for individual RPC frameworks SHOULD document what `rpc.res | Key | Value Type | Description | Example Values | Deprecation Explanation | | --- | --- | --- | --- | --- | -| `message.compressed_size` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | -| `message.id` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | -| `message.type` | string | Deprecated, no replacement at this time. | `SENT`; `RECEIVED` | Deprecated, no replacement at this time. | -| `message.uncompressed_size` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | | `rpc.connect_rpc.error_code` | string | Deprecated, use `rpc.response.status_code` attribute instead. | `cancelled`; `unknown`; `invalid_argument` | Use `rpc.response.status_code` instead. | | `rpc.connect_rpc.request.metadata.` | string[] | Deprecated, use `rpc.request.metadata` instead. | `["1.2.3.4", "1.2.3.5"]` | Use `rpc.request.metadata` instead. | | `rpc.connect_rpc.response.metadata.` | string[] | Deprecated, use `rpc.response.metadata` instead. | `["attribute_value"]` | Use `rpc.response.metadata` instead. | @@ -100,15 +94,6 @@ Semantic conventions for individual RPC frameworks SHOULD document what `rpc.res --- -`message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `RECEIVED` | received | ![Development](https://img.shields.io/badge/-development-blue) | -| `SENT` | sent | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - `rpc.connect_rpc.error_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/registry/attributes/security-rule.md b/docs/registry/attributes/security-rule.md index 8c30ac856b..491913ea93 100644 --- a/docs/registry/attributes/security-rule.md +++ b/docs/registry/attributes/security-rule.md @@ -3,9 +3,7 @@ # Security rule -## Security Rule - -Describes security rule attributes. Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events. +## Security Rule Attributes **Attributes:** diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index 58f01891ad..9a7702de4b 100644 --- a/docs/registry/attributes/server.md +++ b/docs/registry/attributes/server.md @@ -5,8 +5,6 @@ ## Server Attributes -These attributes may be used to describe the server in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/service.md b/docs/registry/attributes/service.md index bd2ffe1b00..b369f6c4da 100644 --- a/docs/registry/attributes/service.md +++ b/docs/registry/attributes/service.md @@ -3,13 +3,8 @@ # Service -- [Service Attributes](#service-attributes) -- [Service Attributes for Peer Services](#service-attributes-for-peer-services) - ## Service Attributes -A service instance. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | @@ -18,6 +13,8 @@ A service instance. | `service.instance.id` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The string ID of the service instance. [2] | `627cc493-f310-47de-96bd-71410b7dec09` | | `service.name` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Logical name of the service. [3] | `shoppingcart` | | `service.namespace` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | A namespace for `service.name`. [4] | `Shop` | +| `service.peer.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Logical name of the service on the other side of the connection. SHOULD be equal to the actual [`service.name`](/docs/resource/README.md#service) resource attribute of the remote service if any. | `shoppingcart` | +| `service.peer.namespace` | ![Development](https://img.shields.io/badge/-development-blue) | string | Logical namespace of the service on the other side of the connection. SHOULD be equal to the actual [`service.namespace`](/docs/resource/README.md#service) resource attribute of the remote service if any. | `Shop` | | `service.version` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version string of the service component. The format is not defined by these conventions. | `2.0.0`; `a01dbef8a` | **[1] `service.criticality`:** Application developers are encouraged to set `service.criticality` to express the operational importance of their services. Telemetry consumers MAY use this attribute to optimize telemetry collection or improve user experience. @@ -72,14 +69,3 @@ The process executable name is the name of the process executable, the same valu **[7]:** Examples include batch processors, cleanup jobs, and internal dashboards. **[8]:** Examples include analytics, reporting, and non-essential integrations. - -## Service Attributes for Peer Services - -How to describe the service on the other side of a request. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `service.peer.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Logical name of the service on the other side of the connection. SHOULD be equal to the actual [`service.name`](/docs/resource/README.md#service) resource attribute of the remote service if any. | `shoppingcart` | -| `service.peer.namespace` | ![Development](https://img.shields.io/badge/-development-blue) | string | Logical namespace of the service on the other side of the connection. SHOULD be equal to the actual [`service.namespace`](/docs/resource/README.md#service) resource attribute of the remote service if any. | `Shop` | diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index bc5f8aefcc..99d25efe9d 100644 --- a/docs/registry/attributes/session.md +++ b/docs/registry/attributes/session.md @@ -5,10 +5,6 @@ ## Session Attributes -Session is defined as the period of time encompassing all activities performed by the application and the actions executed by the end user. -Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in the Logs, Events, and Spans generated during the Session's lifecycle. -When a session reaches end of life, typically due to user inactivity or session timeout, a new session identifier will be assigned. The previous session identifier may be provided by the instrumentation so that telemetry backends can link the two sessions. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/signalr.md b/docs/registry/attributes/signalr.md index d26c3c9f12..e28d88bb25 100644 --- a/docs/registry/attributes/signalr.md +++ b/docs/registry/attributes/signalr.md @@ -5,8 +5,6 @@ ## SignalR Attributes -SignalR attributes - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index b2234e5b2f..112112e3f8 100644 --- a/docs/registry/attributes/source.md +++ b/docs/registry/attributes/source.md @@ -5,8 +5,6 @@ ## Source Attributes -These attributes may be used to describe the sender of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index d7b5f412ec..a79905ebcf 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -3,111 +3,23 @@ # System -- [General System Attributes](#general-system-attributes) -- [Filesystem Attributes](#filesystem-attributes) -- [System Memory Attributes](#system-memory-attributes) -- [System Paging Attributes](#system-paging-attributes) - -## General System Attributes - -Describes System attributes +## System Attributes **Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | | `system.device` | ![Development](https://img.shields.io/badge/-development-blue) | string | The device identifier | `(identifier)` | - -
-Deprecated Attributes: - -| Key | Value Type | Description | Example Values | Deprecation Explanation | -| --- | --- | --- | --- | --- | -| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | -| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | -| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | Use `network.connection.state` instead. | -| `system.paging.type` | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | Use `system.paging.fault.type` instead. | -| `system.process.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | -| `system.processes.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | - ---- - -`system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | -| `interrupt` | interrupt | ![Development](https://img.shields.io/badge/-development-blue) | -| `iowait` | iowait | ![Development](https://img.shields.io/badge/-development-blue) | -| `nice` | nice | ![Development](https://img.shields.io/badge/-development-blue) | -| `steal` | steal | ![Development](https://img.shields.io/badge/-development-blue) | -| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | -| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.network.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `close` | close | ![Development](https://img.shields.io/badge/-development-blue) | -| `close_wait` | close_wait | ![Development](https://img.shields.io/badge/-development-blue) | -| `closing` | closing | ![Development](https://img.shields.io/badge/-development-blue) | -| `delete` | delete | ![Development](https://img.shields.io/badge/-development-blue) | -| `established` | established | ![Development](https://img.shields.io/badge/-development-blue) | -| `fin_wait_1` | fin_wait_1 | ![Development](https://img.shields.io/badge/-development-blue) | -| `fin_wait_2` | fin_wait_2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `last_ack` | last_ack | ![Development](https://img.shields.io/badge/-development-blue) | -| `listen` | listen | ![Development](https://img.shields.io/badge/-development-blue) | -| `syn_recv` | syn_recv | ![Development](https://img.shields.io/badge/-development-blue) | -| `syn_sent` | syn_sent | ![Development](https://img.shields.io/badge/-development-blue) | -| `time_wait` | time_wait | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | -| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.process.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | -| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | -| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | -| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | -| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | -| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | -| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | - -
- -## Filesystem Attributes - -Describes Filesystem attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | | `system.filesystem.mode` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mode | `rw, ro` | | `system.filesystem.mountpoint` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem mount path | `/mnt/data` | | `system.filesystem.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem state | `used` | | `system.filesystem.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | The filesystem type | `ext4` | +| `system.memory.linux.hugepages.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Linux HugePages memory state | `free`; `used` | +| `system.memory.linux.slab.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | +| `system.memory.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The memory state | `free`; `cached` | +| `system.paging.direction` | ![Development](https://img.shields.io/badge/-development-blue) | string | The paging access direction | `in` | +| `system.paging.fault.type` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The paging fault type | `minor` | +| `system.paging.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The memory paging state | `free` | --- @@ -132,18 +44,6 @@ Describes Filesystem attributes | `ntfs` | ntfs | ![Development](https://img.shields.io/badge/-development-blue) | | `refs` | refs | ![Development](https://img.shields.io/badge/-development-blue) | -## System Memory Attributes - -Describes System Memory attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `system.memory.linux.hugepages.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Linux HugePages memory state | `free`; `used` | -| `system.memory.linux.slab.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | -| `system.memory.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The memory state | `free`; `cached` | - --- `system.memory.linux.hugepages.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -175,18 +75,6 @@ Describes System Memory attributes **[1]:** Calculation based on the operating system metrics. On Linux, this corresponds to "MemTotal - MemAvailable" from /proc/meminfo, which more accurately reflects memory in active use by applications compared to older formulas based on free, cached, and buffers. If MemAvailable is not available, a fallback to those older formulas may be used. -## System Paging Attributes - -Describes System Memory Paging attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `system.paging.direction` | ![Development](https://img.shields.io/badge/-development-blue) | string | The paging access direction | `in` | -| `system.paging.fault.type` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The paging fault type | `minor` | -| `system.paging.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The memory paging state | `free` | - --- `system.paging.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -213,3 +101,81 @@ Describes System Memory Paging attributes | --- | --- | --- | | `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | + +
+Deprecated Attributes: + +| Key | Value Type | Description | Example Values | Deprecation Explanation | +| --- | --- | --- | --- | --- | +| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | +| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | +| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | Use `network.connection.state` instead. | +| `system.paging.type` | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | Use `system.paging.fault.type` instead. | +| `system.process.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | +| `system.processes.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | + +--- + +`system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `idle` | idle | ![Development](https://img.shields.io/badge/-development-blue) | +| `interrupt` | interrupt | ![Development](https://img.shields.io/badge/-development-blue) | +| `iowait` | iowait | ![Development](https://img.shields.io/badge/-development-blue) | +| `nice` | nice | ![Development](https://img.shields.io/badge/-development-blue) | +| `steal` | steal | ![Development](https://img.shields.io/badge/-development-blue) | +| `system` | system | ![Development](https://img.shields.io/badge/-development-blue) | +| `user` | user | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.network.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `close` | close | ![Development](https://img.shields.io/badge/-development-blue) | +| `close_wait` | close_wait | ![Development](https://img.shields.io/badge/-development-blue) | +| `closing` | closing | ![Development](https://img.shields.io/badge/-development-blue) | +| `delete` | delete | ![Development](https://img.shields.io/badge/-development-blue) | +| `established` | established | ![Development](https://img.shields.io/badge/-development-blue) | +| `fin_wait_1` | fin_wait_1 | ![Development](https://img.shields.io/badge/-development-blue) | +| `fin_wait_2` | fin_wait_2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `last_ack` | last_ack | ![Development](https://img.shields.io/badge/-development-blue) | +| `listen` | listen | ![Development](https://img.shields.io/badge/-development-blue) | +| `syn_recv` | syn_recv | ![Development](https://img.shields.io/badge/-development-blue) | +| `syn_sent` | syn_sent | ![Development](https://img.shields.io/badge/-development-blue) | +| `time_wait` | time_wait | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | +| `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.process.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | +| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | +| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | +| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `defunct` | defunct | ![Development](https://img.shields.io/badge/-development-blue) | +| `running` | running | ![Development](https://img.shields.io/badge/-development-blue) | +| `sleeping` | sleeping | ![Development](https://img.shields.io/badge/-development-blue) | +| `stopped` | stopped | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/telemetry.md b/docs/registry/attributes/telemetry.md index d26a6e9daf..cf22bc0343 100644 --- a/docs/registry/attributes/telemetry.md +++ b/docs/registry/attributes/telemetry.md @@ -5,8 +5,6 @@ ## Telemetry Attributes -This document defines attributes for telemetry SDK. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 6866377856..9fcb13d128 100644 --- a/docs/registry/attributes/test.md +++ b/docs/registry/attributes/test.md @@ -5,8 +5,6 @@ ## Test Attributes -This group describes attributes specific to [software tests](https://wikipedia.org/wiki/Software_testing). - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index 3420332776..4629e5818f 100644 --- a/docs/registry/attributes/thread.md +++ b/docs/registry/attributes/thread.md @@ -5,8 +5,6 @@ ## Thread Attributes -These attributes may be used for any operation to store information about a thread that started a span. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index 03b147e04b..b7026258f7 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -5,8 +5,6 @@ ## TLS Attributes -This document defines semantic convention attributes in the TLS namespace. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/url.md b/docs/registry/attributes/url.md index 0ccc2c2080..26f6c5c7bb 100644 --- a/docs/registry/attributes/url.md +++ b/docs/registry/attributes/url.md @@ -5,8 +5,6 @@ ## URL Attributes -Attributes describing URL. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/user-agent.md b/docs/registry/attributes/user-agent.md index 78ffa71f4f..0c3c0cf66d 100644 --- a/docs/registry/attributes/user-agent.md +++ b/docs/registry/attributes/user-agent.md @@ -3,12 +3,7 @@ # User agent -- [User-agent Attributes](#user-agent-attributes) -- [User-agent OS Attributes](#user-agent-os-attributes) - -## User-agent Attributes - -Describes user-agent attributes. +## User Agent Attributes **Attributes:** @@ -16,29 +11,20 @@ Describes user-agent attributes. | --- | --- | --- | --- | --- | | `user_agent.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the user-agent extracted from original. Usually refers to the browser's name. [1] | `Safari`; `YourApp` | | `user_agent.original` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `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` | -| `user_agent.version` | ![Development](https://img.shields.io/badge/-development-blue) | string | Version of the user-agent extracted from original. Usually refers to the browser's version [2] | `14.1.2`; `1.0.0` | +| `user_agent.os.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Human readable operating system name. [2] | `iOS`; `Android`; `Ubuntu` | +| `user_agent.os.version` | ![Development](https://img.shields.io/badge/-development-blue) | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). [3] | `14.2.1`; `18.04.1` | +| `user_agent.synthetic.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Specifies the category of synthetic traffic, such as tests or bots. [4] | `bot`; `test` | +| `user_agent.version` | ![Development](https://img.shields.io/badge/-development-blue) | string | Version of the user-agent extracted from original. Usually refers to the browser's version [5] | `14.1.2`; `1.0.0` | **[1] `user_agent.name`:** [Example](https://uaparser.dev/#demo) 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` -**[2] `user_agent.version`:** [Example](https://uaparser.dev/#demo) 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` - -## User-agent OS Attributes - -Describes the OS user-agent attributes. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `user_agent.os.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | Human readable operating system name. [3] | `iOS`; `Android`; `Ubuntu` | -| `user_agent.os.version` | ![Development](https://img.shields.io/badge/-development-blue) | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). [4] | `14.2.1`; `18.04.1` | -| `user_agent.synthetic.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Specifies the category of synthetic traffic, such as tests or bots. [5] | `bot`; `test` | +**[2] `user_agent.os.name`:** For mapping user agent strings to OS names, libraries such as [ua-parser](https://github.com/ua-parser) can be utilized. -**[3] `user_agent.os.name`:** For mapping user agent strings to OS names, libraries such as [ua-parser](https://github.com/ua-parser) can be utilized. +**[3] `user_agent.os.version`:** For mapping user agent strings to OS versions, libraries such as [ua-parser](https://github.com/ua-parser) can be utilized. -**[4] `user_agent.os.version`:** For mapping user agent strings to OS versions, libraries such as [ua-parser](https://github.com/ua-parser) can be utilized. +**[4] `user_agent.synthetic.type`:** This attribute MAY be derived from the contents of the `user_agent.original` attribute. Components that populate the attribute are responsible for determining what they consider to be synthetic bot or test traffic. This attribute can either be set for self-identification purposes, or on telemetry detected to be generated as a result of a synthetic request. This attribute is useful for distinguishing between genuine client traffic and synthetic traffic generated by bots or tests. -**[5] `user_agent.synthetic.type`:** This attribute MAY be derived from the contents of the `user_agent.original` attribute. Components that populate the attribute are responsible for determining what they consider to be synthetic bot or test traffic. This attribute can either be set for self-identification purposes, or on telemetry detected to be generated as a result of a synthetic request. This attribute is useful for distinguishing between genuine client traffic and synthetic traffic generated by bots or tests. +**[5] `user_agent.version`:** [Example](https://uaparser.dev/#demo) 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` --- diff --git a/docs/registry/attributes/user.md b/docs/registry/attributes/user.md index b4142e668e..9d5bdffc3b 100644 --- a/docs/registry/attributes/user.md +++ b/docs/registry/attributes/user.md @@ -5,8 +5,6 @@ ## User Attributes -Describes information about the user. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/v8js.md b/docs/registry/attributes/v8js.md index 78eb4aaff9..565c2c5371 100644 --- a/docs/registry/attributes/v8js.md +++ b/docs/registry/attributes/v8js.md @@ -3,9 +3,7 @@ # V8js -## V8 JS Attributes - -Describes V8 JS Engine Runtime related attributes. +## V8js Attributes **Attributes:** diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index 2c32dca993..ddbafd997f 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -3,12 +3,7 @@ # VCS -- [VCS Repository Attributes](#vcs-repository-attributes) -- [VCS Deprecated Attributes](#vcs-deprecated-attributes) - -## VCS Repository Attributes - -This group defines the attributes for [Version Control Systems (VCS)](https://wikipedia.org/wiki/Version_control). +## VCS Attributes **Attributes:** @@ -145,10 +140,6 @@ the `.git` extension. | `ahead` | How many revisions the change is ahead of the target ref. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `behind` | How many revisions the change is behind the target ref. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | -## VCS Deprecated Attributes - -Describes deprecated vcs attributes. -
Deprecated Attributes: diff --git a/docs/registry/attributes/webengine.md b/docs/registry/attributes/webengine.md index 5d34bacc78..1b939ff63d 100644 --- a/docs/registry/attributes/webengine.md +++ b/docs/registry/attributes/webengine.md @@ -3,9 +3,7 @@ # Webengine -## Web Engine Attributes - -This document defines the attributes used to describe the packaged software running the application code. +## Webengine Attributes **Attributes:** diff --git a/docs/registry/attributes/zos.md b/docs/registry/attributes/zos.md index ee85ea19fd..bc720a948e 100644 --- a/docs/registry/attributes/zos.md +++ b/docs/registry/attributes/zos.md @@ -3,9 +3,7 @@ # zOS -## z/OS attributes - -This document defines attributes of a z/OS resource. +## zOS Attributes **Attributes:** diff --git a/templates/registry/markdown/attribute_macros.j2 b/templates/registry/markdown/attribute_macros.j2 index cc05fcb679..a6990a8884 100644 --- a/templates/registry/markdown/attribute_macros.j2 +++ b/templates/registry/markdown/attribute_macros.j2 @@ -20,10 +20,8 @@ {% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[`{{name(attribute)}}`]({{attribute_registry_base_url}}/{{ find_lineage(attribute.name, lineage_attributes) | split_id | list | reject("eq", "registry")| first | kebab_case }}.md){% endmacro %} -{% macro display_name(group) %} -{%- if 'display_name' in group %}{{ group.display_name }} -{%- else %}{{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes -{%- endif %}{% endmacro %} +{% macro display_name(group) %}{{ group | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes +{% endmacro %} {% macro heading_link_fragments(title) %}{{ title | trim | lower | replace(" ", "-") | replace("(", "") | replace(")", "") | replace("/", "") | replace("\\", "") | replace(".", "") | replace("!", "") | replace("?", "") | replace("~", "") | replace("#", "")}}{% endmacro %} diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 29bc0d1d6f..19b760a745 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -9,49 +9,14 @@ {%- import 'attribute_table.j2' as at -%} {%- import 'attribute_macros.j2' as attrs -%} {%- import 'examples_macros.j2' as examples -%} -{%- set groups = namespace(deprecated=[], non_deprecated=[]) -%} -{%- for group in ctx.groups | sort(attribute="id") -%} -{%- if group.id[-10:] == "deprecated" -%} -{% if ctx.groups | selectattr("id", "eq", group.id[:-11]) | length != 1 %} -{%- set groups.deprecated = groups.deprecated + [group] -%} -{% endif %} -{%- else -%} -{% set deprecatedAttrs = ctx.groups | selectattr("id", "eq", group.id + ".deprecated") %}{% if deprecatedAttrs | length > 0 %}{% set combined = { - "brief": group.brief, - "note": group.note, - "id": group.id, - "attributes": group.attributes + deprecatedAttrs[0].attributes, - "display_name": group.display_name - } %} -{%- set groups.non_deprecated = groups.non_deprecated + [combined] -%} -{% else %} -{%- set groups.non_deprecated = groups.non_deprecated + [group] -%} -{% endif %} -{%- endif -%} -{%- endfor -%} -{%- set attr_groups = groups.non_deprecated + groups.deprecated -%} -# {{ attrs.humanize(attrs.sentence_case(ctx.id)) | acronym | map_text("namespace_mapping") }} +# {{ attrs.humanize(attrs.sentence_case(ctx.root_namespace)) | acronym | map_text("namespace_mapping") }} -{%- if attr_groups | length > 1 %} -{% for group in attr_groups %} -- [{{ attrs.display_name(group) }}](#{{ attrs.heading_link_fragments(attrs.display_name(group)) }}) -{%- endfor -%} -{%- endif %} -{% for group in attr_groups %} -## {{ attrs.display_name(group) }} - -{% if group.brief.endswith("\n") -%} -{{ group.brief }} -{% else -%} -{{ group.brief }} -{{"\n"}} -{%- endif -%} - -{% set filtered_attributes = group.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}**Attributes:** +## {{ attrs.display_name(ctx.root_namespace) }} +{% set filtered_attributes = ctx.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}**Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | @@ -61,6 +26,4 @@ {{ notes.render() }} {%- for enum in filtered_attributes | sort(attribute="name") %} {%- if enum.type is mapping -%}{{ enums.table(enum, notes) }}{% endif %} -{%- endfor -%}{% endif %}{% if (group.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(group.attributes, "", "", "") | trim }}{% if filtered_attributes | length != group.attributes | length %}{{"\n"}}{%endif%} - -{%- endfor -%} +{%- endfor -%}{% endif %}{% if (ctx.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(ctx.attributes, "", "", "") | trim }}{% if filtered_attributes | length != ctx.attributes | length %}{{"\n"}}{%endif%} diff --git a/templates/registry/markdown/attributes_readme.md.j2 b/templates/registry/markdown/attributes_readme.md.j2 index 653ed5886e..7322e8ef31 100644 --- a/templates/registry/markdown/attributes_readme.md.j2 +++ b/templates/registry/markdown/attributes_readme.md.j2 @@ -32,8 +32,8 @@ All registered attributes are listed by namespace in this registry. Currently, the following namespaces exist: {% for bundle in ctx %} -{%- set my_file_name = bundle.id | kebab_case ~ ".md" -%} -- [{{ bundle.id | title_case | acronym | map_text("namespace_mapping") }}]({{ my_file_name }}) +{%- set my_file_name = bundle.root_namespace | kebab_case ~ ".md" -%} +- [{{ bundle.root_namespace | title_case | acronym | map_text("namespace_mapping") }}]({{ my_file_name }}) {% endfor %} [developers recommendations]: ../../general/naming.md#recommendations-for-application-developers diff --git a/templates/registry/markdown/weaver.yaml b/templates/registry/markdown/weaver.yaml index 0ed6e924c3..2e3dd10aa6 100644 --- a/templates/registry/markdown/weaver.yaml +++ b/templates/registry/markdown/weaver.yaml @@ -1,12 +1,12 @@ templates: - pattern: attributes_readme.md.j2 - filter: '.groups | map(select(.type == "attribute_group")) | map(select(.id | startswith("registry"))) | group_by(.id | split(".") | .[1]) | map({id: .[0].id | split(".") | .[1], groups: .})' + filter: semconv_grouped_attributes application_mode: single file_name: attributes/README.md - pattern: attribute_namespace.md.j2 - filter: '.groups | map(select(.type == "attribute_group")) | map(select(.id | startswith("registry"))) | group_by(.id | split(".") | .[1]) | map({id: .[0].id | split(".") | .[1], groups: .})' + filter: semconv_grouped_attributes application_mode: each - file_name: attributes/{{ ctx.id | lower | kebab_case }}.md + file_name: attributes/{{ ctx.root_namespace | lower | kebab_case }}.md - pattern: registry_readme.md.j2 filter: "." application_mode: single From 229443d7850fb3ee6cc46d3fde150beb9e05892d Mon Sep 17 00:00:00 2001 From: James Thompson Date: Wed, 1 Jul 2026 12:26:16 +1000 Subject: [PATCH 6/9] Descope --- docs/README.md | 1 + docs/cloud-providers/aws-sdk.md | 6 +- docs/db/dynamodb.md | 78 +++++----- docs/db/oracledb.md | 20 +-- docs/exceptions/exceptions-spans.md | 4 +- docs/object-stores/s3.md | 6 +- docs/registry/attributes/README.md | 2 +- docs/registry/attributes/android.md | 4 +- docs/registry/attributes/app.md | 2 +- docs/registry/attributes/aspnetcore.md | 2 +- docs/registry/attributes/az.md | 6 +- docs/registry/attributes/code.md | 12 +- docs/registry/attributes/container.md | 8 +- docs/registry/attributes/db.md | 70 ++++----- docs/registry/attributes/deployment.md | 4 +- docs/registry/attributes/dotnet.md | 2 +- docs/registry/attributes/enduser.md | 8 +- docs/registry/attributes/error.md | 6 +- docs/registry/attributes/event.md | 4 +- docs/registry/attributes/exception.md | 4 +- docs/registry/attributes/feature-flag.md | 9 +- docs/registry/attributes/gcp.md | 2 +- docs/registry/attributes/gen-ai.md | 122 ++++++++-------- docs/registry/attributes/hardware.md | 2 - docs/registry/attributes/http.md | 30 ++-- docs/registry/attributes/hw.md | 135 ------------------ docs/registry/attributes/ios.md | 6 +- docs/registry/attributes/jsonrpc.md | 2 +- docs/registry/attributes/jvm.md | 2 +- docs/registry/attributes/k8s.md | 6 +- docs/registry/attributes/linux.md | 4 +- docs/registry/attributes/mcp.md | 10 +- docs/registry/attributes/message.md | 10 +- docs/registry/attributes/messaging.md | 21 +-- docs/registry/attributes/net.md | 32 ++--- docs/registry/attributes/nodejs.md | 2 +- docs/registry/attributes/oci.md | 2 +- docs/registry/attributes/onc-rpc.md | 2 +- docs/registry/attributes/openai.md | 10 +- docs/registry/attributes/oracledb.md | 41 ------ docs/registry/attributes/os.md | 2 +- docs/registry/attributes/otel.md | 6 +- docs/registry/attributes/other.md | 4 +- docs/registry/attributes/peer.md | 4 +- docs/registry/attributes/pool.md | 4 +- docs/registry/attributes/process.md | 18 ++- docs/registry/attributes/rpc.md | 40 +++--- docs/registry/attributes/system.md | 14 +- docs/registry/attributes/tls.md | 4 +- docs/registry/attributes/user-agent.md | 2 +- docs/registry/attributes/v8js.md | 2 +- docs/registry/attributes/vcs.md | 12 +- docs/registry/attributes/webengine.md | 2 +- docs/registry/attributes/zos.md | 2 +- .../registry/markdown/attribute_macros.j2 | 6 +- .../markdown/attribute_namespace.md.j2 | 4 +- .../registry/markdown/attribute_table.j2 | 8 +- .../registry/markdown/attributes_readme.md.j2 | 2 +- templates/registry/markdown/weaver.yaml | 31 +++- 59 files changed, 364 insertions(+), 502 deletions(-) delete mode 100644 docs/registry/attributes/hw.md delete mode 100644 docs/registry/attributes/oracledb.md diff --git a/docs/README.md b/docs/README.md index 10d7eb2e80..865f91ebbb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,7 @@ cascade: redirects: - { from: 'attributes-registry/*', to: 'registry/attributes/:splat' } - { from: 'database/*', to: 'db/:splat' } + - { from: 'registry/attributes/oracledb', to: 'registry/attributes/oracle' } cSpell:ignore: semconv auto_gen: below linkTitle: Semantic conventions diff --git a/docs/cloud-providers/aws-sdk.md b/docs/cloud-providers/aws-sdk.md index 752c815f6b..ebe99866ef 100644 --- a/docs/cloud-providers/aws-sdk.md +++ b/docs/cloud-providers/aws-sdk.md @@ -50,10 +50,10 @@ interesting conventions are found.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- diff --git a/docs/db/dynamodb.md b/docs/db/dynamodb.md index 95d437ba3d..e57337fb04 100644 --- a/docs/db/dynamodb.md +++ b/docs/db/dynamodb.md @@ -66,10 +66,10 @@ This span represents a `DynamoDB.BatchGetItem` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -124,10 +124,10 @@ This span represents a `DynamoDB.BatchWriteItem` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -186,10 +186,10 @@ This span represents a `DynamoDB.CreateTable` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -244,10 +244,10 @@ This span represents a `DynamoDB.DeleteItem` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -300,10 +300,10 @@ This span represents a `DynamoDB.DeleteTable` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -356,10 +356,10 @@ This span represents a `DynamoDB.DescribeTable` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -415,10 +415,10 @@ This span represents a `DynamoDB.GetItem` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -473,10 +473,10 @@ This span represents a `DynamoDB.ListTables` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -531,10 +531,10 @@ This span represents a `DynamoDB.PutItem` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -595,10 +595,10 @@ This span represents a `DynamoDB.Query` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -662,10 +662,10 @@ This span represents a `DynamoDB.Scan` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -720,10 +720,10 @@ This span represents a `DynamoDB.UpdateItem` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- @@ -781,10 +781,10 @@ This span represents a `DynamoDB.UpdateTable` call.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- diff --git a/docs/db/oracledb.md b/docs/db/oracledb.md index 06a74da81a..23ae5e7b04 100644 --- a/docs/db/oracledb.md +++ b/docs/db/oracledb.md @@ -48,11 +48,11 @@ Spans representing calls to a Oracle SQL Database adhere to the general [Semanti | [`db.query.summary`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [11] | string | Low cardinality summary of a database query. [12] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | | [`db.query.text`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [13] | string | The database query being executed. [14] | `SELECT * FROM wuser_table where username = ?` | | [`db.stored_procedure.name`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [15] | string | The name of a stored procedure within the database. [16] | `GetCustomer` | -| [`oracle.db.domain`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database domain associated with the connection. [17] | `example.com`; `corp.internal`; `prod.db.local` | -| [`oracle.db.instance.name`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [18] | `ORCL1`; `ORCL2`; `ORCL3` | -| [`oracle.db.name`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database name associated with the connection. [19] | `ORCL1`; `FREE` | -| [`oracle.db.pdb`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The pluggable database (PDB) name associated with the connection. [20] | `PDB1`; `FREEPDB` | -| [`oracle.db.service`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The service name currently associated with the database connection. [21] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | +| [`oracle.db.domain`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database domain associated with the connection. [17] | `example.com`; `corp.internal`; `prod.db.local` | +| [`oracle.db.instance.name`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [18] | `ORCL1`; `ORCL2`; `ORCL3` | +| [`oracle.db.name`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database name associated with the connection. [19] | `ORCL1`; `FREE` | +| [`oracle.db.pdb`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The pluggable database (PDB) name associated with the connection. [20] | `PDB1`; `FREEPDB` | +| [`oracle.db.service`](/docs/registry/attributes/oracle.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The service name currently associated with the database connection. [21] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | | [`server.address`](/docs/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the database host. [22] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`db.query.parameter.`](/docs/registry/attributes/db.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | string | A database query parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [23] | `someval`; `55` | | [`db.response.returned_rows`](/docs/registry/attributes/db.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | Number of rows returned by the operation. [24] | `10`; `30`; `1000` | @@ -185,11 +185,11 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`db.namespace`](/docs/registry/attributes/db.md) * [`db.query.summary`](/docs/registry/attributes/db.md) * [`db.query.text`](/docs/registry/attributes/db.md) -* [`oracle.db.domain`](/docs/registry/attributes/oracledb.md) -* [`oracle.db.instance.name`](/docs/registry/attributes/oracledb.md) -* [`oracle.db.name`](/docs/registry/attributes/oracledb.md) -* [`oracle.db.pdb`](/docs/registry/attributes/oracledb.md) -* [`oracle.db.service`](/docs/registry/attributes/oracledb.md) +* [`oracle.db.domain`](/docs/registry/attributes/oracle.md) +* [`oracle.db.instance.name`](/docs/registry/attributes/oracle.md) +* [`oracle.db.name`](/docs/registry/attributes/oracle.md) +* [`oracle.db.pdb`](/docs/registry/attributes/oracle.md) +* [`oracle.db.service`](/docs/registry/attributes/oracle.md) * [`server.address`](/docs/registry/attributes/server.md) * [`server.port`](/docs/registry/attributes/server.md) diff --git a/docs/exceptions/exceptions-spans.md b/docs/exceptions/exceptions-spans.md index 5aef4cc461..a83681ebdf 100644 --- a/docs/exceptions/exceptions-spans.md +++ b/docs/exceptions/exceptions-spans.md @@ -75,9 +75,9 @@ classify the failure.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | +| [`exception.escaped`](/docs/registry/attributes/exception.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | boolean | Indicates that the exception is escaping the scope of the span. | |
diff --git a/docs/object-stores/s3.md b/docs/object-stores/s3.md index ed55377f6e..ff0757efbe 100644 --- a/docs/object-stores/s3.md +++ b/docs/object-stores/s3.md @@ -85,10 +85,10 @@ This applies in particular to the following operations:
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| [`rpc.system`](/docs/registry/attributes/rpc.md) | string | The value `aws-api`. | `aws-api` | Use `rpc.system.name` instead. | -| [`rpc.service`](/docs/registry/attributes/rpc.md) | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | +| [`rpc.system`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | The value `aws-api`. | `aws-api` | +| [`rpc.service`](/docs/registry/attributes/rpc.md) | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | The name of the service to which a request is made, as returned by the AWS SDK. | `DynamoDB`; `S3` | --- diff --git a/docs/registry/attributes/README.md b/docs/registry/attributes/README.md index 3abf83bc94..aa8211f552 100644 --- a/docs/registry/attributes/README.md +++ b/docs/registry/attributes/README.md @@ -72,7 +72,7 @@ Currently, the following namespaces exist: - [Heroku](heroku.md) - [Host](host.md) - [HTTP](http.md) -- [Hw](hw.md) +- [Hw](hardware.md) - [iOS](ios.md) - [JSONRPC](jsonrpc.md) - [JVM](jvm.md) diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index 52ba095475..e778ba5e4b 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -27,9 +27,9 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `android.state` | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` | Use `android.app.state` instead. | +| `android.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `android.app.state`. | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` | --- diff --git a/docs/registry/attributes/app.md b/docs/registry/attributes/app.md index 319a29ee97..7e3f341534 100644 --- a/docs/registry/attributes/app.md +++ b/docs/registry/attributes/app.md @@ -3,7 +3,7 @@ # App -## App Attributes +## Application Attributes **Attributes:** diff --git a/docs/registry/attributes/aspnetcore.md b/docs/registry/attributes/aspnetcore.md index 3fe626e818..aa35f2b651 100644 --- a/docs/registry/attributes/aspnetcore.md +++ b/docs/registry/attributes/aspnetcore.md @@ -3,7 +3,7 @@ # Aspnetcore -## Aspnetcore Attributes +## ASP.NET Core Attributes **Attributes:** diff --git a/docs/registry/attributes/az.md b/docs/registry/attributes/az.md index c488c4780e..765963c5fc 100644 --- a/docs/registry/attributes/az.md +++ b/docs/registry/attributes/az.md @@ -8,9 +8,9 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `az.namespace` | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | Use `azure.resource_provider.namespace` instead. | -| `az.service_request_id` | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | Use `azure.service.request.id` instead. | +| `az.namespace` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.resource_provider.namespace`. | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | +| `az.service_request_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.service.request.id`. | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` |
diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index c8317b78dd..c8526ceff1 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -34,12 +34,12 @@ Examples:
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `code.column` | int | Deprecated, use `code.column.number` | `16` | Use `code.column.number` instead. | -| `code.filepath` | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | Use `code.file.path` instead. | -| `code.function` | string | Deprecated, use `code.function.name` instead | `serveRequest` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | -| `code.lineno` | int | Deprecated, use `code.line.number` instead | `42` | Use `code.line.number` instead. | -| `code.namespace` | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | Value should be included in `code.function.name` which is expected to be a fully-qualified name. | +| `code.column` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.column.number`. | int | Deprecated, use `code.column.number` | `16` | +| `code.filepath` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.file.path`. | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | +| `code.function` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `code.function.name` which is expected to be a fully-qualified name. | string | Deprecated, use `code.function.name` instead | `serveRequest` | +| `code.lineno` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.line.number`. | int | Deprecated, use `code.line.number` instead | `42` | +| `code.namespace` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `code.function.name` which is expected to be a fully-qualified name. | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` |
diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index 0b0abe0e5e..7fbb1ad925 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -42,11 +42,11 @@ The ID is assigned by the container runtime and can vary in different environmen
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | Use `cpu.mode` instead. | -| `container.labels.` | string | Deprecated, use `container.label` instead. | `nginx` | Use `container.label` instead. | -| `container.runtime` | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | Use `container.runtime.name` instead. | +| `container.cpu.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | +| `container.labels.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.label`. | string | Deprecated, use `container.label` instead. | `nginx` | +| `container.runtime` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.runtime.name`. | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | --- diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index 4e72088221..2212f480cc 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -191,42 +191,42 @@ stored procedure name then that stored procedure name SHOULD be used.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `db.cassandra.consistency_level` | string | Deprecated, use `cassandra.consistency.level` instead. | `all`; `each_quorum`; `quorum` | Use `cassandra.consistency.level` instead. | -| `db.cassandra.coordinator.dc` | string | Deprecated, use `cassandra.coordinator.dc` instead. | `us-west-2` | Use `cassandra.coordinator.dc` instead. | -| `db.cassandra.coordinator.id` | string | Deprecated, use `cassandra.coordinator.id` instead. | `be13faa2-8574-4d71-926d-27f16cf8a7af` | Use `cassandra.coordinator.id` instead. | -| `db.cassandra.idempotence` | boolean | Deprecated, use `cassandra.query.idempotent` instead. | | Use `cassandra.query.idempotent` instead. | -| `db.cassandra.page_size` | int | Deprecated, use `cassandra.page.size` instead. | `5000` | Use `cassandra.page.size` instead. | -| `db.cassandra.speculative_execution_count` | int | Deprecated, use `cassandra.speculative_execution.count` instead. | `0`; `2` | Use `cassandra.speculative_execution.count` instead. | -| `db.cassandra.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | -| `db.client.connections.pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | -| `db.client.connections.state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | -| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | Replaced by `server.address` and `server.port`. | -| `db.cosmosdb.client_id` | string | Deprecated, use `azure.client.id` instead. | `3ba4827d-4422-483f-b59f-85b74211c11d` | Use `azure.client.id` instead. | -| `db.cosmosdb.connection_mode` | string | Deprecated, use `azure.cosmosdb.connection.mode` instead. | `gateway`; `direct` | Use `azure.cosmosdb.connection.mode` instead. | -| `db.cosmosdb.consistency_level` | string | Deprecated, use `cosmosdb.consistency.level` instead. | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | Use `azure.cosmosdb.consistency.level` instead. | -| `db.cosmosdb.container` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | -| `db.cosmosdb.operation_type` | string | Deprecated, no replacement at this time. | `batch`; `create`; `delete` | Removed, no replacement at this time. | -| `db.cosmosdb.regions_contacted` | string[] | Deprecated, use `azure.cosmosdb.operation.contacted_regions` instead. | `["North Central US", "Australia East", "Australia Southeast"]` | Use `azure.cosmosdb.operation.contacted_regions` instead. | -| `db.cosmosdb.request_charge` | double | Deprecated, use `azure.cosmosdb.operation.request_charge` instead. | `46.18`; `1.0` | Use `azure.cosmosdb.operation.request_charge` instead. | -| `db.cosmosdb.request_content_length` | int | Deprecated, use `azure.cosmosdb.request.body.size` instead. | | Use `azure.cosmosdb.request.body.size` instead. | -| `db.cosmosdb.status_code` | int | Deprecated, use `db.response.status_code` instead. | `200`; `201` | Use `db.response.status_code` instead. | -| `db.cosmosdb.sub_status_code` | int | Deprecated, use `azure.cosmosdb.response.sub_status_code` instead. | `1000`; `1002` | Use `azure.cosmosdb.response.sub_status_code` instead. | -| `db.elasticsearch.cluster.name` | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | Use `db.namespace` instead. | -| `db.elasticsearch.node.name` | string | Deprecated, use `elasticsearch.node.name` instead. | `instance-0000000001` | Use `elasticsearch.node.name` instead. | -| `db.elasticsearch.path_parts.` | string | Deprecated, use `db.operation.parameter` instead. | `test-index`; `123` | Use `db.operation.parameter` instead. | -| `db.instance.id` | string | Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | `mysql-e26b99z.example.com` | Removed, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | -| `db.jdbc.driver_classname` | string | Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | Removed, no replacement at this time. | -| `db.mongodb.collection` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Use `db.collection.name` instead. | -| `db.mssql.instance_name` | string | Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. | `MSSQLSERVER` | Removed, no replacement at this time. | -| `db.name` | string | Deprecated, use `db.namespace` instead. | `customers`; `main` | Use `db.namespace` instead. | -| `db.operation` | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | Use `db.operation.name` instead. | -| `db.redis.database_index` | int | Deprecated, use `db.namespace` instead. | `0`; `1`; `15` | Uncategorized. | -| `db.sql.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | Replaced by `db.collection.name`, but only if not extracting the value from `db.query.text`. | -| `db.statement` | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | Use `db.query.text` instead. | -| `db.system` | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | Use `db.system.name` instead. | -| `db.user` | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | Removed, no replacement at this time. | +| `db.cassandra.consistency_level` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.consistency.level`. | string | Deprecated, use `cassandra.consistency.level` instead. | `all`; `each_quorum`; `quorum` | +| `db.cassandra.coordinator.dc` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.coordinator.dc`. | string | Deprecated, use `cassandra.coordinator.dc` instead. | `us-west-2` | +| `db.cassandra.coordinator.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.coordinator.id`. | string | Deprecated, use `cassandra.coordinator.id` instead. | `be13faa2-8574-4d71-926d-27f16cf8a7af` | +| `db.cassandra.idempotence` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.query.idempotent`. | boolean | Deprecated, use `cassandra.query.idempotent` instead. | | +| `db.cassandra.page_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.page.size`. | int | Deprecated, use `cassandra.page.size` instead. | `5000` | +| `db.cassandra.speculative_execution_count` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.speculative_execution.count`. | int | Deprecated, use `cassandra.speculative_execution.count` instead. | `0`; `2` | +| `db.cassandra.table` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | +| `db.client.connections.pool.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | +| `db.client.connections.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | string | Deprecated, use `db.client.connection.state` instead. | `idle` | +| `db.connection_string` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` and `server.port`. | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | +| `db.cosmosdb.client_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.client.id`. | string | Deprecated, use `azure.client.id` instead. | `3ba4827d-4422-483f-b59f-85b74211c11d` | +| `db.cosmosdb.connection_mode` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.connection.mode`. | string | Deprecated, use `azure.cosmosdb.connection.mode` instead. | `gateway`; `direct` | +| `db.cosmosdb.consistency_level` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.consistency.level`. | string | Deprecated, use `cosmosdb.consistency.level` instead. | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | +| `db.cosmosdb.container` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | +| `db.cosmosdb.operation_type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, no replacement at this time. | `batch`; `create`; `delete` | +| `db.cosmosdb.regions_contacted` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.operation.contacted_regions`. | string[] | Deprecated, use `azure.cosmosdb.operation.contacted_regions` instead. | `["North Central US", "Australia East", "Australia Southeast"]` | +| `db.cosmosdb.request_charge` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.operation.request_charge`. | double | Deprecated, use `azure.cosmosdb.operation.request_charge` instead. | `46.18`; `1.0` | +| `db.cosmosdb.request_content_length` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.request.body.size`. | int | Deprecated, use `azure.cosmosdb.request.body.size` instead. | | +| `db.cosmosdb.status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use `db.response.status_code` instead. | int | Deprecated, use `db.response.status_code` instead. | `200`; `201` | +| `db.cosmosdb.sub_status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.response.sub_status_code`. | int | Deprecated, use `azure.cosmosdb.response.sub_status_code` instead. | `1000`; `1002` | +| `db.elasticsearch.cluster.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | +| `db.elasticsearch.node.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `elasticsearch.node.name`. | string | Deprecated, use `elasticsearch.node.name` instead. | `instance-0000000001` | +| `db.elasticsearch.path_parts.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.operation.parameter`. | string | Deprecated, use `db.operation.parameter` instead. | `test-index`; `123` | +| `db.instance.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | string | Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | `mysql-e26b99z.example.com` | +| `db.jdbc.driver_classname` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | +| `db.mongodb.collection` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | +| `db.mssql.instance_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. | `MSSQLSERVER` | +| `db.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | string | Deprecated, use `db.namespace` instead. | `customers`; `main` | +| `db.operation` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.operation.name`. | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | +| `db.redis.database_index` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Uncategorized. | int | Deprecated, use `db.namespace` instead. | `0`; `1`; `15` | +| `db.sql.table` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`, but only if not extracting the value from `db.query.text`. | string | Deprecated, use `db.collection.name` instead. | `mytable` | +| `db.statement` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.query.text`. | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | +| `db.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.system.name`. | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | +| `db.user` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | --- diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index 3bd81e3d28..d9a0249746 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -45,8 +45,8 @@ considered to be identifying the same service:
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `deployment.environment` | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | Use `deployment.environment.name` instead. | +| `deployment.environment` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `deployment.environment.name`. | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` |
diff --git a/docs/registry/attributes/dotnet.md b/docs/registry/attributes/dotnet.md index 0ae427e980..217649333d 100644 --- a/docs/registry/attributes/dotnet.md +++ b/docs/registry/attributes/dotnet.md @@ -3,7 +3,7 @@ # Dotnet -## Dotnet Attributes +## .NET Attributes **Attributes:** diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index df71c7ea9f..926957828d 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -3,7 +3,7 @@ # Enduser -## Enduser Attributes +## End User Attributes **Attributes:** @@ -25,9 +25,9 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | Use `user.roles` instead. | -| `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | Removed, no replacement at this time. | +| `enduser.role` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use `user.roles` instead. | string | Deprecated, use `user.roles` instead. | `admin` | +| `enduser.scope` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, no replacement at this time. | `read:message, write:files` |
diff --git a/docs/registry/attributes/error.md b/docs/registry/attributes/error.md index 63e0916bab..35188a8bde 100644 --- a/docs/registry/attributes/error.md +++ b/docs/registry/attributes/error.md @@ -48,11 +48,11 @@ it's RECOMMENDED to:
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `error.message` | string | A message providing more detail about an error in human-readable form. [1] | `Unexpected input type: string`; `The user has exceeded their storage quota` | Use domain-specific error message attribute. For example, use `feature_flag.error.message` for feature flag errors. | +| `error.message` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use domain-specific error message attribute. For example, use `feature_flag.error.message` for feature flag errors. | string | A message providing more detail about an error in human-readable form. [2] | `Unexpected input type: string`; `The user has exceeded their storage quota` | -**[1] `error.message`:** `error.message` should provide additional context and detail about an error. +**[2] `error.message`:** `error.message` should provide additional context and detail about an error. It is NOT RECOMMENDED to duplicate the value of `error.type` in `error.message`. It is also NOT RECOMMENDED to duplicate the value of `exception.message` in `error.message`. diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 3c339ab91a..20ae68f1db 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -8,8 +8,8 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `event.name` | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` | The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event. | +| `event.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event. | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` |
diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index 1b93c212d5..f0f0d08aaa 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -28,8 +28,8 @@ classify the failure.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `exception.escaped` | boolean | Indicates that the exception is escaping the scope of the span. | | It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | +| `exception.escaped` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
It's no longer recommended to record exceptions that are handled and do not escape the scope of a span. | boolean | Indicates that the exception is escaping the scope of the span. | |
diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index 21e675cb38..41a9cf125b 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -49,11 +49,12 @@ For example, the variant `red` maybe be used for the value `#c05543`.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `feature_flag.evaluation.error.message` | string | Deprecated, use `feature_flag.error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | Use `feature_flag.error.message` instead. | -| `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | Use `feature_flag.result.reason` instead. | -| `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | Use `feature_flag.result.variant` instead. | +| `feature_flag.evaluation.error.message` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.error.message`. | string | Deprecated, use `feature_flag.error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | +| `feature_flag.evaluation.reason` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.reason`. | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | +| `feature_flag.provider_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.provider.name`. | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | +| `feature_flag.variant` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.variant`. | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | --- diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 38d9b271e4..c18a4e81eb 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -3,7 +3,7 @@ # GCP -## GCP Attributes +## Google Cloud Platform Attributes **Attributes:** diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 155d9e2ef5..44a5383969 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -8,68 +8,68 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `gen_ai.agent.description` | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.agent.id` | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.agent.name` | string | Human-readable name of the GenAI agent provided by the application. | `Math Tutor`; `Fiction Writer` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.agent.version` | string | The version of the GenAI agent. | `1.0.0`; `2025-05-01` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.completion` | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | Removed, no replacement at this time. | -| `gen_ai.conversation.id` | string | The unique identifier for a conversation (session, thread), used to store and correlate messages within this conversation. | `conv_5j66UpCpwteGg4YSxUnt7lPY` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.data_source.id` | string | The data source identifier. [1] | `H7STPQYOND` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.embeddings.dimension.count` | int | The number of dimensions the resulting output embeddings should have. | `512`; `1024` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.evaluation.explanation` | string | A free-form explanation for the assigned score provided by the evaluator. | `The response is factually accurate but lacks sufficient detail to fully address the question.` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.evaluation.name` | string | The name of the evaluation metric used for the GenAI response. | `Relevance`; `IntentResolution` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.evaluation.score.label` | string | Human readable label for evaluation. [2] | `relevant`; `not_relevant`; `correct`; `incorrect`; `pass`; `fail` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.evaluation.score.value` | double | The evaluation score returned by the evaluator. | `4.0` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.input.messages` | any | The chat history provided to the model as an input. [3] | [
  {
    "role": "user",
    "parts": [
      {
        "type": "text",
        "content": "Weather in Paris?"
      }
    ]
  },
  {
    "role": "assistant",
    "parts": [
      {
        "type": "tool_call",
        "id": "call_VSPygqKTWdrhaFErNvMV18Yl",
        "name": "get_weather",
        "arguments": {
          "location": "Paris"
        }
      }
    ]
  },
  {
    "role": "tool",
    "parts": [
      {
        "type": "tool_call_response",
        "id": " call_VSPygqKTWdrhaFErNvMV18Yl",
        "result": "rainy, 57°F"
      }
    ]
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.request.response_format` | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | Replaced by `gen_ai.output.type`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.request.seed` | int | Deprecated, use `gen_ai.request.seed`. | `100` | Replaced by `gen_ai.request.seed`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.request.service_tier` | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | Replaced by `openai.request.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.response.service_tier` | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | Replaced by `openai.response.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.openai.response.system_fingerprint` | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | Replaced by `openai.response.system_fingerprint`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.operation.name` | string | The name of the operation being performed. [4] | `chat`; `generate_content`; `text_completion` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.output.messages` | any | Messages returned by the model where each message represents a specific model response (choice, candidate). [5] | [
  {
    "role": "assistant",
    "parts": [
      {
        "type": "text",
        "content": "The weather in Paris is currently rainy with a temperature of 57°F."
      }
    ],
    "finish_reason": "stop"
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.output.type` | string | Represents the content type requested by the client. [6] | `text`; `json`; `image` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.prompt` | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | Removed, no replacement at this time. | -| `gen_ai.prompt.name` | string | The name of the prompt that uniquely identifies it. | `analyze-code` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.provider.name` | string | The Generative AI provider as identified by the client or server instrumentation. [7] | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.choice.count` | int | The target number of candidate completions to return. | `3` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.encoding_formats` | string[] | The encoding formats requested in an embeddings operation, if specified. [8] | `["base64"]`; `["float", "binary"]` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.frequency_penalty` | double | The frequency penalty setting for the GenAI request. | `0.1` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.max_tokens` | int | The maximum number of tokens the model generates for a request. | `100` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.model` | string | The name of the GenAI model a request is being made to. | `gpt-4` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.presence_penalty` | double | The presence penalty setting for the GenAI request. | `0.1` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.seed` | int | Requests with same seed value more likely to return same result. | `100` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.stop_sequences` | string[] | List of sequences that the model will use to stop generating further tokens. | `["forest", "lived"]` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.stream` | boolean | Indicates whether the GenAI request was made in streaming mode. | | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.temperature` | double | The temperature setting for the GenAI request. | `0.0` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.top_k` | double | The top_k sampling setting for the GenAI request. | `1.0` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.request.top_p` | double | The top_p sampling setting for the GenAI request. | `1.0` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.response.finish_reasons` | string[] | Array of reasons the model stopped generating tokens, corresponding to each generation received. | `["stop"]`; `["stop", "length"]` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.response.id` | string | The unique identifier for the completion. | `chatcmpl-123` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.response.model` | string | The name of the model that generated the response. | `gpt-4-0613` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.response.time_to_first_chunk` | double | Time to first chunk in a streaming response, measured from request issuance, in seconds. The value is measured from when the client issues the generation request to when the first chunk is received in the response stream. | `0.5`; `1.2` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.retrieval.documents` | any | The documents retrieved. [9] | [
  {
    "id": "doc_123",
    "score": 0.95
  },
  {
    "id": "doc_456",
    "score": 0.87
  },
  {
    "id": "doc_789",
    "score": 0.82
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.retrieval.query.text` | string | The query text used for retrieval. [10] | `What is the capital of France?`; `weather in Paris` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.system` | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | Replaced by `gen_ai.provider.name`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.system_instructions` | any | The system message or instructions provided to the GenAI model separately from the chat history. [11] | [
  {
    "type": "text",
    "content": "You are an Agent that greet users, always use greetings tool to respond"
  }
]; [
  {
    "type": "text",
    "content": "You are a language translator."
  },
  {
    "type": "text",
    "content": "Your mission is to translate text in English to French."
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.token.type` | string | The type of token being counted. | `input`; `output` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.call.arguments` | any | Parameters passed to the tool call. [12] | {
    "location": "San Francisco?",
    "date": "2025-10-01"
} | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.call.id` | string | The tool call identifier. | `call_mszuSIzqtI65i1wAUOE8w5H4` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.call.result` | any | The result returned by the tool call (if any and if execution was successful). [13] | {
  "temperature_range": {
    "high": 75,
    "low": 60
  },
  "conditions": "sunny"
} | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.definitions` | any | The list of tool definitions available to the GenAI agent or model. [14] | [
  {
    "type": "function",
    "name": "get_current_weather",
    "description": "Get the current weather in a given location",
    "parameters": {
      "type": "object",
      "properties": {
        "location": {
          "type": "string",
          "description": "The city and state, e.g. San Francisco, CA"
        },
        "unit": {
          "type": "string",
          "enum": [
            "celsius",
            "fahrenheit"
          ]
        }
      },
      "required": [
        "location",
        "unit"
      ]
    }
  }
] | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.description` | string | The tool description. | `Multiply two numbers` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.name` | string | Name of the tool utilized by the agent. | `Flights` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.tool.type` | string | Type of the tool utilized by the agent [15] | `function`; `extension`; `datastore` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.cache_creation.input_tokens` | int | The number of input tokens written to a provider-managed cache. [16] | `25` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.cache_read.input_tokens` | int | The number of input tokens served from a provider-managed cache. [17] | `50` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.completion_tokens` | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | Replaced by `gen_ai.usage.output_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.input_tokens` | int | The number of tokens used in the GenAI input (prompt). [18] | `100` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.output_tokens` | int | The number of tokens used in the GenAI response (completion). | `180` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.prompt_tokens` | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | Replaced by `gen_ai.usage.input_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.usage.reasoning.output_tokens` | int | The number of output tokens used for reasoning (e.g. chain-of-thought, extended thinking). [19] | `50` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `gen_ai.workflow.name` | string | Human-readable name of the GenAI workflow provided by the application. [20] | `multi_agent_rag`; `customer_support_pipeline` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `gen_ai.agent.description` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | +| `gen_ai.agent.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` | +| `gen_ai.agent.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Human-readable name of the GenAI agent provided by the application. | `Math Tutor`; `Fiction Writer` | +| `gen_ai.agent.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The version of the GenAI agent. | `1.0.0`; `2025-05-01` | +| `gen_ai.completion` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | +| `gen_ai.conversation.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The unique identifier for a conversation (session, thread), used to store and correlate messages within this conversation. | `conv_5j66UpCpwteGg4YSxUnt7lPY` | +| `gen_ai.data_source.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The data source identifier. [1] | `H7STPQYOND` | +| `gen_ai.embeddings.dimension.count` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of dimensions the resulting output embeddings should have. | `512`; `1024` | +| `gen_ai.evaluation.explanation` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | A free-form explanation for the assigned score provided by the evaluator. | `The response is factually accurate but lacks sufficient detail to fully address the question.` | +| `gen_ai.evaluation.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the evaluation metric used for the GenAI response. | `Relevance`; `IntentResolution` | +| `gen_ai.evaluation.score.label` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Human readable label for evaluation. [2] | `relevant`; `not_relevant`; `correct`; `incorrect`; `pass`; `fail` | +| `gen_ai.evaluation.score.value` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The evaluation score returned by the evaluator. | `4.0` | +| `gen_ai.input.messages` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The chat history provided to the model as an input. [3] | [
  {
    "role": "user",
    "parts": [
      {
        "type": "text",
        "content": "Weather in Paris?"
      }
    ]
  },
  {
    "role": "assistant",
    "parts": [
      {
        "type": "tool_call",
        "id": "call_VSPygqKTWdrhaFErNvMV18Yl",
        "name": "get_weather",
        "arguments": {
          "location": "Paris"
        }
      }
    ]
  },
  {
    "role": "tool",
    "parts": [
      {
        "type": "tool_call_response",
        "id": " call_VSPygqKTWdrhaFErNvMV18Yl",
        "result": "rainy, 57°F"
      }
    ]
  }
] | +| `gen_ai.openai.request.response_format` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.output.type`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | +| `gen_ai.openai.request.seed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.request.seed`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.request.seed`. | `100` | +| `gen_ai.openai.request.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.request.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | +| `gen_ai.openai.response.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | +| `gen_ai.openai.response.system_fingerprint` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.system_fingerprint`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | +| `gen_ai.operation.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the operation being performed. [4] | `chat`; `generate_content`; `text_completion` | +| `gen_ai.output.messages` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | Messages returned by the model where each message represents a specific model response (choice, candidate). [5] | [
  {
    "role": "assistant",
    "parts": [
      {
        "type": "text",
        "content": "The weather in Paris is currently rainy with a temperature of 57°F."
      }
    ],
    "finish_reason": "stop"
  }
] | +| `gen_ai.output.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Represents the content type requested by the client. [6] | `text`; `json`; `image` | +| `gen_ai.prompt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | +| `gen_ai.prompt.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the prompt that uniquely identifies it. | `analyze-code` | +| `gen_ai.provider.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The Generative AI provider as identified by the client or server instrumentation. [7] | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | +| `gen_ai.request.choice.count` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The target number of candidate completions to return. | `3` | +| `gen_ai.request.encoding_formats` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string[] | The encoding formats requested in an embeddings operation, if specified. [8] | `["base64"]`; `["float", "binary"]` | +| `gen_ai.request.frequency_penalty` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The frequency penalty setting for the GenAI request. | `0.1` | +| `gen_ai.request.max_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The maximum number of tokens the model generates for a request. | `100` | +| `gen_ai.request.model` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the GenAI model a request is being made to. | `gpt-4` | +| `gen_ai.request.presence_penalty` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The presence penalty setting for the GenAI request. | `0.1` | +| `gen_ai.request.seed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Requests with same seed value more likely to return same result. | `100` | +| `gen_ai.request.stop_sequences` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string[] | List of sequences that the model will use to stop generating further tokens. | `["forest", "lived"]` | +| `gen_ai.request.stream` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | boolean | Indicates whether the GenAI request was made in streaming mode. | | +| `gen_ai.request.temperature` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The temperature setting for the GenAI request. | `0.0` | +| `gen_ai.request.top_k` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The top_k sampling setting for the GenAI request. | `1.0` | +| `gen_ai.request.top_p` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The top_p sampling setting for the GenAI request. | `1.0` | +| `gen_ai.response.finish_reasons` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string[] | Array of reasons the model stopped generating tokens, corresponding to each generation received. | `["stop"]`; `["stop", "length"]` | +| `gen_ai.response.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The unique identifier for the completion. | `chatcmpl-123` | +| `gen_ai.response.model` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the model that generated the response. | `gpt-4-0613` | +| `gen_ai.response.time_to_first_chunk` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | Time to first chunk in a streaming response, measured from request issuance, in seconds. The value is measured from when the client issues the generation request to when the first chunk is received in the response stream. | `0.5`; `1.2` | +| `gen_ai.retrieval.documents` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The documents retrieved. [9] | [
  {
    "id": "doc_123",
    "score": 0.95
  },
  {
    "id": "doc_456",
    "score": 0.87
  },
  {
    "id": "doc_789",
    "score": 0.82
  }
] | +| `gen_ai.retrieval.query.text` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The query text used for retrieval. [10] | `What is the capital of France?`; `weather in Paris` | +| `gen_ai.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.provider.name`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | +| `gen_ai.system_instructions` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The system message or instructions provided to the GenAI model separately from the chat history. [11] | [
  {
    "type": "text",
    "content": "You are an Agent that greet users, always use greetings tool to respond"
  }
]; [
  {
    "type": "text",
    "content": "You are a language translator."
  },
  {
    "type": "text",
    "content": "Your mission is to translate text in English to French."
  }
] | +| `gen_ai.token.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The type of token being counted. | `input`; `output` | +| `gen_ai.tool.call.arguments` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | Parameters passed to the tool call. [12] | {
    "location": "San Francisco?",
    "date": "2025-10-01"
} | +| `gen_ai.tool.call.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The tool call identifier. | `call_mszuSIzqtI65i1wAUOE8w5H4` | +| `gen_ai.tool.call.result` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The result returned by the tool call (if any and if execution was successful). [13] | {
  "temperature_range": {
    "high": 75,
    "low": 60
  },
  "conditions": "sunny"
} | +| `gen_ai.tool.definitions` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The list of tool definitions available to the GenAI agent or model. [14] | [
  {
    "type": "function",
    "name": "get_current_weather",
    "description": "Get the current weather in a given location",
    "parameters": {
      "type": "object",
      "properties": {
        "location": {
          "type": "string",
          "description": "The city and state, e.g. San Francisco, CA"
        },
        "unit": {
          "type": "string",
          "enum": [
            "celsius",
            "fahrenheit"
          ]
        }
      },
      "required": [
        "location",
        "unit"
      ]
    }
  }
] | +| `gen_ai.tool.description` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The tool description. | `Multiply two numbers` | +| `gen_ai.tool.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Name of the tool utilized by the agent. | `Flights` | +| `gen_ai.tool.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Type of the tool utilized by the agent [15] | `function`; `extension`; `datastore` | +| `gen_ai.usage.cache_creation.input_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of input tokens written to a provider-managed cache. [16] | `25` | +| `gen_ai.usage.cache_read.input_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of input tokens served from a provider-managed cache. [17] | `50` | +| `gen_ai.usage.completion_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.output_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | +| `gen_ai.usage.input_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of tokens used in the GenAI input (prompt). [18] | `100` | +| `gen_ai.usage.output_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of tokens used in the GenAI response (completion). | `180` | +| `gen_ai.usage.prompt_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.input_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | +| `gen_ai.usage.reasoning.output_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of output tokens used for reasoning (e.g. chain-of-thought, extended thinking). [19] | `50` | +| `gen_ai.workflow.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Human-readable name of the GenAI workflow provided by the application. [20] | `multi_agent_rag`; `customer_support_pipeline` | **[1] `gen_ai.data_source.id`:** Data sources are used by AI agents and RAG applications to store grounding data. A data source may be an external database, object store, document collection, website, or any other storage system used by the GenAI agent or application. The `gen_ai.data_source.id` SHOULD match the identifier used by the GenAI system rather than a name specific to the external storage, such as a database or object store. Semantic conventions referencing `gen_ai.data_source.id` MAY also leverage additional attributes, such as `db.*`, to further identify and describe the data source. diff --git a/docs/registry/attributes/hardware.md b/docs/registry/attributes/hardware.md index 1bcf436329..66a198bab7 100644 --- a/docs/registry/attributes/hardware.md +++ b/docs/registry/attributes/hardware.md @@ -5,8 +5,6 @@ ## Hardware Attributes -Attributes for hardware. - **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 4f890869eb..290f0dda04 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -121,22 +121,22 @@ support custom route formatting. Instrumentations SHOULD document the format and
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `http.client_ip` | string | Deprecated, use `client.address` instead. | `83.164.160.102` | Use `client.address` instead. | -| `http.flavor` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | Split into `network.protocol.name` and `network.protocol.version` | -| `http.host` | string | Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. | `www.example.org` | Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. | -| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | Use `http.request.method` instead. | -| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | Replaced by `http.request.header.content-length`. | -| `http.request_content_length_uncompressed` | int | Deprecated, use `http.request.body.size` instead. | `5493` | Use `http.request.body.size` instead. | -| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | Replaced by `http.response.header.content-length`. | -| `http.response_content_length_uncompressed` | int | Deprecated, use `http.response.body.size` instead. | `5493` | Use `http.response.body.size` instead. | -| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` | Use `url.scheme` instead. | -| `http.server_name` | string | Deprecated, use `server.address` instead. | `example.com` | Use `server.address` instead. | -| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` | Use `http.response.status_code` instead. | -| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | Split to `url.path` and `url.query`. | -| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | Use `url.full` instead. | -| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `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` | Use `user_agent.original` instead. | +| `http.client_ip` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `client.address`. | string | Deprecated, use `client.address` instead. | `83.164.160.102` | +| `http.flavor` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split into `network.protocol.name` and `network.protocol.version` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | +| `http.host` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. | string | Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. | `www.example.org` | +| `http.method` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.method`. | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | +| `http.request_content_length` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.header.content-length`. | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | +| `http.request_content_length_uncompressed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.body.size`. | int | Deprecated, use `http.request.body.size` instead. | `5493` | +| `http.response_content_length` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.header.content-length`. | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | +| `http.response_content_length_uncompressed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.body.size`. | int | Deprecated, use `http.response.body.size` instead. | `5493` | +| `http.scheme` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.scheme`. | string | Deprecated, use `url.scheme` instead. | `http`; `https` | +| `http.server_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | string | Deprecated, use `server.address` instead. | `example.com` | +| `http.status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.status_code`. | int | Deprecated, use `http.response.status_code` instead. | `200` | +| `http.target` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split to `url.path` and `url.query`. | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | +| `http.url` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.full`. | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | +| `http.user_agent` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `user_agent.original`. | string | Deprecated, use `user_agent.original` instead. | `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` | --- diff --git a/docs/registry/attributes/hw.md b/docs/registry/attributes/hw.md deleted file mode 100644 index e3279bf815..0000000000 --- a/docs/registry/attributes/hw.md +++ /dev/null @@ -1,135 +0,0 @@ - - - -# Hw - -## Hw Attributes - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `hw.battery.capacity` | ![Development](https://img.shields.io/badge/-development-blue) | string | Design capacity in Watts-hours or Ampere-hours | `9.3Ah`; `50Wh` | -| `hw.battery.chemistry` | ![Development](https://img.shields.io/badge/-development-blue) | string | Battery [chemistry](https://schemas.dmtf.org/wbem/cim-html/2.31.0/CIM_Battery.html), e.g. Lithium-Ion, Nickel-Cadmium, etc. | `Li-ion`; `NiMH` | -| `hw.battery.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The current state of the battery | `charging`; `discharging` | -| `hw.bios_version` | ![Development](https://img.shields.io/badge/-development-blue) | string | BIOS version of the hardware component | `1.2.3` | -| `hw.driver_version` | ![Development](https://img.shields.io/badge/-development-blue) | string | Driver version for the hardware component | `10.2.1-3` | -| `hw.enclosure.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the enclosure (useful for modular systems) | `Computer`; `Storage`; `Switch` | -| `hw.firmware_version` | ![Development](https://img.shields.io/badge/-development-blue) | string | Firmware version of the hardware component | `2.0.1` | -| `hw.gpu.task` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of task the GPU is performing | `decoder`; `encoder`; `general` | -| `hw.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | -| `hw.limit_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of limit for hardware components | `critical`; `degraded`; `high.critical` | -| `hw.logical_disk.raid_level` | ![Development](https://img.shields.io/badge/-development-blue) | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | -| `hw.logical_disk.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | State of the logical disk space usage | `used`; `free` | -| `hw.memory.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the memory module | `DDR4`; `DDR5`; `LPDDR5` | -| `hw.model` | ![Development](https://img.shields.io/badge/-development-blue) | string | Descriptive model name of the hardware component | `PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery` | -| `hw.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | An easily-recognizable name for the hardware component | `eth0` | -| `hw.network.logical_addresses` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | Logical addresses of the adapter (e.g. IP address, or WWPN) | `["172.16.8.21", "57.11.193.42"]` | -| `hw.network.physical_address` | ![Development](https://img.shields.io/badge/-development-blue) | string | Physical address of the adapter (e.g. MAC address, or WWNN) | `00-90-F5-E9-7B-36` | -| `hw.parent` | ![Development](https://img.shields.io/badge/-development-blue) | string | Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) | `dellStorage_perc_0` | -| `hw.physical_disk.smart_attribute` | ![Development](https://img.shields.io/badge/-development-blue) | string | [S.M.A.R.T.](https://wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis, and Reporting Technology) attribute of the physical disk | `Spin Retry Count`; `Seek Error Rate`; `Raw Read Error Rate` | -| `hw.physical_disk.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | State of the physical disk endurance utilization | `remaining` | -| `hw.physical_disk.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the physical disk | `HDD`; `SSD`; `10K` | -| `hw.sensor_location` | ![Development](https://img.shields.io/badge/-development-blue) | string | Location of the sensor | `cpu0`; `ps1`; `INLET`; `CPU0_DIE`; `AMBIENT`; `MOTHERBOARD`; `PS0 V3_3`; `MAIN_12V`; `CPU_VCORE` | -| `hw.serial_number` | ![Development](https://img.shields.io/badge/-development-blue) | string | Serial number of the hardware component | `CNFCP0123456789` | -| `hw.state` | ![Development](https://img.shields.io/badge/-development-blue) | string | The current state of the component | `degraded`; `failed`; `needs_cleaning` | -| `hw.tape_drive.operation_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of tape drive operation | `mount`; `unmount`; `clean` | -| `hw.type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | -| `hw.vendor` | ![Development](https://img.shields.io/badge/-development-blue) | string | Vendor name of the hardware component | `Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo` | - -**[1] `hw.type`:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. - ---- - -`hw.battery.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `charging` | Charging | ![Development](https://img.shields.io/badge/-development-blue) | -| `discharging` | Discharging | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.gpu.task` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `decoder` | Decoder | ![Development](https://img.shields.io/badge/-development-blue) | -| `encoder` | Encoder | ![Development](https://img.shields.io/badge/-development-blue) | -| `general` | General | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.limit_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `critical` | Critical | ![Development](https://img.shields.io/badge/-development-blue) | -| `degraded` | Degraded | ![Development](https://img.shields.io/badge/-development-blue) | -| `high.critical` | High Critical | ![Development](https://img.shields.io/badge/-development-blue) | -| `high.degraded` | High Degraded | ![Development](https://img.shields.io/badge/-development-blue) | -| `low.critical` | Low Critical | ![Development](https://img.shields.io/badge/-development-blue) | -| `low.degraded` | Low Degraded | ![Development](https://img.shields.io/badge/-development-blue) | -| `max` | Maximum | ![Development](https://img.shields.io/badge/-development-blue) | -| `throttled` | Throttled | ![Development](https://img.shields.io/badge/-development-blue) | -| `turbo` | Turbo | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.logical_disk.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `free` | Free | ![Development](https://img.shields.io/badge/-development-blue) | -| `used` | Used | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.physical_disk.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `remaining` | Remaining | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `degraded` | Degraded | ![Development](https://img.shields.io/badge/-development-blue) | -| `failed` | Failed | ![Development](https://img.shields.io/badge/-development-blue) | -| `needs_cleaning` | Needs Cleaning | ![Development](https://img.shields.io/badge/-development-blue) | -| `ok` | OK | ![Development](https://img.shields.io/badge/-development-blue) | -| `predicted_failure` | Predicted Failure | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.tape_drive.operation_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `clean` | Clean | ![Development](https://img.shields.io/badge/-development-blue) | -| `mount` | Mount | ![Development](https://img.shields.io/badge/-development-blue) | -| `unmount` | Unmount | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `battery` | Battery | ![Development](https://img.shields.io/badge/-development-blue) | -| `cpu` | CPU | ![Development](https://img.shields.io/badge/-development-blue) | -| `disk_controller` | Disk controller | ![Development](https://img.shields.io/badge/-development-blue) | -| `enclosure` | Enclosure | ![Development](https://img.shields.io/badge/-development-blue) | -| `fan` | Fan | ![Development](https://img.shields.io/badge/-development-blue) | -| `gpu` | GPU | ![Development](https://img.shields.io/badge/-development-blue) | -| `logical_disk` | Logical disk | ![Development](https://img.shields.io/badge/-development-blue) | -| `memory` | Memory | ![Development](https://img.shields.io/badge/-development-blue) | -| `network` | Network | ![Development](https://img.shields.io/badge/-development-blue) | -| `physical_disk` | Physical disk | ![Development](https://img.shields.io/badge/-development-blue) | -| `power_supply` | Power supply | ![Development](https://img.shields.io/badge/-development-blue) | -| `tape_drive` | Tape drive | ![Development](https://img.shields.io/badge/-development-blue) | -| `temperature` | Temperature | ![Development](https://img.shields.io/badge/-development-blue) | -| `voltage` | Voltage | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index 5cc6289ffc..0ac31bdf21 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -28,11 +28,11 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [1] | `active`; `inactive`; `background` | Use `ios.app.state` instead. | +| `ios.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `ios.app.state`. | string | Deprecated. Use the `ios.app.state` attribute. [2] | `active`; `inactive`; `background` | -**[1] `ios.state`:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate), and from which the `OS terminology` column values are derived. +**[2] `ios.state`:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate), and from which the `OS terminology` column values are derived. --- diff --git a/docs/registry/attributes/jsonrpc.md b/docs/registry/attributes/jsonrpc.md index 422a216451..698e54c01e 100644 --- a/docs/registry/attributes/jsonrpc.md +++ b/docs/registry/attributes/jsonrpc.md @@ -3,7 +3,7 @@ # JSONRPC -## JSONRPC Attributes +## JSON-RPC Attributes **Attributes:** diff --git a/docs/registry/attributes/jvm.md b/docs/registry/attributes/jvm.md index 23e01726a5..c7c8ffc1d1 100644 --- a/docs/registry/attributes/jvm.md +++ b/docs/registry/attributes/jvm.md @@ -3,7 +3,7 @@ # JVM -## JVM Attributes +## Java Virtual Machine (JVM) Attributes **Attributes:** diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index ff36adf032..cc62d190b9 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -3,7 +3,7 @@ # K8s -## K8s Attributes +## Kubernetes Attributes **Attributes:** @@ -562,8 +562,8 @@ When not set, Kubernetes distributes traffic evenly across all endpoints cluster
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `k8s.pod.labels.` | string | Deprecated, use `k8s.pod.label` instead. | `my-app` | Use `k8s.pod.label` instead. | +| `k8s.pod.labels.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `k8s.pod.label`. | string | Deprecated, use `k8s.pod.label` instead. | `my-app` |
diff --git a/docs/registry/attributes/linux.md b/docs/registry/attributes/linux.md index 1029a7e5e1..042d96b0de 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -8,9 +8,9 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `linux.memory.slab.state` | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | Use `system.memory.linux.slab.state` instead. | +| `linux.memory.slab.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.memory.linux.slab.state`. | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | --- diff --git a/docs/registry/attributes/mcp.md b/docs/registry/attributes/mcp.md index 9fedf7ec66..4cca8c3bad 100644 --- a/docs/registry/attributes/mcp.md +++ b/docs/registry/attributes/mcp.md @@ -8,12 +8,12 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `mcp.method.name` | string | The name of the request or notification method. | `notifications/cancelled`; `initialize`; `notifications/initialized` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `mcp.protocol.version` | string | The [version](https://modelcontextprotocol.io/specification/versioning) of the Model Context Protocol used. | `2025-06-18` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `mcp.resource.uri` | string | The value of the resource uri. [1] | `postgres://database/customers/schema`; `file:///home/user/documents/report.pdf` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `mcp.session.id` | string | Identifies [MCP session](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#session-management). | `191c4850af6c49e08843a3f6c80e5046` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `mcp.method.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the request or notification method. | `notifications/cancelled`; `initialize`; `notifications/initialized` | +| `mcp.protocol.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The [version](https://modelcontextprotocol.io/specification/versioning) of the Model Context Protocol used. | `2025-06-18` | +| `mcp.resource.uri` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The value of the resource uri. [1] | `postgres://database/customers/schema`; `file:///home/user/documents/report.pdf` | +| `mcp.session.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Identifies [MCP session](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#session-management). | `191c4850af6c49e08843a3f6c80e5046` | **[1] `mcp.resource.uri`:** This is a URI of the resource provided in the following requests or notifications: `resources/read`, `resources/subscribe`, `resources/unsubscribe`, or `notifications/resources/updated`. diff --git a/docs/registry/attributes/message.md b/docs/registry/attributes/message.md index ed12472246..ca2152529b 100644 --- a/docs/registry/attributes/message.md +++ b/docs/registry/attributes/message.md @@ -8,12 +8,12 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `message.compressed_size` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | -| `message.id` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | -| `message.type` | string | Deprecated, no replacement at this time. | `SENT`; `RECEIVED` | Deprecated, no replacement at this time. | -| `message.uncompressed_size` | int | Deprecated, no replacement at this time. | | Deprecated, no replacement at this time. | +| `message.compressed_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | int | Deprecated, no replacement at this time. | | +| `message.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | int | Deprecated, no replacement at this time. | | +| `message.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | string | Deprecated, no replacement at this time. | `SENT`; `RECEIVED` | +| `message.uncompressed_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | int | Deprecated, no replacement at this time. | | --- diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index b32bf4658f..804132bc0f 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -135,16 +135,17 @@ size should be used.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | Removed. No replacement at this time. | -| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | Removed. No replacement at this time. | -| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | Use `messaging.consumer.group.name` instead. | -| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | Use `messaging.consumer.group.name` instead. | -| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | Record string representation of the partition id in `messaging.destination.partition.id` attribute. | -| `messaging.kafka.message.offset` | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | Use `messaging.kafka.offset` instead. | -| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | Use `messaging.operation.type` instead. | -| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | -| `messaging.servicebus.destination.subscription_name` | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` | Use `messaging.destination.subscription.name` instead. | +| `messaging.client_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.client.id`. | string | Deprecated, use `messaging.client.id` instead. | `client-5`; `myhost@8742@s8083jm` | +| `messaging.destination_publish.anonymous` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | boolean | Deprecated, no replacement at this time. | | +| `messaging.destination_publish.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | +| `messaging.eventhubs.consumer.group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name`. | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | +| `messaging.kafka.consumer.group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name`. | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | +| `messaging.kafka.destination.partition` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Record string representation of the partition id in `messaging.destination.partition.id` attribute. | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | +| `messaging.kafka.message.offset` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.kafka.offset`. | int | Deprecated, use `messaging.kafka.offset` instead. | `42` | +| `messaging.operation` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.operation.type`. | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | +| `messaging.rocketmq.client_group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | +| `messaging.servicebus.destination.subscription_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.destination.subscription.name`. | string | Deprecated, use `messaging.destination.subscription.name` instead. | `subscription-a` |
diff --git a/docs/registry/attributes/net.md b/docs/registry/attributes/net.md index 846300ea5f..a4fd95ff85 100644 --- a/docs/registry/attributes/net.md +++ b/docs/registry/attributes/net.md @@ -8,23 +8,23 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | Use `network.local.address` instead. | -| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | Use `server.address` instead. | -| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | Use `server.port` instead. | -| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | Use `network.peer.address` instead. | -| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | Replaced by `server.address` on client spans and `client.address` on server spans. | -| `net.peer.port` | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | Replaced by `server.port` on client spans and `client.port` on server spans. | -| `net.protocol.name` | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | Use `network.protocol.name` instead. | -| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | Use `network.protocol.version` instead. | -| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | Split to `network.transport` and `network.type`. | -| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | Use `network.local.address` instead. | -| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | Use `network.local.port` instead. | -| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | Use `network.peer.address` instead. | -| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | Removed. No replacement at this time. | -| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | Use `network.peer.port` instead. | -| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | Use `network.transport` instead. | +| `net.host.ip` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | string | Deprecated, use `network.local.address`. | `192.168.0.1` | +| `net.host.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | string | Deprecated, use `server.address`. | `example.com` | +| `net.host.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port`. | int | Deprecated, use `server.port`. | `8080` | +| `net.peer.ip` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | +| `net.peer.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` on client spans and `client.address` on server spans. | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | +| `net.peer.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port` on client spans and `client.port` on server spans. | int | Deprecated, use `server.port` on client spans and `client.port` on server spans. | `8080` | +| `net.protocol.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.name`. | string | Deprecated, use `network.protocol.name`. | `amqp`; `http`; `mqtt` | +| `net.protocol.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.version`. | string | Deprecated, use `network.protocol.version`. | `3.1.1` | +| `net.sock.family` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split to `network.transport` and `network.type`. | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | +| `net.sock.host.addr` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | string | Deprecated, use `network.local.address`. | `/var/my.sock` | +| `net.sock.host.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.port`. | int | Deprecated, use `network.local.port`. | `8080` | +| `net.sock.peer.addr` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | +| `net.sock.peer.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | string | Deprecated, no replacement at this time. | `/var/my.sock` | +| `net.sock.peer.port` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.port`. | int | Deprecated, use `network.peer.port`. | `65531` | +| `net.transport` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.transport`. | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | --- diff --git a/docs/registry/attributes/nodejs.md b/docs/registry/attributes/nodejs.md index 21a4ff10d2..805e09b128 100644 --- a/docs/registry/attributes/nodejs.md +++ b/docs/registry/attributes/nodejs.md @@ -3,7 +3,7 @@ # NodeJS -## NodeJS Attributes +## Node.js Attributes **Attributes:** diff --git a/docs/registry/attributes/oci.md b/docs/registry/attributes/oci.md index f5a955912e..a5d9840fe9 100644 --- a/docs/registry/attributes/oci.md +++ b/docs/registry/attributes/oci.md @@ -3,7 +3,7 @@ # OCI -## OCI Attributes +## Open Container Initiative (OCI) Attributes **Attributes:** diff --git a/docs/registry/attributes/onc-rpc.md b/docs/registry/attributes/onc-rpc.md index fd223bab20..24e9d7ee4e 100644 --- a/docs/registry/attributes/onc-rpc.md +++ b/docs/registry/attributes/onc-rpc.md @@ -3,7 +3,7 @@ # ONC RPC -## ONC RPC Attributes +## ONC RPC (Sun RPC) Attributes **Attributes:** diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 7fd81ff867..92892edf03 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -8,12 +8,12 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `openai.api.type` | string | The type of OpenAI API being used. | `chat_completions`; `responses` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `openai.request.service_tier` | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `openai.response.service_tier` | string | The service tier used for the response. | `scale`; `default` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | -| `openai.response.system_fingerprint` | string | A fingerprint to track any eventual change in the Generative AI environment. | `fp_44709d6fcb` | Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | +| `openai.api.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The type of OpenAI API being used. | `chat_completions`; `responses` | +| `openai.request.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` | +| `openai.response.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The service tier used for the response. | `scale`; `default` | +| `openai.response.system_fingerprint` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | A fingerprint to track any eventual change in the Generative AI environment. | `fp_44709d6fcb` | --- diff --git a/docs/registry/attributes/oracledb.md b/docs/registry/attributes/oracledb.md deleted file mode 100644 index e4cd29e1b4..0000000000 --- a/docs/registry/attributes/oracledb.md +++ /dev/null @@ -1,41 +0,0 @@ - - - -# OracleDB - -## Oracle Database Attributes - -This section defines attributes for Oracle Database. - -**Attributes:** - -| Key | Stability | Value Type | Description | Example Values | -| --- | --- | --- | --- | --- | -| `oracle.db.domain` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The database domain associated with the connection. [1] | `example.com`; `corp.internal`; `prod.db.local` | -| `oracle.db.instance.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [2] | `ORCL1`; `ORCL2`; `ORCL3` | -| `oracle.db.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The database name associated with the connection. [3] | `ORCL1`; `FREE` | -| `oracle.db.pdb` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The pluggable database (PDB) name associated with the connection. [4] | `PDB1`; `FREEPDB` | -| `oracle.db.service` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The service name currently associated with the database connection. [5] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | - -**[1] `oracle.db.domain`:** This attribute SHOULD be set to the value of the `DB_DOMAIN` initialization parameter, -as exposed in `v$parameter`. `DB_DOMAIN` defines the domain portion of the global -database name and SHOULD be configured when a database is, or may become, part of a -distributed environment. Its value consists of one or more valid identifiers -(alphanumeric ASCII characters) separated by periods. - -**[2] `oracle.db.instance.name`:** There can be multiple instances associated with a single database service. It indicates the -unique instance name to which the connection is currently bound. For non-RAC databases, this value -defaults to the `oracle.db.name`. - -**[3] `oracle.db.name`:** This attribute SHOULD be set to the value of the parameter `DB_NAME` exposed in `v$parameter`. - -**[4] `oracle.db.pdb`:** This attribute SHOULD reflect the PDB that the session is currently connected to. -If instrumentation cannot reliably obtain the active PDB name for each operation -without issuing an additional query (such as `SELECT SYS_CONTEXT`), it is -RECOMMENDED to fall back to the PDB name specified at connection establishment. - -**[5] `oracle.db.service`:** The effective service name for a connection can change during its lifetime, -for example after executing sql, `ALTER SESSION`. If an instrumentation cannot reliably -obtain the current service name for each operation without issuing an additional -query (such as `SELECT SYS_CONTEXT`), it is RECOMMENDED to fall back to the -service name originally provided at connection establishment. diff --git a/docs/registry/attributes/os.md b/docs/registry/attributes/os.md index 20c5120cad..d1f6187365 100644 --- a/docs/registry/attributes/os.md +++ b/docs/registry/attributes/os.md @@ -3,7 +3,7 @@ # OS -## OS Attributes +## Operating System Attributes **Attributes:** diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index af28cffc7d..a25ad88cc3 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -94,9 +94,9 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | Use `otel.scope.name` instead. | -| `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | Use `otel.scope.version` instead. | +| `otel.library.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `otel.scope.name`. | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | +| `otel.library.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `otel.scope.version`. | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` |
diff --git a/docs/registry/attributes/other.md b/docs/registry/attributes/other.md index 5382661bf5..0290b8e562 100644 --- a/docs/registry/attributes/other.md +++ b/docs/registry/attributes/other.md @@ -8,9 +8,9 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | Use `db.client.connection.state` instead. | +| `state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | string | Deprecated, use `db.client.connection.state` instead. | `idle` | --- diff --git a/docs/registry/attributes/peer.md b/docs/registry/attributes/peer.md index c330c7583f..6cc09ff286 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -8,9 +8,9 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `peer.service` | string | 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. [1] | `AuthTokenCache` | Use `service.peer.name` instead. | +| `peer.service` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `service.peer.name`. | string | 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. [1] | `AuthTokenCache` | **[1] `peer.service`:** Examples of `peer.service` that users may specify: diff --git a/docs/registry/attributes/pool.md b/docs/registry/attributes/pool.md index bd28a40dea..932c93b4c8 100644 --- a/docs/registry/attributes/pool.md +++ b/docs/registry/attributes/pool.md @@ -8,8 +8,8 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | Use `db.client.connection.pool.name` instead. | +| `pool.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` |
diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 692b9ae764..f6f217af3d 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -98,11 +98,21 @@ represented as a hex string.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | Use `cpu.mode` instead. | -| `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | Use `process.executable.build_id.htlhash` instead. | -| `process.paging.fault_type` | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | Use `system.paging.fault.type` instead. | +| `process.context_switch_type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.context_switch.type`. | string | "Deprecated, use `process.context_switch.type` instead." | `voluntary`; `involuntary` | +| `process.cpu.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | +| `process.executable.build_id.profiling` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.executable.build_id.htlhash`. | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | +| `process.paging.fault_type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.paging.fault.type`. | string | Deprecated, use `system.paging.fault.type` instead. | `major`; `minor` | + +--- + +`process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `involuntary` | involuntary | ![Development](https://img.shields.io/badge/-development-blue) | +| `voluntary` | voluntary | ![Development](https://img.shields.io/badge/-development-blue) | --- diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 1b79bc7a5d..593969b028 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -3,7 +3,7 @@ # RPC -## RPC Attributes +## Remote Procedure Call (RPC) Attributes **Attributes:** @@ -71,26 +71,26 @@ Semantic conventions for individual RPC frameworks SHOULD document what `rpc.res
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `rpc.connect_rpc.error_code` | string | Deprecated, use `rpc.response.status_code` attribute instead. | `cancelled`; `unknown`; `invalid_argument` | Use `rpc.response.status_code` instead. | -| `rpc.connect_rpc.request.metadata.` | string[] | Deprecated, use `rpc.request.metadata` instead. | `["1.2.3.4", "1.2.3.5"]` | Use `rpc.request.metadata` instead. | -| `rpc.connect_rpc.response.metadata.` | string[] | Deprecated, use `rpc.response.metadata` instead. | `["attribute_value"]` | Use `rpc.response.metadata` instead. | -| `rpc.grpc.request.metadata.` | string[] | Deprecated, use `rpc.request.metadata` instead. | `["1.2.3.4", "1.2.3.5"]` | Use `rpc.request.metadata` instead. | -| `rpc.grpc.response.metadata.` | string[] | Deprecated, use `rpc.response.metadata` instead. | `["attribute_value"]` | Use `rpc.response.metadata` instead. | -| `rpc.grpc.status_code` | int | Deprecated, use string representation on the `rpc.response.status_code` attribute instead. | `0`; `1`; `2` | Use string representation of the gRPC status code on the `rpc.response.status_code` attribute. | -| `rpc.jsonrpc.error_code` | int | Deprecated, use string representation on the `rpc.response.status_code` attribute instead. | `-32700`; `100` | Use string representation of the error code on the `rpc.response.status_code` attribute. | -| `rpc.jsonrpc.error_message` | string | Deprecated, use the span status description when reporting JSON-RPC spans. | `Parse error`; `User already exists` | Use the span status description when reporting JSON-RPC spans. | -| `rpc.jsonrpc.request_id` | string | Deprecated, use `jsonrpc.request.id` instead. | `10`; `request-7`; `` | Use `jsonrpc.request.id` instead. | -| `rpc.jsonrpc.version` | string | Deprecated, use `jsonrpc.protocol.version` instead. | `2.0`; `1.0` | Use `jsonrpc.protocol.version` instead. | -| `rpc.message.compressed_size` | int | Compressed size of the message in bytes. | | Deprecated, no replacement at this time. | -| `rpc.message.id` | int | MUST be calculated as two different counters starting from `1` one for sent messages and one for received message. [1] | | Deprecated, no replacement at this time. | -| `rpc.message.type` | string | Whether this is a received or sent message. | `SENT`; `RECEIVED` | Deprecated, no replacement at this time. | -| `rpc.message.uncompressed_size` | int | Uncompressed size of the message in bytes. | | Deprecated, no replacement at this time. | -| `rpc.service` | string | Deprecated, use fully-qualified `rpc.method` instead. | `myservice.EchoService` | Value should be included in `rpc.method` which is expected to be a fully-qualified name. | -| `rpc.system` | string | Deprecated, use `rpc.system.name` attribute instead. | `grpc`; `java_rmi`; `dotnet_wcf` | Use `rpc.system.name` instead. | - -**[1] `rpc.message.id`:** This way we guarantee that the values will be consistent between different implementations. +| `rpc.connect_rpc.error_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.response.status_code`. | string | Deprecated, use `rpc.response.status_code` attribute instead. | `cancelled`; `unknown`; `invalid_argument` | +| `rpc.connect_rpc.request.metadata.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.request.metadata`. | string[] | Deprecated, use `rpc.request.metadata` instead. | `["1.2.3.4", "1.2.3.5"]` | +| `rpc.connect_rpc.response.metadata.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.response.metadata`. | string[] | Deprecated, use `rpc.response.metadata` instead. | `["attribute_value"]` | +| `rpc.grpc.request.metadata.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.request.metadata`. | string[] | Deprecated, use `rpc.request.metadata` instead. | `["1.2.3.4", "1.2.3.5"]` | +| `rpc.grpc.response.metadata.` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.response.metadata`. | string[] | Deprecated, use `rpc.response.metadata` instead. | `["attribute_value"]` | +| `rpc.grpc.status_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use string representation of the gRPC status code on the `rpc.response.status_code` attribute. | int | Deprecated, use string representation on the `rpc.response.status_code` attribute instead. | `0`; `1`; `2` | +| `rpc.jsonrpc.error_code` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use string representation of the error code on the `rpc.response.status_code` attribute. | int | Deprecated, use string representation on the `rpc.response.status_code` attribute instead. | `-32700`; `100` | +| `rpc.jsonrpc.error_message` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use the span status description when reporting JSON-RPC spans. | string | Deprecated, use the span status description when reporting JSON-RPC spans. | `Parse error`; `User already exists` | +| `rpc.jsonrpc.request_id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `jsonrpc.request.id`. | string | Deprecated, use `jsonrpc.request.id` instead. | `10`; `request-7`; `` | +| `rpc.jsonrpc.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `jsonrpc.protocol.version`. | string | Deprecated, use `jsonrpc.protocol.version` instead. | `2.0`; `1.0` | +| `rpc.message.compressed_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | int | Compressed size of the message in bytes. | | +| `rpc.message.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | int | MUST be calculated as two different counters starting from `1` one for sent messages and one for received message. [6] | | +| `rpc.message.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | string | Whether this is a received or sent message. | `SENT`; `RECEIVED` | +| `rpc.message.uncompressed_size` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no replacement at this time. | int | Uncompressed size of the message in bytes. | | +| `rpc.service` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Value should be included in `rpc.method` which is expected to be a fully-qualified name. | string | Deprecated, use fully-qualified `rpc.method` instead. | `myservice.EchoService` | +| `rpc.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.system.name`. | string | Deprecated, use `rpc.system.name` attribute instead. | `grpc`; `java_rmi`; `dotnet_wcf` | + +**[6] `rpc.message.id`:** This way we guarantee that the values will be consistent between different implementations. --- diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index a79905ebcf..3662d70591 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -105,14 +105,14 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | Use `cpu.logical_number` instead. | -| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | Use `cpu.mode` instead. | -| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | Use `network.connection.state` instead. | -| `system.paging.type` | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | Use `system.paging.fault.type` instead. | -| `system.process.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | -| `system.processes.status` | string | Deprecated, use `process.state` instead. | `running` | Use `process.state` instead. | +| `system.cpu.logical_number` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.logical_number`. | int | Deprecated, use `cpu.logical_number` instead. | `1` | +| `system.cpu.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | +| `system.network.state` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.connection.state`. | string | Deprecated, use `network.connection.state` instead. | `close_wait` | +| `system.paging.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.paging.fault.type`. | string | Deprecated, use `system.paging.fault.type` instead. | `minor` | +| `system.process.status` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.state`. | string | Deprecated, use `process.state` instead. | `running` | +| `system.processes.status` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.state`. | string | Deprecated, use `process.state` instead. | `running` | --- diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index b7026258f7..ce46113792 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -52,8 +52,8 @@
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | Use `server.address` instead. | +| `tls.client.server_name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | string | Deprecated, use `server.address` instead. | `opentelemetry.io` |
diff --git a/docs/registry/attributes/user-agent.md b/docs/registry/attributes/user-agent.md index 0c3c0cf66d..d7548325ce 100644 --- a/docs/registry/attributes/user-agent.md +++ b/docs/registry/attributes/user-agent.md @@ -3,7 +3,7 @@ # User agent -## User Agent Attributes +## User-agent Attributes **Attributes:** diff --git a/docs/registry/attributes/v8js.md b/docs/registry/attributes/v8js.md index 565c2c5371..1889f6c5ab 100644 --- a/docs/registry/attributes/v8js.md +++ b/docs/registry/attributes/v8js.md @@ -3,7 +3,7 @@ # V8js -## V8js Attributes +## V8 JS Attributes **Attributes:** diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index ddbafd997f..dcd39ec29f 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -143,13 +143,13 @@ the `.git` extension.
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `vcs.repository.change.id` | string | Deprecated, use `vcs.change.id` instead. | `123` | Use `vcs.change.id` instead. | -| `vcs.repository.change.title` | string | Deprecated, use `vcs.change.title` instead. | `Fixes broken thing`; `feat: add my new feature`; `[chore] update dependency` | Use `vcs.change.title` instead. | -| `vcs.repository.ref.name` | string | Deprecated, use `vcs.ref.head.name` instead. | `my-feature-branch`; `tag-1-test` | Use `vcs.ref.head.name` instead. | -| `vcs.repository.ref.revision` | string | Deprecated, use `vcs.ref.head.revision` instead. | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | Use `vcs.ref.head.revision` instead. | -| `vcs.repository.ref.type` | string | Deprecated, use `vcs.ref.head.type` instead. | `branch`; `tag` | Use `vcs.ref.head.type` instead. | +| `vcs.repository.change.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.change.id`. | string | Deprecated, use `vcs.change.id` instead. | `123` | +| `vcs.repository.change.title` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.change.title`. | string | Deprecated, use `vcs.change.title` instead. | `Fixes broken thing`; `feat: add my new feature`; `[chore] update dependency` | +| `vcs.repository.ref.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.name`. | string | Deprecated, use `vcs.ref.head.name` instead. | `my-feature-branch`; `tag-1-test` | +| `vcs.repository.ref.revision` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.revision`. | string | Deprecated, use `vcs.ref.head.revision` instead. | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | +| `vcs.repository.ref.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.type`. | string | Deprecated, use `vcs.ref.head.type` instead. | `branch`; `tag` | --- diff --git a/docs/registry/attributes/webengine.md b/docs/registry/attributes/webengine.md index 1b939ff63d..d016871104 100644 --- a/docs/registry/attributes/webengine.md +++ b/docs/registry/attributes/webengine.md @@ -3,7 +3,7 @@ # Webengine -## Webengine Attributes +## Web Engine Attributes **Attributes:** diff --git a/docs/registry/attributes/zos.md b/docs/registry/attributes/zos.md index bc720a948e..de6dc5a5c6 100644 --- a/docs/registry/attributes/zos.md +++ b/docs/registry/attributes/zos.md @@ -3,7 +3,7 @@ # zOS -## zOS Attributes +## z/OS Attributes **Attributes:** diff --git a/templates/registry/markdown/attribute_macros.j2 b/templates/registry/markdown/attribute_macros.j2 index a6990a8884..17eac8ea0c 100644 --- a/templates/registry/markdown/attribute_macros.j2 +++ b/templates/registry/markdown/attribute_macros.j2 @@ -16,11 +16,11 @@ {% macro name(attribute) %}{%- if attribute.type is startingwith("template[") %}{{ attribute.name }}. {%- else %}{{ attribute.name }}{%- endif %}{% endmacro %} -{% macro find_lineage(attr_id, lineage) %}{% if attr_id in lineage %}{{lineage[attr_id].source_group}}{% endif %}{% endmacro %} +{% macro find_lineage(attr_id, lineage) %}{% if attr_id in lineage %}{{lineage[attr_id]}}{% endif %}{% endmacro %} -{% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[`{{name(attribute)}}`]({{attribute_registry_base_url}}/{{ find_lineage(attribute.name, lineage_attributes) | split_id | list | reject("eq", "registry")| first | kebab_case }}.md){% endmacro %} +{% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[`{{name(attribute)}}`]({{attribute_registry_base_url}}/{{ attribute.name | split_id | list | reject("eq", "registry")| first | kebab_case | map_text("root_namespace_aliases") }}.md){% endmacro %} -{% macro display_name(group) %}{{ group | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes +{% macro display_name(group) %}{{ group | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym | map_text("namespace_names") }} Attributes {% endmacro %} {% macro heading_link_fragments(title) %}{{ title | trim | lower | replace(" ", "-") | replace("(", "") | replace(")", "") | replace("/", "") | replace("\\", "") | replace(".", "") | replace("!", "") | replace("?", "") | replace("~", "") | replace("#", "")}}{% endmacro %} diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 19b760a745..a04f1f6630 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -13,7 +13,7 @@ -# {{ attrs.humanize(attrs.sentence_case(ctx.root_namespace)) | acronym | map_text("namespace_mapping") }} +# {{ attrs.humanize(attrs.sentence_case(ctx.root_namespace)) | acronym | map_text("namespace_titles") }} ## {{ attrs.display_name(ctx.root_namespace) }} {% set filtered_attributes = ctx.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}**Attributes:** @@ -26,4 +26,4 @@ {{ notes.render() }} {%- for enum in filtered_attributes | sort(attribute="name") %} {%- if enum.type is mapping -%}{{ enums.table(enum, notes) }}{% endif %} -{%- endfor -%}{% endif %}{% if (ctx.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(ctx.attributes, "", "", "") | trim }}{% if filtered_attributes | length != ctx.attributes | length %}{{"\n"}}{%endif%} +{%- endfor -%}{% endif %}{% if (ctx.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(ctx.attributes, "", "", "", notes) | trim }}{% if filtered_attributes | length != ctx.attributes | length %}{{"\n"}}{%endif%} diff --git a/templates/registry/markdown/attribute_table.j2 b/templates/registry/markdown/attribute_table.j2 index a062731581..e765989364 100644 --- a/templates/registry/markdown/attribute_table.j2 +++ b/templates/registry/markdown/attribute_table.j2 @@ -12,15 +12,15 @@ | --- | --- | --- | --- | --- | --- | {% for attribute in filtered_attributes | attribute_sort %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute), "deprecated": attribute.deprecated}, notes) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) }}| {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} -{% endif %}{{ generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes)}}{% endmacro %} +{% endif %}{{ generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, notes)}}{% endmacro %} {#- Macro for creating deprecated attribute table -#} -{% macro generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | selectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}
+{% macro generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, notes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | selectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}
Deprecated Attributes: -| Key | Value Type | Description | Example Values | Deprecation Explanation | +| Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -{% for attribute in filtered_attributes %}| {% if attribute_registry_base_url != "" %}{{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }}{% else %}{% set attr_anchor = attribute.name | kebab_case %}`{{ attrs.name(attribute) }}`{%endif%} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) }}|{% if attribute.deprecated.reason == "renamed" %} Use `{{attribute.deprecated.renamed_to}}` instead. {% else %} {{attribute.deprecated.note | trim}} {% endif %}| +{% for attribute in filtered_attributes %}| {% if attribute_registry_base_url != "" %}{{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }}{% else %}{% set attr_anchor = attribute.name | kebab_case %}`{{ attrs.name(attribute) }}`{%endif%} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) }}| {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }}
{% endif %}{% endmacro %} diff --git a/templates/registry/markdown/attributes_readme.md.j2 b/templates/registry/markdown/attributes_readme.md.j2 index 7322e8ef31..ed68e5f0e3 100644 --- a/templates/registry/markdown/attributes_readme.md.j2 +++ b/templates/registry/markdown/attributes_readme.md.j2 @@ -32,7 +32,7 @@ All registered attributes are listed by namespace in this registry. Currently, the following namespaces exist: {% for bundle in ctx %} -{%- set my_file_name = bundle.root_namespace | kebab_case ~ ".md" -%} +{%- set my_file_name = bundle.root_namespace | kebab_case | map_text("root_namespace_aliases") ~ ".md" -%} - [{{ bundle.root_namespace | title_case | acronym | map_text("namespace_mapping") }}]({{ my_file_name }}) {% endfor %} [developers recommendations]: ../../general/naming.md#recommendations-for-application-developers diff --git a/templates/registry/markdown/weaver.yaml b/templates/registry/markdown/weaver.yaml index 2e3dd10aa6..fd08b1f5f7 100644 --- a/templates/registry/markdown/weaver.yaml +++ b/templates/registry/markdown/weaver.yaml @@ -4,9 +4,11 @@ templates: application_mode: single file_name: attributes/README.md - pattern: attribute_namespace.md.j2 - filter: semconv_grouped_attributes + filter: 'semconv_grouped_attributes({ + "ignore_code_generation_annotations": true + })' application_mode: each - file_name: attributes/{{ ctx.root_namespace | lower | kebab_case }}.md + file_name: 'attributes/{{ ctx.root_namespace | lower | kebab_case | map_text("root_namespace_aliases") }}.md' - pattern: registry_readme.md.j2 filter: "." application_mode: single @@ -66,3 +68,28 @@ text_maps: CICD Pipeline: CI/CD Pipeline CICD Pipeline Run: CI/CD Pipeline Run CICD Worker: CI/CD Worker + root_namespace_aliases: + hw: hardware + namespace_titles: + Hw: Hardware + CICD: CI/CD + namespace_names: + App: Application + Aspnetcore: ASP.NET Core + Dotnet: .NET + Enduser: End User + FaaS: Function as a Service + GCP: Google Cloud Platform + Hw: Hardware + JSONRPC: JSON-RPC + JVM: Java Virtual Machine (JVM) + K8s: Kubernetes + NodeJS: Node.js + OCI: Open Container Initiative (OCI) + ONC RPC: ONC RPC (Sun RPC) + OS: Operating System + RPC: Remote Procedure Call (RPC) + User Agent: User-agent + V8js: V8 JS + Webengine: Web Engine + zOS: z/OS From fb72d1ec7318265202d3a05cee1eb8e62e170e61 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Fri, 3 Jul 2026 12:20:16 +1000 Subject: [PATCH 7/9] Descope pt. 2 --- docs/registry/attributes/artifact.md | 2 + docs/registry/attributes/aws.md | 168 +++++++++++++++--- docs/registry/attributes/az.md | 4 +- docs/registry/attributes/cicd.md | 4 +- docs/registry/attributes/client.md | 2 + docs/registry/attributes/db.md | 4 +- docs/registry/attributes/destination.md | 2 + docs/registry/attributes/faas.md | 2 +- docs/registry/attributes/gcp.md | 90 +++++++--- docs/registry/attributes/gen-ai.md | 93 ++++++---- docs/registry/attributes/geo.md | 3 + docs/registry/attributes/mcp.md | 9 +- docs/registry/attributes/openai.md | 9 +- docs/registry/attributes/security-rule.md | 4 +- docs/registry/attributes/server.md | 2 + docs/registry/attributes/session.md | 4 + docs/registry/attributes/source.md | 2 + docs/registry/attributes/test.md | 2 + docs/registry/attributes/thread.md | 2 + docs/registry/attributes/vcs.md | 16 +- .../markdown/attribute_group_namespace.md.j2 | 53 ++++++ .../registry/markdown/attribute_macros.j2 | 6 +- .../markdown/attribute_namespace.md.j2 | 3 +- templates/registry/markdown/weaver.yaml | 11 +- 24 files changed, 390 insertions(+), 107 deletions(-) create mode 100644 templates/registry/markdown/attribute_group_namespace.md.j2 diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index 3de39093a8..4c357385a3 100644 --- a/docs/registry/attributes/artifact.md +++ b/docs/registry/attributes/artifact.md @@ -5,6 +5,8 @@ ## Artifact Attributes +This group describes attributes specific to artifacts. Artifacts are files or other immutable objects that are intended for distribution. This definition aligns directly with the [SLSA](https://slsa.dev/spec/v1.0/terminology#package-model) package model. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index c6bddec116..9571539e3f 100644 --- a/docs/registry/attributes/aws.md +++ b/docs/registry/attributes/aws.md @@ -3,7 +3,34 @@ # AWS -## AWS Attributes +- [General AWS Attributes](#general-aws-attributes) +- [Amazon Bedrock Attributes](#amazon-bedrock-attributes) +- [Amazon DynamoDB Attributes](#amazon-dynamodb-attributes) +- [Amazon ECS Attributes](#amazon-ecs-attributes) +- [Amazon EKS Attributes](#amazon-eks-attributes) +- [Amazon Kinesis Attributes](#amazon-kinesis-attributes) +- [Amazon Lambda Attributes](#amazon-lambda-attributes) +- [Amazon Logs Attributes](#amazon-logs-attributes) +- [Amazon S3 Attributes](#amazon-s3-attributes) +- [Amazon Secrets Manager Attributes](#amazon-secrets-manager-attributes) +- [Amazon SNS Attributes](#amazon-sns-attributes) +- [Amazon SQS Attributes](#amazon-sqs-attributes) +- [Amazon Step Functions Attributes](#amazon-step-functions-attributes) + +## General AWS Attributes + +This section defines generic attributes for AWS services. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `aws.extended_request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | +| `aws.request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | + +## Amazon Bedrock Attributes + +This document defines attributes for AWS Bedrock. **Attributes:** @@ -11,6 +38,15 @@ | --- | --- | --- | --- | --- | | `aws.bedrock.guardrail.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Guardrail. A [guardrail](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) helps safeguard and prevent unwanted behavior from model responses or user messages. | `sgi5gkybzqak` | | `aws.bedrock.knowledge_base.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the AWS Bedrock Knowledge base. A [knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) is a bank of information that can be queried by models to generate more relevant responses and augment prompts. | `XFWUPB9PAW` | + +## Amazon DynamoDB Attributes + +This document defines attributes for AWS DynamoDB. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | | `aws.dynamodb.attribute_definitions` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]` | | `aws.dynamodb.attributes_to_get` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The value of the `AttributesToGet` request parameter. | `["lives", "id"]` | | `aws.dynamodb.consistent_read` | ![Development](https://img.shields.io/badge/-development-blue) | boolean | The value of the `ConsistentRead` request parameter. | | @@ -33,6 +69,15 @@ | `aws.dynamodb.table_count` | ![Development](https://img.shields.io/badge/-development-blue) | int | The number of items in the `TableNames` response parameter. | `20` | | `aws.dynamodb.table_names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The keys in the `RequestItems` object field. | `["Users", "Cats"]` | | `aws.dynamodb.total_segments` | ![Development](https://img.shields.io/badge/-development-blue) | int | The value of the `TotalSegments` request parameter. | `100` | + +## Amazon ECS Attributes + +This document defines attributes for AWS Elastic Container Service (ECS). + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | | `aws.ecs.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | | `aws.ecs.container.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). | `arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9` | | `aws.ecs.launchtype` | ![Development](https://img.shields.io/badge/-development-blue) | string | The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task. | `ec2`; `fargate` | @@ -40,29 +85,61 @@ | `aws.ecs.task.family` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `opentelemetry-family` | | `aws.ecs.task.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ID of a running ECS task. The ID MUST be extracted from `task.arn`. | `10838bed-421f-43ef-870a-f43feacbbb5b`; `23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd` | | `aws.ecs.task.revision` | ![Development](https://img.shields.io/badge/-development-blue) | string | The revision for the task definition used to create the ECS task. | `8`; `26` | + +--- + +`aws.ecs.launchtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `ec2` | Amazon EC2 | ![Development](https://img.shields.io/badge/-development-blue) | +| `fargate` | Amazon Fargate | ![Development](https://img.shields.io/badge/-development-blue) | + +## Amazon EKS Attributes + +This document defines attributes for AWS Elastic Kubernetes Service (EKS). + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | | `aws.eks.cluster.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | -| `aws.extended_request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | + +## Amazon Kinesis Attributes + +This document defines attributes for AWS Kinesis. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | | `aws.kinesis.stream_name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the AWS Kinesis [stream](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) the request refers to. Corresponds to the `--stream-name` parameter of the Kinesis [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) operation. | `some-stream-name` | + +## Amazon Lambda Attributes + +This document defines attributes for AWS Lambda. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | | `aws.lambda.invoked_arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). [1] | `arn:aws:lambda:us-east-1:123456:function:myfunction:myalias` | | `aws.lambda.resource_mapping.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. | `587ad24b-03b9-4413-8202-bbd56b36e5b7` | + +**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. + +## Amazon Logs Attributes + +This document defines attributes for AWS Logs. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | | `aws.log.group.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The Amazon Resource Name(s) (ARN) of the AWS log group(s). [2] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]` | | `aws.log.group.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log group(s) an application is writing to. [3] | `["/aws/lambda/my-function", "opentelemetry-service"]` | | `aws.log.stream.arns` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The ARN(s) of the AWS log stream(s). [4] | `["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | | `aws.log.stream.names` | ![Development](https://img.shields.io/badge/-development-blue) | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | -| `aws.request_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The AWS request ID as returned in the response headers `x-amzn-requestid`, `x-amzn-request-id` or `x-amz-request-id`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | -| `aws.s3.bucket` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [5] | `some-bucket-name` | -| `aws.s3.copy_source` | ![Development](https://img.shields.io/badge/-development-blue) | string | The source object (in the form `bucket`/`key`) for the copy operation. [6] | `someFile.yml` | -| `aws.s3.delete` | ![Development](https://img.shields.io/badge/-development-blue) | string | The delete request container that specifies the objects to be deleted. [7] | `Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean` | -| `aws.s3.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [8] | `someFile.yml` | -| `aws.s3.part_number` | ![Development](https://img.shields.io/badge/-development-blue) | int | The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. [9] | `3456` | -| `aws.s3.upload_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Upload ID that identifies the multipart upload. [10] | `dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ` | -| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Manager | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | -| `aws.sns.topic.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS SNS Topic. An Amazon SNS [topic](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) is a logical access point that acts as a communication channel. | `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` | -| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | -| `aws.step_functions.activity.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | -| `aws.step_functions.state_machine.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | - -**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. **[2] `aws.log.group.arns`:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). @@ -70,6 +147,21 @@ **[4] `aws.log.stream.arns`:** 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. +## Amazon S3 Attributes + +This document defines attributes for AWS S3. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `aws.s3.bucket` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [5] | `some-bucket-name` | +| `aws.s3.copy_source` | ![Development](https://img.shields.io/badge/-development-blue) | string | The source object (in the form `bucket`/`key`) for the copy operation. [6] | `someFile.yml` | +| `aws.s3.delete` | ![Development](https://img.shields.io/badge/-development-blue) | string | The delete request container that specifies the objects to be deleted. [7] | `Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean` | +| `aws.s3.key` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. [8] | `someFile.yml` | +| `aws.s3.part_number` | ![Development](https://img.shields.io/badge/-development-blue) | int | The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. [9] | `3456` | +| `aws.s3.upload_id` | ![Development](https://img.shields.io/badge/-development-blue) | string | Upload ID that identifies the multipart upload. [10] | `dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ` | + **[5] `aws.s3.bucket`:** 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`. @@ -116,11 +208,43 @@ This applies in particular to the following operations: - [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) ---- +## Amazon Secrets Manager Attributes -`aws.ecs.launchtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. +This document defines attributes for AWS Secrets Manager. -| Value | Description | Stability | -| --- | --- | --- | -| `ec2` | Amazon EC2 | ![Development](https://img.shields.io/badge/-development-blue) | -| `fargate` | Amazon Fargate | ![Development](https://img.shields.io/badge/-development-blue) | +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `aws.secretsmanager.secret.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the Secret stored in the Secrets Manager | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | + +## Amazon SNS Attributes + +This document defines attributes for AWS SNS. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `aws.sns.topic.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS SNS Topic. An Amazon SNS [topic](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) is a logical access point that acts as a communication channel. | `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` | + +## Amazon SQS Attributes + +This document defines attributes for AWS SQS. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `aws.sqs.queue.url` | ![Development](https://img.shields.io/badge/-development-blue) | string | The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it. | `https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue` | + +## Amazon Step Functions Attributes + +This document defines attributes for AWS Step Functions. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `aws.step_functions.activity.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | +| `aws.step_functions.state_machine.arn` | ![Development](https://img.shields.io/badge/-development-blue) | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | diff --git a/docs/registry/attributes/az.md b/docs/registry/attributes/az.md index 765963c5fc..e16ed07df1 100644 --- a/docs/registry/attributes/az.md +++ b/docs/registry/attributes/az.md @@ -1,9 +1,9 @@ -# Az +# Azure -## Az Attributes +## Azure Attributes
Deprecated Attributes: diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index 24c384f200..3df0e04111 100644 --- a/docs/registry/attributes/cicd.md +++ b/docs/registry/attributes/cicd.md @@ -3,7 +3,9 @@ # CI/CD -## CICD Attributes +## CI/CD Pipeline Attributes + +This group describes attributes specific to pipelines within a Continuous Integration and Continuous Deployment (CI/CD) system. A [pipeline](https://wikipedia.org/wiki/Pipeline_(computing)) in this case is a series of steps that are performed in order to deliver a new version of software. This aligns with the [Britannica](https://www.britannica.com/dictionary/pipeline) definition of a pipeline where a **pipeline** is the system for developing and producing something. In the context of CI/CD, a pipeline produces or delivers software. **Attributes:** diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index fdaa61b96d..31975814ea 100644 --- a/docs/registry/attributes/client.md +++ b/docs/registry/attributes/client.md @@ -5,6 +5,8 @@ ## Client Attributes +These attributes may be used to describe the client in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index 2212f480cc..4297b2016f 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -1,9 +1,9 @@ -# DB +# Database -## DB Attributes +## Database Attributes **Attributes:** diff --git a/docs/registry/attributes/destination.md b/docs/registry/attributes/destination.md index 3d3c3341e3..3c17d469c3 100644 --- a/docs/registry/attributes/destination.md +++ b/docs/registry/attributes/destination.md @@ -5,6 +5,8 @@ ## Destination Attributes +These attributes may be used to describe the receiver of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/faas.md b/docs/registry/attributes/faas.md index 30cadc9f81..77413981b1 100644 --- a/docs/registry/attributes/faas.md +++ b/docs/registry/attributes/faas.md @@ -3,7 +3,7 @@ # Faas -## Faas Attributes +## Function as a Service Attributes **Attributes:** diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index c18a4e81eb..137c134e5d 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -3,7 +3,15 @@ # GCP -## Google Cloud Platform Attributes +- [GCP - AppHub Attributes](#gcp---apphub-attributes) +- [GCP - AppHub Destination Attributes](#gcp---apphub-destination-attributes) +- [GCP Client Attributes](#gcp-client-attributes) +- [GCP - Google Cloud Run Attributes](#gcp---google-cloud-run-attributes) +- [GCP - Google Compute Engine (GCE) Attributes](#gcp---google-compute-engine-gce-attributes) + +## GCP - AppHub Attributes + +This document defines attributes AppHub will apply to resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). **Attributes:** @@ -18,24 +26,6 @@ | `gcp.apphub.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a workload indicates its importance to the business. [3] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | | `gcp.apphub.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a workload is the stage of a software lifecycle. [4] | `PRODUCTION`; `STAGING`; `TEST` | | `gcp.apphub.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the workload as configured in AppHub. | `my-workload` | -| `gcp.apphub_destination.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | -| `gcp.apphub_destination.application.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination application as configured in AppHub. | `my-application` | -| `gcp.apphub_destination.application.location` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GCP zone or region where the destination application is defined. | `us-central1` | -| `gcp.apphub_destination.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub_destination.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | -| `gcp.apphub_destination.service.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination service as configured in AppHub. | `my-service` | -| `gcp.apphub_destination.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | -| `gcp.apphub_destination.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a destination workload is the stage of a software lifecycle as provided in the [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | -| `gcp.apphub_destination.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination workload as configured in AppHub. | `my-workload` | -| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | -| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | -| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | -| `gcp.gce.instance.hostname` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | -| `gcp.gce.instance.labels.` | ![Development](https://img.shields.io/badge/-development-blue) | string | GCE instance labels, `` being the label name and the value being the label value. [6] | `observability` | -| `gcp.gce.instance.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `instance-1`; `my-vm-name` | -| `gcp.gce.instance_group_manager.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the Instance Group Manager (IGM) that manages this VM, if any. | `web-igm`; `my-managed-group` | -| `gcp.gce.instance_group_manager.region` | ![Development](https://img.shields.io/badge/-development-blue) | string | The region of a **regional** Instance Group Manager (e.g., `us-central1`). Set this **only** when the IGM is regional. | `us-central1`; `europe-west1` | -| `gcp.gce.instance_group_manager.zone` | ![Development](https://img.shields.io/badge/-development-blue) | string | The zone of a **zonal** Instance Group Manager (e.g., `us-central1-a`). Set this **only** when the IGM is zonal. | `us-central1-a`; `europe-west1-b` | **[1] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) @@ -45,10 +35,6 @@ **[4] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) -**[5] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. - -**[6] `gcp.gce.instance.labels.`:** For example, a GCE instance label `team` with value `observability` SHOULD be recorded as the `gcp.gce.instance.labels.team` attribute with value `"observability"`. The `` MUST be the exact GCE instance label key. - --- `gcp.apphub.service.criticality_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -93,6 +79,24 @@ | `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) | +## GCP - AppHub Destination Attributes + +This document defines attributes AppHub will apply to destination resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `gcp.apphub_destination.application.container` | ![Development](https://img.shields.io/badge/-development-blue) | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | +| `gcp.apphub_destination.application.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination application as configured in AppHub. | `my-application` | +| `gcp.apphub_destination.application.location` | ![Development](https://img.shields.io/badge/-development-blue) | string | The GCP zone or region where the destination application is defined. | `us-central1` | +| `gcp.apphub_destination.service.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub_destination.service.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub_destination.service.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination service as configured in AppHub. | `my-service` | +| `gcp.apphub_destination.workload.criticality_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | +| `gcp.apphub_destination.workload.environment_type` | ![Development](https://img.shields.io/badge/-development-blue) | string | Environment of a destination workload is the stage of a software lifecycle as provided in the [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | +| `gcp.apphub_destination.workload.id` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the destination workload as configured in AppHub. | `my-workload` | + --- `gcp.apphub_destination.service.criticality_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. @@ -136,3 +140,43 @@ | `PRODUCTION` | Production environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) | | `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) | + +## GCP Client Attributes + +Attributes for Google Cloud client libraries. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `gcp.client.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | + +**[5] `gcp.client.service`:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. + +## GCP - Google Cloud Run Attributes + +This document defines attributes for Google Cloud Run. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `gcp.cloud_run.job.execution` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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. | `job-name-xxxx`; `sample-job-mdw84` | +| `gcp.cloud_run.job.task_index` | ![Development](https://img.shields.io/badge/-development-blue) | int | 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. | `0`; `1` | + +## GCP - Google Compute Engine (GCE) Attributes + +This document defines attributes for Google Compute Engine (GCE). + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `gcp.gce.instance.hostname` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `my-host1234.example.com`; `sample-vm.us-west1-b.c.my-project.internal` | +| `gcp.gce.instance.labels.` | ![Development](https://img.shields.io/badge/-development-blue) | string | GCE instance labels, `` being the label name and the value being the label value. [6] | `observability` | +| `gcp.gce.instance.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | 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). | `instance-1`; `my-vm-name` | +| `gcp.gce.instance_group_manager.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the Instance Group Manager (IGM) that manages this VM, if any. | `web-igm`; `my-managed-group` | +| `gcp.gce.instance_group_manager.region` | ![Development](https://img.shields.io/badge/-development-blue) | string | The region of a **regional** Instance Group Manager (e.g., `us-central1`). Set this **only** when the IGM is regional. | `us-central1`; `europe-west1` | +| `gcp.gce.instance_group_manager.zone` | ![Development](https://img.shields.io/badge/-development-blue) | string | The zone of a **zonal** Instance Group Manager (e.g., `us-central1-a`). Set this **only** when the IGM is zonal. | `us-central1-a`; `europe-west1-b` | + +**[6] `gcp.gce.instance.labels.`:** For example, a GCE instance label `team` with value `observability` SHOULD be recorded as the `gcp.gce.instance.labels.team` attribute with value `"observability"`. The `` MUST be the exact GCE instance label key. diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 44a5383969..3e33cc988f 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -3,10 +3,15 @@ # Gen AI -## Gen AI Attributes +- [GenAI Attributes (Moved)](#genai-attributes-moved) +- [Deprecated GenAI Attributes](#deprecated-genai-attributes) +- [Deprecated OpenAI GenAI Attributes](#deprecated-openai-genai-attributes) -
-Deprecated Attributes: +## GenAI Attributes (Moved) + +Generative AI (GenAI) attributes have moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). + +**Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | @@ -14,7 +19,6 @@ | `gen_ai.agent.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` | | `gen_ai.agent.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Human-readable name of the GenAI agent provided by the application. | `Math Tutor`; `Fiction Writer` | | `gen_ai.agent.version` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The version of the GenAI agent. | `1.0.0`; `2025-05-01` | -| `gen_ai.completion` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | | `gen_ai.conversation.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The unique identifier for a conversation (session, thread), used to store and correlate messages within this conversation. | `conv_5j66UpCpwteGg4YSxUnt7lPY` | | `gen_ai.data_source.id` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The data source identifier. [1] | `H7STPQYOND` | | `gen_ai.embeddings.dimension.count` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of dimensions the resulting output embeddings should have. | `512`; `1024` | @@ -23,15 +27,9 @@ | `gen_ai.evaluation.score.label` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Human readable label for evaluation. [2] | `relevant`; `not_relevant`; `correct`; `incorrect`; `pass`; `fail` | | `gen_ai.evaluation.score.value` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | The evaluation score returned by the evaluator. | `4.0` | | `gen_ai.input.messages` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The chat history provided to the model as an input. [3] | [
  {
    "role": "user",
    "parts": [
      {
        "type": "text",
        "content": "Weather in Paris?"
      }
    ]
  },
  {
    "role": "assistant",
    "parts": [
      {
        "type": "tool_call",
        "id": "call_VSPygqKTWdrhaFErNvMV18Yl",
        "name": "get_weather",
        "arguments": {
          "location": "Paris"
        }
      }
    ]
  },
  {
    "role": "tool",
    "parts": [
      {
        "type": "tool_call_response",
        "id": " call_VSPygqKTWdrhaFErNvMV18Yl",
        "result": "rainy, 57°F"
      }
    ]
  }
] | -| `gen_ai.openai.request.response_format` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.output.type`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | -| `gen_ai.openai.request.seed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.request.seed`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.request.seed`. | `100` | -| `gen_ai.openai.request.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.request.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | -| `gen_ai.openai.response.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | -| `gen_ai.openai.response.system_fingerprint` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.system_fingerprint`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | | `gen_ai.operation.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the operation being performed. [4] | `chat`; `generate_content`; `text_completion` | | `gen_ai.output.messages` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | Messages returned by the model where each message represents a specific model response (choice, candidate). [5] | [
  {
    "role": "assistant",
    "parts": [
      {
        "type": "text",
        "content": "The weather in Paris is currently rainy with a temperature of 57°F."
      }
    ],
    "finish_reason": "stop"
  }
] | | `gen_ai.output.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Represents the content type requested by the client. [6] | `text`; `json`; `image` | -| `gen_ai.prompt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | | `gen_ai.prompt.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The name of the prompt that uniquely identifies it. | `analyze-code` | | `gen_ai.provider.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The Generative AI provider as identified by the client or server instrumentation. [7] | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | | `gen_ai.request.choice.count` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The target number of candidate completions to return. | `3` | @@ -52,7 +50,6 @@ | `gen_ai.response.time_to_first_chunk` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | double | Time to first chunk in a streaming response, measured from request issuance, in seconds. The value is measured from when the client issues the generation request to when the first chunk is received in the response stream. | `0.5`; `1.2` | | `gen_ai.retrieval.documents` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The documents retrieved. [9] | [
  {
    "id": "doc_123",
    "score": 0.95
  },
  {
    "id": "doc_456",
    "score": 0.87
  },
  {
    "id": "doc_789",
    "score": 0.82
  }
] | | `gen_ai.retrieval.query.text` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The query text used for retrieval. [10] | `What is the capital of France?`; `weather in Paris` | -| `gen_ai.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.provider.name`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | | `gen_ai.system_instructions` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | The system message or instructions provided to the GenAI model separately from the chat history. [11] | [
  {
    "type": "text",
    "content": "You are an Agent that greet users, always use greetings tool to respond"
  }
]; [
  {
    "type": "text",
    "content": "You are a language translator."
  },
  {
    "type": "text",
    "content": "Your mission is to translate text in English to French."
  }
] | | `gen_ai.token.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | The type of token being counted. | `input`; `output` | | `gen_ai.tool.call.arguments` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | any | Parameters passed to the tool call. [12] | {
    "location": "San Francisco?",
    "date": "2025-10-01"
} | @@ -64,10 +61,8 @@ | `gen_ai.tool.type` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Type of the tool utilized by the agent [15] | `function`; `extension`; `datastore` | | `gen_ai.usage.cache_creation.input_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of input tokens written to a provider-managed cache. [16] | `25` | | `gen_ai.usage.cache_read.input_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of input tokens served from a provider-managed cache. [17] | `50` | -| `gen_ai.usage.completion_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.output_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | | `gen_ai.usage.input_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of tokens used in the GenAI input (prompt). [18] | `100` | | `gen_ai.usage.output_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of tokens used in the GenAI response (completion). | `180` | -| `gen_ai.usage.prompt_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.input_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | | `gen_ai.usage.reasoning.output_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | The number of output tokens used for reasoning (e.g. chain-of-thought, extended thinking). [19] | `50` | | `gen_ai.workflow.name` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Human-readable name of the GenAI workflow provided by the application. [20] | `multi_agent_rag`; `customer_support_pipeline` | @@ -220,25 +215,6 @@ by summing different token types parsed from the provider output. --- -`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| --- | --- | --- | -| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | -| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -294,6 +270,29 @@ by summing different token types parsed from the provider output. --- +`gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| --- | --- | --- | +| `input` | Input tokens (prompt, input, etc.) | ![Development](https://img.shields.io/badge/-development-blue) | +| `output` | Output tokens (completion, response, etc.) | ![Development](https://img.shields.io/badge/-development-blue) | + +## Deprecated GenAI Attributes + +Describes deprecated `gen_ai` attributes. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `gen_ai.completion` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | +| `gen_ai.prompt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | +| `gen_ai.system` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.provider.name`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | +| `gen_ai.usage.completion_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.output_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | +| `gen_ai.usage.prompt_tokens` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.input_tokens`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | + +--- + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -320,13 +319,35 @@ by summing different token types parsed from the provider output. **[26]:** This refers to the 'aiplatform.googleapis.com' endpoint. May use common attributes prefixed with 'gcp.gen_ai.'. +## Deprecated OpenAI GenAI Attributes + +Describes deprecated `gen_ai.openai` attributes. + +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +| `gen_ai.openai.request.response_format` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.output.type`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | +| `gen_ai.openai.request.seed` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.request.seed`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | int | Deprecated, use `gen_ai.request.seed`. | `100` | +| `gen_ai.openai.request.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.request.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | +| `gen_ai.openai.response.service_tier` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.service_tier`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | +| `gen_ai.openai.response.system_fingerprint` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.system_fingerprint`, which has moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | + --- -`gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. +`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | -| `input` | Input tokens (prompt, input, etc.) | ![Development](https://img.shields.io/badge/-development-blue) | -| `output` | Output tokens (completion, response, etc.) | ![Development](https://img.shields.io/badge/-development-blue) | +| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. -
+| Value | Description | Stability | +| --- | --- | --- | +| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | +| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index 91ceb5ab36..dce0873d70 100644 --- a/docs/registry/attributes/geo.md +++ b/docs/registry/attributes/geo.md @@ -5,6 +5,9 @@ ## Geo Attributes +Geo fields can carry data about a specific location related to an event. This geolocation information can be derived from techniques such as Geo IP, or be user-supplied. +Note: Geo attributes are typically used under another namespace, such as client.* and describe the location of the corresponding entity (device, end-user, etc). Semantic conventions that reference geo attributes (as a root namespace) or embed them (under their own namespace) SHOULD document what geo attributes describe in the scope of that convention. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/mcp.md b/docs/registry/attributes/mcp.md index 4cca8c3bad..97cd0afea2 100644 --- a/docs/registry/attributes/mcp.md +++ b/docs/registry/attributes/mcp.md @@ -3,10 +3,11 @@ # MCP -## MCP Attributes +## MCP Attributes (Moved) -
-Deprecated Attributes: +[Model Context Protocol (MCP)](https://modelcontextprotocol.io) attributes have moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). + +**Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | @@ -48,5 +49,3 @@ | `sampling/createMessage` | Request to create a sampling message. | ![Development](https://img.shields.io/badge/-development-blue) | | `tools/call` | Request to call a tool. | ![Development](https://img.shields.io/badge/-development-blue) | | `tools/list` | Request to list tools available on server. | ![Development](https://img.shields.io/badge/-development-blue) | - -
diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 92892edf03..83edf928a7 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -3,10 +3,11 @@ # OpenAI -## OpenAI Attributes +## OpenAI Attributes (Moved) -
-Deprecated Attributes: +OpenAI attributes have moved to the [OpenTelemetry GenAI semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-genai). + +**Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | @@ -32,5 +33,3 @@ | --- | --- | --- | | `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | | `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | - -
diff --git a/docs/registry/attributes/security-rule.md b/docs/registry/attributes/security-rule.md index 491913ea93..8c30ac856b 100644 --- a/docs/registry/attributes/security-rule.md +++ b/docs/registry/attributes/security-rule.md @@ -3,7 +3,9 @@ # Security rule -## Security Rule Attributes +## Security Rule + +Describes security rule attributes. Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events. **Attributes:** diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index 9a7702de4b..58f01891ad 100644 --- a/docs/registry/attributes/server.md +++ b/docs/registry/attributes/server.md @@ -5,6 +5,8 @@ ## Server Attributes +These attributes may be used to describe the server in a connection-based network interaction where there is one side that initiates the connection (the client is the side that initiates the connection). This covers all TCP network interactions since TCP is connection-based and one side initiates the connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server). This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index 99d25efe9d..bc5f8aefcc 100644 --- a/docs/registry/attributes/session.md +++ b/docs/registry/attributes/session.md @@ -5,6 +5,10 @@ ## Session Attributes +Session is defined as the period of time encompassing all activities performed by the application and the actions executed by the end user. +Consequently, a Session is represented as a collection of Logs, Events, and Spans emitted by the Client Application throughout the Session's duration. Each Session is assigned a unique identifier, which is included as an attribute in the Logs, Events, and Spans generated during the Session's lifecycle. +When a session reaches end of life, typically due to user inactivity or session timeout, a new session identifier will be assigned. The previous session identifier may be provided by the instrumentation so that telemetry backends can link the two sessions. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index 112112e3f8..b2234e5b2f 100644 --- a/docs/registry/attributes/source.md +++ b/docs/registry/attributes/source.md @@ -5,6 +5,8 @@ ## Source Attributes +These attributes may be used to describe the sender of a network exchange/packet. These should be used when there is no client/server relationship between the two sides, or when that relationship is unknown. This covers low-level network interactions (e.g. packet tracing) where you don't know if there was a connection or which side initiated it. This also covers unidirectional UDP flows and peer-to-peer communication where the "user-facing" surface of the protocol / API doesn't expose a clear notion of client and server. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 9fcb13d128..6866377856 100644 --- a/docs/registry/attributes/test.md +++ b/docs/registry/attributes/test.md @@ -5,6 +5,8 @@ ## Test Attributes +This group describes attributes specific to [software tests](https://wikipedia.org/wiki/Software_testing). + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index 4629e5818f..3420332776 100644 --- a/docs/registry/attributes/thread.md +++ b/docs/registry/attributes/thread.md @@ -5,6 +5,8 @@ ## Thread Attributes +These attributes may be used for any operation to store information about a thread that started a span. + **Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index dcd39ec29f..3be6d23b15 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -3,7 +3,12 @@ # VCS -## VCS Attributes +- [VCS Repository Attributes](#vcs-repository-attributes) +- [VCS Deprecated Attributes](#vcs-deprecated-attributes) + +## VCS Repository Attributes + +This group defines the attributes for [Version Control Systems (VCS)](https://wikipedia.org/wiki/Version_control). **Attributes:** @@ -140,8 +145,11 @@ the `.git` extension. | `ahead` | How many revisions the change is ahead of the target ref. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `behind` | How many revisions the change is behind the target ref. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | -
-Deprecated Attributes: +## VCS Deprecated Attributes + +Describes deprecated vcs attributes. + +**Attributes:** | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | @@ -159,5 +167,3 @@ the `.git` extension. | --- | --- | --- | | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Development](https://img.shields.io/badge/-development-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Development](https://img.shields.io/badge/-development-blue) | - -
diff --git a/templates/registry/markdown/attribute_group_namespace.md.j2 b/templates/registry/markdown/attribute_group_namespace.md.j2 new file mode 100644 index 0000000000..568cd9645f --- /dev/null +++ b/templates/registry/markdown/attribute_group_namespace.md.j2 @@ -0,0 +1,53 @@ +{#- This template is rendered per top-level registry namespace. -#} +{#- It consists of two variables: -#} +{#- - id: The top-level namespace id. -#} +{#- - groups: A sequence of all attribute groups under this namespace. -#} +{#- This includes deprecated groups. -#} +{%- import 'stability.j2' as stability -%} +{%- import 'notes.j2' as notes -%} +{%- import 'enum_macros.j2' as enums -%} +{%- import 'attribute_table.j2' as at -%} +{%- import 'attribute_macros.j2' as attrs -%} +{%- import 'examples_macros.j2' as examples -%} +{%- set groups = namespace(deprecated=[], non_deprecated=[]) -%} +{%- for group in ctx.groups | sort(attribute="id") -%} +{%- if group.id[-10:] == "deprecated" -%} +{%- set groups.deprecated = groups.deprecated + [group] -%} +{%- else -%} +{%- set groups.non_deprecated = groups.non_deprecated + [group] -%} +{%- endif -%} +{%- endfor -%} +{%- set attr_groups = groups.non_deprecated + groups.deprecated -%} + + + + +# {{ attrs.humanize(attrs.sentence_case(ctx.id)) | acronym | map_text("namespace_mapping") }} + +{%- if attr_groups | length > 1 %} +{% for group in attr_groups %} +- [{{ attrs.display_name(group) | trim }}](#{{ attrs.heading_link_fragments(attrs.display_name(group)) }}) +{%- endfor -%} +{%- endif %} +{% for group in attr_groups %} +## {{ attrs.display_name(group) | trim }} + +{% if group.brief.endswith("\n") -%} +{{ group.brief }} +{% else -%} +{{ group.brief }} +{{"\n"}} +{%- endif -%} +**Attributes:** + +| Key | Stability | Value Type | Description | Example Values | +| --- | --- | --- | --- | --- | +{%- for attribute in group.attributes | sort(attribute="name") %}{% set attr_anchor = attribute.name | kebab_case %} +| `{{ attrs.name(attribute) }}` | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) }}| +{%- endfor %} +{{ notes.render() }} +{%- for enum in group.attributes | sort(attribute="name") %} +{%- if enum.type is mapping -%}{{ enums.table(enum, notes) }}{% endif %} +{%- endfor -%} +{%- endfor -%} + diff --git a/templates/registry/markdown/attribute_macros.j2 b/templates/registry/markdown/attribute_macros.j2 index 17eac8ea0c..4d6d9c3017 100644 --- a/templates/registry/markdown/attribute_macros.j2 +++ b/templates/registry/markdown/attribute_macros.j2 @@ -20,8 +20,10 @@ {% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[`{{name(attribute)}}`]({{attribute_registry_base_url}}/{{ attribute.name | split_id | list | reject("eq", "registry")| first | kebab_case | map_text("root_namespace_aliases") }}.md){% endmacro %} -{% macro display_name(group) %}{{ group | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym | map_text("namespace_names") }} Attributes -{% endmacro %} +{% macro display_name(group) %} +{%- if 'display_name' in group %}{{ group.display_name }} +{%- else %}{{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes +{%- endif %}{% endmacro %} {% macro heading_link_fragments(title) %}{{ title | trim | lower | replace(" ", "-") | replace("(", "") | replace(")", "") | replace("/", "") | replace("\\", "") | replace(".", "") | replace("!", "") | replace("?", "") | replace("~", "") | replace("#", "")}}{% endmacro %} diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index a04f1f6630..6fa7719aa5 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -15,7 +15,8 @@ # {{ attrs.humanize(attrs.sentence_case(ctx.root_namespace)) | acronym | map_text("namespace_titles") }} -## {{ attrs.display_name(ctx.root_namespace) }} +## {{ ctx.root_namespace | title_case | acronym | map_text("namespace_names") }} Attributes + {% set filtered_attributes = ctx.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}**Attributes:** | Key | Stability | Value Type | Description | Example Values | diff --git a/templates/registry/markdown/weaver.yaml b/templates/registry/markdown/weaver.yaml index fd08b1f5f7..d41b3085e2 100644 --- a/templates/registry/markdown/weaver.yaml +++ b/templates/registry/markdown/weaver.yaml @@ -5,10 +5,15 @@ templates: file_name: attributes/README.md - pattern: attribute_namespace.md.j2 filter: 'semconv_grouped_attributes({ + "exclude_root_namespace": ["artifact", "aws","cicd", "client", "destination", "gcp", "gen_ai", "geo", "mcp", "openai", "security_rule", "server", "session", "source", "test", "thread", "vcs"], "ignore_code_generation_annotations": true })' application_mode: each file_name: 'attributes/{{ ctx.root_namespace | lower | kebab_case | map_text("root_namespace_aliases") }}.md' + - pattern: attribute_group_namespace.md.j2 + filter: '.groups | map(select(.type == "attribute_group")) | map(select(.id | startswith("registry"))) | group_by(.id | split(".") | .[1]) | map({id: .[0].id | split(".") | .[1], groups: .}) | map(select(.id as $id | ["artifact", "aws","cicd", "client", "destination", "gcp", "gen_ai", "geo", "mcp", "openai", "security_rule", "server", "session", "source", "test", "thread", "vcs"] | index($id)))' + application_mode: each + file_name: attributes/{{ ctx.id | lower | kebab_case }}.md - pattern: registry_readme.md.j2 filter: "." application_mode: single @@ -71,14 +76,18 @@ text_maps: root_namespace_aliases: hw: hardware namespace_titles: + Az: Azure + DB: Database Hw: Hardware CICD: CI/CD namespace_names: App: Application Aspnetcore: ASP.NET Core + Az: Azure + DB: Database Dotnet: .NET Enduser: End User - FaaS: Function as a Service + Faas: Function as a Service GCP: Google Cloud Platform Hw: Hardware JSONRPC: JSON-RPC From d5b6dbd75b769de97843734bddc438c31b16667b Mon Sep 17 00:00:00 2001 From: James Thompson Date: Fri, 3 Jul 2026 12:20:23 +1000 Subject: [PATCH 8/9] Yaml lint --- templates/registry/markdown/weaver.yaml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/templates/registry/markdown/weaver.yaml b/templates/registry/markdown/weaver.yaml index d41b3085e2..544661d97f 100644 --- a/templates/registry/markdown/weaver.yaml +++ b/templates/registry/markdown/weaver.yaml @@ -11,7 +11,13 @@ templates: application_mode: each file_name: 'attributes/{{ ctx.root_namespace | lower | kebab_case | map_text("root_namespace_aliases") }}.md' - pattern: attribute_group_namespace.md.j2 - filter: '.groups | map(select(.type == "attribute_group")) | map(select(.id | startswith("registry"))) | group_by(.id | split(".") | .[1]) | map({id: .[0].id | split(".") | .[1], groups: .}) | map(select(.id as $id | ["artifact", "aws","cicd", "client", "destination", "gcp", "gen_ai", "geo", "mcp", "openai", "security_rule", "server", "session", "source", "test", "thread", "vcs"] | index($id)))' + filter: '.groups | map(select(.type == "attribute_group")) | + map(select(.id | startswith("registry"))) | + group_by(.id | split(".") | .[1]) | + map({id: .[0].id | split(".") | .[1], groups: .}) | + map(select( + .id as $id | ["artifact", "aws","cicd", "client", "destination", "gcp", "gen_ai", "geo", "mcp", "openai", "security_rule", "server", "session", "source", "test", "thread", "vcs"] | index($id) + ))' application_mode: each file_name: attributes/{{ ctx.id | lower | kebab_case }}.md - pattern: registry_readme.md.j2 From 60a48aefb2e174735178b27522ace9ac286f384d Mon Sep 17 00:00:00 2001 From: James Thompson Date: Sat, 18 Jul 2026 14:40:40 +1000 Subject: [PATCH 9/9] Review feedback --- docs/registry/attributes/android.md | 2 +- docs/registry/attributes/artifact.md | 2 +- docs/registry/attributes/aws.md | 2 +- docs/registry/attributes/az.md | 2 +- docs/registry/attributes/cicd.md | 2 +- docs/registry/attributes/client.md | 2 +- docs/registry/attributes/code.md | 2 +- docs/registry/attributes/container.md | 2 +- docs/registry/attributes/db.md | 2 +- docs/registry/attributes/deployment.md | 2 +- docs/registry/attributes/destination.md | 2 +- docs/registry/attributes/enduser.md | 2 +- docs/registry/attributes/error.md | 2 +- docs/registry/attributes/event.md | 2 +- docs/registry/attributes/exception.md | 2 +- docs/registry/attributes/feature-flag.md | 2 +- docs/registry/attributes/gcp.md | 2 +- docs/registry/attributes/gen-ai.md | 2 +- docs/registry/attributes/geo.md | 2 +- docs/registry/attributes/http.md | 2 +- docs/registry/attributes/ios.md | 2 +- docs/registry/attributes/k8s.md | 2 +- docs/registry/attributes/linux.md | 2 +- docs/registry/attributes/mcp.md | 2 +- docs/registry/attributes/message.md | 2 +- docs/registry/attributes/messaging.md | 2 +- docs/registry/attributes/net.md | 2 +- docs/registry/attributes/openai.md | 2 +- docs/registry/attributes/otel.md | 2 +- docs/registry/attributes/other.md | 2 +- docs/registry/attributes/peer.md | 2 +- docs/registry/attributes/pool.md | 2 +- docs/registry/attributes/process.md | 2 +- docs/registry/attributes/rpc.md | 2 +- docs/registry/attributes/security-rule.md | 2 +- docs/registry/attributes/server.md | 2 +- docs/registry/attributes/session.md | 2 +- docs/registry/attributes/source.md | 2 +- docs/registry/attributes/system.md | 2 +- docs/registry/attributes/test.md | 2 +- docs/registry/attributes/thread.md | 2 +- docs/registry/attributes/tls.md | 2 +- docs/registry/attributes/vcs.md | 2 +- templates/registry/markdown/attribute_group_namespace.md.j2 | 2 +- templates/registry/markdown/attribute_namespace.md.j2 | 2 +- templates/registry/markdown/attribute_table.j2 | 4 ++-- 46 files changed, 47 insertions(+), 47 deletions(-) diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index e778ba5e4b..da6d02eab8 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -24,7 +24,7 @@ | `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) | | `foreground` | 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. | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index 4c357385a3..6071bfe5c6 100644 --- a/docs/registry/attributes/artifact.md +++ b/docs/registry/attributes/artifact.md @@ -1,5 +1,5 @@ - + # Artifact diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index 9571539e3f..d7b5919ead 100644 --- a/docs/registry/attributes/aws.md +++ b/docs/registry/attributes/aws.md @@ -1,5 +1,5 @@ - + # AWS diff --git a/docs/registry/attributes/az.md b/docs/registry/attributes/az.md index e16ed07df1..eef0b323bf 100644 --- a/docs/registry/attributes/az.md +++ b/docs/registry/attributes/az.md @@ -5,7 +5,7 @@ ## Azure Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index 3df0e04111..49b9e571ad 100644 --- a/docs/registry/attributes/cicd.md +++ b/docs/registry/attributes/cicd.md @@ -1,5 +1,5 @@ - + # CI/CD diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index 31975814ea..261bf5bf98 100644 --- a/docs/registry/attributes/client.md +++ b/docs/registry/attributes/client.md @@ -1,5 +1,5 @@ - + # Client diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index c8526ceff1..62f2b212a1 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -31,7 +31,7 @@ Examples: * Rust: `playground::my_module::my_cool_func` * C function: `fopen` -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index 7fbb1ad925..000b8e77a7 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -39,7 +39,7 @@ The ID is assigned by the container runtime and can vary in different environmen **[6] `container.label.`:** For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`. -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index e4270d5ad9..ce8ed82081 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -193,7 +193,7 @@ stored procedure name then that stored procedure name SHOULD be used. | `teradata` | [Teradata](https://www.teradata.com/) | ![Development](https://img.shields.io/badge/-development-blue) | | `trino` | [Trino](https://trino.io/) | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/deployment.md b/docs/registry/attributes/deployment.md index d9a0249746..4d41d936aa 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -42,7 +42,7 @@ considered to be identifying the same service: | `failed` | failed | ![Development](https://img.shields.io/badge/-development-blue) | | `succeeded` | succeeded | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/destination.md b/docs/registry/attributes/destination.md index 3c17d469c3..0392e83188 100644 --- a/docs/registry/attributes/destination.md +++ b/docs/registry/attributes/destination.md @@ -1,5 +1,5 @@ - + # Destination diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index 926957828d..15f745484b 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -22,7 +22,7 @@ > [!Warning] > This field contains sensitive (linkable PII) information. -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/error.md b/docs/registry/attributes/error.md index 35188a8bde..9372f04bd9 100644 --- a/docs/registry/attributes/error.md +++ b/docs/registry/attributes/error.md @@ -45,7 +45,7 @@ it's RECOMMENDED to: | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 20ae68f1db..34e922cdf0 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -5,7 +5,7 @@ ## Event Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index f0f0d08aaa..78a1e008b3 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -25,7 +25,7 @@ exception instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index 41a9cf125b..700a27ae14 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -46,7 +46,7 @@ For example, the variant `red` maybe be used for the value `#c05543`. | `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `unknown` | The reason for the resolved value could not be determined. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 137c134e5d..efbcaaa096 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -1,5 +1,5 @@ - + # GCP diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 3e33cc988f..be0da13543 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -1,5 +1,5 @@ - + # Gen AI diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index dce0873d70..5840d25a05 100644 --- a/docs/registry/attributes/geo.md +++ b/docs/registry/attributes/geo.md @@ -1,5 +1,5 @@ - + # Geo diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 290f0dda04..69e30e3c48 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -118,7 +118,7 @@ support custom route formatting. Instrumentations SHOULD document the format and | `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) | | `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index 0ac31bdf21..8dafbcadc1 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -25,7 +25,7 @@ | `inactive` | The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ![Development](https://img.shields.io/badge/-development-blue) | | `terminate` | The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index cc62d190b9..2450cfa4bf 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -559,7 +559,7 @@ When not set, Kubernetes distributes traffic evenly across all endpoints cluster | `persistentVolumeClaim` | A [persistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/volumes/#persistentvolumeclaim) volume | ![Development](https://img.shields.io/badge/-development-blue) | | `secret` | A [secret](https://kubernetes.io/docs/concepts/storage/volumes/#secret) volume | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/linux.md b/docs/registry/attributes/linux.md index 042d96b0de..130d1c4053 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -5,7 +5,7 @@ ## Linux Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/mcp.md b/docs/registry/attributes/mcp.md index 97cd0afea2..a244ad91a0 100644 --- a/docs/registry/attributes/mcp.md +++ b/docs/registry/attributes/mcp.md @@ -1,5 +1,5 @@ - + # MCP diff --git a/docs/registry/attributes/message.md b/docs/registry/attributes/message.md index ca2152529b..9237f7cb65 100644 --- a/docs/registry/attributes/message.md +++ b/docs/registry/attributes/message.md @@ -5,7 +5,7 @@ ## Message Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 99bd942ec4..8a379398b5 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -135,7 +135,7 @@ size should be used. | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/net.md b/docs/registry/attributes/net.md index a4fd95ff85..d167f45d74 100644 --- a/docs/registry/attributes/net.md +++ b/docs/registry/attributes/net.md @@ -5,7 +5,7 @@ ## Net Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 83edf928a7..3a4856a1b2 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -1,5 +1,5 @@ - + # OpenAI diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index a25ad88cc3..7ce994894f 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -91,7 +91,7 @@ E.g. for Java the fully qualified classname SHOULD be used in this case. | `ERROR` | The operation contains an error. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/other.md b/docs/registry/attributes/other.md index 0290b8e562..cf9edceca4 100644 --- a/docs/registry/attributes/other.md +++ b/docs/registry/attributes/other.md @@ -5,7 +5,7 @@ ## Other Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/peer.md b/docs/registry/attributes/peer.md index 6cc09ff286..9363480c8a 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -5,7 +5,7 @@ ## Peer Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/pool.md b/docs/registry/attributes/pool.md index 932c93b4c8..21878827b5 100644 --- a/docs/registry/attributes/pool.md +++ b/docs/registry/attributes/pool.md @@ -5,7 +5,7 @@ ## Pool Attributes -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index f6f217af3d..b4336267b5 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -95,7 +95,7 @@ represented as a hex string. | `sleeping` | sleeping | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `stopped` | stopped | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 593969b028..2cb9b168c9 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -68,7 +68,7 @@ Semantic conventions for individual RPC frameworks SHOULD document what `rpc.res | `grpc` | [gRPC](https://grpc.io/) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `jsonrpc` | [JSON-RPC](https://www.jsonrpc.org/) | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/security-rule.md b/docs/registry/attributes/security-rule.md index 8c30ac856b..de01aa7dff 100644 --- a/docs/registry/attributes/security-rule.md +++ b/docs/registry/attributes/security-rule.md @@ -1,5 +1,5 @@ - + # Security rule diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index 58f01891ad..e8319bb624 100644 --- a/docs/registry/attributes/server.md +++ b/docs/registry/attributes/server.md @@ -1,5 +1,5 @@ - + # Server diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index bc5f8aefcc..04338864a7 100644 --- a/docs/registry/attributes/session.md +++ b/docs/registry/attributes/session.md @@ -1,5 +1,5 @@ - + # Session diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index b2234e5b2f..8ba98f24b8 100644 --- a/docs/registry/attributes/source.md +++ b/docs/registry/attributes/source.md @@ -1,5 +1,5 @@ - + # Source diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index 3662d70591..b51b0a00f7 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -102,7 +102,7 @@ | `free` | free | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | used | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 6866377856..b691736508 100644 --- a/docs/registry/attributes/test.md +++ b/docs/registry/attributes/test.md @@ -1,5 +1,5 @@ - + # Test diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index 3420332776..e3fb98a4a8 100644 --- a/docs/registry/attributes/thread.md +++ b/docs/registry/attributes/thread.md @@ -1,5 +1,5 @@ - + # Thread diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index ce46113792..902e564e84 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -49,7 +49,7 @@ | `ssl` | ssl | ![Development](https://img.shields.io/badge/-development-blue) | | `tls` | tls | ![Development](https://img.shields.io/badge/-development-blue) | -
+
Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index 3be6d23b15..0a2f3d436f 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -1,5 +1,5 @@ - + # VCS diff --git a/templates/registry/markdown/attribute_group_namespace.md.j2 b/templates/registry/markdown/attribute_group_namespace.md.j2 index 568cd9645f..78a66876bd 100644 --- a/templates/registry/markdown/attribute_group_namespace.md.j2 +++ b/templates/registry/markdown/attribute_group_namespace.md.j2 @@ -20,7 +20,7 @@ {%- set attr_groups = groups.non_deprecated + groups.deprecated -%} - + # {{ attrs.humanize(attrs.sentence_case(ctx.id)) | acronym | map_text("namespace_mapping") }} diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 6fa7719aa5..2ccd0410e2 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -27,4 +27,4 @@ {{ notes.render() }} {%- for enum in filtered_attributes | sort(attribute="name") %} {%- if enum.type is mapping -%}{{ enums.table(enum, notes) }}{% endif %} -{%- endfor -%}{% endif %}{% if (ctx.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(ctx.attributes, "", "", "", notes) | trim }}{% if filtered_attributes | length != ctx.attributes | length %}{{"\n"}}{%endif%} +{%- endfor -%}{% endif %}{% if (ctx.attributes | selectattr("deprecated")) and filtered_attributes %}{{"\n"}}{% endif %}{{ at.generate_deprecated(ctx.attributes, "", "", "", notes, " open") | trim }}{% if filtered_attributes | length != ctx.attributes | length %}{{"\n"}}{%endif%} diff --git a/templates/registry/markdown/attribute_table.j2 b/templates/registry/markdown/attribute_table.j2 index e765989364..53499b3e81 100644 --- a/templates/registry/markdown/attribute_table.j2 +++ b/templates/registry/markdown/attribute_table.j2 @@ -12,10 +12,10 @@ | --- | --- | --- | --- | --- | --- | {% for attribute in filtered_attributes | attribute_sort %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute), "deprecated": attribute.deprecated}, notes) | trim }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) }}| {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} -{% endif %}{{ generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, notes)}}{% endmacro %} +{% endif %}{{ generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, notes, "")}}{% endmacro %} {#- Macro for creating deprecated attribute table -#} -{% macro generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, notes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | selectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %}
+{% macro generate_deprecated(attributes, tag_filter, attribute_registry_base_url, lineage_attributes, notes, open) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes | selectattr("deprecated") | attribute_sort %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) | attribute_sort %}{% endif %}{% if (filtered_attributes is defined) and (filtered_attributes | length > 0) %} Deprecated Attributes: | Key | Stability | Value Type | Description | Example Values |