From 9dc00f2c4c31a7433bb6731012730e2443169868 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Fri, 19 Sep 2025 15:40:13 +1000 Subject: [PATCH 1/4] 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/4] 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/4] 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 5187b63cf1c8c9a662c225963acb356a3c9289f9 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Thu, 30 Oct 2025 15:23:50 +1100 Subject: [PATCH 4/4] 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..6be4df1400 --- /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 \ No newline at end of file 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 %}