Skip to content

Commit

Permalink
docs: explain deployment.environment impact on service identity (#481)
Browse files Browse the repository at this point in the history
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
  • Loading branch information
3 people authored Nov 7, 2023
1 parent da1dbb5 commit 39af37d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ stabilized.
- Change the precedence between `:authority` and `Host` headers when populating
`server.address` and `server.port` attributes.
([#455](https://github.com/open-telemetry/semantic-conventions/pull/455))
- Explain `deployment.environment` impact on service identity. ([#481](https://github.com/open-telemetry/semantic-conventions/pull/481))

## v1.22.0 (2023-10-12)

Expand Down
10 changes: 9 additions & 1 deletion docs/resource/deployment-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@
<!-- semconv deployment -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `deployment.environment` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). | `staging`; `production` | Recommended |
| `deployment.environment` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` | Recommended |

**[1]:** `deployment.environment` 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=production`
* `service.name=frontend`, `deployment.environment=staging`.
<!-- endsemconv -->

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md
8 changes: 8 additions & 0 deletions model/resource/deployment_environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,12 @@ groups:
brief: >
Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
(aka deployment tier).
note: |
`deployment.environment` 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=production`
* `service.name=frontend`, `deployment.environment=staging`.
examples: ['staging', 'production']

0 comments on commit 39af37d

Please sign in to comment.