groups: - id: registry.gcp.client type: attribute_group display_name: GCP Client Attributes brief: > Attributes for Google Cloud client libraries. attributes: - id: gcp.client.service type: string stability: development brief: Identifies the Google Cloud service for which the official client library is intended. note: > Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. examples: ['appengine', 'run', 'firestore', 'alloydb', 'spanner'] - id: registry.gcp.cloud_run type: attribute_group display_name: GCP - Google Cloud Run Attributes brief: > This document defines attributes for Google Cloud Run. attributes: - id: gcp.cloud_run.job.execution type: string stability: development brief: > The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. examples: ['job-name-xxxx', 'sample-job-mdw84'] - id: gcp.cloud_run.job.task_index type: int stability: development brief: > The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. examples: [0, 1] - id: registry.gcp.apphub type: attribute_group display_name: GCP - AppHub Attributes brief: > This document defines attributes AppHub will apply to resources in GCP. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). attributes: - id: gcp.apphub.application.container type: string stability: development brief: > The container within GCP where the AppHub application is defined. examples: ['projects/my-container-project'] - id: gcp.apphub.application.location type: string stability: development brief: > The GCP zone or region where the application is defined. examples: ['us-central1'] - id: gcp.apphub.application.id type: string stability: development brief: > The name of the application as configured in AppHub. examples: ['my-application'] - id: gcp.apphub.service.id type: string stability: development brief: > The name of the service as configured in AppHub. examples: ['my-service'] - id: gcp.apphub.service.environment_type type: members: - id: production value: "PRODUCTION" brief: Production environment. stability: development - id: staging value: "STAGING" brief: Staging environment. stability: development - id: test value: "TEST" brief: Test environment. stability: development - id: development value: "DEVELOPMENT" brief: Development environment. stability: development stability: development brief: > Environment of a service is the stage of a software lifecycle. note: > [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) - id: gcp.apphub.service.criticality_type type: members: - id: mission_critical value: "MISSION_CRITICAL" brief: Mission critical service. stability: development - id: high value: "HIGH" brief: High impact. stability: development - id: medium value: "MEDIUM" brief: Medium impact. stability: development - id: low value: "LOW" brief: Low impact. stability: development stability: development brief: > Criticality of a service indicates its importance to the business. note: > [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) - id: gcp.apphub.workload.id type: string stability: development brief: > The name of the workload as configured in AppHub. examples: ['my-workload'] - id: gcp.apphub.workload.environment_type type: members: - id: production value: "PRODUCTION" brief: Production environment. stability: development - id: staging value: "STAGING" brief: Staging environment. stability: development - id: test value: "TEST" brief: Test environment. stability: development - id: development value: "DEVELOPMENT" brief: Development environment. stability: development stability: development brief: > Environment of a workload is the stage of a software lifecycle. note: > [See AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1) - id: gcp.apphub.workload.criticality_type type: members: - id: mission_critical value: "MISSION_CRITICAL" brief: Mission critical service. stability: development - id: high value: "HIGH" brief: High impact. stability: development - id: medium value: "MEDIUM" brief: Medium impact. stability: development - id: low value: "LOW" brief: Low impact. stability: development stability: development brief: > Criticality of a workload indicates its importance to the business. note: > [See AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type) - id: registry.gcp.gce type: attribute_group display_name: GCP - Google Compute Engine (GCE) Attributes brief: > This document defines attributes for Google Compute Engine (GCE). attributes: - id: gcp.gce.instance.name type: string stability: development brief: > The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). examples: ['instance-1', 'my-vm-name'] - id: gcp.gce.instance.hostname type: string stability: development brief: > The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). examples: ['my-host1234.example.com', 'sample-vm.us-west1-b.c.my-project.internal']