Skip to content

Commit 9759d81

Browse files
Document 'gcp.apphub_destination.*' attributes. (#2663)
1 parent 6db52d9 commit 9759d81

File tree

4 files changed

+196
-0
lines changed

4 files changed

+196
-0
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
change_type: enhancement
2+
component: gcp
3+
note: Document `gcp.apphub_destination.*` attributes
4+
issues: [2649]

docs/registry/attributes/gcp.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# GCP
55

66
- [GCP - AppHub Attributes](#gcp---apphub-attributes)
7+
- [GCP - AppHub Destination Attributes](#gcp---apphub-destination-attributes)
78
- [GCP Client Attributes](#gcp-client-attributes)
89
- [GCP - Google Cloud Run Attributes](#gcp---google-cloud-run-attributes)
910
- [GCP - Google Compute Engine (GCE) Attributes](#gcp---google-compute-engine-gce-attributes)
@@ -76,6 +77,66 @@ This document defines attributes AppHub will apply to resources in GCP. See [App
7677
| `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) |
7778
| `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) |
7879

80+
## GCP - AppHub Destination Attributes
81+
82+
This document defines attributes AppHub will apply to destination resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview).
83+
84+
| Attribute | Type | Description | Examples | Stability |
85+
|---|---|---|---|---|
86+
| <a id="gcp-apphub-destination-application-container" href="#gcp-apphub-destination-application-container">`gcp.apphub_destination.application.container`</a> | string | The container within GCP where the AppHub destination application is defined. | `projects/my-container-project` | ![Development](https://img.shields.io/badge/-development-blue) |
87+
| <a id="gcp-apphub-destination-application-id" href="#gcp-apphub-destination-application-id">`gcp.apphub_destination.application.id`</a> | string | The name of the destination application as configured in AppHub. | `my-application` | ![Development](https://img.shields.io/badge/-development-blue) |
88+
| <a id="gcp-apphub-destination-application-location" href="#gcp-apphub-destination-application-location">`gcp.apphub_destination.application.location`</a> | string | The GCP zone or region where the destination application is defined. | `us-central1` | ![Development](https://img.shields.io/badge/-development-blue) |
89+
| <a id="gcp-apphub-destination-service-criticality-type" href="#gcp-apphub-destination-service-criticality-type">`gcp.apphub_destination.service.criticality_type`</a> | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) |
90+
| <a id="gcp-apphub-destination-service-environment-type" href="#gcp-apphub-destination-service-environment-type">`gcp.apphub_destination.service.environment_type`</a> | string | Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) |
91+
| <a id="gcp-apphub-destination-service-id" href="#gcp-apphub-destination-service-id">`gcp.apphub_destination.service.id`</a> | string | The name of the destination service as configured in AppHub. | `my-service` | ![Development](https://img.shields.io/badge/-development-blue) |
92+
| <a id="gcp-apphub-destination-workload-criticality-type" href="#gcp-apphub-destination-workload-criticality-type">`gcp.apphub_destination.workload.criticality_type`</a> | string | Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | ![Development](https://img.shields.io/badge/-development-blue) |
93+
| <a id="gcp-apphub-destination-workload-environment-type" href="#gcp-apphub-destination-workload-environment-type">`gcp.apphub_destination.workload.environment_type`</a> | string | Environment of a destination workload is the stage of a software lifecycle as provided in the [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) | `PRODUCTION`; `STAGING`; `TEST` | ![Development](https://img.shields.io/badge/-development-blue) |
94+
| <a id="gcp-apphub-destination-workload-id" href="#gcp-apphub-destination-workload-id">`gcp.apphub_destination.workload.id`</a> | string | The name of the destination workload as configured in AppHub. | `my-workload` | ![Development](https://img.shields.io/badge/-development-blue) |
95+
96+
---
97+
98+
`gcp.apphub_destination.service.criticality_type` 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.
99+
100+
| Value | Description | Stability |
101+
|---|---|---|
102+
| `HIGH` | High impact. | ![Development](https://img.shields.io/badge/-development-blue) |
103+
| `LOW` | Low impact. | ![Development](https://img.shields.io/badge/-development-blue) |
104+
| `MEDIUM` | Medium impact. | ![Development](https://img.shields.io/badge/-development-blue) |
105+
| `MISSION_CRITICAL` | Mission critical service. | ![Development](https://img.shields.io/badge/-development-blue) |
106+
107+
---
108+
109+
`gcp.apphub_destination.service.environment_type` 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.
110+
111+
| Value | Description | Stability |
112+
|---|---|---|
113+
| `DEVELOPMENT` | Development environment. | ![Development](https://img.shields.io/badge/-development-blue) |
114+
| `PRODUCTION` | Production environment. | ![Development](https://img.shields.io/badge/-development-blue) |
115+
| `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) |
116+
| `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) |
117+
118+
---
119+
120+
`gcp.apphub_destination.workload.criticality_type` 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.
121+
122+
| Value | Description | Stability |
123+
|---|---|---|
124+
| `HIGH` | High impact. | ![Development](https://img.shields.io/badge/-development-blue) |
125+
| `LOW` | Low impact. | ![Development](https://img.shields.io/badge/-development-blue) |
126+
| `MEDIUM` | Medium impact. | ![Development](https://img.shields.io/badge/-development-blue) |
127+
| `MISSION_CRITICAL` | Mission critical service. | ![Development](https://img.shields.io/badge/-development-blue) |
128+
129+
---
130+
131+
`gcp.apphub_destination.workload.environment_type` 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.
132+
133+
| Value | Description | Stability |
134+
|---|---|---|
135+
| `DEVELOPMENT` | Development environment. | ![Development](https://img.shields.io/badge/-development-blue) |
136+
| `PRODUCTION` | Production environment. | ![Development](https://img.shields.io/badge/-development-blue) |
137+
| `STAGING` | Staging environment. | ![Development](https://img.shields.io/badge/-development-blue) |
138+
| `TEST` | Test environment. | ![Development](https://img.shields.io/badge/-development-blue) |
139+
79140
## GCP Client Attributes
80141

81142
Attributes for Google Cloud client libraries.

docs/resource/cloud-provider/gcp/apphub.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ on the source of telemetry. For example, metrics coming from a Google Cloud
88
service will be annotated with the appropriate `gcp.apphub.application` and
99
`gcp.apphub.service` as configured in AppHub.
1010

11+
Note that each `gcp.apphub.*` attribute has a corresponding `gcp.apphub_destination.*` attribute, describing the
12+
destination/dependency application/service/workload for telemetry which can reference more than one AppHub component.
13+
For example, `CLIENT` spans may contain both `gcp.apphub.*` attributes describing the application where the client
14+
operation was running as well as `gcp.apphub_destination.*` attributes describing the application that it is talking to.
15+
1116
See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resources) for what data will be annotated by Google Cloud.
1217

1318
## Application

model/gcp/registry.yaml

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,132 @@ groups:
172172
Criticality of a workload indicates its importance to the business.
173173
note: >
174174
[See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type)
175+
- id: registry.gcp.apphub_destination
176+
type: attribute_group
177+
display_name: GCP - AppHub Destination Attributes
178+
brief: >
179+
This document defines attributes AppHub will apply to destination resources in GCP.
180+
See [AppHub overview](https://cloud.google.com/app-hub/docs/overview).
181+
attributes:
182+
- id: gcp.apphub_destination.application.container
183+
type: string
184+
stability: development
185+
brief: >
186+
The container within GCP where the AppHub destination application is defined.
187+
examples: ['projects/my-container-project']
188+
- id: gcp.apphub_destination.application.location
189+
type: string
190+
stability: development
191+
brief: >
192+
The GCP zone or region where the destination application is defined.
193+
examples: ['us-central1']
194+
- id: gcp.apphub_destination.application.id
195+
type: string
196+
stability: development
197+
brief: >
198+
The name of the destination application as configured in AppHub.
199+
examples: ['my-application']
200+
- id: gcp.apphub_destination.service.id
201+
type: string
202+
stability: development
203+
brief: >
204+
The name of the destination service as configured in AppHub.
205+
examples: ['my-service']
206+
- id: gcp.apphub_destination.service.environment_type
207+
type:
208+
members:
209+
- id: production
210+
value: "PRODUCTION"
211+
brief: Production environment.
212+
stability: development
213+
- id: staging
214+
value: "STAGING"
215+
brief: Staging environment.
216+
stability: development
217+
- id: test
218+
value: "TEST"
219+
brief: Test environment.
220+
stability: development
221+
- id: development
222+
value: "DEVELOPMENT"
223+
brief: Development environment.
224+
stability: development
225+
stability: development
226+
brief: >
227+
Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1)
228+
- id: gcp.apphub_destination.service.criticality_type
229+
type:
230+
members:
231+
- id: mission_critical
232+
value: "MISSION_CRITICAL"
233+
brief: Mission critical service.
234+
stability: development
235+
- id: high
236+
value: "HIGH"
237+
brief: High impact.
238+
stability: development
239+
- id: medium
240+
value: "MEDIUM"
241+
brief: Medium impact.
242+
stability: development
243+
- id: low
244+
value: "LOW"
245+
brief: Low impact.
246+
stability: development
247+
stability: development
248+
brief: >
249+
Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type)
250+
- id: gcp.apphub_destination.workload.id
251+
type: string
252+
stability: development
253+
brief: >
254+
The name of the destination workload as configured in AppHub.
255+
examples: ['my-workload']
256+
- id: gcp.apphub_destination.workload.environment_type
257+
type:
258+
members:
259+
- id: production
260+
value: "PRODUCTION"
261+
brief: Production environment.
262+
stability: development
263+
- id: staging
264+
value: "STAGING"
265+
brief: Staging environment.
266+
stability: development
267+
- id: test
268+
value: "TEST"
269+
brief: Test environment.
270+
stability: development
271+
- id: development
272+
value: "DEVELOPMENT"
273+
brief: Development environment.
274+
stability: development
275+
stability: development
276+
brief: >
277+
Environment of a destination workload is the stage of a software lifecycle as provided in the
278+
[AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1)
279+
- id: gcp.apphub_destination.workload.criticality_type
280+
type:
281+
members:
282+
- id: mission_critical
283+
value: "MISSION_CRITICAL"
284+
brief: Mission critical service.
285+
stability: development
286+
- id: high
287+
value: "HIGH"
288+
brief: High impact.
289+
stability: development
290+
- id: medium
291+
value: "MEDIUM"
292+
brief: Medium impact.
293+
stability: development
294+
- id: low
295+
value: "LOW"
296+
brief: Low impact.
297+
stability: development
298+
stability: development
299+
brief: >
300+
Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type)
175301
- id: registry.gcp.gce
176302
type: attribute_group
177303
display_name: GCP - Google Compute Engine (GCE) Attributes

0 commit comments

Comments
 (0)