open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: explain deployment.environment impact on service identity (#481) 

Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
This commit is contained in:
Ben Blackmore 2023-11-07 13:54:51 +01:00 committed by GitHub
parent da1dbb567f
commit 39af37d093
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -100,6 +100,7 @@ stabilized.
- Change the precedence between `:authority` and `Host` headers when populating - Change the precedence between `:authority` and `Host` headers when populating
`server.address` and `server.port` attributes. `server.address` and `server.port` attributes.
([#455](https://github.com/open-telemetry/semantic-conventions/pull/455)) ([#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) ## v1.22.0 (2023-10-12)

10
docs/resource/deployment-environment.md
View File

@ -9,7 +9,15 @@
<!-- semconv deployment --> <!-- semconv deployment -->
| Attribute | Type | Description | Examples | Requirement Level | | 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 --> <!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md

8
model/resource/deployment_environment.yaml
View File

@ -10,4 +10,12 @@ groups:
brief: > brief: >
Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
(aka deployment tier). (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'] examples: ['staging', 'production']