From 70cc1ea69a847b9f55c25c816dd52112c89801dd Mon Sep 17 00:00:00 2001 From: James Thompson Date: Fri, 19 Sep 2025 15:40:13 +1000 Subject: [PATCH 1/2] Automatically split attribute tables based on status --- docs/exceptions/exceptions-spans.md | 9 +- docs/registry/attributes/android.md | 20 +- docs/registry/attributes/app.md | 3 +- docs/registry/attributes/artifact.md | 3 +- docs/registry/attributes/aspnetcore.md | 3 +- docs/registry/attributes/aws.md | 119 +++--- docs/registry/attributes/azure.md | 32 +- 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 | 21 +- docs/registry/attributes/container.md | 51 ++- docs/registry/attributes/cpu.md | 3 +- docs/registry/attributes/cpython.md | 3 +- docs/registry/attributes/db.md | 387 +++++++++--------- docs/registry/attributes/deployment.md | 13 +- 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 | 15 +- docs/registry/attributes/error.md | 3 +- docs/registry/attributes/event.md | 3 +- docs/registry/attributes/exception.md | 13 +- docs/registry/attributes/faas.md | 3 +- docs/registry/attributes/feature-flag.md | 65 +-- docs/registry/attributes/file.md | 3 +- docs/registry/attributes/gcp.md | 69 ++-- docs/registry/attributes/gen-ai.md | 159 +++---- 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 | 39 +- docs/registry/attributes/ios.md | 33 +- 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 | 87 ++-- docs/registry/attributes/network.md | 103 ++--- 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/opentracing.md | 3 +- docs/registry/attributes/os.md | 3 +- docs/registry/attributes/otel.md | 55 +-- docs/registry/attributes/peer.md | 3 +- docs/registry/attributes/pprof.md | 3 +- docs/registry/attributes/process.md | 18 +- 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 | 155 +++---- docs/registry/attributes/telemetry.md | 3 +- docs/registry/attributes/test.md | 3 +- docs/registry/attributes/thread.md | 3 +- docs/registry/attributes/tls.md | 27 +- 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 | 22 +- .../registry/markdown/attribute_table.j2 | 15 +- 86 files changed, 1040 insertions(+), 785 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 c39ca0ad7d..27a4944c68 100644 --- a/docs/exceptions/exceptions-spans.md +++ b/docs/exceptions/exceptions-spans.md @@ -35,13 +35,20 @@ This event describes a single exception. |---|---|---|---|---|---| | [`exception.message`](/docs/registry/attributes/exception.md) | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | `Conditionally Required` [1] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | [`exception.type`](/docs/registry/attributes/exception.md) | 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` | `Conditionally Required` [2] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| [`exception.escaped`](/docs/registry/attributes/exception.md) | boolean | Indicates that the exception is escaping the scope of the span. | | `Recommended` | ![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. | | [`exception.stacktrace`](/docs/registry/attributes/exception.md) | 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)` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | **[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 b0bb6eb511..740957c529 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -3,14 +3,12 @@ # Android -- [Android Attributes](#android-attributes) -- [Deprecated Android Attributes](#deprecated-android-attributes) - ## Android Attributes The Android platform on which the Android application is running. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `android.app.state` | string | This attribute represents the state of the application. [1] | `created` | ![Development](https://img.shields.io/badge/-development-blue) | | `android.os.api_level` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -26,14 +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. - -| Attribute | Type | Description | Examples | Stability | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `android.state` | string | Deprecated. Use `android.app.state` attribute instead. | `created`; `background`; `foreground` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `android.app.state`. | +| `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. --- @@ -44,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 13b23e6b16..2f9ff5d7d5 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). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `app.build_id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `app.installation.id` | string | A unique identifier representing the installation of an application on a specific device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index 093423e2da..602f679a5b 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `artifact.attestation.filename` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `artifact.attestation.hash` | string | The full [hash value (see glossary)](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), of the built attestation. Some envelopes in the [software attestation space](https://github.com/in-toto/attestation/tree/main/spec) also refer to this as the **digest**. | `1b31dfcd5b7f9267bf2ff47651df1cfb9147b9e4df1f335accf65b4cda498408` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/aspnetcore.md b/docs/registry/attributes/aspnetcore.md index 42e6f4e0a3..55168bbd0a 100644 --- a/docs/registry/attributes/aspnetcore.md +++ b/docs/registry/attributes/aspnetcore.md @@ -7,7 +7,8 @@ ASP.NET Core attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aspnetcore.authentication.result` | string | The result of the authentication operation. | `success`; `failure` | ![Development](https://img.shields.io/badge/-development-blue) | | `aspnetcore.authentication.scheme` | string | The identifier that names a particular authentication handler. | `Cookies`; `Bearer`; `Identity.Application` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index 548abe4c77..e33ea743bf 100644 --- a/docs/registry/attributes/aws.md +++ b/docs/registry/attributes/aws.md @@ -4,42 +4,35 @@ # 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.extended_request_id` | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.request_id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -## Amazon Bedrock Attributes - -This document defines attributes for AWS Bedrock. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `aws.bedrock.guardrail.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.bedrock.knowledge_base.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | - ## Amazon DynamoDB Attributes This document defines attributes for AWS DynamoDB. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.dynamodb.attribute_definitions` | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.dynamodb.attributes_to_get` | string[] | The value of the `AttributesToGet` request parameter. | `["lives", "id"]` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -68,7 +61,8 @@ This document defines attributes for AWS DynamoDB. This document defines attributes for AWS Elastic Container Service (ECS). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.ecs.cluster.arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.ecs.container.arn` | string | The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). | `arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -91,51 +85,47 @@ This document defines attributes for AWS Elastic Container Service (ECS). This document defines attributes for AWS Elastic Kubernetes Service (EKS). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.eks.cluster.arn` | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | ![Development](https://img.shields.io/badge/-development-blue) | -## Amazon Kinesis Attributes +## Amazon Logs Attributes -This document defines attributes for AWS Kinesis. +This document defines attributes for AWS Logs. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.kinesis.stream_name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | - -## Amazon Lambda Attributes +| `aws.log.group.arns` | 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:*"]` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.log.group.names` | string[] | The name(s) of the AWS log group(s) an application is writing to. [2] | `["/aws/lambda/my-function", "opentelemetry-service"]` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.log.stream.arns` | 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"]` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.log.stream.names` | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | ![Development](https://img.shields.io/badge/-development-blue) | -This document defines attributes for AWS Lambda. +**[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). -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `aws.lambda.invoked_arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.lambda.resource_mapping.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +**[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. -**[1] `aws.lambda.invoked_arn`:** This may be different from `cloud.resource_id` if an alias is involved. +**[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. -## Amazon Logs Attributes +## Amazon Lambda Attributes -This document defines attributes for AWS Logs. +This document defines attributes for AWS Lambda. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.log.group.arns` | 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:*"]` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.log.group.names` | string[] | The name(s) of the AWS log group(s) an application is writing to. [3] | `["/aws/lambda/my-function", "opentelemetry-service"]` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.log.stream.arns` | 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"]` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.log.stream.names` | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | ![Development](https://img.shields.io/badge/-development-blue) | - -**[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` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.lambda.resource_mapping.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -**[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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.s3.bucket` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.s3.copy_source` | string | The source object (in the form `bucket`/`key`) for the copy operation. [6] | `someFile.yml` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -190,35 +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 +## Amazon SQS Attributes -This document defines attributes for AWS Secrets Manager. +This document defines attributes for AWS SQS. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.secretsmanager.secret.arn` | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.sqs.queue.url` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | ## Amazon SNS Attributes This document defines attributes for AWS SNS. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.sns.topic.arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -## Amazon SQS Attributes +## Amazon Kinesis Attributes -This document defines attributes for AWS SQS. +This document defines attributes for AWS Kinesis. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.sqs.queue.url` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.kinesis.stream_name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | ## Amazon Step Functions Attributes This document defines attributes for AWS Step Functions. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.step_functions.activity.arn` | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.step_functions.state_machine.arn` | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | ![Development](https://img.shields.io/badge/-development-blue) | + +## Amazon Secrets Manager Attributes + +This document defines attributes for AWS Secrets Manager. + +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `aws.secretsmanager.secret.arn` | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | ![Development](https://img.shields.io/badge/-development-blue) | + +## Amazon Bedrock Attributes + +This document defines attributes for AWS Bedrock. + +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `aws.bedrock.guardrail.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.bedrock.knowledge_base.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/azure.md b/docs/registry/attributes/azure.md index 1b21398fa3..5003f37c22 100644 --- a/docs/registry/attributes/azure.md +++ b/docs/registry/attributes/azure.md @@ -3,15 +3,31 @@ # Azure +- [Deprecated Azure Attributes](#deprecated-azure-attributes) - [Azure Client Library Attributes](#azure-client-library-attributes) - [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes) -- [Deprecated Azure Attributes](#deprecated-azure-attributes) + +## Deprecated Azure Attributes + +This section describes deprecated Azure attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | 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. | + +
## Azure Client Library Attributes This section defines generic attributes used by Azure Client Libraries. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `azure.client.id` | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | ![Development](https://img.shields.io/badge/-development-blue) | | `azure.resource_provider.namespace` | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -21,7 +37,8 @@ This section defines generic attributes used by Azure Client Libraries. This section defines attributes for Azure Cosmos DB. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `azure.cosmosdb.connection.mode` | string | Cosmos client connection mode. | `gateway`; `direct` | ![Development](https://img.shields.io/badge/-development-blue) | | `azure.cosmosdb.consistency.level` | string | Account or request [consistency level](https://learn.microsoft.com/azure/cosmos-db/consistency-levels). | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -52,12 +69,3 @@ This section defines attributes for Azure Cosmos DB. | `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) | - -## Deprecated Azure Attributes - -This section describes deprecated Azure attributes. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `az.namespace` | string | Deprecated, use `azure.resource_provider.namespace` instead. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.resource_provider.namespace`. | -| `az.service_request_id` | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.service.request.id`. | diff --git a/docs/registry/attributes/browser.md b/docs/registry/attributes/browser.md index d4f145a4bf..2589f1a913 100644 --- a/docs/registry/attributes/browser.md +++ b/docs/registry/attributes/browser.md @@ -7,7 +7,8 @@ The web browser attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `browser.brands` | string[] | Array of brand name and version separated by a space [1] | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | ![Development](https://img.shields.io/badge/-development-blue) | | `browser.language` | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cassandra.md b/docs/registry/attributes/cassandra.md index 985a530f2e..4051269095 100644 --- a/docs/registry/attributes/cassandra.md +++ b/docs/registry/attributes/cassandra.md @@ -7,7 +7,8 @@ This section defines attributes for Cassandra. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cassandra.consistency.level` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `cassandra.coordinator.dc` | string | The data center of the coordinating node for a query. | `us-west-2` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index 3350fcd324..03cc6fbf84 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cicd.pipeline.action.name` | string | The kind of action a pipeline run is performing. | `BUILD`; `RUN`; `SYNC` | ![Development](https://img.shields.io/badge/-development-blue) | | `cicd.pipeline.name` | string | The human readable name of the pipeline within a CI/CD system. | `Build and Test`; `Lint`; `Deploy Go Project`; `deploy_to_environment` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index 0c4dd1d68e..013bc47b38 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `client.address` | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `client.port` | int | Client port number. [2] | `65123` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/cloud.md b/docs/registry/attributes/cloud.md index a3d7eb0f25..7994b49539 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). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cloud.account.id` | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | ![Development](https://img.shields.io/badge/-development-blue) | | `cloud.availability_zone` | string | Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. [1] | `us-east-1c` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cloudevents.md b/docs/registry/attributes/cloudevents.md index 03a3cfd92c..e1505b252c 100644 --- a/docs/registry/attributes/cloudevents.md +++ b/docs/registry/attributes/cloudevents.md @@ -7,7 +7,8 @@ This document defines attributes for CloudEvents. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cloudevents.event_id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `cloudevents.event_source` | string | The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened. | `https://github.com/cloudevents`; `/cloudevents/spec/pull/123`; `my-service` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cloudfoundry.md b/docs/registry/attributes/cloudfoundry.md index 231fd53cf0..524ef2f8dc 100644 --- a/docs/registry/attributes/cloudfoundry.md +++ b/docs/registry/attributes/cloudfoundry.md @@ -7,7 +7,8 @@ CloudFoundry resource attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cloudfoundry.app.id` | string | The guid of the application. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | ![Development](https://img.shields.io/badge/-development-blue) | | `cloudfoundry.app.instance.id` | string | The index of the application instance. 0 when just one instance is active. [2] | `0`; `1` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index 9c8008ce75..b60ba8ee2f 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -10,7 +10,8 @@ These attributes provide context about source code -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `code.column.number` | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `code.file.path` | string | The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity. | `/usr/local/MyApplication/content_root/app/index.php` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | @@ -38,10 +39,16 @@ Examples: These deprecated attributes provide context about source code -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `code.column` | int | Deprecated, use `code.column.number` | `16` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.column.number`. | -| `code.filepath` | string | Deprecated, use `code.file.path` instead | `/usr/local/MyApplication/content_root/app/index.php` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.file.path`. | -| `code.function` | string | Deprecated, use `code.function.name` instead | `serveRequest` | ![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. | -| `code.lineno` | int | Deprecated, use `code.line.number` instead | `42` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `code.line.number`. | -| `code.namespace` | string | Deprecated, namespace is now included into `code.function.name` | `com.example.MyHttpService` | ![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. | +| `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 e9a134672a..ec983b0efd 100644 --- a/docs/registry/attributes/container.md +++ b/docs/registry/attributes/container.md @@ -3,14 +3,41 @@ # 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `container.command` | string | The command used to run the container (i.e. the command name). [1] | `otelcontribcol` | ![Development](https://img.shields.io/badge/-development-blue) | | `container.command_args` | string[] | All the command arguments (including the command/executable itself) run by the container. | `["otelcontribcol", "--config", "config.yaml"]` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -41,23 +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/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field. **[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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | -| `container.labels.` | string | Deprecated, use `container.label` instead. | `nginx` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.label`. | -| `container.runtime` | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.runtime.name`. | - ---- - -`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 7f2a474ecf..be8e8d4ac8 100644 --- a/docs/registry/attributes/cpu.md +++ b/docs/registry/attributes/cpu.md @@ -7,7 +7,8 @@ Attributes specific to a cpu instance. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cpu.logical_number` | int | The logical CPU number [0..n-1] | `1` | ![Development](https://img.shields.io/badge/-development-blue) | | `cpu.mode` | string | The mode of the CPU | `user`; `system` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cpython.md b/docs/registry/attributes/cpython.md index d66e8ede5a..247a9dbdb0 100644 --- a/docs/registry/attributes/cpython.md +++ b/docs/registry/attributes/cpython.md @@ -7,7 +7,8 @@ This document defines CPython related attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cpython.gc.generation` | int | Value of the garbage collector collection generation. | `0`; `1`; `2` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index e5e19a7dd4..e59042f4e5 100644 --- a/docs/registry/attributes/db.md +++ b/docs/registry/attributes/db.md @@ -3,15 +3,213 @@ # 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` | Uncategorized. | +| `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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `db.client.connection.pool.name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `db.client.connection.state` | string | The state of a connection in the pool | `idle` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -165,188 +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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `db.cassandra.consistency_level` | string | Deprecated, use `cassandra.consistency.level` instead. | `all`; `each_quorum`; `quorum` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.consistency.level`. | -| `db.cassandra.coordinator.dc` | string | Deprecated, use `cassandra.coordinator.dc` instead. | `us-west-2` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.coordinator.dc`. | -| `db.cassandra.coordinator.id` | string | Deprecated, use `cassandra.coordinator.id` instead. | `be13faa2-8574-4d71-926d-27f16cf8a7af` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.coordinator.id`. | -| `db.cassandra.idempotence` | boolean | Deprecated, use `cassandra.query.idempotent` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.query.idempotent`. | -| `db.cassandra.page_size` | int | Deprecated, use `cassandra.page.size` instead. | `5000` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.page.size`. | -| `db.cassandra.speculative_execution_count` | int | Deprecated, use `cassandra.speculative_execution.count` instead. | `0`; `2` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cassandra.speculative_execution.count`. | -| `db.cassandra.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | -| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` and `server.port`. | -| `db.cosmosdb.client_id` | string | Deprecated, use `azure.client.id` instead. | `3ba4827d-4422-483f-b59f-85b74211c11d` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.client.id`. | -| `db.cosmosdb.connection_mode` | string | Deprecated, use `azure.cosmosdb.connection.mode` instead. | `gateway`; `direct` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.connection.mode`. | -| `db.cosmosdb.consistency_level` | string | Deprecated, use `cosmosdb.consistency.level` instead. | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.consistency.level`. | -| `db.cosmosdb.container` | string | Deprecated, use `db.collection.name` instead. | `mytable` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | -| `db.cosmosdb.operation_type` | string | Deprecated, no replacement at this time. | `batch`; `create`; `delete` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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"]` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.operation.contacted_regions`. | -| `db.cosmosdb.request_charge` | double | Deprecated, use `azure.cosmosdb.operation.request_charge` instead. | `46.18`; `1.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.operation.request_charge`. | -| `db.cosmosdb.request_content_length` | int | Deprecated, use `azure.cosmosdb.request.body.size` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.request.body.size`. | -| `db.cosmosdb.status_code` | int | Deprecated, use `db.response.status_code` instead. | `200`; `201` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Uncategorized. | -| `db.cosmosdb.sub_status_code` | int | Deprecated, use `azure.cosmosdb.response.sub_status_code` instead. | `1000`; `1002` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `azure.cosmosdb.response.sub_status_code`. | -| `db.elasticsearch.cluster.name` | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | -| `db.elasticsearch.node.name` | string | Deprecated, use `elasticsearch.node.name` instead. | `instance-0000000001` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `elasticsearch.node.name`. | -| `db.elasticsearch.path_parts.` | string | Deprecated, use `db.operation.parameter` instead. | `test-index`; `123` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.operation.parameter`. | -| `db.instance.id` | string | Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | `mysql-e26b99z.example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | -| `db.mongodb.collection` | string | Deprecated, use `db.collection.name` instead. | `mytable` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | -| `db.mssql.instance_name` | string | Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. | `MSSQLSERVER` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | -| `db.name` | string | Deprecated, use `db.namespace` instead. | `customers`; `main` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | -| `db.operation` | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.operation.name`. | -| `db.redis.database_index` | int | Deprecated, use `db.namespace` instead. | `0`; `1`; `15` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Uncategorized. | -| `db.sql.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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"` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.query.text`. | -| `db.system` | string | Deprecated, use `db.system.name` instead. | `other_sql`; `adabas`; `intersystems_cache` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.system.name`. | -| `db.user` | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `db.client.connections.pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | -| `db.client.connections.state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | -| `pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | -| `state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | - ---- - -`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 018c3a8989..cde5954cb4 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -10,7 +10,8 @@ This document defines attributes for software deployments. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `deployment.environment.name` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` | ![Development](https://img.shields.io/badge/-development-blue) | | `deployment.id` | string | The id of the deployment. | `1208` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -38,6 +39,12 @@ considered to be identifying the same service: Describes deprecated deployment attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `deployment.environment` | string | Deprecated, use `deployment.environment.name` instead. | `staging`; `production` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `deployment.environment.name`. | +| `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 868a9f8130..7a3bc00bba 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `destination.address` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `destination.port` | int | Destination port number | `3389`; `2888` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/device.md b/docs/registry/attributes/device.md index e43e2e3dd9..62bd044857 100644 --- a/docs/registry/attributes/device.md +++ b/docs/registry/attributes/device.md @@ -7,7 +7,8 @@ Describes device attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `device.id` | string | A unique identifier representing the device [1] | `123456789012345`; `01:23:45:67:89:AB` | ![Development](https://img.shields.io/badge/-development-blue) | | `device.manufacturer` | string | The name of the device manufacturer [2] | `Apple`; `Samsung` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/disk.md b/docs/registry/attributes/disk.md index cb15956a1d..056450386b 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `disk.io.direction` | string | The disk IO operation direction. | `read` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/dns.md b/docs/registry/attributes/dns.md index eb6ec38e53..cb146a76f5 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `dns.answers` | string[] | The list of IPv4 or IPv6 addresses resolved during DNS lookup. | `["10.0.0.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"]` | ![Development](https://img.shields.io/badge/-development-blue) | | `dns.question.name` | string | The name being queried. [1] | `www.example.com`; `opentelemetry.io` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/dotnet.md b/docs/registry/attributes/dotnet.md index 025d570a86..7e75db6def 100644 --- a/docs/registry/attributes/dotnet.md +++ b/docs/registry/attributes/dotnet.md @@ -7,7 +7,8 @@ This document defines .NET related attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `dotnet.gc.heap.generation` | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/elasticsearch.md b/docs/registry/attributes/elasticsearch.md index aa1f493860..18f78a42ef 100644 --- a/docs/registry/attributes/elasticsearch.md +++ b/docs/registry/attributes/elasticsearch.md @@ -7,6 +7,7 @@ This section defines attributes for Elasticsearch. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `elasticsearch.node.name` | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index 9cd639d3f5..145cd68103 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -10,7 +10,8 @@ Describes the end user. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `enduser.id` | string | Unique identifier of an end user in the system. It maybe a username, email address, or other identifier. [1] | `username` | ![Development](https://img.shields.io/badge/-development-blue) | | `enduser.pseudo.id` | string | Pseudonymous identifier of an end user. This identifier should be a random value that is not directly linked or associated with the end user's actual identity. [2] | `QdH5CAWJgqVT4rOr0qtumf` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -29,7 +30,13 @@ Describes the end user. Describes deprecated enduser attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Uncategorized. | -| `enduser.scope` | string | Deprecated, no replacement at this time. | `read:message, write:files` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | +| `enduser.role` | string | Deprecated, use `user.roles` instead. | `admin` | Uncategorized. | +| `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 fdf9325b4c..6ff6b215eb 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `error.message` | string | A message providing more detail about an error in human-readable form. [1] | `Unexpected input type: string`; `The user has exceeded their storage quota` | ![Development](https://img.shields.io/badge/-development-blue) | | `error.type` | string | Describes a class of error the operation ended with. [2] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 216c9e699a..7fec2f0510 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -7,7 +7,8 @@ Attributes for Events represented using Log Records. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `event.name` | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index 739113022f..35619f8136 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `exception.message` | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `exception.stacktrace` | 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)` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | @@ -20,6 +21,12 @@ This document defines the shared attributes used to report a single exception as Deprecated exception attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `exception.escaped` | boolean | Indicates that the exception is escaping the scope of the span. | | ![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. | +| `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 303fa44585..4e2edec682 100644 --- a/docs/registry/attributes/faas.md +++ b/docs/registry/attributes/faas.md @@ -7,7 +7,8 @@ FaaS attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `faas.coldstart` | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | | ![Development](https://img.shields.io/badge/-development-blue) | | `faas.cron` | string | A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm). | `0/5 * * * ? *` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index 82a85fdb8c..c94bcd2b14 100644 --- a/docs/registry/attributes/feature-flag.md +++ b/docs/registry/attributes/feature-flag.md @@ -3,14 +3,48 @@ # 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `feature_flag.context.id` | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | | `feature_flag.key` | string | The lookup key of the feature flag. | `logo-color` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | @@ -47,30 +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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `feature_flag.evaluation.error.message` | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `error.message`. | -| `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.reason`. | -| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.provider.name`. | -| `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.variant`. | - ---- - -`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 e1af7f0e89..8d4d69dfc4 100644 --- a/docs/registry/attributes/file.md +++ b/docs/registry/attributes/file.md @@ -7,7 +7,8 @@ Describes file attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `file.accessed` | string | Time when the file was last accessed, in ISO 8601 format. [1] | `2021-01-01T12:00:00Z` | ![Development](https://img.shields.io/badge/-development-blue) | | `file.attributes` | string[] | Array of file attributes. [2] | `["readonly", "hidden"]` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 7fc4ed6380..51d3242e48 100644 --- a/docs/registry/attributes/gcp.md +++ b/docs/registry/attributes/gcp.md @@ -3,35 +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 | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `gcp.client.service` | string | Identifies the Google Cloud service for which the official client library is intended. [1] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | ![Development](https://img.shields.io/badge/-development-blue) | + +**[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 | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `gcp.cloud_run.job.execution` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.cloud_run.job.task_index` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | + ## 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). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gcp.apphub.application.container` | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.application.id` | string | The name of the application as configured in AppHub. | `my-application` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.application.location` | string | The GCP zone or region where the application is defined. | `us-central1` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.service.criticality_type` | string | Criticality of a service indicates its importance to the business. [1] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.service.environment_type` | string | Environment of a service is the stage of a software lifecycle. [2] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.service.criticality_type` | string | Criticality of a service indicates its importance to the business. [2] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.service.environment_type` | string | Environment of a service is the stage of a software lifecycle. [3] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.service.id` | string | The name of the service as configured in AppHub. | `my-service` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.workload.criticality_type` | string | Criticality of a workload indicates its importance to the business. [3] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.workload.environment_type` | string | Environment of a workload is the stage of a software lifecycle. [4] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.workload.criticality_type` | string | Criticality of a workload indicates its importance to the business. [4] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.workload.environment_type` | string | Environment of a workload is the stage of a software lifecycle. [5] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.workload.id` | string | The name of the workload as configured in AppHub. | `my-workload` | ![Development](https://img.shields.io/badge/-development-blue) | -**[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) --- @@ -81,7 +103,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). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gcp.apphub_destination.application.container` | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub_destination.application.id` | string | The name of the destination application as configured in AppHub. | `my-application` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -137,30 +160,12 @@ 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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `gcp.client.service` | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | ![Development](https://img.shields.io/badge/-development-blue) | - -**[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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `gcp.cloud_run.job.execution` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.cloud_run.job.task_index` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | - ## GCP - Google Compute Engine (GCE) Attributes This document defines attributes for Google Compute Engine (GCE). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gcp.gce.instance.hostname` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.gce.instance.name` | string | The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). | `instance-1`; `my-vm-name` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index abc61bcf9b..246edae417 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -3,15 +3,99 @@ # Gen AI -- [GenAI Attributes](#genai-attributes) - [Deprecated GenAI Attributes](#deprecated-genai-attributes) - [Deprecated OpenAI GenAI Attributes](#deprecated-openai-genai-attributes) +- [GenAI Attributes](#genai-attributes) + +## Deprecated GenAI Attributes + +Describes deprecated `gen_ai` attributes. + +**Current Attributes:** +
+Past Attributes: + +| Key | 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. | +| `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. | + +--- + +`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `anthropic` | Anthropic | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.bedrock` | AWS Bedrock | ![Development](https://img.shields.io/badge/-development-blue) | +| `azure.ai.inference` | Azure AI Inference | ![Development](https://img.shields.io/badge/-development-blue) | +| `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 [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) | +| `openai` | OpenAI | ![Development](https://img.shields.io/badge/-development-blue) | +| `perplexity` | Perplexity | ![Development](https://img.shields.io/badge/-development-blue) | +| `xai` | xAI | ![Development](https://img.shields.io/badge/-development-blue) | + +**[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.'. + +**[3]:** 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. + +**Current Attributes:** +
+Past Attributes: + +| Key | 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. | +| `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. | + +--- + +`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | +| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | + +
## GenAI Attributes This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gen_ai.agent.description` | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | ![Development](https://img.shields.io/badge/-development-blue) | | `gen_ai.agent.id` | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -232,74 +316,3 @@ 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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `gen_ai.completion` | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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?'}]` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, no replacement at this time. | -| `gen_ai.system` | string | Deprecated, use `gen_ai.provider.name` instead. | `openai`; `gcp.gen_ai`; `gcp.vertex_ai` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.provider.name`. | -| `gen_ai.usage.completion_tokens` | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.output_tokens`. | -| `gen_ai.usage.prompt_tokens` | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.usage.input_tokens`. | - ---- - -`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `anthropic` | Anthropic | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.bedrock` | AWS Bedrock | ![Development](https://img.shields.io/badge/-development-blue) | -| `azure.ai.inference` | Azure AI Inference | ![Development](https://img.shields.io/badge/-development-blue) | -| `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) | -| `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) | -| `openai` | OpenAI | ![Development](https://img.shields.io/badge/-development-blue) | -| `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.'. - -**[18]:** May be used when specific backend is unknown. 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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `gen_ai.openai.request.response_format` | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.output.type`. | -| `gen_ai.openai.request.seed` | int | Deprecated, use `gen_ai.request.seed`. | `100` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `gen_ai.request.seed`. | -| `gen_ai.openai.request.service_tier` | string | Deprecated, use `openai.request.service_tier`. | `auto`; `default` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.request.service_tier`. | -| `gen_ai.openai.response.service_tier` | string | Deprecated, use `openai.response.service_tier`. | `scale`; `default` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.service_tier`. | -| `gen_ai.openai.response.system_fingerprint` | string | Deprecated, use `openai.response.system_fingerprint`. | `fp_44709d6fcb` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `openai.response.system_fingerprint`. | - ---- - -`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | -| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index 2b8dff726b..88e4a88839 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `geo.continent.code` | string | Two-letter code representing continent’s name. | `AF`; `AN`; `AS` | ![Development](https://img.shields.io/badge/-development-blue) | | `geo.country.iso_code` | string | Two-letter ISO Country Code ([ISO 3166-1 alpha2](https://wikipedia.org/wiki/ISO_3166-1#Codes)). | `CA` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/go.md b/docs/registry/attributes/go.md index 6f75136a83..fe104beb36 100644 --- a/docs/registry/attributes/go.md +++ b/docs/registry/attributes/go.md @@ -7,7 +7,8 @@ This document defines Go related attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `go.memory.type` | string | The type of memory. | `other`; `stack` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/graphql.md b/docs/registry/attributes/graphql.md index 779c3d23c7..227f10beee 100644 --- a/docs/registry/attributes/graphql.md +++ b/docs/registry/attributes/graphql.md @@ -7,7 +7,8 @@ This document defines attributes for GraphQL. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `graphql.document` | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | ![Development](https://img.shields.io/badge/-development-blue) | | `graphql.operation.name` | string | The name of the operation being executed. | `findBookById` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/hardware.md b/docs/registry/attributes/hardware.md index 2445fac5f4..5b72d6c5b1 100644 --- a/docs/registry/attributes/hardware.md +++ b/docs/registry/attributes/hardware.md @@ -7,7 +7,8 @@ Attributes for hardware. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `hw.battery.capacity` | string | Design capacity in Watts-hours or Amper-hours | `9.3Ah`; `50Wh` | ![Development](https://img.shields.io/badge/-development-blue) | | `hw.battery.chemistry` | string | Battery [chemistry](https://schemas.dmtf.org/wbem/cim-html/2.31.0/CIM_Battery.html), e.g. Lithium-Ion, Nickel-Cadmium, etc. | `Li-ion`; `NiMH` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/heroku.md b/docs/registry/attributes/heroku.md index 6052029edb..3107b6ac71 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `heroku.app.id` | string | Unique identifier for the application | `2daa2797-e42b-4624-9322-ec3f968df4da` | ![Development](https://img.shields.io/badge/-development-blue) | | `heroku.release.commit` | string | Commit hash for the current release | `e6134959463efd8966b20e75b913cafe3f5ec` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/host.md b/docs/registry/attributes/host.md index aef5841091..10da386e77 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `host.arch` | string | The CPU architecture the host system is running on. | `amd64`; `arm32`; `arm64` | ![Development](https://img.shields.io/badge/-development-blue) | | `host.cpu.cache.l2.size` | int | The amount of level 2 memory cache available to the processor (in Bytes). | `12288000` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index 309813d5c2..c557a65076 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -10,7 +10,8 @@ This document defines semantic convention attributes in the HTTP namespace. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `http.connection.state` | string | State of the HTTP connection in the HTTP connection pool. | `active`; `idle` | ![Development](https://img.shields.io/badge/-development-blue) | | `http.request.body.size` | int | The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. | `3495` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -118,22 +119,26 @@ support custom route formatting. Instrumentations SHOULD document the format and Describes deprecated HTTP attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `http.client_ip` | string | Deprecated, use `client.address` instead. | `83.164.160.102` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `client.address`. | -| `http.flavor` | string | Deprecated, use `network.protocol.name` and `network.protocol.version` instead. | `1.0`; `1.1`; `2.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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` | ![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. | -| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.method`. | -| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.header.content-length`. | -| `http.request_content_length_uncompressed` | int | Deprecated, use `http.request.body.size` instead. | `5493` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.request.body.size`. | -| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.header.content-length`. | -| `http.response_content_length_uncompressed` | int | Deprecated, use `http.response.body.size` instead. | `5493` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.body.size`. | -| `http.scheme` | string | Deprecated, use `url.scheme` instead. | `http`; `https` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.scheme`. | -| `http.server_name` | string | Deprecated, use `server.address` instead. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | -| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `http.response.status_code`. | -| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split to `url.path` and `url.query`. | -| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.full`. | -| `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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `user_agent.original`. | +| `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. | --- @@ -147,3 +152,5 @@ Describes deprecated HTTP attributes. | `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 c17f12f4db..c9c2e91a7d 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -3,22 +3,26 @@ # iOS -- [iOS Attributes](#ios-attributes) - [Deprecated iOS Attributes](#deprecated-ios-attributes) +- [iOS Attributes](#ios-attributes) -## iOS Attributes +## Deprecated iOS Attributes -This group describes iOS-specific attributes. +The iOS platform on which the iOS application is running. + +**Current Attributes:** +
+Past Attributes: -| Attribute | Type | Description | Examples | Stability | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `ios.app.state` | string | This attribute represents the state of the application. [1] | `active`; `inactive`; `background` | ![Development](https://img.shields.io/badge/-development-blue) | +| `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [1] | `active`; `inactive`; `background` | Use `ios.app.state` instead. | -**[1] `ios.app.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. --- -`ios.app.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. +`ios.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 | |---|---|---| @@ -28,19 +32,22 @@ 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. +## iOS Attributes + +This group describes iOS-specific attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [2] | `active`; `inactive`; `background` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `ios.app.state`. | +| `ios.app.state` | string | This attribute represents the state of the application. [1] | `active`; `inactive`; `background` | ![Development](https://img.shields.io/badge/-development-blue) | -**[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.app.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. --- -`ios.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. +`ios.app.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 | |---|---|---| diff --git a/docs/registry/attributes/jvm.md b/docs/registry/attributes/jvm.md index 9b6f030276..bce6f65c6c 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `jvm.buffer.pool.name` | string | Name of the buffer pool. [1] | `mapped`; `direct` | ![Development](https://img.shields.io/badge/-development-blue) | | `jvm.gc.action` | string | Name of the garbage collector action. [2] | `end of minor GC`; `end of major GC` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index 93bed72c14..0d733d2504 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -10,7 +10,8 @@ Kubernetes resource attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `k8s.cluster.name` | string | The name of the cluster. | `opentelemetry-cluster` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.cluster.uid` | string | A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -352,6 +353,12 @@ When this occurs, the exact value as reported by the Kubernetes API SHOULD be us Describes deprecated k8s attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `k8s.pod.labels.` | string | Deprecated, use `k8s.pod.label` instead. | `my-app` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `k8s.pod.label`. | +| `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 9795b3094b..b0a426a545 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -7,7 +7,8 @@ Describes Linux Memory attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `linux.memory.slab.state` | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/log.md b/docs/registry/attributes/log.md index d59ae5223b..aac4f87fb0 100644 --- a/docs/registry/attributes/log.md +++ b/docs/registry/attributes/log.md @@ -11,7 +11,8 @@ This document defines log attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `log.iostream` | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -28,7 +29,8 @@ This document defines log attributes Attributes for a file to which log was emitted. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `log.file.name` | string | The basename of the file. | `audit.log` | ![Development](https://img.shields.io/badge/-development-blue) | | `log.file.name_resolved` | string | The basename of the file, with symlinks resolved. | `uuid.log` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -39,7 +41,8 @@ Attributes for a file to which log was emitted. This document defines the generic attributes that may be used in any Log Record. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `log.record.original` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `log.record.uid` | string | A unique identifier for the Log Record. [2] | `01ARZ3NDEKTSV4RRFFQ69G5FAV` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/mainframe.md b/docs/registry/attributes/mainframe.md index 776b793f85..de28c30ae5 100644 --- a/docs/registry/attributes/mainframe.md +++ b/docs/registry/attributes/mainframe.md @@ -7,6 +7,7 @@ This document defines attributes of a Mainframe Logical Partition (LPAR). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `mainframe.lpar.name` | string | Name of the logical partition that hosts a systems with a mainframe operating system. | `LPAR01` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 362c111201..7e2a4b829e 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -4,19 +4,20 @@ # Messaging - [General Messaging Attributes](#general-messaging-attributes) -- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) -- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) - [Kafka Attributes](#kafka-attributes) - [RabbitMQ Attributes](#rabbitmq-attributes) - [RocketMQ Attributes](#rocketmq-attributes) +- [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](#deprecated-messaging-attributes) ## General Messaging Attributes Attributes describing telemetry around messaging systems and messaging activities. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.batch.message_count` | int | The number of messages sent, received, or processed in the scope of the batching operation. [1] | `0`; `1`; `2` | ![Development](https://img.shields.io/badge/-development-blue) | | `messaging.client.id` | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -87,30 +88,12 @@ 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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `messaging.eventhubs.message.enqueued_time` | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | ![Development](https://img.shields.io/badge/-development-blue) | - -## GCP Pub/Sub Attributes - -This group describes attributes specific to GCP Pub/Sub. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `messaging.gcp_pubsub.message.ack_deadline` | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | ![Development](https://img.shields.io/badge/-development-blue) | -| `messaging.gcp_pubsub.message.ack_id` | string | The ack id for a given message. | `ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | -| `messaging.gcp_pubsub.message.delivery_attempt` | int | The delivery attempt for a given message. | `2` | ![Development](https://img.shields.io/badge/-development-blue) | -| `messaging.gcp_pubsub.message.ordering_key` | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | - ## Kafka Attributes This group describes attributes specific to Apache Kafka. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.kafka.message.key` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `messaging.kafka.message.tombstone` | boolean | A boolean that is true if the message is a tombstone. | | ![Development](https://img.shields.io/badge/-development-blue) | @@ -122,7 +105,8 @@ This group describes attributes specific to Apache Kafka. This group describes attributes specific to RabbitMQ. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.rabbitmq.destination.routing_key` | string | RabbitMQ message routing key. | `myKey` | ![Development](https://img.shields.io/badge/-development-blue) | | `messaging.rabbitmq.message.delivery_tag` | int | RabbitMQ message delivery tag | `123` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -131,7 +115,8 @@ This group describes attributes specific to RabbitMQ. This group describes attributes specific to RocketMQ. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.rocketmq.consumption_model` | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | ![Development](https://img.shields.io/badge/-development-blue) | | `messaging.rocketmq.message.delay_time_level` | int | The delay time level for delay message, which determines the message delay time. | `3` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -162,11 +147,24 @@ 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 | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `messaging.gcp_pubsub.message.ack_deadline` | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | ![Development](https://img.shields.io/badge/-development-blue) | +| `messaging.gcp_pubsub.message.ack_id` | string | The ack id for a given message. | `ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | +| `messaging.gcp_pubsub.message.delivery_attempt` | int | The delivery attempt for a given message. | `2` | ![Development](https://img.shields.io/badge/-development-blue) | +| `messaging.gcp_pubsub.message.ordering_key` | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | + ## Azure Service Bus Attributes This group describes attributes specific to Azure Service Bus. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.servicebus.disposition_status` | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | ![Development](https://img.shields.io/badge/-development-blue) | | `messaging.servicebus.message.delivery_count` | int | Number of deliveries that have been attempted for this message. | `2` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -183,19 +181,34 @@ 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 + +This group describes attributes specific to Azure Event Hubs. + +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `messaging.eventhubs.message.enqueued_time` | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | ![Development](https://img.shields.io/badge/-development-blue) | + ## Deprecated Messaging Attributes Describes deprecated messaging attributes. -| Attribute | Type | Description | Examples | Stability | +**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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.client.id`. | -| `messaging.destination_publish.anonymous` | boolean | Deprecated, no replacement at this time. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | -| `messaging.destination_publish.name` | string | Deprecated, no replacement at this time. | `MyQueue`; `MyTopic` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | -| `messaging.eventhubs.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `$Default` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name`. | -| `messaging.kafka.consumer.group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `my-group` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.consumer.group.name`. | -| `messaging.kafka.destination.partition` | int | Deprecated, use `messaging.destination.partition.id` instead. | `2` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.kafka.offset`. | -| `messaging.operation` | string | Deprecated, use `messaging.operation.type` instead. | `publish`; `create`; `process` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.operation.type`. | -| `messaging.rocketmq.client_group` | string | Deprecated, use `messaging.consumer.group.name` instead. | `myConsumerGroup` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.destination.subscription.name`. | +| `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 ce34a109e0..4b771295a9 100644 --- a/docs/registry/attributes/network.md +++ b/docs/registry/attributes/network.md @@ -3,14 +3,67 @@ # Network -- [Network Attributes](#network-attributes) - [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. + +
## Network Attributes These attributes may be used for any network related operation. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `network.carrier.icc` | string | The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. | `DE` | ![Development](https://img.shields.io/badge/-development-blue) | | `network.carrier.mcc` | string | The mobile carrier country code. | `310` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -131,49 +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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `net.host.ip` | string | Deprecated, use `network.local.address`. | `192.168.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | -| `net.host.name` | string | Deprecated, use `server.address`. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | -| `net.host.port` | int | Deprecated, use `server.port`. | `8080` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.port`. | -| `net.peer.ip` | string | Deprecated, use `network.peer.address`. | `127.0.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | -| `net.peer.name` | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.name`. | -| `net.protocol.version` | string | Deprecated, use `network.protocol.version`. | `3.1.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.protocol.version`. | -| `net.sock.family` | string | Deprecated, use `network.transport` and `network.type`. | `inet`; `inet6`; `unix` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Split to `network.transport` and `network.type`. | -| `net.sock.host.addr` | string | Deprecated, use `network.local.address`. | `/var/my.sock` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.address`. | -| `net.sock.host.port` | int | Deprecated, use `network.local.port`. | `8080` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.local.port`. | -| `net.sock.peer.addr` | string | Deprecated, use `network.peer.address`. | `192.168.0.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.address`. | -| `net.sock.peer.name` | string | Deprecated, no replacement at this time. | `/var/my.sock` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed. No replacement at this time. | -| `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.port`. | -| `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.transport`. | - ---- - -`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 25e50c2209..c1a52fdf5d 100644 --- a/docs/registry/attributes/nfs.md +++ b/docs/registry/attributes/nfs.md @@ -7,7 +7,8 @@ NFS Server replies check a Reply Cache (repcache), which can have one of 3 result states -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `nfs.operation.name` | string | NFSv4+ operation name. | `OPEN`; `READ`; `GETATTR` | ![Development](https://img.shields.io/badge/-development-blue) | | `nfs.server.repcache.status` | string | Linux: one of "hit" (NFSD_STATS_RC_HITS), "miss" (NFSD_STATS_RC_MISSES), or "nocache" (NFSD_STATS_RC_NOCACHE -- uncacheable) | `hit` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/nodejs.md b/docs/registry/attributes/nodejs.md index 2c59738dac..81acbfacb7 100644 --- a/docs/registry/attributes/nodejs.md +++ b/docs/registry/attributes/nodejs.md @@ -7,7 +7,8 @@ Describes Node.js related attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `nodejs.eventloop.state` | string | The state of event loop time. | `active`; `idle` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/oci.md b/docs/registry/attributes/oci.md index 16a98b210a..96ff3f50db 100644 --- a/docs/registry/attributes/oci.md +++ b/docs/registry/attributes/oci.md @@ -7,7 +7,8 @@ An OCI image manifest. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `oci.manifest.digest` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/onc-rpc.md b/docs/registry/attributes/onc-rpc.md index 8e6c673b9b..6c8239b76c 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) -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `onc_rpc.procedure.name` | string | ONC/Sun RPC procedure name. | `OPEN`; `READ`; `GETATTR` | ![Development](https://img.shields.io/badge/-development-blue) | | `onc_rpc.procedure.number` | int | ONC/Sun RPC procedure number. | | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 07f53b86d7..066abbd6ca 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -7,7 +7,8 @@ This group defines attributes for OpenAI. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `openai.request.service_tier` | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` | ![Development](https://img.shields.io/badge/-development-blue) | | `openai.response.service_tier` | string | The service tier used for the response. | `scale`; `default` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/opentracing.md b/docs/registry/attributes/opentracing.md index e886f66f8c..23e7b8f8c7 100644 --- a/docs/registry/attributes/opentracing.md +++ b/docs/registry/attributes/opentracing.md @@ -7,7 +7,8 @@ Attributes used by the OpenTracing Shim layer. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `opentracing.ref_type` | string | Parent-child Reference type [1] | `child_of`; `follows_from` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/os.md b/docs/registry/attributes/os.md index 86a8c8cfba..daa2254a9b 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `os.build_id` | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | ![Development](https://img.shields.io/badge/-development-blue) | | `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index adcffba052..7bfa9d1f76 100644 --- a/docs/registry/attributes/otel.md +++ b/docs/registry/attributes/otel.md @@ -3,16 +3,32 @@ # 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 -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `otel.span.parent.origin` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `otel.span.sampling_result` | string | The result value of the sampler for this span | `DROP`; `RECORD_ONLY`; `RECORD_AND_SAMPLE` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -48,11 +64,23 @@ 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 | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `otel.scope.schema_url` | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | ![Development](https://img.shields.io/badge/-development-blue) | +| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + ## OTel Component Attributes Attributes used for OpenTelemetry component self-monitoring -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `otel.component.name` | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | ![Development](https://img.shields.io/badge/-development-blue) | | `otel.component.type` | string | A name identifying the type of the OpenTelemetry component. [2] | `batching_span_processor`; `com.example.MySpanExporter` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -96,22 +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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `otel.scope.schema_url` | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | ![Development](https://img.shields.io/badge/-development-blue) | -| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - -## Deprecated OTel Library Attributes - -Describes deprecated otel.library attributes. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `otel.scope.name`. | -| `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `otel.scope.version`. | diff --git a/docs/registry/attributes/peer.md b/docs/registry/attributes/peer.md index 485cf0e8a1..f565cf5df3 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -7,6 +7,7 @@ Operations that access some remote service. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `peer.service` | string | The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/pprof.md b/docs/registry/attributes/pprof.md index bc964a4aed..35078d0a7e 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `pprof.location.is_folded` | 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. | | ![Development](https://img.shields.io/badge/-development-blue) | | `pprof.mapping.has_filenames` | boolean | Indicates that there are filenames related to this mapping. | | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index da564b9fa5..0f95819435 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -11,7 +11,8 @@ An operating system process. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `process.args_count` | int | Length of the process.command_args array [1] | `4` | ![Development](https://img.shields.io/badge/-development-blue) | | `process.command` | string | The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in `proc/[pid]/cmdline`. On Windows, can be set to the first parameter extracted from `GetCommandLineW`. | `cmd/otelcol` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -84,7 +85,8 @@ with value `"/usr/local/bin:/usr/bin"`. Describes Linux Process attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `process.linux.cgroup` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -94,10 +96,14 @@ Describes Linux Process attributes Deprecated process attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | -| `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.executable.build_id.htlhash`. | +| `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. | --- @@ -108,3 +114,5 @@ Deprecated process attributes. | `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) | + +
diff --git a/docs/registry/attributes/profile.md b/docs/registry/attributes/profile.md index 6ca899a6e5..6ec4ccd328 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `profile.frame.type` | string | Describes the interpreter or compiler of a single frame. | `cpython` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index 3a0dd99355..f3b1bd1af3 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `rpc.connect_rpc.error_code` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `rpc.connect_rpc.request.metadata.` | string[] | Connect request metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values. [1] | `["1.2.3.4", "1.2.3.5"]` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -134,12 +135,16 @@ the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute Deprecated rpc message attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `message.compressed_size` | int | Deprecated, use `rpc.message.compressed_size` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.compressed_size`. | -| `message.id` | int | Deprecated, use `rpc.message.id` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.id`. | -| `message.type` | string | Deprecated, use `rpc.message.type` instead. | `SENT`; `RECEIVED` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.type`. | -| `message.uncompressed_size` | int | Deprecated, use `rpc.message.uncompressed_size` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.uncompressed_size`. | +| `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 +154,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 919289e3c5..592fcaf837 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `security_rule.category` | string | A categorization value keyword used by the entity using the rule for detection of this event | `Attempted Information Leak` | ![Development](https://img.shields.io/badge/-development-blue) | | `security_rule.description` | string | The description of the rule generating the event. | `Block requests to public DNS over HTTPS / TLS protocols` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index a0206f280a..42fb2081fc 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `server.address` | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `server.port` | int | Server port number. [2] | `80`; `8080`; `443` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/service.md b/docs/registry/attributes/service.md index c8e427eb5d..0b3da96ea5 100644 --- a/docs/registry/attributes/service.md +++ b/docs/registry/attributes/service.md @@ -7,7 +7,8 @@ A service instance. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `service.instance.id` | string | The string ID of the service instance. [1] | `627cc493-f310-47de-96bd-71410b7dec09` | ![Development](https://img.shields.io/badge/-development-blue) | | `service.name` | string | Logical name of the service. [2] | `shoppingcart` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index 9a64b92c47..27557fc6af 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `session.id` | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | ![Development](https://img.shields.io/badge/-development-blue) | | `session.previous_id` | string | The previous `session.id` for this user, when known. | `00112233-4455-6677-8899-aabbccddeeff` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/signalr.md b/docs/registry/attributes/signalr.md index c96e0dd539..964fe61789 100644 --- a/docs/registry/attributes/signalr.md +++ b/docs/registry/attributes/signalr.md @@ -7,7 +7,8 @@ SignalR attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `signalr.connection.status` | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `signalr.transport` | string | [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index 2925a03b7f..6eb166a07e 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `source.address` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `source.port` | int | Source port number | `3389`; `2888` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index c4044984fb..75e9b84d91 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -3,60 +3,89 @@ # System +- [Deprecated System Attributes](#deprecated-system-attributes) - [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) - [System Process Attributes](#system-process-attributes) -- [Deprecated System Attributes](#deprecated-system-attributes) -## General System Attributes +## Deprecated System Attributes -Describes System attributes +Deprecated system attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `system.device` | string | The device identifier | `(identifier)` | ![Development](https://img.shields.io/badge/-development-blue) | +| `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.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | Use `system.process.status` instead. | -## Filesystem Attributes +--- -Describes Filesystem attributes +`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. -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `system.filesystem.mode` | string | The filesystem mode | `rw, ro` | ![Development](https://img.shields.io/badge/-development-blue) | -| `system.filesystem.mountpoint` | string | The filesystem mount path | `/mnt/data` | ![Development](https://img.shields.io/badge/-development-blue) | -| `system.filesystem.state` | string | The filesystem state | `used` | ![Development](https://img.shields.io/badge/-development-blue) | -| `system.filesystem.type` | string | The filesystem type | `ext4` | ![Development](https://img.shields.io/badge/-development-blue) | +| 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.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. +`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 | |---|---|---| -| `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) | +| `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.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. +`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 | |---|---|---| -| `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) | +| `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) | + +
+ +## General System Attributes + +Describes System attributes + +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `system.device` | string | The device identifier | `(identifier)` | ![Development](https://img.shields.io/badge/-development-blue) | ## System Memory Attributes Describes System Memory attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `system.memory.state` | string | The memory state | `free`; `cached` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -77,7 +106,8 @@ Describes System Memory attributes Describes System Memory Paging attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `system.paging.direction` | string | The paging access direction | `in` | ![Development](https://img.shields.io/badge/-development-blue) | | `system.paging.state` | string | The memory paging state | `free` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -110,72 +140,53 @@ Describes System Memory Paging attributes | `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | | `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | -## System Process Attributes +## Filesystem Attributes -Describes System Process attributes +Describes Filesystem attributes -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `system.process.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.mode` | string | The filesystem mode | `rw, ro` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.mountpoint` | string | The filesystem mount path | `/mnt/data` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.state` | string | The filesystem state | `used` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.type` | string | The filesystem type | `ext4` | ![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. +`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 | |---|---|---| -| `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) | - -## Deprecated System Attributes - -Deprecated system attributes. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `system.cpu.logical_number` | int | Deprecated, use `cpu.logical_number` instead. | `1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.logical_number`. | -| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode`. | -| `system.network.state` | string | Deprecated, use `network.connection.state` instead. | `close_wait` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.connection.state`. | -| `system.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.process.status`. | +| `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.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. +`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 | |---|---|---| -| `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) | +| `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 Process Attributes -`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. +Describes System Process attributes -| 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) | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `system.process.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | ![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. +`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 | |---|---|---| diff --git a/docs/registry/attributes/telemetry.md b/docs/registry/attributes/telemetry.md index f7c5fc7686..95ab37e96f 100644 --- a/docs/registry/attributes/telemetry.md +++ b/docs/registry/attributes/telemetry.md @@ -7,7 +7,8 @@ This document defines attributes for telemetry SDK. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `telemetry.distro.name` | string | The name of the auto instrumentation agent or distribution, if used. [1] | `parts-unlimited-java` | ![Development](https://img.shields.io/badge/-development-blue) | | `telemetry.distro.version` | string | The version string of the auto instrumentation agent or distribution, if used. | `1.2.3` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 058dd9b8ed..7cf001ca71 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). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `test.case.name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `test.case.result.status` | string | The status of the actual test case result from test execution. | `pass`; `fail` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index 2db73eb24f..86551fd4a0 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `thread.id` | int | Current "managed" thread ID (as opposed to OS thread ID). | `42` | ![Development](https://img.shields.io/badge/-development-blue) | | `thread.name` | string | Current thread name. | `main` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index 775154efc4..b9a33d34bf 100644 --- a/docs/registry/attributes/tls.md +++ b/docs/registry/attributes/tls.md @@ -3,14 +3,29 @@ # 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `tls.cipher` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `tls.client.certificate` | string | PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. | `MII...` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -51,11 +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. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `tls.client.server_name` | string | Deprecated, use `server.address` instead. | `opentelemetry.io` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address`. | diff --git a/docs/registry/attributes/url.md b/docs/registry/attributes/url.md index f5cf1649c5..cdb11c1025 100644 --- a/docs/registry/attributes/url.md +++ b/docs/registry/attributes/url.md @@ -7,7 +7,8 @@ Attributes describing URL. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `url.domain` | 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]` | ![Development](https://img.shields.io/badge/-development-blue) | | `url.extension` | string | The file extension extracted from the `url.full`, excluding the leading dot. [2] | `png`; `gz` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/user-agent.md b/docs/registry/attributes/user-agent.md index 48bfa7e7d4..965287fd6f 100644 --- a/docs/registry/attributes/user-agent.md +++ b/docs/registry/attributes/user-agent.md @@ -10,7 +10,8 @@ Describes user-agent attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `user_agent.name` | string | Name of the user-agent extracted from original. Usually refers to the browser's name. [1] | `Safari`; `YourApp` | ![Development](https://img.shields.io/badge/-development-blue) | | `user_agent.original` | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1`; `YourApp/1.0.0 grpc-java-okhttp/1.27.2` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | @@ -24,7 +25,8 @@ Describes user-agent attributes. Describes the OS user-agent attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `user_agent.os.name` | string | Human readable operating system name. [3] | `iOS`; `Android`; `Ubuntu` | ![Development](https://img.shields.io/badge/-development-blue) | | `user_agent.os.version` | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). [4] | `14.2.1`; `18.04.1` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/user.md b/docs/registry/attributes/user.md index 8fff26de66..ab0316a916 100644 --- a/docs/registry/attributes/user.md +++ b/docs/registry/attributes/user.md @@ -7,7 +7,8 @@ Describes information about the user. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `user.email` | string | User email address. | `a.einstein@example.com` | ![Development](https://img.shields.io/badge/-development-blue) | | `user.full_name` | string | User's full name | `Albert Einstein` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/v8js.md b/docs/registry/attributes/v8js.md index 4877a5e69c..8616331d56 100644 --- a/docs/registry/attributes/v8js.md +++ b/docs/registry/attributes/v8js.md @@ -7,7 +7,8 @@ Describes V8 JS Engine Runtime related attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `v8js.gc.type` | string | The type of garbage collection. | `major`; `minor`; `incremental` | ![Development](https://img.shields.io/badge/-development-blue) | | `v8js.heap.space.name` | string | The name of the space type of heap memory. [1] | `new_space`; `old_space`; `code_space` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index fe5721f7e3..21c3b06f3c 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). -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `vcs.change.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `vcs.change.state` | string | The state of the change (pull request/merge request/changelist). | `open`; `closed`; `merged` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -147,13 +148,17 @@ the `.git` extension. Describes deprecated vcs attributes. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +
+Past Attributes: + +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `vcs.repository.change.id` | string | Deprecated, use `vcs.change.id` instead. | `123` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.change.id`. | -| `vcs.repository.change.title` | string | Deprecated, use `vcs.change.title` instead. | `Fixes broken thing`; `feat: add my new feature`; `[chore] update dependency` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.change.title`. | -| `vcs.repository.ref.name` | string | Deprecated, use `vcs.ref.head.name` instead. | `my-feature-branch`; `tag-1-test` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.name`. | -| `vcs.repository.ref.revision` | string | Deprecated, use `vcs.ref.head.revision` instead. | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.revision`. | -| `vcs.repository.ref.type` | string | Deprecated, use `vcs.ref.head.type` instead. | `branch`; `tag` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `vcs.ref.head.type`. | +| `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. | --- @@ -163,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 2cf245f193..74b83fb82e 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `webengine.description` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `webengine.name` | string | The name of the web engine. | `WildFly` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/zos.md b/docs/registry/attributes/zos.md index 2b94b43030..bfdc3287e9 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. -| Attribute | Type | Description | Examples | Stability | +**Current Attributes:** +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `zos.smf.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `zos.sysplex.name` | string | The name of the SYSPLEX to which the z/OS system belongs too. | `SYSPLEX1` | ![Development](https://img.shields.io/badge/-development-blue) | 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 a1f4f61966..7712ed02e3 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,14 +29,15 @@ {% else -%} {{ group.brief }} {{"\n"}} -{%- endif -%} -| Attribute | Type | Description | Examples | Stability | +{%- endif -%} **Current Attributes:** +{% set filtered_attributes = group.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -{%- 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) }}` | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | 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 5b862dbd31..4d42e99906 100644 --- a/templates/registry/markdown/attribute_table.j2 +++ b/templates/registry/markdown/attribute_table.j2 @@ -6,8 +6,19 @@ {% 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) %}{% 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) %}| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | +{% macro generate(attributes, tag_filter, attribute_registry_base_url, lineage_attributes) %}{% 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) %}| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| -{% for attribute in filtered_attributes | attribute_sort %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute)}, notes) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | 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) }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {{ requirement.render({"level": attribute.requirement_level, "name": attrs.name(attribute), "deprecated": attribute.deprecated}, notes) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | 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 f1e27821d7f1af550a3a5bc47f58647919ea4e15 Mon Sep 17 00:00:00 2001 From: James Thompson Date: Mon, 29 Sep 2025 13:15:53 +1000 Subject: [PATCH 2/2] Lint document --- docs/registry/attributes/android.md | 2 + docs/registry/attributes/app.md | 1 + docs/registry/attributes/artifact.md | 1 + docs/registry/attributes/aspnetcore.md | 1 + docs/registry/attributes/aws.md | 101 +++--- docs/registry/attributes/azure.md | 33 +- docs/registry/attributes/browser.md | 1 + docs/registry/attributes/cassandra.md | 1 + docs/registry/attributes/cicd.md | 1 + docs/registry/attributes/client.md | 1 + docs/registry/attributes/cloud.md | 1 + docs/registry/attributes/cloudevents.md | 1 + docs/registry/attributes/cloudfoundry.md | 1 + docs/registry/attributes/code.md | 2 +- docs/registry/attributes/container.md | 54 +-- docs/registry/attributes/cpu.md | 1 + docs/registry/attributes/cpython.md | 1 + docs/registry/attributes/db.md | 325 +++++++++--------- docs/registry/attributes/deployment.md | 2 +- docs/registry/attributes/destination.md | 1 + docs/registry/attributes/device.md | 1 + docs/registry/attributes/disk.md | 1 + docs/registry/attributes/dns.md | 1 + docs/registry/attributes/dotnet.md | 1 + docs/registry/attributes/elasticsearch.md | 1 + docs/registry/attributes/enduser.md | 2 +- docs/registry/attributes/error.md | 1 + docs/registry/attributes/event.md | 1 + docs/registry/attributes/exception.md | 2 +- docs/registry/attributes/faas.md | 1 + docs/registry/attributes/feature-flag.md | 68 ++-- docs/registry/attributes/file.md | 1 + docs/registry/attributes/gcp.md | 67 ++-- docs/registry/attributes/gen-ai.md | 167 +++++---- docs/registry/attributes/geo.md | 1 + docs/registry/attributes/go.md | 1 + docs/registry/attributes/graphql.md | 1 + docs/registry/attributes/hardware.md | 1 + docs/registry/attributes/heroku.md | 1 + docs/registry/attributes/host.md | 1 + docs/registry/attributes/http.md | 2 +- docs/registry/attributes/ios.md | 34 +- docs/registry/attributes/jvm.md | 1 + docs/registry/attributes/k8s.md | 2 +- docs/registry/attributes/linux.md | 1 + docs/registry/attributes/log.md | 3 + docs/registry/attributes/mainframe.md | 1 + docs/registry/attributes/messaging.md | 54 +-- docs/registry/attributes/network.md | 106 +++--- docs/registry/attributes/nfs.md | 1 + docs/registry/attributes/nodejs.md | 1 + docs/registry/attributes/oci.md | 1 + docs/registry/attributes/onc-rpc.md | 1 + docs/registry/attributes/openai.md | 1 + docs/registry/attributes/opentracing.md | 1 + docs/registry/attributes/os.md | 1 + docs/registry/attributes/otel.md | 58 ++-- docs/registry/attributes/peer.md | 1 + docs/registry/attributes/pprof.md | 1 + docs/registry/attributes/process.md | 3 +- docs/registry/attributes/profile.md | 1 + docs/registry/attributes/rpc.md | 2 +- docs/registry/attributes/security-rule.md | 1 + docs/registry/attributes/server.md | 1 + docs/registry/attributes/service.md | 1 + docs/registry/attributes/session.md | 1 + docs/registry/attributes/signalr.md | 1 + docs/registry/attributes/source.md | 1 + docs/registry/attributes/system.md | 154 +++++---- docs/registry/attributes/telemetry.md | 1 + docs/registry/attributes/test.md | 1 + docs/registry/attributes/thread.md | 1 + docs/registry/attributes/tls.md | 30 +- docs/registry/attributes/url.md | 1 + docs/registry/attributes/user-agent.md | 2 + docs/registry/attributes/user.md | 1 + docs/registry/attributes/v8js.md | 1 + docs/registry/attributes/vcs.md | 2 +- docs/registry/attributes/webengine.md | 1 + docs/registry/attributes/zos.md | 1 + .../markdown/attribute_namespace.md.j2 | 19 +- 81 files changed, 727 insertions(+), 624 deletions(-) diff --git a/docs/registry/attributes/android.md b/docs/registry/attributes/android.md index 740957c529..0e2f6afaeb 100644 --- a/docs/registry/attributes/android.md +++ b/docs/registry/attributes/android.md @@ -8,6 +8,7 @@ The Android platform on which the Android application is running. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `android.app.state` | string | This attribute represents the state of the application. [1] | `created` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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 2f9ff5d7d5..f29e096f72 100644 --- a/docs/registry/attributes/app.md +++ b/docs/registry/attributes/app.md @@ -8,6 +8,7 @@ Describes attributes related to client-side applications (e.g. web apps or mobile apps). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `app.build_id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/artifact.md b/docs/registry/attributes/artifact.md index 602f679a5b..4a09961ad9 100644 --- a/docs/registry/attributes/artifact.md +++ b/docs/registry/attributes/artifact.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `artifact.attestation.filename` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/aspnetcore.md b/docs/registry/attributes/aspnetcore.md index 55168bbd0a..8ff14146b2 100644 --- a/docs/registry/attributes/aspnetcore.md +++ b/docs/registry/attributes/aspnetcore.md @@ -8,6 +8,7 @@ ASP.NET Core attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aspnetcore.authentication.result` | string | The result of the authentication operation. | `success`; `failure` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/aws.md b/docs/registry/attributes/aws.md index e33ea743bf..6f4f436d60 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.extended_request_id` | string | The AWS extended request ID as returned in the response header `x-amz-id-2`. | `wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.request_id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +## Amazon Bedrock Attributes + +This document defines attributes for AWS Bedrock. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `aws.bedrock.guardrail.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.bedrock.knowledge_base.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | + ## Amazon DynamoDB Attributes This document defines attributes for AWS DynamoDB. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.dynamodb.attribute_definitions` | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -62,6 +75,7 @@ This document defines attributes for AWS DynamoDB. This document defines attributes for AWS Elastic Container Service (ECS). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.ecs.cluster.arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -86,45 +100,59 @@ This document defines attributes for AWS Elastic Container Service (ECS). This document defines attributes for AWS Elastic Kubernetes Service (EKS). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.eks.cluster.arn` | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | ![Development](https://img.shields.io/badge/-development-blue) | -## Amazon Logs Attributes +## Amazon Kinesis Attributes -This document defines attributes for AWS Logs. +This document defines attributes for AWS Kinesis. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.log.group.arns` | 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:*"]` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.log.group.names` | string[] | The name(s) of the AWS log group(s) an application is writing to. [2] | `["/aws/lambda/my-function", "opentelemetry-service"]` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.log.stream.arns` | 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"]` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.log.stream.names` | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | ![Development](https://img.shields.io/badge/-development-blue) | - -**[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` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | ## Amazon Lambda Attributes This document defines attributes for AWS Lambda. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.lambda.invoked_arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.lambda.invoked_arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.lambda.resource_mapping.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -**[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. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `aws.log.group.arns` | 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:*"]` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.log.group.names` | string[] | The name(s) of the AWS log group(s) an application is writing to. [3] | `["/aws/lambda/my-function", "opentelemetry-service"]` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.log.stream.arns` | 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"]` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.log.stream.names` | string[] | The name(s) of the AWS log stream(s) an application is writing to. | `["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]` | ![Development](https://img.shields.io/badge/-development-blue) | + +**[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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.s3.bucket` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.sqs.queue.url` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.secretsmanager.secret.arn` | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | ![Development](https://img.shields.io/badge/-development-blue) | ## Amazon SNS Attributes This document defines attributes for AWS SNS. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.sns.topic.arn` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -## Amazon Kinesis Attributes +## Amazon SQS Attributes -This document defines attributes for AWS Kinesis. +This document defines attributes for AWS SQS. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `aws.kinesis.stream_name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.sqs.queue.url` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | ## Amazon Step Functions Attributes This document defines attributes for AWS Step Functions. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `aws.step_functions.activity.arn` | string | The ARN of the AWS Step Functions Activity. | `arn:aws:states:us-east-1:123456789012:activity:get-greeting` | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.step_functions.state_machine.arn` | string | The ARN of the AWS Step Functions State Machine. | `arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1` | ![Development](https://img.shields.io/badge/-development-blue) | - -## Amazon Secrets Manager Attributes - -This document defines attributes for AWS Secrets Manager. - -**Current Attributes:** -| Key | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `aws.secretsmanager.secret.arn` | string | The ARN of the Secret stored in the Secrets Mangger | `arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters` | ![Development](https://img.shields.io/badge/-development-blue) | - -## Amazon Bedrock Attributes - -This document defines attributes for AWS Bedrock. - -**Current Attributes:** -| Key | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `aws.bedrock.guardrail.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.bedrock.knowledge_base.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/azure.md b/docs/registry/attributes/azure.md index 5003f37c22..3c533fe12f 100644 --- a/docs/registry/attributes/azure.md +++ b/docs/registry/attributes/azure.md @@ -3,30 +3,16 @@ # Azure -- [Deprecated Azure Attributes](#deprecated-azure-attributes) - [Azure Client Library Attributes](#azure-client-library-attributes) - [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes) - -## Deprecated Azure Attributes - -This section describes deprecated Azure attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | 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. | - -
+- [Deprecated Azure Attributes](#deprecated-azure-attributes) ## Azure Client Library Attributes This section defines generic attributes used by Azure Client Libraries. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `azure.client.id` | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -38,6 +24,7 @@ This section defines generic attributes used by Azure Client Libraries. This section defines attributes for Azure Cosmos DB. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `azure.cosmosdb.connection.mode` | string | Cosmos client connection mode. | `gateway`; `direct` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -69,3 +56,17 @@ This section defines attributes for Azure Cosmos DB. | `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) | + +## Deprecated Azure Attributes + +This section describes deprecated Azure attributes. + +
+Past Attributes: + +| Key | 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/browser.md b/docs/registry/attributes/browser.md index 2589f1a913..70fd6760e0 100644 --- a/docs/registry/attributes/browser.md +++ b/docs/registry/attributes/browser.md @@ -8,6 +8,7 @@ The web browser attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `browser.brands` | string[] | Array of brand name and version separated by a space [1] | `[" Not A;Brand 99", "Chromium 99", "Chrome 99"]` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cassandra.md b/docs/registry/attributes/cassandra.md index 4051269095..17d828243f 100644 --- a/docs/registry/attributes/cassandra.md +++ b/docs/registry/attributes/cassandra.md @@ -8,6 +8,7 @@ This section defines attributes for Cassandra. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cassandra.consistency.level` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cicd.md b/docs/registry/attributes/cicd.md index 03cc6fbf84..862539a33e 100644 --- a/docs/registry/attributes/cicd.md +++ b/docs/registry/attributes/cicd.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cicd.pipeline.action.name` | string | The kind of action a pipeline run is performing. | `BUILD`; `RUN`; `SYNC` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/client.md b/docs/registry/attributes/client.md index 013bc47b38..5d20e2de44 100644 --- a/docs/registry/attributes/client.md +++ b/docs/registry/attributes/client.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `client.address` | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/cloud.md b/docs/registry/attributes/cloud.md index 7994b49539..9b98f33c8d 100644 --- a/docs/registry/attributes/cloud.md +++ b/docs/registry/attributes/cloud.md @@ -8,6 +8,7 @@ A cloud environment (e.g. GCP, Azure, AWS). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cloud.account.id` | string | The cloud account ID the resource is assigned to. | `111111111111`; `opentelemetry` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cloudevents.md b/docs/registry/attributes/cloudevents.md index e1505b252c..b2cd8c3cc0 100644 --- a/docs/registry/attributes/cloudevents.md +++ b/docs/registry/attributes/cloudevents.md @@ -8,6 +8,7 @@ This document defines attributes for CloudEvents. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cloudevents.event_id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cloudfoundry.md b/docs/registry/attributes/cloudfoundry.md index 524ef2f8dc..b96660dbee 100644 --- a/docs/registry/attributes/cloudfoundry.md +++ b/docs/registry/attributes/cloudfoundry.md @@ -8,6 +8,7 @@ CloudFoundry resource attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cloudfoundry.app.id` | string | The guid of the application. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/code.md b/docs/registry/attributes/code.md index b60ba8ee2f..7810607b99 100644 --- a/docs/registry/attributes/code.md +++ b/docs/registry/attributes/code.md @@ -11,6 +11,7 @@ These attributes provide context about source code **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `code.column.number` | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | @@ -39,7 +40,6 @@ Examples: These deprecated attributes provide context about source code -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/container.md b/docs/registry/attributes/container.md index ec983b0efd..55cec1d4d7 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `container.command` | string | The command used to run the container (i.e. the command name). [1] | `otelcontribcol` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field. **[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 be8e8d4ac8..50196fab18 100644 --- a/docs/registry/attributes/cpu.md +++ b/docs/registry/attributes/cpu.md @@ -8,6 +8,7 @@ Attributes specific to a cpu instance. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cpu.logical_number` | int | The logical CPU number [0..n-1] | `1` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/cpython.md b/docs/registry/attributes/cpython.md index 247a9dbdb0..a67d876212 100644 --- a/docs/registry/attributes/cpython.md +++ b/docs/registry/attributes/cpython.md @@ -8,6 +8,7 @@ This document defines CPython related attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `cpython.gc.generation` | int | Value of the garbage collector collection generation. | `0`; `1`; `2` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/db.md b/docs/registry/attributes/db.md index e59042f4e5..44e7939e7a 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. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `db.client.connection.pool.name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `db.client.connection.state` | string | The state of a connection in the pool | `idle` | ![Development](https://img.shields.io/badge/-development-blue) | +| `db.collection.name` | string | The name of a collection (table, container) within the database. [1] | `public.users`; `customers` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.namespace` | string | The name of the database, fully qualified within the server address and port. [2] | `customers`; `test.users` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.operation.batch.size` | int | The number of queries included in a batch operation. [3] | `2`; `3`; `4` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.operation.name` | string | The name of the operation or command being executed. [4] | `findAndModify`; `HMSET`; `SELECT` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.operation.parameter.` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `db.query.parameter.` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `db.query.summary` | string | Low cardinality summary of a database query. [7] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.query.text` | string | The database query being executed. [8] | `SELECT * FROM wuser_table where username = ?`; `SET mykey ?` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.response.returned_rows` | int | Number of rows returned by the operation. | `10`; `30`; `1000` | ![Development](https://img.shields.io/badge/-development-blue) | +| `db.response.status_code` | string | Database response status code. [9] | `102`; `ORA-17002`; `08P01`; `404` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.stored_procedure.name` | string | The name of a stored procedure within the database. [10] | `GetCustomer` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `db.system.name` | string | The database management system (DBMS) product as identified by the client instrumentation. [11] | `other_sql`; `softwareag.adabas`; `actian.ingres` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + +**[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 | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `db.client.connection.pool.name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `db.client.connection.state` | string | The state of a connection in the pool | `idle` | ![Development](https://img.shields.io/badge/-development-blue) | -| `db.collection.name` | string | The name of a collection (table, container) within the database. [1] | `public.users`; `customers` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.namespace` | string | The name of the database, fully qualified within the server address and port. [2] | `customers`; `test.users` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.operation.batch.size` | int | The number of queries included in a batch operation. [3] | `2`; `3`; `4` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.operation.name` | string | The name of the operation or command being executed. [4] | `findAndModify`; `HMSET`; `SELECT` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.operation.parameter.` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `db.query.parameter.` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `db.query.summary` | string | Low cardinality summary of a database query. [7] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.query.text` | string | The database query being executed. [8] | `SELECT * FROM wuser_table where username = ?`; `SET mykey ?` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.response.returned_rows` | int | Number of rows returned by the operation. | `10`; `30`; `1000` | ![Development](https://img.shields.io/badge/-development-blue) | -| `db.response.status_code` | string | Database response status code. [9] | `102`; `ORA-17002`; `08P01`; `404` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.stored_procedure.name` | string | The name of a stored procedure within the database. [10] | `GetCustomer` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `db.system.name` | string | The database management system (DBMS) product as identified by the client instrumentation. [11] | `other_sql`; `softwareag.adabas`; `actian.ingres` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - -**[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 cde5954cb4..bb0bd531fe 100644 --- a/docs/registry/attributes/deployment.md +++ b/docs/registry/attributes/deployment.md @@ -11,6 +11,7 @@ This document defines attributes for software deployments. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `deployment.environment.name` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -39,7 +40,6 @@ considered to be identifying the same service: Describes deprecated deployment attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/destination.md b/docs/registry/attributes/destination.md index 7a3bc00bba..122d15e87a 100644 --- a/docs/registry/attributes/destination.md +++ b/docs/registry/attributes/destination.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `destination.address` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/device.md b/docs/registry/attributes/device.md index 62bd044857..5ff20f08d1 100644 --- a/docs/registry/attributes/device.md +++ b/docs/registry/attributes/device.md @@ -8,6 +8,7 @@ Describes device attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `device.id` | string | A unique identifier representing the device [1] | `123456789012345`; `01:23:45:67:89:AB` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/disk.md b/docs/registry/attributes/disk.md index 056450386b..6b2c555163 100644 --- a/docs/registry/attributes/disk.md +++ b/docs/registry/attributes/disk.md @@ -8,6 +8,7 @@ These attributes may be used for any disk related operation. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `disk.io.direction` | string | The disk IO operation direction. | `read` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/dns.md b/docs/registry/attributes/dns.md index cb146a76f5..5e9f7a827a 100644 --- a/docs/registry/attributes/dns.md +++ b/docs/registry/attributes/dns.md @@ -8,6 +8,7 @@ This document defines the shared attributes used to report a DNS query. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `dns.answers` | string[] | The list of IPv4 or IPv6 addresses resolved during DNS lookup. | `["10.0.0.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"]` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/dotnet.md b/docs/registry/attributes/dotnet.md index 7e75db6def..f51763fa84 100644 --- a/docs/registry/attributes/dotnet.md +++ b/docs/registry/attributes/dotnet.md @@ -8,6 +8,7 @@ This document defines .NET related attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `dotnet.gc.heap.generation` | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/elasticsearch.md b/docs/registry/attributes/elasticsearch.md index 18f78a42ef..b2dd3ae061 100644 --- a/docs/registry/attributes/elasticsearch.md +++ b/docs/registry/attributes/elasticsearch.md @@ -8,6 +8,7 @@ This section defines attributes for Elasticsearch. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `elasticsearch.node.name` | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/enduser.md b/docs/registry/attributes/enduser.md index 145cd68103..0b51c56ad4 100644 --- a/docs/registry/attributes/enduser.md +++ b/docs/registry/attributes/enduser.md @@ -11,6 +11,7 @@ Describes the end user. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `enduser.id` | string | Unique identifier of an end user in the system. It maybe a username, email address, or other identifier. [1] | `username` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -30,7 +31,6 @@ Describes the end user. Describes deprecated enduser attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/error.md b/docs/registry/attributes/error.md index 6ff6b215eb..f465c3850f 100644 --- a/docs/registry/attributes/error.md +++ b/docs/registry/attributes/error.md @@ -8,6 +8,7 @@ This document defines the shared attributes used to report an error. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `error.message` | string | A message providing more detail about an error in human-readable form. [1] | `Unexpected input type: string`; `The user has exceeded their storage quota` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 7fec2f0510..b4c93e9023 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -8,6 +8,7 @@ Attributes for Events represented using Log Records. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `event.name` | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/exception.md b/docs/registry/attributes/exception.md index 35619f8136..e6d5f4eaa4 100644 --- a/docs/registry/attributes/exception.md +++ b/docs/registry/attributes/exception.md @@ -11,6 +11,7 @@ This document defines the shared attributes used to report a single exception associated with a span or log. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `exception.message` | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | @@ -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 4e2edec682..d9e9c6b10f 100644 --- a/docs/registry/attributes/faas.md +++ b/docs/registry/attributes/faas.md @@ -8,6 +8,7 @@ FaaS attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `faas.coldstart` | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/feature-flag.md b/docs/registry/attributes/feature-flag.md index c94bcd2b14..2c496c4a9f 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `feature_flag.context.id` | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | @@ -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 8d4d69dfc4..42ca9e934e 100644 --- a/docs/registry/attributes/file.md +++ b/docs/registry/attributes/file.md @@ -8,6 +8,7 @@ Describes file attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `file.accessed` | string | Time when the file was last accessed, in ISO 8601 format. [1] | `2021-01-01T12:00:00Z` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/gcp.md b/docs/registry/attributes/gcp.md index 51d3242e48..94ec33cc81 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 | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `gcp.client.service` | string | Identifies the Google Cloud service for which the official client library is intended. [1] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | ![Development](https://img.shields.io/badge/-development-blue) | - -**[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 | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `gcp.cloud_run.job.execution` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.cloud_run.job.task_index` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | - ## 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gcp.apphub.application.container` | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.application.id` | string | The name of the application as configured in AppHub. | `my-application` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.application.location` | string | The GCP zone or region where the application is defined. | `us-central1` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.service.criticality_type` | string | Criticality of a service indicates its importance to the business. [2] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.service.environment_type` | string | Environment of a service is the stage of a software lifecycle. [3] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.service.criticality_type` | string | Criticality of a service indicates its importance to the business. [1] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.service.environment_type` | string | Environment of a service is the stage of a software lifecycle. [2] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.service.id` | string | The name of the service as configured in AppHub. | `my-service` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.workload.criticality_type` | string | Criticality of a workload indicates its importance to the business. [4] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | -| `gcp.apphub.workload.environment_type` | string | Environment of a workload is the stage of a software lifecycle. [5] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.workload.criticality_type` | string | Criticality of a workload indicates its importance to the business. [3] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.apphub.workload.environment_type` | string | Environment of a workload is the stage of a software lifecycle. [4] | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp.apphub.workload.id` | string | The name of the workload as configured in AppHub. | `my-workload` | ![Development](https://img.shields.io/badge/-development-blue) | -**[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) --- @@ -104,6 +84,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). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gcp.apphub_destination.application.container` | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `gcp.client.service` | string | Identifies the Google Cloud service for which the official client library is intended. [5] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` | ![Development](https://img.shields.io/badge/-development-blue) | + +**[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. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `gcp.cloud_run.job.execution` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | +| `gcp.cloud_run.job.task_index` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | + ## GCP - Google Compute Engine (GCE) Attributes This document defines attributes for Google Compute Engine (GCE). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gcp.gce.instance.hostname` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/gen-ai.md b/docs/registry/attributes/gen-ai.md index 246edae417..380b5991ef 100644 --- a/docs/registry/attributes/gen-ai.md +++ b/docs/registry/attributes/gen-ai.md @@ -3,98 +3,16 @@ # Gen AI +- [GenAI Attributes](#genai-attributes) - [Deprecated GenAI Attributes](#deprecated-genai-attributes) - [Deprecated OpenAI GenAI Attributes](#deprecated-openai-genai-attributes) -- [GenAI Attributes](#genai-attributes) - -## Deprecated GenAI Attributes - -Describes deprecated `gen_ai` attributes. - -**Current Attributes:** -
-Past Attributes: - -| Key | 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. | -| `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. | - ---- - -`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `anthropic` | Anthropic | ![Development](https://img.shields.io/badge/-development-blue) | -| `aws.bedrock` | AWS Bedrock | ![Development](https://img.shields.io/badge/-development-blue) | -| `azure.ai.inference` | Azure AI Inference | ![Development](https://img.shields.io/badge/-development-blue) | -| `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 [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) | -| `openai` | OpenAI | ![Development](https://img.shields.io/badge/-development-blue) | -| `perplexity` | Perplexity | ![Development](https://img.shields.io/badge/-development-blue) | -| `xai` | xAI | ![Development](https://img.shields.io/badge/-development-blue) | - -**[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.'. - -**[3]:** 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. - -**Current Attributes:** -
-Past Attributes: - -| Key | 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. | -| `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. | - ---- - -`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | -| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | - ---- - -`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -|---|---|---| -| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | -| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | - -
## GenAI Attributes This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `gen_ai.agent.description` | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -316,3 +234,84 @@ 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. + +
+Past Attributes: + +| Key | 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. | +| `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. | + +--- + +`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `anthropic` | Anthropic | ![Development](https://img.shields.io/badge/-development-blue) | +| `aws.bedrock` | AWS Bedrock | ![Development](https://img.shields.io/badge/-development-blue) | +| `azure.ai.inference` | Azure AI Inference | ![Development](https://img.shields.io/badge/-development-blue) | +| `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 [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) | +| `openai` | OpenAI | ![Development](https://img.shields.io/badge/-development-blue) | +| `perplexity` | Perplexity | ![Development](https://img.shields.io/badge/-development-blue) | +| `xai` | xAI | ![Development](https://img.shields.io/badge/-development-blue) | + +**[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.'. + +**[3]:** 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. + +
+Past Attributes: + +| Key | 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. | +| `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. | + +--- + +`gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `json_object` | JSON object response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `json_schema` | JSON schema response format | ![Development](https://img.shields.io/badge/-development-blue) | +| `text` | Text response format | ![Development](https://img.shields.io/badge/-development-blue) | + +--- + +`gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +|---|---|---| +| `auto` | The system will utilize scale tier credits until they are exhausted. | ![Development](https://img.shields.io/badge/-development-blue) | +| `default` | The system will utilize the default scale tier. | ![Development](https://img.shields.io/badge/-development-blue) | + +
diff --git a/docs/registry/attributes/geo.md b/docs/registry/attributes/geo.md index 88e4a88839..283f5473b0 100644 --- a/docs/registry/attributes/geo.md +++ b/docs/registry/attributes/geo.md @@ -9,6 +9,7 @@ Geo fields can carry data about a specific location related to an event. This ge 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `geo.continent.code` | string | Two-letter code representing continent’s name. | `AF`; `AN`; `AS` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/go.md b/docs/registry/attributes/go.md index fe104beb36..c95a07dce6 100644 --- a/docs/registry/attributes/go.md +++ b/docs/registry/attributes/go.md @@ -8,6 +8,7 @@ This document defines Go related attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `go.memory.type` | string | The type of memory. | `other`; `stack` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/graphql.md b/docs/registry/attributes/graphql.md index 227f10beee..1ac1eb74a3 100644 --- a/docs/registry/attributes/graphql.md +++ b/docs/registry/attributes/graphql.md @@ -8,6 +8,7 @@ This document defines attributes for GraphQL. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `graphql.document` | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/hardware.md b/docs/registry/attributes/hardware.md index 5b72d6c5b1..f331a57806 100644 --- a/docs/registry/attributes/hardware.md +++ b/docs/registry/attributes/hardware.md @@ -8,6 +8,7 @@ Attributes for hardware. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `hw.battery.capacity` | string | Design capacity in Watts-hours or Amper-hours | `9.3Ah`; `50Wh` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/heroku.md b/docs/registry/attributes/heroku.md index 3107b6ac71..42be25f859 100644 --- a/docs/registry/attributes/heroku.md +++ b/docs/registry/attributes/heroku.md @@ -8,6 +8,7 @@ This document defines attributes for the Heroku platform on which application/s are running. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `heroku.app.id` | string | Unique identifier for the application | `2daa2797-e42b-4624-9322-ec3f968df4da` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/host.md b/docs/registry/attributes/host.md index 10da386e77..45993fb04d 100644 --- a/docs/registry/attributes/host.md +++ b/docs/registry/attributes/host.md @@ -8,6 +8,7 @@ A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `host.arch` | string | The CPU architecture the host system is running on. | `amd64`; `arm32`; `arm64` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/http.md b/docs/registry/attributes/http.md index c557a65076..1af873c22f 100644 --- a/docs/registry/attributes/http.md +++ b/docs/registry/attributes/http.md @@ -11,6 +11,7 @@ This document defines semantic convention attributes in the HTTP namespace. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `http.connection.state` | string | State of the HTTP connection in the HTTP connection pool. | `active`; `idle` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -119,7 +120,6 @@ support custom route formatting. Instrumentations SHOULD document the format and Describes deprecated HTTP attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/ios.md b/docs/registry/attributes/ios.md index c9c2e91a7d..f2fe2a5176 100644 --- a/docs/registry/attributes/ios.md +++ b/docs/registry/attributes/ios.md @@ -3,26 +3,24 @@ # iOS -- [Deprecated iOS Attributes](#deprecated-ios-attributes) - [iOS Attributes](#ios-attributes) +- [Deprecated iOS Attributes](#deprecated-ios-attributes) -## Deprecated iOS Attributes +## iOS Attributes -The iOS platform on which the iOS application is running. +This group describes iOS-specific attributes. **Current Attributes:** -
-Past Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [1] | `active`; `inactive`; `background` | Use `ios.app.state` instead. | +| `ios.app.state` | string | This attribute represents the state of the application. [1] | `active`; `inactive`; `background` | ![Development](https://img.shields.io/badge/-development-blue) | -**[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. +**[1] `ios.app.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. --- -`ios.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. +`ios.app.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 | |---|---|---| @@ -32,22 +30,22 @@ The iOS platform on which the iOS application is running. | `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 -## iOS Attributes +The iOS platform on which the iOS application is running. -This group describes iOS-specific attributes. +
+Past Attributes: -**Current Attributes:** -| Key | Type | Summary | Example Values | Stability | +| Key | Type | Summary | Example Values | Deprecation Explanation | |---|---|---|---|---| -| `ios.app.state` | string | This attribute represents the state of the application. [1] | `active`; `inactive`; `background` | ![Development](https://img.shields.io/badge/-development-blue) | +| `ios.state` | string | Deprecated. Use the `ios.app.state` attribute. [1] | `active`; `inactive`; `background` | Use `ios.app.state` instead. | -**[1] `ios.app.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. --- -`ios.app.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. +`ios.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 | |---|---|---| @@ -56,3 +54,5 @@ This group describes iOS-specific attributes. | `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 bce6f65c6c..f917742488 100644 --- a/docs/registry/attributes/jvm.md +++ b/docs/registry/attributes/jvm.md @@ -8,6 +8,7 @@ This document defines Java Virtual machine related attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `jvm.buffer.pool.name` | string | Name of the buffer pool. [1] | `mapped`; `direct` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/k8s.md b/docs/registry/attributes/k8s.md index 0d733d2504..7602295d26 100644 --- a/docs/registry/attributes/k8s.md +++ b/docs/registry/attributes/k8s.md @@ -11,6 +11,7 @@ Kubernetes resource attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `k8s.cluster.name` | string | The name of the cluster. | `opentelemetry-cluster` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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 b0a426a545..f2e90575ad 100644 --- a/docs/registry/attributes/linux.md +++ b/docs/registry/attributes/linux.md @@ -8,6 +8,7 @@ Describes Linux Memory attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `linux.memory.slab.state` | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/log.md b/docs/registry/attributes/log.md index aac4f87fb0..2c745f3535 100644 --- a/docs/registry/attributes/log.md +++ b/docs/registry/attributes/log.md @@ -12,6 +12,7 @@ This document defines log attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `log.iostream` | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -30,6 +31,7 @@ This document defines log attributes Attributes for a file to which log was emitted. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `log.file.name` | string | The basename of the file. | `audit.log` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -42,6 +44,7 @@ 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `log.record.original` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/mainframe.md b/docs/registry/attributes/mainframe.md index de28c30ae5..881963de5e 100644 --- a/docs/registry/attributes/mainframe.md +++ b/docs/registry/attributes/mainframe.md @@ -8,6 +8,7 @@ This document defines attributes of a Mainframe Logical Partition (LPAR). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `mainframe.lpar.name` | string | Name of the logical partition that hosts a systems with a mainframe operating system. | `LPAR01` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/messaging.md b/docs/registry/attributes/messaging.md index 7e2a4b829e..b67253c332 100644 --- a/docs/registry/attributes/messaging.md +++ b/docs/registry/attributes/messaging.md @@ -4,12 +4,12 @@ # Messaging - [General Messaging Attributes](#general-messaging-attributes) +- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) +- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) - [Kafka Attributes](#kafka-attributes) - [RabbitMQ Attributes](#rabbitmq-attributes) - [RocketMQ Attributes](#rocketmq-attributes) -- [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](#deprecated-messaging-attributes) ## General Messaging Attributes @@ -17,6 +17,7 @@ Attributes describing telemetry around messaging systems and messaging activities. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.batch.message_count` | int | The number of messages sent, received, or processed in the scope of the batching operation. [1] | `0`; `1`; `2` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -88,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. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `messaging.eventhubs.message.enqueued_time` | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | ![Development](https://img.shields.io/badge/-development-blue) | + +## GCP Pub/Sub Attributes + +This group describes attributes specific to GCP Pub/Sub. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `messaging.gcp_pubsub.message.ack_deadline` | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | ![Development](https://img.shields.io/badge/-development-blue) | +| `messaging.gcp_pubsub.message.ack_id` | string | The ack id for a given message. | `ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | +| `messaging.gcp_pubsub.message.delivery_attempt` | int | The delivery attempt for a given message. | `2` | ![Development](https://img.shields.io/badge/-development-blue) | +| `messaging.gcp_pubsub.message.ordering_key` | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | + ## Kafka Attributes This group describes attributes specific to Apache Kafka. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.kafka.message.key` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -106,6 +131,7 @@ This group describes attributes specific to Apache Kafka. This group describes attributes specific to RabbitMQ. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.rabbitmq.destination.routing_key` | string | RabbitMQ message routing key. | `myKey` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -116,6 +142,7 @@ This group describes attributes specific to RabbitMQ. This group describes attributes specific to RocketMQ. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.rocketmq.consumption_model` | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -147,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 | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `messaging.gcp_pubsub.message.ack_deadline` | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | ![Development](https://img.shields.io/badge/-development-blue) | -| `messaging.gcp_pubsub.message.ack_id` | string | The ack id for a given message. | `ack_id` | ![Development](https://img.shields.io/badge/-development-blue) | -| `messaging.gcp_pubsub.message.delivery_attempt` | int | The delivery attempt for a given message. | `2` | ![Development](https://img.shields.io/badge/-development-blue) | -| `messaging.gcp_pubsub.message.ordering_key` | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | ![Development](https://img.shields.io/badge/-development-blue) | - ## Azure Service Bus Attributes This group describes attributes specific to Azure Service Bus. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `messaging.servicebus.disposition_status` | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -181,20 +197,10 @@ 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 - -This group describes attributes specific to Azure Event Hubs. - -**Current Attributes:** -| Key | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `messaging.eventhubs.message.enqueued_time` | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | ![Development](https://img.shields.io/badge/-development-blue) | - ## Deprecated Messaging Attributes Describes deprecated messaging attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/network.md b/docs/registry/attributes/network.md index 4b771295a9..396e7f7c0f 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `network.carrier.icc` | string | The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. | `DE` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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 c1a52fdf5d..e833f1e1f8 100644 --- a/docs/registry/attributes/nfs.md +++ b/docs/registry/attributes/nfs.md @@ -8,6 +8,7 @@ NFS Server replies check a Reply Cache (repcache), which can have one of 3 result states **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `nfs.operation.name` | string | NFSv4+ operation name. | `OPEN`; `READ`; `GETATTR` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/nodejs.md b/docs/registry/attributes/nodejs.md index 81acbfacb7..7ba925137b 100644 --- a/docs/registry/attributes/nodejs.md +++ b/docs/registry/attributes/nodejs.md @@ -8,6 +8,7 @@ Describes Node.js related attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `nodejs.eventloop.state` | string | The state of event loop time. | `active`; `idle` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/oci.md b/docs/registry/attributes/oci.md index 96ff3f50db..c9bcbc4c21 100644 --- a/docs/registry/attributes/oci.md +++ b/docs/registry/attributes/oci.md @@ -8,6 +8,7 @@ An OCI image manifest. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `oci.manifest.digest` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/onc-rpc.md b/docs/registry/attributes/onc-rpc.md index 6c8239b76c..8c9f0b5690 100644 --- a/docs/registry/attributes/onc-rpc.md +++ b/docs/registry/attributes/onc-rpc.md @@ -8,6 +8,7 @@ This document defines attributes for [ONC RPC (Sun RPC)](https://datatracker.ietf.org/doc/html/rfc5531) **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `onc_rpc.procedure.name` | string | ONC/Sun RPC procedure name. | `OPEN`; `READ`; `GETATTR` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/openai.md b/docs/registry/attributes/openai.md index 066abbd6ca..34adececb5 100644 --- a/docs/registry/attributes/openai.md +++ b/docs/registry/attributes/openai.md @@ -8,6 +8,7 @@ This group defines attributes for OpenAI. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `openai.request.service_tier` | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/opentracing.md b/docs/registry/attributes/opentracing.md index 23e7b8f8c7..22330e6300 100644 --- a/docs/registry/attributes/opentracing.md +++ b/docs/registry/attributes/opentracing.md @@ -8,6 +8,7 @@ Attributes used by the OpenTracing Shim layer. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `opentracing.ref_type` | string | Parent-child Reference type [1] | `child_of`; `follows_from` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/os.md b/docs/registry/attributes/os.md index daa2254a9b..f27aafddaa 100644 --- a/docs/registry/attributes/os.md +++ b/docs/registry/attributes/os.md @@ -8,6 +8,7 @@ The operating system (OS) on which the process represented by this resource is running. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `os.build_id` | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/otel.md b/docs/registry/attributes/otel.md index 7bfa9d1f76..59ac6b7d55 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `otel.span.parent.origin` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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 | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | -| `otel.scope.schema_url` | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | ![Development](https://img.shields.io/badge/-development-blue) | -| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | - ## OTel Component Attributes Attributes used for OpenTelemetry component self-monitoring **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `otel.component.name` | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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. + +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `otel.scope.schema_url` | string | The schema URL of the instrumentation scope. | `https://opentelemetry.io/schemas/1.31.0` | ![Development](https://img.shields.io/badge/-development-blue) | +| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + +## 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 f565cf5df3..dde79e7b53 100644 --- a/docs/registry/attributes/peer.md +++ b/docs/registry/attributes/peer.md @@ -8,6 +8,7 @@ Operations that access some remote service. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `peer.service` | string | The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/pprof.md b/docs/registry/attributes/pprof.md index 35078d0a7e..2e889885bc 100644 --- a/docs/registry/attributes/pprof.md +++ b/docs/registry/attributes/pprof.md @@ -8,6 +8,7 @@ Attributes specific to pprof that help convert from pprof to Profiling signal. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `pprof.location.is_folded` | 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. | | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/process.md b/docs/registry/attributes/process.md index 0f95819435..ca09afcd2a 100644 --- a/docs/registry/attributes/process.md +++ b/docs/registry/attributes/process.md @@ -12,6 +12,7 @@ An operating system process. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `process.args_count` | int | Length of the process.command_args array [1] | `4` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -86,6 +87,7 @@ with value `"/usr/local/bin:/usr/bin"`. Describes Linux Process attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `process.linux.cgroup` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -96,7 +98,6 @@ Describes Linux Process attributes Deprecated process attributes. -**Current Attributes:**
Past Attributes: diff --git a/docs/registry/attributes/profile.md b/docs/registry/attributes/profile.md index 6ec4ccd328..e84393f16c 100644 --- a/docs/registry/attributes/profile.md +++ b/docs/registry/attributes/profile.md @@ -8,6 +8,7 @@ Describes the origin of a single frame in a Profile. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `profile.frame.type` | string | Describes the interpreter or compiler of a single frame. | `cpython` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/rpc.md b/docs/registry/attributes/rpc.md index f3b1bd1af3..a58cf09714 100644 --- a/docs/registry/attributes/rpc.md +++ b/docs/registry/attributes/rpc.md @@ -11,6 +11,7 @@ This document defines attributes for remote procedure calls. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `rpc.connect_rpc.error_code` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -135,7 +136,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 592fcaf837..ed0c2232f1 100644 --- a/docs/registry/attributes/security-rule.md +++ b/docs/registry/attributes/security-rule.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `security_rule.category` | string | A categorization value keyword used by the entity using the rule for detection of this event | `Attempted Information Leak` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/server.md b/docs/registry/attributes/server.md index 42fb2081fc..44af5a3867 100644 --- a/docs/registry/attributes/server.md +++ b/docs/registry/attributes/server.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `server.address` | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/service.md b/docs/registry/attributes/service.md index 0b3da96ea5..7bce5714c3 100644 --- a/docs/registry/attributes/service.md +++ b/docs/registry/attributes/service.md @@ -8,6 +8,7 @@ A service instance. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `service.instance.id` | string | The string ID of the service instance. [1] | `627cc493-f310-47de-96bd-71410b7dec09` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/session.md b/docs/registry/attributes/session.md index 27557fc6af..1db95761ba 100644 --- a/docs/registry/attributes/session.md +++ b/docs/registry/attributes/session.md @@ -10,6 +10,7 @@ Consequently, a Session is represented as a collection of Logs, Events, and Span 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `session.id` | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/signalr.md b/docs/registry/attributes/signalr.md index 964fe61789..6311bd33c1 100644 --- a/docs/registry/attributes/signalr.md +++ b/docs/registry/attributes/signalr.md @@ -8,6 +8,7 @@ SignalR attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `signalr.connection.status` | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | diff --git a/docs/registry/attributes/source.md b/docs/registry/attributes/source.md index 6eb166a07e..b0ee129442 100644 --- a/docs/registry/attributes/source.md +++ b/docs/registry/attributes/source.md @@ -8,6 +8,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. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `source.address` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/system.md b/docs/registry/attributes/system.md index 75e9b84d91..c690cb4279 100644 --- a/docs/registry/attributes/system.md +++ b/docs/registry/attributes/system.md @@ -3,88 +3,65 @@ # System -- [Deprecated System Attributes](#deprecated-system-attributes) - [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) - [System Process Attributes](#system-process-attributes) +- [Deprecated System Attributes](#deprecated-system-attributes) -## Deprecated System Attributes +## General System Attributes -Deprecated system attributes. +Describes System attributes **Current Attributes:** -
-Past Attributes: -| Key | Type | Summary | Example Values | Deprecation Explanation | +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `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.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | Use `system.process.status` instead. | +| `system.device` | string | The device identifier | `(identifier)` | ![Development](https://img.shields.io/badge/-development-blue) | ---- +## Filesystem Attributes -`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. +Describes Filesystem attributes -| 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) | +**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | +|---|---|---|---|---| +| `system.filesystem.mode` | string | The filesystem mode | `rw, ro` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.mountpoint` | string | The filesystem mount path | `/mnt/data` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.state` | string | The filesystem state | `used` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.filesystem.type` | string | The filesystem type | `ext4` | ![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. +`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 | |---|---|---| -| `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) | +| `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.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. +`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 | |---|---|---| -| `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) | - -
- -## General System Attributes - -Describes System attributes - -**Current Attributes:** -| Key | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `system.device` | string | The device identifier | `(identifier)` | ![Development](https://img.shields.io/badge/-development-blue) | +| `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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `system.memory.state` | string | The memory state | `free`; `cached` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -107,6 +84,7 @@ Describes System Memory attributes Describes System Memory Paging attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `system.paging.direction` | string | The paging access direction | `in` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -140,53 +118,77 @@ Describes System Memory Paging attributes | `major` | major | ![Development](https://img.shields.io/badge/-development-blue) | | `minor` | minor | ![Development](https://img.shields.io/badge/-development-blue) | -## Filesystem Attributes +## System Process Attributes -Describes Filesystem attributes +Describes System Process attributes **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| -| `system.filesystem.mode` | string | The filesystem mode | `rw, ro` | ![Development](https://img.shields.io/badge/-development-blue) | -| `system.filesystem.mountpoint` | string | The filesystem mount path | `/mnt/data` | ![Development](https://img.shields.io/badge/-development-blue) | -| `system.filesystem.state` | string | The filesystem state | `used` | ![Development](https://img.shields.io/badge/-development-blue) | -| `system.filesystem.type` | string | The filesystem type | `ext4` | ![Development](https://img.shields.io/badge/-development-blue) | +| `system.process.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | ![Development](https://img.shields.io/badge/-development-blue) | --- -`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. +`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 | |---|---|---| -| `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) | +| `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) | + +## Deprecated System Attributes + +Deprecated system attributes. + +
+Past Attributes: + +| Key | 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.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | Use `system.process.status` instead. | --- -`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. +`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 | |---|---|---| -| `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) | +| `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 Process Attributes +--- -Describes System Process attributes +`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. -**Current Attributes:** -| Key | Type | Summary | Example Values | Stability | -|---|---|---|---|---| -| `system.process.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | ![Development](https://img.shields.io/badge/-development-blue) | +| 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.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. +`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 | |---|---|---| @@ -194,3 +196,5 @@ Describes System Process 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 95ab37e96f..8b52a451ec 100644 --- a/docs/registry/attributes/telemetry.md +++ b/docs/registry/attributes/telemetry.md @@ -8,6 +8,7 @@ This document defines attributes for telemetry SDK. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `telemetry.distro.name` | string | The name of the auto instrumentation agent or distribution, if used. [1] | `parts-unlimited-java` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/test.md b/docs/registry/attributes/test.md index 7cf001ca71..f11ed96f9a 100644 --- a/docs/registry/attributes/test.md +++ b/docs/registry/attributes/test.md @@ -8,6 +8,7 @@ This group describes attributes specific to [software tests](https://wikipedia.org/wiki/Software_testing). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `test.case.name` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/thread.md b/docs/registry/attributes/thread.md index 86551fd4a0..e97fea5405 100644 --- a/docs/registry/attributes/thread.md +++ b/docs/registry/attributes/thread.md @@ -8,6 +8,7 @@ These attributes may be used for any operation to store information about a thread that started a span. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `thread.id` | int | Current "managed" thread ID (as opposed to OS thread ID). | `42` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/tls.md b/docs/registry/attributes/tls.md index b9a33d34bf..dbe684ee19 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:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `tls.cipher` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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 cdb11c1025..f8089a62ca 100644 --- a/docs/registry/attributes/url.md +++ b/docs/registry/attributes/url.md @@ -8,6 +8,7 @@ Attributes describing URL. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `url.domain` | 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]` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/user-agent.md b/docs/registry/attributes/user-agent.md index 965287fd6f..a8a7556fbe 100644 --- a/docs/registry/attributes/user-agent.md +++ b/docs/registry/attributes/user-agent.md @@ -11,6 +11,7 @@ Describes user-agent attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `user_agent.name` | string | Name of the user-agent extracted from original. Usually refers to the browser's name. [1] | `Safari`; `YourApp` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -26,6 +27,7 @@ Describes user-agent attributes. Describes the OS user-agent attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `user_agent.os.name` | string | Human readable operating system name. [3] | `iOS`; `Android`; `Ubuntu` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/user.md b/docs/registry/attributes/user.md index ab0316a916..290999229b 100644 --- a/docs/registry/attributes/user.md +++ b/docs/registry/attributes/user.md @@ -8,6 +8,7 @@ Describes information about the user. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `user.email` | string | User email address. | `a.einstein@example.com` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/v8js.md b/docs/registry/attributes/v8js.md index 8616331d56..d52f8a8ebf 100644 --- a/docs/registry/attributes/v8js.md +++ b/docs/registry/attributes/v8js.md @@ -8,6 +8,7 @@ Describes V8 JS Engine Runtime related attributes. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `v8js.gc.type` | string | The type of garbage collection. | `major`; `minor`; `incremental` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/vcs.md b/docs/registry/attributes/vcs.md index 21c3b06f3c..ccec6b2e85 100644 --- a/docs/registry/attributes/vcs.md +++ b/docs/registry/attributes/vcs.md @@ -11,6 +11,7 @@ This group defines the attributes for [Version Control Systems (VCS)](https://wikipedia.org/wiki/Version_control). **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `vcs.change.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -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 74b83fb82e..818c99cead 100644 --- a/docs/registry/attributes/webengine.md +++ b/docs/registry/attributes/webengine.md @@ -8,6 +8,7 @@ This document defines the attributes used to describe the packaged software running the application code. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `webengine.description` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/docs/registry/attributes/zos.md b/docs/registry/attributes/zos.md index bfdc3287e9..cdbf978268 100644 --- a/docs/registry/attributes/zos.md +++ b/docs/registry/attributes/zos.md @@ -8,6 +8,7 @@ This document defines attributes of a z/OS resource. **Current Attributes:** + | Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| | `zos.smf.id` | 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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 7712ed02e3..d56eabfee6 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 | Type | Summary | Example Values | Stability | +{%- endif -%} + +{% set filtered_attributes = group.attributes | rejectattr("deprecated") | sort(attribute="name") %}{% if filtered_attributes | length > 0 %}**Current Attributes:** + +| Key | Type | Summary | Example Values | Stability | |---|---|---|---|---| {%- for attribute in filtered_attributes %}{% set attr_anchor = attribute.name | kebab_case %} | `{{ attrs.name(attribute) }}` | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add({"note": attribute.note, "name": attrs.name(attribute)}) }} | {{ examples.format(attribute) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated, attribute.brief) | 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 -%}