apphub.md

Google Cloud AppHub

Status: Development

These conventions are used by Google Cloud when using AppHub. Observability data from Google Cloud will be annotated with these resource types, depending on the source of telemetry. For example, metrics coming from a Google Cloud service will be annotated with the appropriate gcp.apphub.application and gcp.apphub.service as configured in AppHub.

See Supported Resources for what data will be annotated by Google Cloud.

Application

Status:

type: gcp.apphub.application

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

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
gcp.apphub.application.id	string	The name of the application as configured in AppHub.	my-application	Required
gcp.apphub.application.location	string	The GCP zone or region where the application is defined.	us-central1	Required

Service

Status:

type: gcp.apphub.service

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

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
gcp.apphub.service.environment_type	string	Environment of a service is the stage of a software lifecycle. [2]	PRODUCTION; STAGING; TEST	Required
gcp.apphub.service.id	string	The name of the service as configured in AppHub.	my-service	Required

[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.
LOW	Low impact.
MEDIUM	Medium impact.
MISSION_CRITICAL	Mission critical service.

---

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.
PRODUCTION	Production environment.
STAGING	Staging environment.
TEST	Test environment.

Workload

Status:

type: gcp.apphub.workload

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

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

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

[2] 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.
LOW	Low impact.
MEDIUM	Medium impact.
MISSION_CRITICAL	Mission critical service.

---

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.
PRODUCTION	Production environment.
STAGING	Staging environment.
TEST	Test environment.