semantic-conventions/model/deployment/registry.yaml at 884d62d1ed3852b7bb804ce1a28c1118c575599e · Arnav-Bansal/semantic-conventions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
groups:
  - id: registry.deployment
    type: attribute_group
    display_name: Deployment Attributes
    brief: >
      This document defines attributes for software deployments.
    attributes:
      - id: deployment.name
        type: string
        stability: development
        brief: >
          The name of the deployment.
        examples: ["deploy my app", "deploy-frontend"]
      - id: deployment.id
        type: string
        stability: development
        brief: >
          The id of the deployment.
        examples: ["1208"]
      - id: deployment.status
        type:
          members:
            - id: failed
              value: failed
              brief: failed
              stability: development
            - id: succeeded
              value: succeeded
              brief: succeeded
              stability: development
        brief: >
          The status of the deployment.
        stability: development
      - id: deployment.environment.name
        type:
          members:
            - id: production
              value: "production"
              brief: Production environment
              stability: stable
            - id: staging
              value: "staging"
              brief: Staging environment
              stability: stable
            - id: test
              value: "test"
              brief: Testing environment
              stability: stable
            - id: development
              value: "development"
              brief: Development environment
              stability: stable
        stability: stable
        brief: >
          Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
          (aka deployment tier).
        note: |
          `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`.
        examples: ["staging", "production"]