Compute Engine health check

A Compute Engine health check in Google Cloud continuously monitors the status of virtual machine instances or backend services. It sends periodic probes to determine if instances are healthy and can handle traffic. If an instance fails the health check, it is automatically removed from load balancing until it recovers. This ensures high availability and reliable application performance.

gcp.compute_health_check

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
check_interval_seccoreint64How often (in seconds) to send a health check. The default value is 5 seconds.
creation_timestampcoretimestampOutput only. [Output Only] Creation timestamp in3339 text format.
datadog_display_namecorestring
descriptioncorestringAn optional description of this resource. Provide this property when you create the resource.
grpc_health_checkcorejson
healthy_thresholdcoreint64A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
http2_health_checkcorejson
http_health_checkcorejson
https_health_checkcorejson
idcorestring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindcorestringOutput only. Type of the resource.
labelscorearray<string>
log_configcorejsonConfigure logging on this health check.
namecorestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
regioncorestringOutput only. [Output Only] Region where the health check resides. Not applicable to global health checks.
region_idcorestring
resource_namecorestring
self_linkcorestring[Output Only] Server-defined URL for the resource.
source_regionscorearray<string>The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.
ssl_health_checkcorejson
tagscorehstore_csv
tcp_health_checkcorejson
timeout_seccoreint64How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
typecorestringSpecifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must matchtype field.
unhealthy_thresholdcoreint64A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
zone_idcorestring