Skip to content

Commit 4fdfcee

Browse files
committed
Stabilize deployment.environment.name attribute
1 parent 4ff951a commit 4fdfcee

File tree

5 files changed

+29
-14
lines changed

5 files changed

+29
-14
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: enhancement
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: deployment
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Stabilize `deployment.environment.name` attribute.
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: []
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext: |
23+
The `deployment.environment.name` attribute is promoted from development to stable.

docs/registry/attributes/deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document defines attributes for software deployments.
1414

1515
| Key | Stability | Value Type | Description | Example Values |
1616
| --- | --- | --- | --- | --- |
17-
| <a id="deployment-environment-name" href="#deployment-environment-name">`deployment.environment.name`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
17+
| <a id="deployment-environment-name" href="#deployment-environment-name">`deployment.environment.name`</a> | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
1818
| <a id="deployment-id" href="#deployment-id">`deployment.id`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The id of the deployment. | `1208` |
1919
| <a id="deployment-name" href="#deployment-name">`deployment.name`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the deployment. | `deploy my app`; `deploy-frontend` |
2020
| <a id="deployment-status" href="#deployment-status">`deployment.status`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The status of the deployment. | `failed`; `succeeded` |

docs/registry/entities/deployment.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,17 @@
55

66
## Deployment
77

8-
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
8+
**Status:** ![Stable](https://img.shields.io/badge/-stable-lightgreen)
99

1010
**type:** `deployment`
1111

1212
**Description:** The software deployment.
1313

14-
> [!warning]
15-
> This entity definition contains attributes without a role.
16-
> Stable Entities MUST NOT have attributes without a defined role.
17-
1814
**Attributes:**
1915

2016
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
2117
| --- | --- | --- | --- | --- | --- | --- |
22-
| Other | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
18+
| Other | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
2319

2420
**[1] `deployment.environment.name`:** `deployment.environment.name` does not affect the uniqueness constraints defined through
2521
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.

docs/resource/deployment-environment.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,17 @@
55
<!-- see templates/registry/markdown/snippet.md.j2 -->
66
<!-- prettier-ignore-start -->
77

8-
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
8+
**Status:** ![Stable](https://img.shields.io/badge/-stable-lightgreen)
99

1010
**type:** `deployment`
1111

1212
**Description:** The software deployment.
1313

14-
> [!warning]
15-
> This entity definition contains attributes without a role.
16-
> Stable Entities MUST NOT have attributes without a defined role.
17-
1814
**Attributes:**
1915

2016
| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
2117
| --- | --- | --- | --- | --- | --- | --- |
22-
| Other | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
18+
| Other | [`deployment.environment.name`](/docs/registry/attributes/deployment.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |
2319

2420
**[1] `deployment.environment.name`:** `deployment.environment.name` does not affect the uniqueness constraints defined through
2521
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.

model/deployment/registry.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ groups:
3333
stability: development
3434
- id: deployment.environment.name
3535
type: string
36-
stability: development
36+
stability: stable
3737
brief: >
3838
Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
3939
(aka deployment tier).

0 commit comments

Comments
 (0)