From d515887174e20a3546e89df5cb5a306231e1424b Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Thu, 5 Sep 2024 14:04:58 +0200 Subject: [PATCH] [chore] Add missing deprecated and briefs for deprecated attributes (#1391) --- docs/attributes-registry/android.md | 6 +++--- docs/attributes-registry/db.md | 2 +- docs/attributes-registry/otel.md | 8 ++++---- model/registry/deprecated/android.yaml | 1 + model/registry/deprecated/db.yaml | 3 +-- model/registry/deprecated/messaging.yaml | 15 +++++---------- model/registry/deprecated/otel.yaml | 8 ++++---- 7 files changed, 19 insertions(+), 24 deletions(-) diff --git a/docs/attributes-registry/android.md b/docs/attributes-registry/android.md index a8c442da77..f9d57b0c34 100644 --- a/docs/attributes-registry/android.md +++ b/docs/attributes-registry/android.md @@ -21,9 +21,9 @@ The Android platform on which the Android application is running. This document defines attributes that represents an occurrence of a lifecycle transition on the Android platform. -| Attribute | Type | Description | Examples | Stability | -| --------------- | ------ | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------- | -| `android.state` | string | Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead. [1] | `created`; `background`; `foreground` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| Attribute | Type | Description | Examples | Stability | +| --------------- | ------ | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `android.state` | string | Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead. [1] | `created`; `background`; `foreground` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `device.app.lifecycle`. | **[1]:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived. diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md index 7f2237aea5..5f869e9c57 100644 --- a/docs/attributes-registry/db.md +++ b/docs/attributes-registry/db.md @@ -206,7 +206,7 @@ This group defines attributes for Elasticsearch. | Attribute | Type | Description | Examples | Stability | | ------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `db.cassandra.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | -| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
"Replaced by `server.address` and `server.port`." | +| `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `server.address` and `server.port`. | | `db.cosmosdb.container` | string | Deprecated, use `db.collection.name` instead. | `mytable` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.collection.name`. | | `db.elasticsearch.cluster.name` | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.namespace`. | | `db.instance.id` | string | Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | `mysql-e26b99z.example.com` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. | diff --git a/docs/attributes-registry/otel.md b/docs/attributes-registry/otel.md index 07ed204dc1..1a41a578a4 100644 --- a/docs/attributes-registry/otel.md +++ b/docs/attributes-registry/otel.md @@ -39,7 +39,7 @@ Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concept 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. | +| Attribute | Type | Description | Examples | Stability | +| ---------------------- | ------ | --------------------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------ | +| `otel.library.name` | string | Deprecated. Use the `otel.scope.name` attribute | `io.opentelemetry.contrib.mongodb` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use the `otel.scope.name` attribute. | +| `otel.library.version` | string | Deprecated. Use the `otel.scope.version` attribute. | `1.0.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Use the `otel.scope.version` attribute. | diff --git a/model/registry/deprecated/android.yaml b/model/registry/deprecated/android.yaml index fdf2018447..3b0c9ce079 100644 --- a/model/registry/deprecated/android.yaml +++ b/model/registry/deprecated/android.yaml @@ -7,6 +7,7 @@ groups: attributes: - id: android.state stability: experimental + deprecated: "Replaced by `device.app.lifecycle`." brief: > Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead. diff --git a/model/registry/deprecated/db.yaml b/model/registry/deprecated/db.yaml index 9f8e56eb48..e8fdf5d667 100644 --- a/model/registry/deprecated/db.yaml +++ b/model/registry/deprecated/db.yaml @@ -9,8 +9,7 @@ groups: type: string brief: 'Deprecated, use `server.address`, `server.port` attributes instead.' stability: experimental - deprecated: > - "Replaced by `server.address` and `server.port`." + deprecated: "Replaced by `server.address` and `server.port`." examples: Server=(localdb)\v11.0;Integrated Security=true; - id: db.jdbc.driver_classname type: string diff --git a/model/registry/deprecated/messaging.yaml b/model/registry/deprecated/messaging.yaml index 8054a9e1ae..02c145f2ce 100644 --- a/model/registry/deprecated/messaging.yaml +++ b/model/registry/deprecated/messaging.yaml @@ -29,8 +29,7 @@ groups: type: string brief: > Deprecated, use `messaging.consumer.group.name` instead. - deprecated: > - Replaced by `messaging.consumer.group.name`. + deprecated: "Replaced by `messaging.consumer.group.name`." stability: experimental examples: 'my-group' - id: messaging.rocketmq.client_group @@ -39,32 +38,28 @@ groups: Deprecated, use `messaging.consumer.group.name` instead. stability: experimental examples: 'myConsumerGroup' - deprecated: > - Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans. + deprecated: "Replaced by `messaging.consumer.group.name` on the consumer spans. No replacement for producer spans." - id: messaging.eventhubs.consumer.group type: string brief: > Deprecated, use `messaging.consumer.group.name` instead. stability: experimental examples: '$Default' - deprecated: > - Replaced by `messaging.consumer.group.name`. + deprecated: "Replaced by `messaging.consumer.group.name`." - id: messaging.servicebus.destination.subscription_name type: string brief: > Deprecated, use `messaging.servicebus.destination.subscription_name` instead. stability: experimental examples: 'subscription-a' - deprecated: > - Replaced by `messaging.servicebus.destination.subscription_name`. + deprecated: "Replaced by `messaging.servicebus.destination.subscription_name`." - id: messaging.kafka.message.offset type: int stability: experimental brief: > Deprecated, use `messaging.kafka.offset` instead. examples: 42 - deprecated: > - Replaced by `messaging.kafka.offset`. + deprecated: "Replaced by `messaging.kafka.offset`." - id: messaging.destination_publish.anonymous type: boolean stability: experimental diff --git a/model/registry/deprecated/otel.yaml b/model/registry/deprecated/otel.yaml index 634eb4ea1d..165fbe043e 100644 --- a/model/registry/deprecated/otel.yaml +++ b/model/registry/deprecated/otel.yaml @@ -6,13 +6,13 @@ groups: attributes: - id: otel.library.name type: string - deprecated: use the `otel.scope.name` attribute. + deprecated: "Use the `otel.scope.name` attribute." stability: experimental - brief: "" + brief: "Deprecated. Use the `otel.scope.name` attribute" examples: ['io.opentelemetry.contrib.mongodb'] - id: otel.library.version type: string - deprecated: use the `otel.scope.version` attribute. + deprecated: "Use the `otel.scope.version` attribute." stability: experimental - brief: "" + brief: "Deprecated. Use the `otel.scope.version` attribute." examples: ['1.0.0']