Skip to content

Commit

Permalink
[chore] Add missing deprecated and briefs for deprecated attributes (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
joaopgrassi authored Sep 5, 2024
1 parent d73e44d commit d515887
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 24 deletions.
6 changes: 3 additions & 3 deletions docs/attributes-registry/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br>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.

Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br>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)<br>"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)<br>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)<br>Replaced by `db.collection.name`. |
| `db.elasticsearch.cluster.name` | string | Deprecated, use `db.namespace` instead. | `e9106fc68e3044f0b1475b04bf4ffd5f` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>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)<br>Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. |
Expand Down
8 changes: 4 additions & 4 deletions docs/attributes-registry/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br>use the `otel.scope.name` attribute. |
| `otel.library.version` | string | | `1.0.0` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>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)<br>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)<br>Use the `otel.scope.version` attribute. |
1 change: 1 addition & 0 deletions model/registry/deprecated/android.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions model/registry/deprecated/db.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 5 additions & 10 deletions model/registry/deprecated/messaging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions model/registry/deprecated/otel.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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']

0 comments on commit d515887

Please sign in to comment.