diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3e8f596ce..059ede01d1 100644 --- 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 index b2af508988..4f16ea2e7b 100644 --- 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 index c540e60cea..a8c442da77 100644 --- 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 index 1fe1a2ad74..941c86fcb0 100644 --- 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 index fa4cf4deac..4d36c2e3c8 100644 --- a/docs/attributes-registry/aws.md +++ b/docs/attributes-registry/aws.md @@ -6,15 +6,15 @@ # 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. @@ -22,7 +22,7 @@ This document defines generic attributes for AWS services. | ---------------- | ------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | `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,7 +72,7 @@ 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). @@ -80,7 +80,7 @@ This document defines attributes for AWS Elastic Kubernetes Service (EKS). | --------------------- | ------ | -------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------- | | `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 index fdca43d789..4aef8d3f91 100644 --- 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 index db78b93f6b..066ca70bac 100644 --- 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.` | 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.`, where `` 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)
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)
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.` | 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.`, where `` 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 index 6345d59240..a03b3cef57 100644 --- 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 index 66ba5a0d1e..db2d7a5835 100644 --- 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 index 26a1200ece..6279999b71 100644 --- 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 index cade703150..04f6f981bf 100644 --- 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 index a9c090a32b..d136ebf575 100644 --- 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 index 7d33288aef..069666a943 100644 --- 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 index f15cf13d6a..a8891cdcbd 100644 --- 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 index 70f08089d7..75f1f3093a 100644 --- 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 index b9bc225333..34d2e64c88 100644 --- 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 index 7aeff8c921..c24c22b1ac 100644 --- 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 diff --git a/docs/attributes-registry/messaging.md b/docs/attributes-registry/messaging.md index dd69d0c13e..cf7a11b0b1 100644 --- a/docs/attributes-registry/messaging.md +++ b/docs/attributes-registry/messaging.md @@ -6,16 +6,16 @@ # Messaging -- [Messaging](#messaging-attributes) -- [Messaging Deprecated](#messaging-deprecated-attributes) -- [Messaging Eventhubs](#messaging-eventhubs-attributes) -- [Messaging Gcp Pubsub](#messaging-gcp-pubsub-attributes) -- [Messaging Kafka](#messaging-kafka-attributes) -- [Messaging Rabbitmq](#messaging-rabbitmq-attributes) -- [Messaging Rocketmq](#messaging-rocketmq-attributes) -- [Messaging Servicebus](#messaging-servicebus-attributes) +- [General Messaging Attributes](#general-messaging-attributes) +- [Azure Event Hubs Attributes](#azure-event-hubs-attributes) +- [GCP Pub/Sub Attributes](#gcp-pubsub-attributes) +- [Kafka Attributes](#kafka-attributes) +- [RabbitMQ Attributes](#rabbitmq-attributes) +- [RocketMQ Attributes](#rocketmq-attributes) +- [Azure Service Bus Attributes](#azure-service-bus-attributes) +- [Deprecated Messaging Attributes](#deprecated-messaging-attributes) -## Messaging Attributes +## General Messaging Attributes Attributes describing telemetry around messaging systems and messaging activities. @@ -91,21 +91,7 @@ size should be used. | `rocketmq` | Apache RocketMQ | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `servicebus` | Azure Service Bus | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## Messaging Deprecated Attributes - -Describes deprecated messaging attributes. - -| Attribute | Type | Description | Examples | Stability | -| ---------------------------------------------------- | ------ | ----------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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.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)
Replaced by `messaging.destination.partition.id`. | -| `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.servicebus.destination.subscription_name` instead. | `subscription-a` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.servicebus.destination.subscription_name`. | - -## Messaging Eventhubs Attributes +## Azure Event Hubs Attributes This group describes attributes specific to Azure Event Hubs. @@ -113,7 +99,7 @@ This group describes attributes specific to Azure Event Hubs. | ------------------------------------------- | ---- | -------------------------------------------------------------------------------------- | ------------ | ---------------------------------------------------------------- | | `messaging.eventhubs.message.enqueued_time` | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## Messaging GCP Pubsub Attributes +## GCP Pub/Sub Attributes This group describes attributes specific to GCP Pub/Sub. @@ -124,7 +110,7 @@ This group describes attributes specific to GCP Pub/Sub. | `messaging.gcp_pubsub.message.delivery_attempt` | int | The delivery attempt for a given message. | `2` | ![Experimental](https://img.shields.io/badge/-experimental-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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## Messaging Kafka Attributes +## Kafka Attributes This group describes attributes specific to Apache Kafka. @@ -136,7 +122,7 @@ This group describes attributes specific to Apache Kafka. **[11]:** If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value. -## Messaging RabbitMQ Attributes +## RabbitMQ Attributes This group describes attributes specific to RabbitMQ. @@ -145,7 +131,7 @@ This group describes attributes specific to RabbitMQ. | `messaging.rabbitmq.destination.routing_key` | string | RabbitMQ message routing key. | `myKey` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `messaging.rabbitmq.message.delivery_tag` | int | RabbitMQ message delivery tag | `123` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## Messaging RocketMQ Attributes +## RocketMQ Attributes This group describes attributes specific to RocketMQ. @@ -176,7 +162,7 @@ This group describes attributes specific to RocketMQ. | `normal` | Normal message | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `transaction` | Transaction message | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## Messaging Servicebus Attributes +## Azure Service Bus Attributes This group describes attributes specific to Azure Service Bus. @@ -194,3 +180,17 @@ This group describes attributes specific to Azure Service Bus. | `complete` | Message is completed | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `dead_letter` | Message is sent to dead letter queue | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `defer` | Message is deferred | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +## Deprecated Messaging Attributes + +Describes deprecated messaging attributes. + +| Attribute | Type | Description | Examples | Stability | +| ---------------------------------------------------- | ------ | ----------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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.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)
Replaced by `messaging.destination.partition.id`. | +| `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.servicebus.destination.subscription_name` instead. | `subscription-a` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `messaging.servicebus.destination.subscription_name`. | diff --git a/docs/attributes-registry/network.md b/docs/attributes-registry/network.md index 54bf6099f8..1d1e742e6b 100644 --- a/docs/attributes-registry/network.md +++ b/docs/attributes-registry/network.md @@ -6,8 +6,8 @@ # Network -- [Network](#network-attributes) -- [Network Deprecated](#network-deprecated-attributes) +- [Network Attributes](#network-attributes) +- [Deprecated Network Attributes](#deprecated-network-attributes) ## Network Attributes @@ -102,7 +102,7 @@ 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) | -## Network Deprecated Attributes +## Deprecated Network Attributes These attributes may be used for any network related operation. diff --git a/docs/attributes-registry/oci.md b/docs/attributes-registry/oci.md index 6a2aa64c15..c528a50fcb 100644 --- a/docs/attributes-registry/oci.md +++ b/docs/attributes-registry/oci.md @@ -6,7 +6,7 @@ # OCI -## OCI Manifest Attributes +## Open Container Initiative (OCI) Attributes An OCI image manifest. diff --git a/docs/attributes-registry/os.md b/docs/attributes-registry/os.md index 8785622356..a5b4f44ce8 100644 --- a/docs/attributes-registry/os.md +++ b/docs/attributes-registry/os.md @@ -6,7 +6,7 @@ # OS -## OS Attributes +## Operating System Attributes The operating system (OS) on which the process represented by this resource is running. diff --git a/docs/attributes-registry/otel.md b/docs/attributes-registry/otel.md index 5ac726e13d..07ed204dc1 100644 --- a/docs/attributes-registry/otel.md +++ b/docs/attributes-registry/otel.md @@ -6,9 +6,9 @@ # OTel -- [Otel](#otel-attributes) -- [Otel Library Deprecated](#otel-library-deprecated-attributes) -- [Otel Scope](#otel-scope-attributes) +- [OTel Attributes](#otel-attributes) +- [OTel Scope Attributes](#otel-scope-attributes) +- [Deprecated OTel Library Attributes](#deprecated-otel-library-attributes) ## OTel Attributes @@ -26,15 +26,6 @@ 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 Library Deprecated Attributes - -Describes deprecated otel.library attributes. - -| Attribute | Type | Description | Examples | Stability | -| ---------------------- | ------ | ----------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `otel.library.name` | string | | `io.opentelemetry.contrib.mongodb` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
use the `otel.scope.name` attribute. | -| `otel.library.version` | string | | `1.0.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
use the `otel.scope.version` attribute. | - ## OTel Scope Attributes Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. @@ -43,3 +34,12 @@ Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concept | -------------------- | ------ | ------------------------------------------------------------------------------------ | ---------------------------------- | ---------------------------------------------------------- | | `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.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 | | `io.opentelemetry.contrib.mongodb` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
use the `otel.scope.name` attribute. | +| `otel.library.version` | string | | `1.0.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
use the `otel.scope.version` attribute. | diff --git a/docs/attributes-registry/process.md b/docs/attributes-registry/process.md index 9b47e08949..922286f11d 100644 --- a/docs/attributes-registry/process.md +++ b/docs/attributes-registry/process.md @@ -6,8 +6,8 @@ # Process -- [Process](#process-attributes) -- [Process Deprecated](#process-deprecated-attributes) +- [Process Attributes](#process-attributes) +- [Deprecated Process Attributes](#deprecated-process-attributes) ## Process Attributes @@ -58,7 +58,7 @@ An operating system process. | `major` | major | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `minor` | minor | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## Process Deprecated Attributes +## Deprecated Process Attributes Deprecated process attributes. diff --git a/docs/attributes-registry/rpc.md b/docs/attributes-registry/rpc.md index 561e7c27bc..9c6088a1ce 100644 --- a/docs/attributes-registry/rpc.md +++ b/docs/attributes-registry/rpc.md @@ -6,10 +6,10 @@ # RPC -- [Rpc](#rpc-attributes) -- [Rpc Deprecated](#rpc-deprecated-attributes) +- [Remote Procedure Call (RPC) Attributes](#remote-procedure-call-rpc-attributes) +- [Deprecated RPC Attributes](#deprecated-rpc-attributes) -## RPC Attributes +## Remote Procedure Call (RPC) Attributes This document defines attributes for remote procedure calls. @@ -107,7 +107,7 @@ This document defines attributes for remote procedure calls. | `grpc` | gRPC | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `java_rmi` | Java RMI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## RPC Deprecated Attributes +## Deprecated RPC Attributes Deprecated rpc message attributes. diff --git a/docs/attributes-registry/system.md b/docs/attributes-registry/system.md index c504f989f9..60871019ba 100644 --- a/docs/attributes-registry/system.md +++ b/docs/attributes-registry/system.md @@ -6,16 +6,16 @@ # System -- [System](#system-attributes) -- [System Cpu](#system-cpu-attributes) -- [System Deprecated](#system-deprecated-attributes) -- [System Filesystem](#system-filesystem-attributes) -- [System Memory](#system-memory-attributes) -- [System Network](#system-network-attributes) -- [System Paging](#system-paging-attributes) -- [System Process](#system-process-attributes) +- [General System Attributes](#general-system-attributes) +- [System CPU Attributes](#system-cpu-attributes) +- [Filesystem Attributes](#filesystem-attributes) +- [System Memory Attributes](#system-memory-attributes) +- [System Network Attributes](#system-network-attributes) +- [System Paging Attributes](#system-paging-attributes) +- [System Process Attributes](#system-process-attributes) +- [Deprecated System Attributes](#deprecated-system-attributes) -## System Attributes +## General System Attributes Describes System attributes @@ -31,37 +31,7 @@ Describes System CPU attributes | --------------------------- | ---- | ------------------------------- | -------- | ---------------------------------------------------------------- | | `system.cpu.logical_number` | int | The logical CPU number [0..n-1] | `1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -## System Deprecated Attributes - -Deprecated system attributes. - -| Attribute | Type | Description | Examples | Stability | -| ------------------------- | ------ | ------------------------------------------------ | ------------------- | --------------------------------------------------------------------------------------------------- | -| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode` | -| `system.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.process.status`. | - -`system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| ----------- | ----------- | ---------------------------------------------------------------- | -| `idle` | idle | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `interrupt` | interrupt | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `iowait` | iowait | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `nice` | nice | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `steal` | steal | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `system` | system | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `user` | user | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - -`system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - -| Value | Description | Stability | -| ---------- | ----------- | ---------------------------------------------------------------- | -| `defunct` | defunct | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `running` | running | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `sleeping` | sleeping | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `stopped` | stopped | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - -## System Filesystem Attributes +## Filesystem Attributes Describes Filesystem attributes @@ -181,3 +151,33 @@ Describes System Process attributes | `running` | running | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `sleeping` | sleeping | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `stopped` | stopped | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +## Deprecated System Attributes + +Deprecated system attributes. + +| Attribute | Type | Description | Examples | Stability | +| ------------------------- | ------ | ------------------------------------------------ | ------------------- | --------------------------------------------------------------------------------------------------- | +| `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode` | +| `system.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.process.status`. | + +`system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| ----------- | ----------- | ---------------------------------------------------------------- | +| `idle` | idle | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `interrupt` | interrupt | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `iowait` | iowait | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `nice` | nice | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `steal` | steal | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `system` | system | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `user` | user | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +`system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| ---------- | ----------- | ---------------------------------------------------------------- | +| `defunct` | defunct | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `running` | running | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `sleeping` | sleeping | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `stopped` | stopped | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/docs/attributes-registry/user-agent.md b/docs/attributes-registry/user-agent.md index 34b0c71f89..b7a10cd630 100644 --- a/docs/attributes-registry/user-agent.md +++ b/docs/attributes-registry/user-agent.md @@ -6,7 +6,7 @@ # User Agent -## User Agent Attributes +## User-agent Attributes Describes user-agent attributes. diff --git a/docs/attributes-registry/v8js.md b/docs/attributes-registry/v8js.md index 2e2bf3fec3..a8ae0bff7a 100644 --- a/docs/attributes-registry/v8js.md +++ b/docs/attributes-registry/v8js.md @@ -6,7 +6,7 @@ # V8js -## V8js Attributes +## V8 JS Attributes Describes V8 JS Engine Runtime related attributes. diff --git a/docs/attributes-registry/webengine.md b/docs/attributes-registry/webengine.md index be5955444e..1cb10ac3fb 100644 --- a/docs/attributes-registry/webengine.md +++ b/docs/attributes-registry/webengine.md @@ -6,7 +6,7 @@ # Webengine -## Webengine Attributes +## Web Engine Attributes This document defines the attributes used to describe the packaged software running the application code. diff --git a/internal/tools/schema_check.sh b/internal/tools/schema_check.sh index 68883941b1..779fd957e8 100755 --- a/internal/tools/schema_check.sh +++ b/internal/tools/schema_check.sh @@ -6,7 +6,7 @@ set -e -BUILD_TOOL_SCHEMAS_VERSION=0.24.0 +BUILD_TOOL_SCHEMAS_VERSION=0.25.0 # List of versions that do not require or have a schema. declare -a skip_versions=("1.0.0" "1.0.1" "1.1.0" "1.2.0" "1.3.0" "1.6.0") diff --git a/model/README.md b/model/README.md index 012b4f4ed7..ec76e3f883 100644 --- a/model/README.md +++ b/model/README.md @@ -14,12 +14,12 @@ Semantic conventions for the spec MUST adhere to the [attribute requirement level](../docs/general/attribute-requirement-level.md), and [metric requirement level](../docs/general/metric-requirement-level.md) conventions. -Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/v0.24.0/semantic-conventions/syntax.md) +Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/v0.25.0/semantic-conventions/syntax.md) for how to write the YAML files for semantic conventions and what the YAML properties mean. A schema file for VS code is configured in the `/.vscode/settings.json` of this repository, enabling auto-completion and additional checks. Refer to -[the generator README](https://github.com/open-telemetry/build-tools/tree/v0.24.0/semantic-conventions/README.md) for what extension you need. +[the generator README](https://github.com/open-telemetry/build-tools/tree/v0.25.0/semantic-conventions/README.md) for what extension you need. ## Generating markdown diff --git a/model/registry/android.yaml b/model/registry/android.yaml index cfdcac8a46..c9c23e46ae 100644 --- a/model/registry/android.yaml +++ b/model/registry/android.yaml @@ -2,6 +2,7 @@ groups: - id: registry.android prefix: android type: attribute_group + display_name: Android Attributes brief: > The Android platform on which the Android application is running. attributes: diff --git a/model/registry/aspnetcore.yaml b/model/registry/aspnetcore.yaml index 0c93fc1aee..c5e36497e1 100644 --- a/model/registry/aspnetcore.yaml +++ b/model/registry/aspnetcore.yaml @@ -2,6 +2,7 @@ groups: - id: registry.aspnetcore prefix: aspnetcore type: attribute_group + display_name: ASP.NET Core Attributes brief: ASP.NET Core attributes attributes: - id: rate_limiting.policy diff --git a/model/registry/aws.yaml b/model/registry/aws.yaml index 90bb10b853..4ed5f82ff8 100644 --- a/model/registry/aws.yaml +++ b/model/registry/aws.yaml @@ -2,6 +2,7 @@ groups: - id: registry.aws prefix: aws type: attribute_group + display_name: General AWS Attributes brief: > This document defines generic attributes for AWS services. attributes: @@ -15,6 +16,7 @@ groups: - id: registry.aws.dynamodb prefix: aws.dynamodb type: attribute_group + display_name: Amazon DynamoDB Attributes brief: > This document defines attributes for AWS DynamoDB. attributes: @@ -256,6 +258,7 @@ groups: - id: registry.aws.ecs prefix: aws.ecs type: attribute_group + display_name: Amazon ECS Attributes brief: > This document defines attributes for AWS Elastic Container Service (ECS). attributes: @@ -316,6 +319,7 @@ groups: - id: registry.aws.eks prefix: aws.eks type: attribute_group + display_name: Amazon EKS Attributes brief: > This document defines attributes for AWS Elastic Kubernetes Service (EKS). attributes: @@ -328,6 +332,7 @@ groups: - id: registry.aws.log prefix: aws.log type: attribute_group + display_name: Amazon Logs Attributes brief: > This document defines attributes for AWS Logs. attributes: @@ -371,6 +376,7 @@ groups: - id: registry.aws.lambda prefix: aws.lambda type: attribute_group + display_name: Amazon Lambda Attributes brief: > This document defines attributes for AWS Lambda. attributes: @@ -385,6 +391,7 @@ groups: - id: registry.aws.s3 prefix: aws.s3 type: attribute_group + display_name: Amazon S3 Attributes brief: > This document defines attributes for AWS S3. attributes: diff --git a/model/registry/browser.yaml b/model/registry/browser.yaml index fad84c9787..4e6f39c3e3 100644 --- a/model/registry/browser.yaml +++ b/model/registry/browser.yaml @@ -2,6 +2,7 @@ groups: - id: registry.browser prefix: browser type: attribute_group + display_name: Browser Attributes brief: > The web browser attributes attributes: diff --git a/model/registry/client.yaml b/model/registry/client.yaml index 3b17ed8b4e..507dfd53a7 100644 --- a/model/registry/client.yaml +++ b/model/registry/client.yaml @@ -2,6 +2,7 @@ groups: - id: registry.client prefix: client type: attribute_group + display_name: Client Attributes brief: > 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). diff --git a/model/registry/cloud.yaml b/model/registry/cloud.yaml index ddb83338cc..c86357be9d 100644 --- a/model/registry/cloud.yaml +++ b/model/registry/cloud.yaml @@ -2,6 +2,7 @@ groups: - id: registry.cloud prefix: cloud type: attribute_group + display_name: Cloud Attributes brief: > A cloud environment (e.g. GCP, Azure, AWS). attributes: diff --git a/model/registry/cloudevents.yaml b/model/registry/cloudevents.yaml index 4da702f8a8..61952f29b2 100644 --- a/model/registry/cloudevents.yaml +++ b/model/registry/cloudevents.yaml @@ -2,6 +2,7 @@ groups: - id: registry.cloudevents prefix: cloudevents type: attribute_group + display_name: CloudEvents Attributes brief: > This document defines attributes for CloudEvents. attributes: diff --git a/model/registry/code.yaml b/model/registry/code.yaml index 967607205a..b7119d5150 100644 --- a/model/registry/code.yaml +++ b/model/registry/code.yaml @@ -2,6 +2,7 @@ groups: - id: registry.code prefix: code type: attribute_group + display_name: Code Attributes brief: > These attributes allow to report this unit of code and therefore to provide more context about the span. attributes: diff --git a/model/registry/container.yaml b/model/registry/container.yaml index 60348628b4..750d8854bd 100644 --- a/model/registry/container.yaml +++ b/model/registry/container.yaml @@ -2,6 +2,7 @@ groups: - id: registry.container prefix: container type: attribute_group + display_name: Container Attributes brief: > A container instance. attributes: diff --git a/model/registry/cpu.yaml b/model/registry/cpu.yaml index 43fb145a38..93a327f9fa 100644 --- a/model/registry/cpu.yaml +++ b/model/registry/cpu.yaml @@ -3,6 +3,7 @@ groups: prefix: cpu type: attribute_group brief: Attributes specific to a cpu instance. + display_name: CPU Attributes attributes: - id: mode brief: "The mode of the CPU" diff --git a/model/registry/db.yaml b/model/registry/db.yaml index c94ac32e0f..8529414fbe 100644 --- a/model/registry/db.yaml +++ b/model/registry/db.yaml @@ -2,6 +2,7 @@ groups: - id: registry.db prefix: db type: attribute_group + display_name: General Database Attributes brief: > This group defines the attributes used to describe telemetry in the context of databases. attributes: @@ -340,6 +341,7 @@ groups: - id: registry.db.cassandra prefix: db type: attribute_group + display_name: Cassandra Attributes brief: > This group defines attributes for Cassandra. attributes: @@ -414,6 +416,7 @@ groups: - id: registry.db.cosmosdb prefix: db type: attribute_group + display_name: Azure Cosmos DB Attributes brief: > This group defines attributes for Azure Cosmos DB. attributes: @@ -509,6 +512,7 @@ groups: - id: registry.db.elasticsearch prefix: db type: attribute_group + display_name: Elasticsearch Attributes brief: > This group defines attributes for Elasticsearch. attributes: diff --git a/model/registry/deployment.yaml b/model/registry/deployment.yaml index ffc0050eab..0d4b6699bb 100644 --- a/model/registry/deployment.yaml +++ b/model/registry/deployment.yaml @@ -2,6 +2,7 @@ groups: - id: registry.deployment prefix: deployment type: attribute_group + display_name: Deployment Attributes brief: > This document defines attributes for software deployments. attributes: diff --git a/model/registry/deprecated/android.yaml b/model/registry/deprecated/android.yaml index 97e9bd1e7a..9445a91d5c 100644 --- a/model/registry/deprecated/android.yaml +++ b/model/registry/deprecated/android.yaml @@ -2,6 +2,7 @@ groups: - id: registry.android.deprecated prefix: android 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: diff --git a/model/registry/deprecated/container.yaml b/model/registry/deprecated/container.yaml index 63e69621dd..01312d6865 100644 --- a/model/registry/deprecated/container.yaml +++ b/model/registry/deprecated/container.yaml @@ -1,6 +1,7 @@ groups: - id: registry.container.deprecated type: attribute_group + display_name: Deprecated Container Attributes brief: "Describes deprecated container attributes." attributes: - id: container.labels diff --git a/model/registry/deprecated/db.yaml b/model/registry/deprecated/db.yaml index a58a742881..4bdf5f1de3 100644 --- a/model/registry/deprecated/db.yaml +++ b/model/registry/deprecated/db.yaml @@ -2,6 +2,7 @@ groups: - id: registry.db.deprecated prefix: db type: attribute_group + display_name: Deprecated Database Attributes brief: > "Describes deprecated db attributes." attributes: @@ -94,6 +95,7 @@ groups: - id: registry.db.metrics.deprecated type: attribute_group + display_name: Deprecated Database Metrics brief: > "Describes deprecated db metrics attributes." attributes: diff --git a/model/registry/deprecated/enduser.yaml b/model/registry/deprecated/enduser.yaml index 8908ec8fbd..54e97dcde6 100644 --- a/model/registry/deprecated/enduser.yaml +++ b/model/registry/deprecated/enduser.yaml @@ -2,6 +2,7 @@ groups: - id: registry.enduser.deprecated prefix: enduser type: attribute_group + display_name: Deprecated End User Attributes brief: Describes deprecated enduser attributes. Complete enduser namespace has been deprecated attributes: - id: id diff --git a/model/registry/deprecated/gen-ai.yaml b/model/registry/deprecated/gen-ai.yaml index ca6abd6732..04a2968a74 100644 --- a/model/registry/deprecated/gen-ai.yaml +++ b/model/registry/deprecated/gen-ai.yaml @@ -2,6 +2,7 @@ groups: - id: registry.gen_ai.deprecated type: attribute_group brief: Describes deprecated `gen_ai` attributes. + display_name: Deprecated GenAI Attributes attributes: - id: gen_ai.usage.prompt_tokens type: int diff --git a/model/registry/deprecated/http.yaml b/model/registry/deprecated/http.yaml index 6fc36ef838..1c35ecdc5e 100644 --- a/model/registry/deprecated/http.yaml +++ b/model/registry/deprecated/http.yaml @@ -1,6 +1,7 @@ groups: - id: registry.http.deprecated type: attribute_group + display_name: Deprecated HTTP Attributes brief: "Describes deprecated HTTP attributes." prefix: http attributes: diff --git a/model/registry/deprecated/ios.yaml b/model/registry/deprecated/ios.yaml index acc1a9f1f9..326a40fcfd 100644 --- a/model/registry/deprecated/ios.yaml +++ b/model/registry/deprecated/ios.yaml @@ -2,6 +2,7 @@ groups: - id: registry.ios.deprecated prefix: ios type: attribute_group + display_name: Deprecated iOS Attributes brief: > The iOS platform on which the iOS application is running. attributes: diff --git a/model/registry/deprecated/k8s.yaml b/model/registry/deprecated/k8s.yaml index e2785dd08e..a928d2d31e 100644 --- a/model/registry/deprecated/k8s.yaml +++ b/model/registry/deprecated/k8s.yaml @@ -1,6 +1,7 @@ groups: - id: registry.k8s.deprecated type: attribute_group + display_name: Deprecated Kubernetes Attributes brief: "Describes deprecated k8s attributes." attributes: - id: k8s.pod.labels diff --git a/model/registry/deprecated/messaging.yaml b/model/registry/deprecated/messaging.yaml index 5f477018ad..c7dd7b05e5 100644 --- a/model/registry/deprecated/messaging.yaml +++ b/model/registry/deprecated/messaging.yaml @@ -1,6 +1,7 @@ groups: - id: registry.messaging.deprecated type: attribute_group + display_name: Deprecated Messaging Attributes brief: "Describes deprecated messaging attributes." attributes: - id: messaging.kafka.destination.partition diff --git a/model/registry/deprecated/network.yaml b/model/registry/deprecated/network.yaml index f13c79f9a9..7487f69adf 100644 --- a/model/registry/deprecated/network.yaml +++ b/model/registry/deprecated/network.yaml @@ -2,6 +2,7 @@ groups: - id: registry.network.deprecated prefix: net type: attribute_group + display_name: Deprecated Network Attributes brief: > These attributes may be used for any network related operation. attributes: diff --git a/model/registry/deprecated/otel.yaml b/model/registry/deprecated/otel.yaml index c52a51fe8c..b0b9cf0a8b 100644 --- a/model/registry/deprecated/otel.yaml +++ b/model/registry/deprecated/otel.yaml @@ -2,6 +2,7 @@ groups: - id: registry.otel.library.deprecated prefix: otel.library type: attribute_group + display_name: Deprecated OTel Library Attributes brief: "Describes deprecated otel.library attributes." attributes: - id: name diff --git a/model/registry/deprecated/process.yaml b/model/registry/deprecated/process.yaml index 33c5adb0cb..1c79cf81b2 100644 --- a/model/registry/deprecated/process.yaml +++ b/model/registry/deprecated/process.yaml @@ -2,6 +2,7 @@ groups: - id: registry.process.deprecated type: attribute_group brief: "Deprecated process attributes." + display_name: Deprecated Process Attributes attributes: - id: process.cpu.state brief: "Deprecated, use `cpu.mode` instead." diff --git a/model/registry/deprecated/rpc.yaml b/model/registry/deprecated/rpc.yaml index 1d9d22c2d4..e4b37f5d2b 100644 --- a/model/registry/deprecated/rpc.yaml +++ b/model/registry/deprecated/rpc.yaml @@ -1,6 +1,7 @@ groups: - id: registry.rpc.deprecated type: attribute_group + display_name: Deprecated RPC Attributes brief: 'Deprecated rpc message attributes.' attributes: - id: message.type diff --git a/model/registry/deprecated/system.yaml b/model/registry/deprecated/system.yaml index d220a501b7..8f2ece9d84 100644 --- a/model/registry/deprecated/system.yaml +++ b/model/registry/deprecated/system.yaml @@ -1,6 +1,7 @@ groups: - id: registry.system.deprecated type: attribute_group + display_name: Deprecated System Attributes brief: "Deprecated system attributes." attributes: - id: system.processes.status diff --git a/model/registry/destination.yaml b/model/registry/destination.yaml index c05a0c992a..a0631c5201 100644 --- a/model/registry/destination.yaml +++ b/model/registry/destination.yaml @@ -2,6 +2,7 @@ groups: - id: registry.destination prefix: destination type: attribute_group + display_name: Destination Attributes brief: > 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. diff --git a/model/registry/device.yaml b/model/registry/device.yaml index 5c324e37fe..901bf1869c 100644 --- a/model/registry/device.yaml +++ b/model/registry/device.yaml @@ -2,6 +2,7 @@ groups: - id: registry.device prefix: device type: attribute_group + display_name: Device Attributes brief: > Describes device attributes. attributes: diff --git a/model/registry/disk.yaml b/model/registry/disk.yaml index aa8c091135..b8dc420351 100644 --- a/model/registry/disk.yaml +++ b/model/registry/disk.yaml @@ -2,6 +2,7 @@ groups: - id: registry.disk prefix: disk type: attribute_group + display_name: Disk Attributes brief: > These attributes may be used for any disk related operation. attributes: diff --git a/model/registry/dns.yaml b/model/registry/dns.yaml index d4042c4add..f58187e0c9 100644 --- a/model/registry/dns.yaml +++ b/model/registry/dns.yaml @@ -1,6 +1,7 @@ groups: - id: registry.dns type: attribute_group + display_name: DNS Attributes prefix: dns brief: > This document defines the shared attributes used to report a DNS query. diff --git a/model/registry/error.yaml b/model/registry/error.yaml index 68bde170ba..95183df639 100644 --- a/model/registry/error.yaml +++ b/model/registry/error.yaml @@ -1,6 +1,7 @@ groups: - id: registry.error type: attribute_group + display_name: Error Attributes prefix: error brief: > This document defines the shared attributes used to report an error. diff --git a/model/registry/event.yaml b/model/registry/event.yaml index 5c246bfdff..0c1e32400e 100644 --- a/model/registry/event.yaml +++ b/model/registry/event.yaml @@ -2,6 +2,7 @@ groups: - id: registry.event prefix: event type: attribute_group + display_name: Event Attributes brief: > Attributes for Events represented using Log Records. attributes: diff --git a/model/registry/exception.yaml b/model/registry/exception.yaml index 70dea3d509..def10422b2 100644 --- a/model/registry/exception.yaml +++ b/model/registry/exception.yaml @@ -1,6 +1,7 @@ groups: - id: registry.exception type: attribute_group + display_name: Exception Attributes prefix: exception brief: > This document defines the shared attributes used to diff --git a/model/registry/faas.yaml b/model/registry/faas.yaml index a4fc8a3d55..6fb139fbf0 100644 --- a/model/registry/faas.yaml +++ b/model/registry/faas.yaml @@ -2,6 +2,7 @@ groups: - id: registry.faas brief: FaaS attributes type: attribute_group + display_name: Function as a Service Attributes prefix: faas attributes: - id: name diff --git a/model/registry/feature-flag.yaml b/model/registry/feature-flag.yaml index 9de106ffc8..1b41ff3898 100644 --- a/model/registry/feature-flag.yaml +++ b/model/registry/feature-flag.yaml @@ -2,6 +2,7 @@ groups: - id: registry.feature_flag prefix: feature_flag type: attribute_group + display_name: Feature Flag Attributes brief: > This document defines attributes for Feature Flags. attributes: diff --git a/model/registry/file.yaml b/model/registry/file.yaml index bbe0f99fd2..57d33a4106 100644 --- a/model/registry/file.yaml +++ b/model/registry/file.yaml @@ -2,6 +2,7 @@ groups: - id: registry.file prefix: file type: attribute_group + display_name: File Attributes brief: "Describes file attributes." attributes: - id: directory diff --git a/model/registry/gcp.yaml b/model/registry/gcp.yaml index 307713df87..66f9273d20 100644 --- a/model/registry/gcp.yaml +++ b/model/registry/gcp.yaml @@ -2,10 +2,12 @@ groups: - id: registry.gcp prefix: gcp type: attribute_group + display_name: GCP Attributes brief: Attributes for Google Cloud - id: registry.gcp.client prefix: gcp.client type: attribute_group + display_name: GCP Client Attributes brief: > Attributes for Google Cloud client libraries. attributes: @@ -22,6 +24,7 @@ groups: - id: registry.gcp.cloud_run prefix: gcp.cloud_run type: attribute_group + display_name: GCP - Google Cloud Run Attributes brief: > This document defines attributes for Google Cloud Run. attributes: @@ -46,6 +49,7 @@ groups: - id: registry.gcp.gce prefix: gcp.gce type: attribute_group + display_name: GCP - Google Compute Engine (GCE) Attributes brief: > This document defines attributes for Google Compute Engine (GCE). attributes: diff --git a/model/registry/gen-ai.yaml b/model/registry/gen-ai.yaml index ce6755a1db..820906f108 100644 --- a/model/registry/gen-ai.yaml +++ b/model/registry/gen-ai.yaml @@ -2,6 +2,7 @@ groups: - id: registry.gen_ai prefix: gen_ai type: attribute_group + display_name: GenAI Attributes brief: > This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses. attributes: diff --git a/model/registry/go.yaml b/model/registry/go.yaml index d599102301..2c3727d5c7 100644 --- a/model/registry/go.yaml +++ b/model/registry/go.yaml @@ -1,6 +1,7 @@ groups: - id: registry.go type: attribute_group + display_name: Go Attributes prefix: go brief: > This document defines Go related attributes. diff --git a/model/registry/graphql.yaml b/model/registry/graphql.yaml index 460444d891..ca015d017f 100644 --- a/model/registry/graphql.yaml +++ b/model/registry/graphql.yaml @@ -2,6 +2,7 @@ groups: - id: registry.graphql prefix: graphql type: attribute_group + display_name: GraphQL Attributes brief: 'This document defines attributes for GraphQL.' attributes: - id: operation.name diff --git a/model/registry/heroku.yaml b/model/registry/heroku.yaml index d9fe99a731..f9ff7a85e2 100644 --- a/model/registry/heroku.yaml +++ b/model/registry/heroku.yaml @@ -2,6 +2,7 @@ groups: - id: registry.heroku prefix: heroku type: attribute_group + display_name: Heroku Attributes brief: > This document defines attributes for the Android platform on which the Android application is running. attributes: diff --git a/model/registry/host.yaml b/model/registry/host.yaml index 332ea01f9c..fd2d3db9e1 100644 --- a/model/registry/host.yaml +++ b/model/registry/host.yaml @@ -2,6 +2,7 @@ groups: - id: registry.host prefix: host type: attribute_group + display_name: Host Attributes brief: > A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array. attributes: diff --git a/model/registry/http.yaml b/model/registry/http.yaml index e013704a49..71583d4767 100644 --- a/model/registry/http.yaml +++ b/model/registry/http.yaml @@ -2,6 +2,7 @@ groups: - id: registry.http prefix: http type: attribute_group + display_name: HTTP Attributes brief: 'This document defines semantic convention attributes in the HTTP namespace.' attributes: - id: request.body.size diff --git a/model/registry/jvm.yaml b/model/registry/jvm.yaml index 5f3b14f7ec..9ec093f5fe 100644 --- a/model/registry/jvm.yaml +++ b/model/registry/jvm.yaml @@ -1,6 +1,7 @@ groups: - id: registry.jvm type: attribute_group + display_name: Java Virtual Machine (JVM) Attributes prefix: jvm brief: > This document defines Java Virtual machine related attributes. diff --git a/model/registry/k8s.yaml b/model/registry/k8s.yaml index 8b7de837f2..50f38b3132 100644 --- a/model/registry/k8s.yaml +++ b/model/registry/k8s.yaml @@ -2,6 +2,7 @@ groups: - id: registry.k8s prefix: k8s type: attribute_group + display_name: Kubernetes Attributes brief: > Kubernetes resource attributes. attributes: diff --git a/model/registry/log.yaml b/model/registry/log.yaml index bc18100451..399ec35b6b 100644 --- a/model/registry/log.yaml +++ b/model/registry/log.yaml @@ -1,6 +1,7 @@ groups: - id: registry.log type: attribute_group + display_name: General Log Attributes prefix: log brief: > This document defines log attributes @@ -23,6 +24,7 @@ groups: - id: registry.log.file # TODO: should we move it to the file model? type: attribute_group + display_name: Log File Attributes prefix: log.file brief: > Attributes for a file to which log was emitted. @@ -54,6 +56,7 @@ groups: - id: registry.log.record type: attribute_group + display_name: Log Record Attributes prefix: log.record brief: > This document defines the generic attributes that may be used in any Log Record. diff --git a/model/registry/messaging.yaml b/model/registry/messaging.yaml index 5c95891653..1c9fe27be2 100644 --- a/model/registry/messaging.yaml +++ b/model/registry/messaging.yaml @@ -2,6 +2,7 @@ groups: - id: registry.messaging prefix: messaging type: attribute_group + display_name: General Messaging Attributes brief: 'Attributes describing telemetry around messaging systems and messaging activities.' attributes: - id: batch.message_count @@ -217,6 +218,7 @@ groups: - id: registry.messaging.kafka prefix: messaging type: attribute_group + display_name: Kafka Attributes brief: > This group describes attributes specific to Apache Kafka. attributes: @@ -244,6 +246,7 @@ groups: - id: registry.messaging.rabbitmq prefix: messaging type: attribute_group + display_name: RabbitMQ Attributes brief: > This group describes attributes specific to RabbitMQ. attributes: @@ -262,6 +265,7 @@ groups: - id: registry.messaging.rocketmq prefix: messaging type: attribute_group + display_name: RocketMQ Attributes brief: > This group describes attributes specific to RocketMQ. attributes: @@ -342,6 +346,7 @@ groups: - id: registry.messaging.gcp_pubsub prefix: messaging type: attribute_group + display_name: GCP Pub/Sub Attributes brief: > This group describes attributes specific to GCP Pub/Sub. attributes: @@ -372,6 +377,7 @@ groups: - id: registry.messaging.servicebus prefix: messaging type: attribute_group + display_name: Azure Service Bus Attributes brief: > This group describes attributes specific to Azure Service Bus. attributes: @@ -413,6 +419,7 @@ groups: - id: registry.messaging.eventhubs prefix: messaging type: attribute_group + display_name: Azure Event Hubs Attributes brief: > This group describes attributes specific to Azure Event Hubs. attributes: diff --git a/model/registry/network.yaml b/model/registry/network.yaml index 2f3f19576c..322c0ddc8c 100644 --- a/model/registry/network.yaml +++ b/model/registry/network.yaml @@ -2,6 +2,7 @@ groups: - id: registry.network prefix: network type: attribute_group + display_name: Network Attributes brief: > These attributes may be used for any network related operation. attributes: diff --git a/model/registry/oci.yaml b/model/registry/oci.yaml index 00d0e28c2b..da0ce6dace 100644 --- a/model/registry/oci.yaml +++ b/model/registry/oci.yaml @@ -2,6 +2,7 @@ groups: - id: registry.oci.manifest prefix: oci.manifest type: attribute_group + display_name: Open Container Initiative (OCI) Attributes brief: > An OCI image manifest. attributes: diff --git a/model/registry/opentracing.yaml b/model/registry/opentracing.yaml index fd9d68e380..c5cafc291e 100644 --- a/model/registry/opentracing.yaml +++ b/model/registry/opentracing.yaml @@ -2,6 +2,7 @@ groups: - id: registry.opentracing prefix: opentracing type: attribute_group + display_name: OpenTracing Attributes brief: Attributes used by the OpenTracing Shim layer. attributes: - id: ref_type diff --git a/model/registry/os.yaml b/model/registry/os.yaml index 3317958f16..18b59568a0 100644 --- a/model/registry/os.yaml +++ b/model/registry/os.yaml @@ -2,6 +2,7 @@ groups: - id: registry.os prefix: os type: attribute_group + display_name: Operating System Attributes brief: > The operating system (OS) on which the process represented by this resource is running. note: > diff --git a/model/registry/otel.yaml b/model/registry/otel.yaml index 76286cdc9b..8ed9405a58 100644 --- a/model/registry/otel.yaml +++ b/model/registry/otel.yaml @@ -2,6 +2,7 @@ groups: - id: registry.otel prefix: otel type: attribute_group + display_name: OTel Attributes brief: Attributes reserved for OpenTelemetry attributes: - id: status_code @@ -26,6 +27,7 @@ groups: - id: registry.otel.scope prefix: otel.scope type: attribute_group + display_name: OTel Scope Attributes brief: Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. attributes: - id: name diff --git a/model/registry/peer.yaml b/model/registry/peer.yaml index a6e38a129d..ee9d3f722f 100644 --- a/model/registry/peer.yaml +++ b/model/registry/peer.yaml @@ -1,6 +1,7 @@ groups: - id: registry.peer type: attribute_group + display_name: Peer Attributes prefix: peer brief: > Operations that access some remote service. diff --git a/model/registry/process.yaml b/model/registry/process.yaml index d9c0575ae7..bc8362357d 100644 --- a/model/registry/process.yaml +++ b/model/registry/process.yaml @@ -2,6 +2,7 @@ groups: - id: registry.process prefix: process type: attribute_group + display_name: Process Attributes brief: > An operating system process. attributes: diff --git a/model/registry/rpc.yaml b/model/registry/rpc.yaml index d1e0aa05cf..8e04df3224 100644 --- a/model/registry/rpc.yaml +++ b/model/registry/rpc.yaml @@ -2,6 +2,7 @@ groups: - id: registry.rpc prefix: rpc type: attribute_group + display_name: Remote Procedure Call (RPC) Attributes brief: 'This document defines attributes for remote procedure calls.' attributes: - id: connect_rpc.error_code diff --git a/model/registry/server.yaml b/model/registry/server.yaml index d6927fe98a..9da2b85ae1 100644 --- a/model/registry/server.yaml +++ b/model/registry/server.yaml @@ -2,6 +2,7 @@ groups: - id: registry.server prefix: server type: attribute_group + display_name: Server Attributes brief: > 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). diff --git a/model/registry/service.yaml b/model/registry/service.yaml index 5af22be57e..44bc2985f6 100644 --- a/model/registry/service.yaml +++ b/model/registry/service.yaml @@ -2,6 +2,7 @@ groups: - id: registry.service prefix: service type: attribute_group + display_name: Service Attributes brief: > A service instance. attributes: diff --git a/model/registry/session.yaml b/model/registry/session.yaml index 3f53c9c6cd..bf39e6ca30 100644 --- a/model/registry/session.yaml +++ b/model/registry/session.yaml @@ -2,6 +2,7 @@ groups: - id: registry.session prefix: session type: attribute_group + display_name: Session Attributes brief: > Session is defined as the period of time encompassing all activities performed by the application and the actions executed by the end user. diff --git a/model/registry/signalr.yaml b/model/registry/signalr.yaml index 879034e7b3..4e87161712 100644 --- a/model/registry/signalr.yaml +++ b/model/registry/signalr.yaml @@ -2,6 +2,7 @@ groups: - id: registry.signalr prefix: signalr type: attribute_group + display_name: SignalR Attributes brief: SignalR attributes attributes: - id: connection.status diff --git a/model/registry/source.yaml b/model/registry/source.yaml index 077da82310..9e0a8af449 100644 --- a/model/registry/source.yaml +++ b/model/registry/source.yaml @@ -2,6 +2,7 @@ groups: - id: registry.source prefix: source type: attribute_group + display_name: Source Attributes brief: > 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. diff --git a/model/registry/system.yaml b/model/registry/system.yaml index 790a1374af..c7d8cbc0d8 100644 --- a/model/registry/system.yaml +++ b/model/registry/system.yaml @@ -3,6 +3,7 @@ groups: - id: registry.system prefix: system type: attribute_group + display_name: General System Attributes brief: "Describes System attributes" attributes: - id: device @@ -14,6 +15,7 @@ groups: - id: registry.system.cpu prefix: system.cpu type: attribute_group + display_name: System CPU Attributes brief: "Describes System CPU attributes" attributes: - id: logical_number @@ -25,6 +27,7 @@ groups: - id: registry.system.memory prefix: system.memory type: attribute_group + display_name: System Memory Attributes brief: "Describes System Memory attributes" attributes: - id: state @@ -54,6 +57,7 @@ groups: - id: registry.system.paging prefix: system.paging type: attribute_group + display_name: System Paging Attributes brief: "Describes System Memory Paging attributes" attributes: - id: state @@ -98,6 +102,7 @@ groups: - id: registry.system.filesystem prefix: system.filesystem type: attribute_group + display_name: Filesystem Attributes brief: "Describes Filesystem attributes" attributes: - id: state @@ -155,6 +160,7 @@ groups: - id: registry.system.network prefix: system.network type: attribute_group + display_name: System Network Attributes brief: "Describes Network attributes" attributes: - id: state @@ -204,6 +210,7 @@ groups: - id: registry.system.process prefix: system.process type: attribute_group + display_name: System Process Attributes brief: "Describes System Process attributes" attributes: - id: status diff --git a/model/registry/telemetry.yaml b/model/registry/telemetry.yaml index 2179330323..97b762377a 100644 --- a/model/registry/telemetry.yaml +++ b/model/registry/telemetry.yaml @@ -2,6 +2,7 @@ groups: - id: registry.telemetry prefix: telemetry type: attribute_group + display_name: Telemetry Attributes brief: > This document defines attributes for telemetry SDK. attributes: diff --git a/model/registry/thread.yaml b/model/registry/thread.yaml index 9c99772b9b..b6f3556107 100644 --- a/model/registry/thread.yaml +++ b/model/registry/thread.yaml @@ -2,6 +2,7 @@ groups: - id: registry.thread prefix: thread type: attribute_group + display_name: Thread Attributes brief: > These attributes may be used for any operation to store information about a thread that started a span. attributes: diff --git a/model/registry/tls.yaml b/model/registry/tls.yaml index 2c4f31a752..f4937dfb78 100644 --- a/model/registry/tls.yaml +++ b/model/registry/tls.yaml @@ -2,6 +2,7 @@ groups: - id: registry.tls prefix: tls type: attribute_group + display_name: TLS Attributes brief: "This document defines semantic convention attributes in the TLS namespace." attributes: - id: cipher diff --git a/model/registry/url.yaml b/model/registry/url.yaml index f979c23a5f..0c808ad5f0 100644 --- a/model/registry/url.yaml +++ b/model/registry/url.yaml @@ -2,6 +2,7 @@ groups: - id: registry.url brief: Attributes describing URL. type: attribute_group + display_name: URL Attributes prefix: url attributes: - id: domain diff --git a/model/registry/user-agent.yaml b/model/registry/user-agent.yaml index 5503454d22..9520c8c5d8 100644 --- a/model/registry/user-agent.yaml +++ b/model/registry/user-agent.yaml @@ -2,6 +2,7 @@ groups: - id: registry.user_agent prefix: user_agent type: attribute_group + display_name: User-agent Attributes brief: "Describes user-agent attributes." attributes: - id: original diff --git a/model/registry/user.yaml b/model/registry/user.yaml index 98792de275..10178f00a8 100644 --- a/model/registry/user.yaml +++ b/model/registry/user.yaml @@ -2,6 +2,7 @@ groups: - id: registry.user prefix: user type: attribute_group + display_name: User Attributes brief: "Describes information about the user." attributes: - id: email diff --git a/model/registry/v8js.yaml b/model/registry/v8js.yaml index a03cbe7143..d39f6e0967 100644 --- a/model/registry/v8js.yaml +++ b/model/registry/v8js.yaml @@ -2,6 +2,7 @@ groups: - id: registry.v8js type: attribute_group brief: Describes V8 JS Engine Runtime related attributes. + display_name: V8 JS Attributes prefix: v8js attributes: - id: gc.type diff --git a/model/registry/webengine.yaml b/model/registry/webengine.yaml index a1579b7d24..97d01e45aa 100644 --- a/model/registry/webengine.yaml +++ b/model/registry/webengine.yaml @@ -2,6 +2,7 @@ groups: - id: registry.webengine prefix: webengine type: attribute_group + display_name: Web Engine Attributes brief: > This document defines the attributes used to describe the packaged software running the application code. attributes: diff --git a/templates/registry/markdown/attribute_macros.j2 b/templates/registry/markdown/attribute_macros.j2 index de9321eae6..7ac1d474c0 100644 --- a/templates/registry/markdown/attribute_macros.j2 +++ b/templates/registry/markdown/attribute_macros.j2 @@ -34,3 +34,10 @@ {%- endif %}{%- elif attribute.type is mapping %} {%- for e in attribute.type.members %}{% if loop.index0 < 3 %}{% if loop.first == false %}; {% endif %}`{{ e.value | trim }}`{% endif %}{%- endfor %} {%- endif %}{% endmacro %} + +{% macro display_name(group) %} +{%- if 'display_name' in group %}{{ group.display_name }} +{%- else %}{{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes +{%- endif %}{% endmacro %} + +{% macro heading_link_fragments(title) %}{{ title | trim | lower | replace(" ", "-") | replace("(", "") | replace(")", "") | replace("/", "") | replace("\\", "") | replace(".", "") | replace("!", "") | replace("?", "") | replace("~", "") | replace("#", "")}}{% endmacro %} diff --git a/templates/registry/markdown/attribute_namespace.md.j2 b/templates/registry/markdown/attribute_namespace.md.j2 index 432943393d..edf210f99d 100644 --- a/templates/registry/markdown/attribute_namespace.md.j2 +++ b/templates/registry/markdown/attribute_namespace.md.j2 @@ -9,6 +9,15 @@ {% import 'attribute_macros.j2' as attrs %} {%- set my_file_name = ctx.id | lower | kebab_case ~ ".md" -%} {{- template.set_file_name(my_file_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 -%} @@ -18,12 +27,12 @@ # {{ ctx.id | title_case | acronym }} -{% if ctx.groups | length > 1 %}{% for group in ctx.groups | sort(attribute="id") %} -{%- set group_name = group.id | split_id | list | reject("eq", "registry") | join(" ") -%} -- [{{ group_name | title_case }}](#{{group_name | kebab_case }}-attributes) -{% endfor %}{% endif %} -{% for group in ctx.groups | sort(attribute="id") %} -## {{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes +{%- if attr_groups | length > 1 %}{% for group in attr_groups %} +- [{{ attrs.display_name(group) }}](#{{ attrs.heading_link_fragments(attrs.display_name(group)) }}) +{%- endfor -%}{%- endif -%} + +{% for group in attr_groups %} +## {{ attrs.display_name(group) }} {{ group.brief }}