semantic-conventions/docs/registry/entities/gcp.md

10 KiB

GCP

GCP Apphub Application

Status: Development

type: gcp.apphub.application

Description: Attributes denoting data from an Application in AppHub. See AppHub overview.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
gcp.apphub.application.container string The container within GCP where the AppHub application is defined. projects/my-container-project Required Development
gcp.apphub.application.id string The name of the application as configured in AppHub. my-application Required Development
gcp.apphub.application.location string The GCP zone or region where the application is defined. us-central1 Required Development

GCP Apphub Service

Status: Development

type: gcp.apphub.service

Description: Attributes denoting data from a Service in AppHub. See AppHub overview.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
gcp.apphub.service.criticality_type string Criticality of a service indicates its importance to the business. [1] MISSION_CRITICAL; HIGH; MEDIUM Required Development
gcp.apphub.service.environment_type string Environment of a service is the stage of a software lifecycle. [2] PRODUCTION; STAGING; TEST Required Development
gcp.apphub.service.id string The name of the service as configured in AppHub. my-service Required Development

[1] gcp.apphub.service.criticality_type: See AppHub type enum

[2] gcp.apphub.service.environment_type: See AppHub environment type


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.

Value Description Stability
HIGH High impact. Development
LOW Low impact. Development
MEDIUM Medium impact. Development
MISSION_CRITICAL Mission critical service. Development

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.

Value Description Stability
DEVELOPMENT Development environment. Development
PRODUCTION Production environment. Development
STAGING Staging environment. Development
TEST Test environment. Development

GCP Apphub Workload

Status: Development

type: gcp.apphub.workload

Description: Attributes denoting data from a Workload in AppHub. See AppHub overview.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
gcp.apphub.workload.criticality_type string Criticality of a workload indicates its importance to the business. [3] MISSION_CRITICAL; HIGH; MEDIUM Required Development
gcp.apphub.workload.environment_type string Environment of a workload is the stage of a software lifecycle. [4] PRODUCTION; STAGING; TEST Required Development
gcp.apphub.workload.id string The name of the workload as configured in AppHub. my-workload Required Development

[3] gcp.apphub.workload.criticality_type: See AppHub type enum

[4] gcp.apphub.workload.environment_type: See AppHub environment type


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.

Value Description Stability
HIGH High impact. Development
LOW Low impact. Development
MEDIUM Medium impact. Development
MISSION_CRITICAL Mission critical service. Development

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.

Value Description Stability
DEVELOPMENT Development environment. Development
PRODUCTION Production environment. Development
STAGING Staging environment. Development
TEST Test environment. Development

GCP Cloud Run

Status: Development

type: gcp.cloud_run

Description: Resource used by Google Cloud Run.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
gcp.cloud_run.job.execution string The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION environment variable. job-name-xxxx; sample-job-mdw84 Recommended Development
gcp.cloud_run.job.task_index int The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX environment variable. 0; 1 Recommended Development

GCP GCE

Status: Development

type: gcp.gce

Description: Resources used by Google Compute Engine (GCE).

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
gcp.gce.instance.hostname string The hostname of a GCE instance. This is the full value of the default or custom hostname. my-host1234.example.com; sample-vm.us-west1-b.c.my-project.internal Recommended Development
gcp.gce.instance.name string 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. instance-1; my-vm-name Recommended Development