Update build-tools version to 0.25.0 and add display_name to all re…

…gistry attribute groups (#985) Signed-off-by: Alexander Wert <[email protected]>
open-telemetry · Jul 15, 2024 · 4e7c42e · 4e7c42e
1 parent f79fe6b
commit 4e7c42e
Show file tree

Hide file tree

Showing 101 changed files with 289 additions and 176 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -83,7 +83,7 @@ environment configured:
 ### 1. Modify the YAML model
 
 Refer to the
-[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.24.0/semantic-conventions/syntax.md)
+[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.25.0/semantic-conventions/syntax.md)
 to learn how to make changes to the YAML files.
 
 #### Schema files

diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@ CHLOGGEN_CONFIG  := .chloggen/config.yaml
 
 # see https://github.com/open-telemetry/build-tools/releases for semconvgen updates
 # Keep links in model/README.md and .vscode/settings.json in sync!
-SEMCONVGEN_VERSION=0.24.0
+SEMCONVGEN_VERSION=0.25.0
 WEAVER_VERSION=0.5.0
 
 # From where to resolve the containers (e.g. "otel/weaver").

diff --git a/docs/attributes-registry/android.md b/docs/attributes-registry/android.md
@@ -6,8 +6,8 @@
 
 # Android
 
-- [Android](#android-attributes)
-- [Android Deprecated](#android-deprecated-attributes)
+- [Android Attributes](#android-attributes)
+- [Deprecated Android Attributes](#deprecated-android-attributes)
 
 ## Android Attributes
 
@@ -17,7 +17,7 @@ The Android platform on which the Android application is running.
 | ---------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------- |
 | `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 [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## Android Deprecated Attributes
+## Deprecated Android Attributes
 
 This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform.
 

diff --git a/docs/attributes-registry/aspnetcore.md b/docs/attributes-registry/aspnetcore.md
@@ -6,7 +6,7 @@
 
 # Aspnetcore
 
-## Aspnetcore Attributes
+## ASP.NET Core Attributes
 
 ASP.NET Core attributes
 

diff --git a/docs/attributes-registry/aws.md b/docs/attributes-registry/aws.md
@@ -6,23 +6,23 @@
 
 # AWS
 
-- [Aws](#aws-attributes)
-- [Aws Dynamodb](#aws-dynamodb-attributes)
-- [Aws Ecs](#aws-ecs-attributes)
-- [Aws Eks](#aws-eks-attributes)
-- [Aws Lambda](#aws-lambda-attributes)
-- [Aws Log](#aws-log-attributes)
-- [Aws S3](#aws-s3-attributes)
+- [General AWS Attributes](#general-aws-attributes)
+- [Amazon DynamoDB Attributes](#amazon-dynamodb-attributes)
+- [Amazon ECS Attributes](#amazon-ecs-attributes)
+- [Amazon EKS Attributes](#amazon-eks-attributes)
+- [Amazon Lambda Attributes](#amazon-lambda-attributes)
+- [Amazon Logs Attributes](#amazon-logs-attributes)
+- [Amazon S3 Attributes](#amazon-s3-attributes)
 
-## AWS Attributes
+## General AWS Attributes
 
 This document defines generic attributes for AWS services.
 
 | Attribute        | Type   | Description                                                                                     | Examples                                                   | Stability                                                        |
 | ---------------- | ------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
 | `aws.request_id` | string | The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid`. | `79b9da39-b7ae-508a-a6bc-864b2829c622`; `C9ER4AJX75574TDJ` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## AWS DynamoDB Attributes
+## Amazon DynamoDB Attributes
 
 This document defines attributes for AWS DynamoDB.
 
@@ -51,7 +51,7 @@ This document defines attributes for AWS DynamoDB.
 | `aws.dynamodb.table_names`                    | string[] | The keys in the `RequestItems` object field.                                               | `["Users", "Cats"]`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `aws.dynamodb.total_segments`                 | int      | The value of the `TotalSegments` request parameter.                                        | `100`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## AWS ECS Attributes
+## Amazon ECS Attributes
 
 This document defines attributes for AWS Elastic Container Service (ECS).
 
@@ -72,15 +72,15 @@ This document defines attributes for AWS Elastic Container Service (ECS).
 | `ec2`     | ec2         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `fargate` | fargate     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## AWS EKS Attributes
+## Amazon EKS Attributes
 
 This document defines attributes for AWS Elastic Kubernetes Service (EKS).
 
 | Attribute             | Type   | Description                | Examples                                                | Stability                                                        |
 | --------------------- | ------ | -------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------- |
 | `aws.eks.cluster.arn` | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## AWS Lambda Attributes
+## Amazon Lambda Attributes
 
 This document defines attributes for AWS Lambda.
 
@@ -90,7 +90,7 @@ This document defines attributes for AWS Lambda.
 
 **[1]:** This may be different from `cloud.resource_id` if an alias is involved.
 
-## AWS Log Attributes
+## Amazon Logs Attributes
 
 This document defines attributes for AWS Logs.
 
@@ -107,7 +107,7 @@ This document defines attributes for AWS Logs.
 
 **[4]:** 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 S3 Attributes
+## Amazon S3 Attributes
 
 This document defines attributes for AWS S3.
 

diff --git a/docs/attributes-registry/container.md b/docs/attributes-registry/container.md
@@ -6,8 +6,8 @@
 
 # Container
 
-- [Container](#container-attributes)
-- [Container Deprecated](#container-deprecated-attributes)
+- [Container Attributes](#container-attributes)
+- [Deprecated Container Attributes](#deprecated-container-attributes)
 
 ## Container Attributes
 
@@ -35,7 +35,7 @@ The ID is assigned by the container runtime and can vary in different environmen
 
 **[3]:** [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.
 
-## Container Deprecated Attributes
+## Deprecated Container Attributes
 
 Describes deprecated container attributes.
 

diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md
@@ -6,14 +6,14 @@
 
 # Db
 
-- [Db](#db-attributes)
-- [Db Cassandra](#db-cassandra-attributes)
-- [Db Cosmosdb](#db-cosmosdb-attributes)
-- [Db Deprecated](#db-deprecated-attributes)
-- [Db Elasticsearch](#db-elasticsearch-attributes)
-- [Db Metrics Deprecated](#db-metrics-deprecated-attributes)
+- [General Database Attributes](#general-database-attributes)
+- [Cassandra Attributes](#cassandra-attributes)
+- [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes)
+- [Elasticsearch Attributes](#elasticsearch-attributes)
+- [Deprecated Database Attributes](#deprecated-database-attributes)
+- [Deprecated Database Metrics](#deprecated-database-metrics)
 
-## Db Attributes
+## General Database Attributes
 
 This group defines the attributes used to describe telemetry in the context of databases.
 
@@ -118,7 +118,7 @@ Even though parameterized query text can potentially have sensitive data, by usi
 | `trino`              | Trino                                                     | ![Experimental](https://img.shields.io/badge/-experimental-blue)                                 |
 | `vertica`            | Vertica                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue)                                 |
 
-## Db Cassandra Attributes
+## Cassandra Attributes
 
 This group defines attributes for Cassandra.
 
@@ -147,7 +147,7 @@ This group defines attributes for Cassandra.
 | `three`        | three        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `two`          | two          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## Db CosmosDB Attributes
+## Azure Cosmos DB Attributes
 
 This group defines attributes for Azure Cosmos DB.
 
@@ -188,7 +188,18 @@ This group defines attributes for Azure Cosmos DB.
 | `Replace`           | replace            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `Upsert`            | upsert             | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## Db Deprecated Attributes
+## Elasticsearch Attributes
+
+This group defines attributes for Elasticsearch.
+
+| Attribute                           | Type   | Description                                                                                  | Examples                                                                                 | Stability                                                        |
+| ----------------------------------- | ------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `db.elasticsearch.node.name`        | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001`                                                                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `db.elasticsearch.path_parts.<key>` | string | A dynamic value in the url path. [8]                                                         | `db.elasticsearch.path_parts.index=test-index`; `db.elasticsearch.path_parts.doc_id=123` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+**[8]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.<key>`, where `<key>` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names.
+
+## Deprecated Database Attributes
 
 "Describes deprecated db attributes."
 
@@ -209,18 +220,7 @@ This group defines attributes for Azure Cosmos DB.
 | `db.statement`                  | string | The database statement being executed.                                                                        | `SELECT * FROM wuser_table`; `SET mykey "WuValue"`                      | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `db.query.text`.                                                                                  |
 | `db.user`                       | string | Deprecated, no replacement at this time.                                                                      | `readonly_user`; `reporting_user`                                       | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>No replacement at this time.                                                                                  |
 
-## Db Elasticsearch Attributes
-
-This group defines attributes for Elasticsearch.
-
-| Attribute                           | Type   | Description                                                                                  | Examples                                                                                 | Stability                                                        |
-| ----------------------------------- | ------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `db.elasticsearch.node.name`        | string | Represents the human-readable identifier of the node/instance to which a request was routed. | `instance-0000000001`                                                                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `db.elasticsearch.path_parts.<key>` | string | A dynamic value in the url path. [8]                                                         | `db.elasticsearch.path_parts.index=test-index`; `db.elasticsearch.path_parts.doc_id=123` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-
-**[8]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.<key>`, where `<key>` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names.
-
-## Db Metrics Deprecated Attributes
+## Deprecated Database Metrics
 
 "Describes deprecated db metrics attributes."
 

diff --git a/docs/attributes-registry/dns.md b/docs/attributes-registry/dns.md
@@ -6,7 +6,7 @@
 
 # Dns
 
-## Dns Attributes
+## DNS Attributes
 
 This document defines the shared attributes used to report a DNS query.
 

diff --git a/docs/attributes-registry/enduser.md b/docs/attributes-registry/enduser.md
@@ -6,7 +6,7 @@
 
 # Enduser
 
-## Enduser Deprecated Attributes
+## Deprecated End User Attributes
 
 Describes deprecated enduser attributes. Complete enduser namespace has been deprecated
 

diff --git a/docs/attributes-registry/faas.md b/docs/attributes-registry/faas.md
@@ -6,7 +6,7 @@
 
 # Faas
 
-## Faas Attributes
+## Function as a Service Attributes
 
 FaaS attributes
 

diff --git a/docs/attributes-registry/gcp.md b/docs/attributes-registry/gcp.md
@@ -6,10 +6,10 @@
 
 # GCP
 
-- [Gcp](#gcp-attributes)
-- [Gcp Client](#gcp-client-attributes)
-- [Gcp Cloud Run](#gcp-cloud-run-attributes)
-- [Gcp Gce](#gcp-gce-attributes)
+- [GCP Attributes](#gcp-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 Attributes
 
@@ -28,7 +28,7 @@ Attributes for Google Cloud client libraries.
 
 **[1]:** 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 Cloud Run Attributes
+## GCP - Google Cloud Run Attributes
 
 This document defines attributes for Google Cloud Run.
 
@@ -37,7 +37,7 @@ This document defines attributes for Google Cloud Run.
 | `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` | ![Experimental](https://img.shields.io/badge/-experimental-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`                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## GCP GCE Attributes
+## GCP - Google Compute Engine (GCE) Attributes
 
 This document defines attributes for Google Compute Engine (GCE).
 

diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md
@@ -6,10 +6,10 @@
 
 # Gen AI
 
-- [Gen Ai](#gen-ai-attributes)
-- [Gen Ai Deprecated](#gen-ai-deprecated-attributes)
+- [GenAI Attributes](#genai-attributes)
+- [Deprecated GenAI Attributes](#deprecated-genai-attributes)
 
-## Gen AI Attributes
+## GenAI Attributes
 
 This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses.
 
@@ -73,7 +73,7 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`.
 | `input`  | Input tokens (prompt, input, etc.)         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `output` | Output tokens (completion, response, etc.) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-## Gen AI Deprecated Attributes
+## Deprecated GenAI Attributes
 
 Describes deprecated `gen_ai` attributes.
 

diff --git a/docs/attributes-registry/http.md b/docs/attributes-registry/http.md
@@ -6,8 +6,8 @@
 
 # HTTP
 
-- [Http](#http-attributes)
-- [Http Deprecated](#http-deprecated-attributes)
+- [HTTP Attributes](#http-attributes)
+- [Deprecated HTTP Attributes](#deprecated-http-attributes)
 
 ## HTTP Attributes
 
@@ -78,7 +78,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
 | `PUT`     | PUT method.                                                         | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
 | `TRACE`   | TRACE method.                                                       | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
 
-## HTTP Deprecated Attributes
+## Deprecated HTTP Attributes
 
 Describes deprecated HTTP attributes.
 

diff --git a/docs/attributes-registry/ios.md b/docs/attributes-registry/ios.md
@@ -6,7 +6,7 @@
 
 # iOS
 
-## iOS Deprecated Attributes
+## Deprecated iOS Attributes
 
 The iOS platform on which the iOS application is running.
 

diff --git a/docs/attributes-registry/jvm.md b/docs/attributes-registry/jvm.md
@@ -6,7 +6,7 @@
 
 # JVM
 
-## JVM Attributes
+## Java Virtual Machine (JVM) Attributes
 
 This document defines Java Virtual machine related attributes.
 

diff --git a/docs/attributes-registry/k8s.md b/docs/attributes-registry/k8s.md
@@ -6,10 +6,10 @@
 
 # K8s
 
-- [K8s](#k8s-attributes)
-- [K8s Deprecated](#k8s-deprecated-attributes)
+- [Kubernetes Attributes](#kubernetes-attributes)
+- [Deprecated Kubernetes Attributes](#deprecated-kubernetes-attributes)
 
-## K8s Attributes
+## Kubernetes Attributes
 
 Kubernetes resource attributes.
 
@@ -63,7 +63,7 @@ Which states:
 Therefore, UIDs between clusters should be extremely unlikely to
 conflict.
 
-## K8s Deprecated Attributes
+## Deprecated Kubernetes Attributes
 
 Describes deprecated k8s attributes.
 

diff --git a/docs/attributes-registry/log.md b/docs/attributes-registry/log.md
@@ -6,11 +6,11 @@
 
 # Log
 
-- [Log](#log-attributes)
-- [Log File](#log-file-attributes)
-- [Log Record](#log-record-attributes)
+- [General Log Attributes](#general-log-attributes)
+- [Log File Attributes](#log-file-attributes)
+- [Log Record Attributes](#log-record-attributes)
 
-## Log Attributes
+## General Log Attributes
 
 This document defines log attributes