Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Move deployment attributes to the registry #845

Merged
Merged
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ body:
- area:code
- area:container
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ body:
- area:code
- area:container
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ body:
- area:code
- area:container
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Currently, the following namespaces exist:
* [Code](code.md)
* [Container](container.md)
* [DB](db.md) (database)
* [Deployment](deployment.md)
* [Destination](destination.md)
* [Device](device.md)
* [Disk](disk.md)
Expand Down
16 changes: 16 additions & 0 deletions docs/attributes-registry/deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Deployment

## Deployment Attributes
<!-- semconv registry.deployment(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `deployment.environment` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` |

**[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 -->
2 changes: 1 addition & 1 deletion docs/resource/deployment-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<!-- 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). [1] | `staging`; `production` | Recommended |
| [`deployment.environment`](../attributes-registry/deployment.md) | 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.
Expand Down
22 changes: 22 additions & 0 deletions model/registry/deployment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
groups:
- id: registry.deployment
prefix: deployment
type: attribute_group
brief: >
This document defines attributes for software deployments.
attributes:
- id: environment
type: string
stability: experimental
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']
18 changes: 2 additions & 16 deletions model/resource/deployment_environment.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,8 @@
groups:
- id: deployment
prefix: deployment
type: resource
brief: >
The software deployment.
attributes:
- id: environment
type: string
stability: experimental
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']
- ref: deployment.environment
requirement_level: recommended
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
Loading