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: Development

type: gcp.apphub.application

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

AttributeTypeDescriptionExamplesRequirement LevelStability
gcp.apphub.application.containerstringThe container within GCP where the AppHub application is defined.projects/my-container-projectRequiredDevelopment
gcp.apphub.application.idstringThe name of the application as configured in AppHub.my-applicationRequiredDevelopment
gcp.apphub.application.locationstringThe GCP zone or region where the application is defined.us-central1RequiredDevelopment

Service

Status: Development

type: gcp.apphub.service

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

AttributeTypeDescriptionExamplesRequirement LevelStability
gcp.apphub.service.criticality_typestringCriticality of a service indicates its importance to the business. [1]MISSION_CRITICAL; HIGH; MEDIUMRequiredDevelopment
gcp.apphub.service.environment_typestringEnvironment of a service is the stage of a software lifecycle. [2]PRODUCTION; STAGING; TESTRequiredDevelopment
gcp.apphub.service.idstringThe name of the service as configured in AppHub.my-serviceRequiredDevelopment

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

ValueDescriptionStability
HIGHHigh impact.Development
LOWLow impact.Development
MEDIUMMedium impact.Development
MISSION_CRITICALMission 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.

ValueDescriptionStability
DEVELOPMENTDevelopment environment.Development
PRODUCTIONProduction environment.Development
STAGINGStaging environment.Development
TESTTest environment.Development

Workload

Status: Development

type: gcp.apphub.workload

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

AttributeTypeDescriptionExamplesRequirement LevelStability
gcp.apphub.workload.criticality_typestringCriticality of a workload indicates its importance to the business. [1]MISSION_CRITICAL; HIGH; MEDIUMRequiredDevelopment
gcp.apphub.workload.environment_typestringEnvironment of a workload is the stage of a software lifecycle. [2]PRODUCTION; STAGING; TESTRequiredDevelopment
gcp.apphub.workload.idstringThe name of the workload as configured in AppHub.my-workloadRequiredDevelopment

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

ValueDescriptionStability
HIGHHigh impact.Development
LOWLow impact.Development
MEDIUMMedium impact.Development
MISSION_CRITICALMission 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.

ValueDescriptionStability
DEVELOPMENTDevelopment environment.Development
PRODUCTIONProduction environment.Development
STAGINGStaging environment.Development
TESTTest environment.Development