Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions .chloggen/deployment-environment-stable.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Use this changelog template to create an entry for release notes.

# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: deployment

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Stabilize `deployment.environment.name` attribute.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [3339]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
The `deployment.environment.name` attribute is promoted from development to stable.
10 changes: 5 additions & 5 deletions docs/registry/attributes/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This document defines attributes for software deployments.

| Key | Stability | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- |
| <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` |
| <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` |
| <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` |
| <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` |
| <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` |
Expand All @@ -33,10 +33,10 @@ considered to be identifying the same service:

| Value | Description | Stability |
| --- | --- | --- |
| `development` | Development environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `production` | Production environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `staging` | Staging environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `test` | Testing environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `development` | Development environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `production` | Production environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `staging` | Staging environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `test` | Testing environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

---

Expand Down
10 changes: 5 additions & 5 deletions docs/registry/entities/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- | --- | --- |
| 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` |
Comment thread
Arnav-Bansal marked this conversation as resolved.
| 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` |

**[1] `deployment.environment.name`:** `deployment.environment.name` does not affect the uniqueness constraints defined through
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
Expand All @@ -35,7 +35,7 @@ considered to be identifying the same service:

| Value | Description | Stability |
| --- | --- | --- |
| `development` | Development environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `production` | Production environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `staging` | Staging environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `test` | Testing environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `development` | Development environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `production` | Production environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `staging` | Staging environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `test` | Testing environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
10 changes: 5 additions & 5 deletions docs/resource/deployment-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

| Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
| --- | --- | --- | --- | --- | --- | --- |
| 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` |
| 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` |

**[1] `deployment.environment.name`:** `deployment.environment.name` does not affect the uniqueness constraints defined through
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
Expand All @@ -35,10 +35,10 @@ considered to be identifying the same service:

| Value | Description | Stability |
| --- | --- | --- |
| `development` | Development environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `production` | Production environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `staging` | Staging environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `test` | Testing environment | ![Development](https://img.shields.io/badge/-development-blue) |
| `development` | Development environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `production` | Production environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `staging` | Staging environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `test` | Testing environment | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->
10 changes: 5 additions & 5 deletions model/deployment/registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,20 @@ groups:
- id: production
value: "production"
brief: Production environment
stability: development
stability: stable
- id: staging
value: "staging"
brief: Staging environment
stability: development
stability: stable
- id: test
value: "test"
brief: Testing environment
stability: development
stability: stable
- id: development
value: "development"
brief: Development environment
stability: development
stability: development
stability: stable
stability: stable
brief: >
Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
(aka deployment tier).
Expand Down
Loading