|
| 1 | +# Google Cloud AppHub |
| 2 | + |
| 3 | +**Status**: [Development][DocumentStatus] |
| 4 | + |
| 5 | +These conventions are used by Google Cloud when using [AppHub](https://cloud.google.com/app-hub/docs/overview). Observability |
| 6 | +data from Google Cloud will be annotated with these resource types, depending |
| 7 | +on the source of telemetry. For example, metrics coming from a Google Cloud |
| 8 | +service will be annotated with the appropriate `gcp.apphub.application` and |
| 9 | +`gcp.apphub.service` as configured in AppHub. |
| 10 | + |
| 11 | +See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resources) for what data will be annotated by Google Cloud. |
| 12 | + |
| 13 | +## Application |
| 14 | + |
| 15 | +<!-- semconv resource.gcp.apphub.application --> |
| 16 | +<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> |
| 17 | +<!-- see templates/registry/markdown/snippet.md.j2 --> |
| 18 | +<!-- prettier-ignore-start --> |
| 19 | +<!-- markdownlint-capture --> |
| 20 | +<!-- markdownlint-disable --> |
| 21 | + |
| 22 | + |
| 23 | +**Status:**  |
| 24 | + |
| 25 | +**type:** `gcp.apphub.application` |
| 26 | + |
| 27 | +**Description:** Attributes denoting data from an Application in AppHub. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). |
| 28 | + |
| 29 | +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |
| 30 | +|---|---|---|---|---|---| |
| 31 | +| [`gcp.apphub.application.container`](/docs/attributes-registry/gcp.md) | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` | `Required` |  | |
| 32 | +| [`gcp.apphub.application.id`](/docs/attributes-registry/gcp.md) | string | The name of the application as configured in AppHub. | `my-application` | `Required` |  | |
| 33 | +| [`gcp.apphub.application.location`](/docs/attributes-registry/gcp.md) | string | The GCP zone or region where the application is defined. | `us-central1` | `Required` |  | |
| 34 | + |
| 35 | +<!-- markdownlint-restore --> |
| 36 | +<!-- prettier-ignore-end --> |
| 37 | +<!-- END AUTOGENERATED TEXT --> |
| 38 | +<!-- endsemconv --> |
| 39 | + |
| 40 | +## Service |
| 41 | + |
| 42 | +<!-- semconv resource.gcp.apphub.service --> |
| 43 | +<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> |
| 44 | +<!-- see templates/registry/markdown/snippet.md.j2 --> |
| 45 | +<!-- prettier-ignore-start --> |
| 46 | +<!-- markdownlint-capture --> |
| 47 | +<!-- markdownlint-disable --> |
| 48 | + |
| 49 | + |
| 50 | +**Status:**  |
| 51 | + |
| 52 | +**type:** `gcp.apphub.service` |
| 53 | + |
| 54 | +**Description:** Attributes denoting data from a Service in AppHub. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). |
| 55 | + |
| 56 | +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |
| 57 | +|---|---|---|---|---|---| |
| 58 | +| [`gcp.apphub.service.criticality_type`](/docs/attributes-registry/gcp.md) | string | Criticality of a service indicates its importance to the business. [1] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | `Required` |  | |
| 59 | +| [`gcp.apphub.service.environment_type`](/docs/attributes-registry/gcp.md) | string | Environment of a service is the stage of a software lifecycle. [2] | `PRODUCTION`; `STAGING`; `TEST` | `Required` |  | |
| 60 | +| [`gcp.apphub.service.id`](/docs/attributes-registry/gcp.md) | string | The name of the service as configured in AppHub. | `my-service` | `Required` |  | |
| 61 | + |
| 62 | +**[1] `gcp.apphub.service.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) |
| 63 | + |
| 64 | +**[2] `gcp.apphub.service.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +`gcp.apphub.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. |
| 69 | + |
| 70 | +| Value | Description | Stability | |
| 71 | +|---|---|---| |
| 72 | +| `HIGH` | High impact. |  | |
| 73 | +| `LOW` | Low impact. |  | |
| 74 | +| `MEDIUM` | Medium impact. |  | |
| 75 | +| `MISSION_CRITICAL` | Mission critical service. |  | |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +`gcp.apphub.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. |
| 80 | + |
| 81 | +| Value | Description | Stability | |
| 82 | +|---|---|---| |
| 83 | +| `DEVELOPMENT` | Development environment. |  | |
| 84 | +| `PRODUCTION` | Production environment. |  | |
| 85 | +| `STAGING` | Staging environment. |  | |
| 86 | +| `TEST` | Test environment. |  | |
| 87 | + |
| 88 | +<!-- markdownlint-restore --> |
| 89 | +<!-- prettier-ignore-end --> |
| 90 | +<!-- END AUTOGENERATED TEXT --> |
| 91 | +<!-- endsemconv --> |
| 92 | + |
| 93 | +## Workload |
| 94 | + |
| 95 | +<!-- semconv resource.gcp.apphub.workload --> |
| 96 | +<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> |
| 97 | +<!-- see templates/registry/markdown/snippet.md.j2 --> |
| 98 | +<!-- prettier-ignore-start --> |
| 99 | +<!-- markdownlint-capture --> |
| 100 | +<!-- markdownlint-disable --> |
| 101 | + |
| 102 | + |
| 103 | +**Status:**  |
| 104 | + |
| 105 | +**type:** `gcp.apphub.workload` |
| 106 | + |
| 107 | +**Description:** Attributes denoting data from a Workload in AppHub. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). |
| 108 | + |
| 109 | +| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |
| 110 | +|---|---|---|---|---|---| |
| 111 | +| [`gcp.apphub.workload.criticality_type`](/docs/attributes-registry/gcp.md) | string | Criticality of a workload indicates its importance to the business. [1] | `MISSION_CRITICAL`; `HIGH`; `MEDIUM` | `Required` |  | |
| 112 | +| [`gcp.apphub.workload.environment_type`](/docs/attributes-registry/gcp.md) | string | Environment of a workload is the stage of a software lifecycle. [2] | `PRODUCTION`; `STAGING`; `TEST` | `Required` |  | |
| 113 | +| [`gcp.apphub.workload.id`](/docs/attributes-registry/gcp.md) | string | The name of the workload as configured in AppHub. | `my-workload` | `Required` |  | |
| 114 | + |
| 115 | +**[1] `gcp.apphub.workload.criticality_type`:** [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) |
| 116 | + |
| 117 | +**[2] `gcp.apphub.workload.environment_type`:** [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +`gcp.apphub.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. |
| 122 | + |
| 123 | +| Value | Description | Stability | |
| 124 | +|---|---|---| |
| 125 | +| `HIGH` | High impact. |  | |
| 126 | +| `LOW` | Low impact. |  | |
| 127 | +| `MEDIUM` | Medium impact. |  | |
| 128 | +| `MISSION_CRITICAL` | Mission critical service. |  | |
| 129 | + |
| 130 | +--- |
| 131 | + |
| 132 | +`gcp.apphub.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. |
| 133 | + |
| 134 | +| Value | Description | Stability | |
| 135 | +|---|---|---| |
| 136 | +| `DEVELOPMENT` | Development environment. |  | |
| 137 | +| `PRODUCTION` | Production environment. |  | |
| 138 | +| `STAGING` | Staging environment. |  | |
| 139 | +| `TEST` | Test environment. |  | |
| 140 | + |
| 141 | +<!-- markdownlint-restore --> |
| 142 | +<!-- prettier-ignore-end --> |
| 143 | +<!-- END AUTOGENERATED TEXT --> |
| 144 | +<!-- endsemconv --> |
| 145 | + |
| 146 | +[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status |
0 commit comments