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.

Note that each gcp.apphub.* attribute has a corresponding gcp.apphub_destination.* attribute, describing the destination/dependency application/service/workload for telemetry which can reference more than one AppHub component. For example, CLIENT spans may contain both gcp.apphub.* attributes describing the application where the client operation was running as well as gcp.apphub_destination.* attributes describing the application that it is talking to.

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.

Attributes:

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

Service

Status:

type: gcp.apphub.service

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

Attributes:

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

[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.

Attributes:

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

[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.