Skip to content

[chore] Show deprecated enum members in docs #2496 #2623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[chore] Show deprecated enum members in docs #2496 #2623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2630373
Show deprecated enum members in docs #2496
thompson-tomo Aug 13, 2025
18c1d3e
Show past values in own section
thompson-tomo Sep 15, 2025
c10e874
Add in briefs for deprecated members
thompson-tomo Sep 15, 2025
b4c953b
Show member values of deprecated attributes the same as deprecated
thompson-tomo Oct 12, 2025
1e78cac
Switch to italic
thompson-tomo Oct 30, 2025
b2b4842
Back out brief fixes
thompson-tomo Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions docs/cicd/cicd-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down Expand Up @@ -450,6 +459,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down Expand Up @@ -534,6 +552,15 @@ revision based on the VCS system and situational context.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down Expand Up @@ -618,6 +645,15 @@ revision based on the VCS system and situational context.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down Expand Up @@ -656,6 +692,15 @@ This metric is [recommended][MetricRecommended].
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down Expand Up @@ -704,6 +749,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

---

`vcs.ref.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand Down Expand Up @@ -793,6 +847,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

---

`vcs.ref.base.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand Down Expand Up @@ -881,6 +944,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

---

`vcs.ref.base.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand Down Expand Up @@ -963,6 +1035,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

---

`vcs.ref.head.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand Down Expand Up @@ -1019,6 +1100,15 @@ the same backends.
| `github` | [GitHub](https://github.com) | ![Development](https://img.shields.io/badge/-development-blue) |
| `gitlab` | [GitLab](https://gitlab.com) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `gittea` | [Gitea](https://gitea.io) | Use `gitea` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
9 changes: 9 additions & 0 deletions docs/gen-ai/gen-ai-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,15 @@ applicable `aws.bedrock.*` attributes and are not expected to include
| `input` | Input tokens (prompt, input, etc.) | ![Development](https://img.shields.io/badge/-development-blue) |
| `output` | Output tokens (completion, response, etc.) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `output` | Output tokens (completion, response, etc.) | Use `output` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
20 changes: 20 additions & 0 deletions docs/messaging/azure-messaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

---

`messaging.servicebus.disposition_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.
Expand Down Expand Up @@ -272,6 +282,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/gcp-pubsub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/messaging-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,16 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

---

`messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/messaging-spans.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

---

`messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/rabbitmq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/rocketmq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

---

`messaging.rocketmq.consumption_model` 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.
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/sns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
10 changes: 10 additions & 0 deletions docs/messaging/sqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ and SHOULD be provided **at span creation time** (if provided at all):
| `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Development](https://img.shields.io/badge/-development-blue) |
| `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `deliver` | Deprecated. Use `process` instead. | Use `process` value instead. |
| `publish` | Deprecated. Use `send` instead. | Use `send` value instead. |

</details>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand Down
13 changes: 9 additions & 4 deletions docs/registry/attributes/android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,13 @@ This document defines attributes that represents an occurrence of a lifecycle tr

`android.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 |
<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | ![Development](https://img.shields.io/badge/-development-blue) |
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Development](https://img.shields.io/badge/-development-blue) |
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Development](https://img.shields.io/badge/-development-blue) |
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | Use `background` value for `android.app.state` attribute instead. |
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | Use `created` value for `android.app.state` attribute instead. |
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | Use `foreground` value for `android.app.state` attribute instead. |

</details>
15 changes: 15 additions & 0 deletions docs/registry/attributes/cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,21 @@ The following well-known definitions MUST be used if you set this attribute and
| `tencent_cloud_eks` | Tencent Cloud Elastic Kubernetes Service (EKS) | ![Development](https://img.shields.io/badge/-development-blue) |
| `tencent_cloud_scf` | Tencent Cloud Serverless Cloud Function (SCF) | ![Development](https://img.shields.io/badge/-development-blue) |

<details>
<summary><i>Deprecated Values:</i></summary>

| Value | Description | Deprecation Explanation |
|---|---|---|
| `azure_aks` | Azure Kubernetes Service | Use `azure.aks` value instead. |
| `azure_app_service` | Azure App Service | Use `azure.app_service` value instead. |
| `azure_container_apps` | Azure Container Apps | Use `azure.container_apps` value instead. |
| `azure_container_instances` | Azure Container Instances | Use `azure.container_instances` value instead. |
| `azure_functions` | Azure Functions | Use `azure.functions` value instead. |
| `azure_openshift` | Azure Red Hat OpenShift | Use `azure.openshift` value instead. |
| `azure_vm` | Azure Virtual Machines | Use `azure.vm` value instead. |

</details>

---

`cloud.provider` 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.
Expand Down
Loading
Loading