semantic-conventions/docs/attributes-registry/deployment.md

<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Deployment

- [Deployment Attributes](#deployment-attributes)
- [Deployment Deprecated Attributes](#deployment-deprecated-attributes)

## Deployment Attributes

This document defines attributes for software deployments.

| Attribute                     | Type   | Description                                                                                                        | Examples                           | Stability                                                        |
| ----------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | ---------------------------------------------------------------- |
| `deployment.environment.name` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production`            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `deployment.id`               | string | The id of the deployment.                                                                                          | `1208`                             | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `deployment.name`             | string | The name of the deployment.                                                                                        | `deploy my app`; `deploy-frontend` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `deployment.status`           | string | The status of the deployment.                                                                                      | `failed`; `succeeded`              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** `deployment.environment.name` does not affect the uniqueness constraints defined through
the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
This implies that resources carrying the following attribute combinations MUST be
considered to be identifying the same service:

- `service.name=frontend`, `deployment.environment.name=production`
- `service.name=frontend`, `deployment.environment.name=staging`.

`deployment.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.

| Value       | Description | Stability                                                        |
| ----------- | ----------- | ---------------------------------------------------------------- |
| `failed`    | failed      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `succeeded` | succeeded   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Deployment Deprecated Attributes

"Describes deprecated deployment attributes."

| Attribute                | Type   | Description                                              | Examples                | Stability                                                                                                             |
| ------------------------ | ------ | -------------------------------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `deployment.environment` | string | 'Deprecated, use `deployment.environment.name` instead.' | `staging`; `production` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `deployment.environment.name` instead. |