Health Checks determine whether instances are responsive and able to do work. They are an important part of a comprehensive load balancing configuration, as they enable monitoring instances behind load balancers.
Health Checks poll instances at a specified interval. Instances that do not respond successfully to some number of probes in a row are marked as unhealthy. No new connections are sent to unhealthy instances, though existing connections will continue. The health check will continue to poll unhealthy instances. If an instance later responds successfully to some number of consecutive probes, it is marked healthy again and can receive new connections.
To get more information about RegionHealthCheck, see:
resource "google_compute_region_health_check" "tcp-region-health-check" {
name = "tcp-region-health-check"
timeout_sec = 1
check_interval_sec = 1
tcp_health_check {
port = "80"
}
}
resource "google_compute_region_health_check" "tcp-region-health-check" {
name = "tcp-region-health-check"
description = "Health check via tcp"
timeout_sec = 1
check_interval_sec = 1
healthy_threshold = 4
unhealthy_threshold = 5
tcp_health_check {
port_name = "health-check-port"
port_specification = "USE_NAMED_PORT"
request = "ARE YOU HEALTHY?"
proxy_header = "NONE"
response = "I AM HEALTHY"
}
}
resource "google_compute_region_health_check" "ssl-region-health-check" {
name = "ssl-region-health-check"
timeout_sec = 1
check_interval_sec = 1
ssl_health_check {
port = "443"
}
}
resource "google_compute_region_health_check" "ssl-region-health-check" {
name = "ssl-region-health-check"
description = "Health check via ssl"
timeout_sec = 1
check_interval_sec = 1
healthy_threshold = 4
unhealthy_threshold = 5
ssl_health_check {
port_name = "health-check-port"
port_specification = "USE_NAMED_PORT"
request = "ARE YOU HEALTHY?"
proxy_header = "NONE"
response = "I AM HEALTHY"
}
}
resource "google_compute_region_health_check" "http-region-health-check" {
name = "http-region-health-check"
timeout_sec = 1
check_interval_sec = 1
http_health_check {
port = "80"
}
}
resource "google_compute_region_health_check" "http-region-health-check" {
provider = google-beta
name = "http-region-health-check"
timeout_sec = 1
check_interval_sec = 1
http_health_check {
port = "80"
}
log_config {
enable = true
}
}
resource "google_compute_region_health_check" "http-region-health-check" {
name = "http-region-health-check"
description = "Health check via http"
timeout_sec = 1
check_interval_sec = 1
healthy_threshold = 4
unhealthy_threshold = 5
http_health_check {
port_name = "health-check-port"
port_specification = "USE_NAMED_PORT"
host = "1.2.3.4"
request_path = "/mypath"
proxy_header = "NONE"
response = "I AM HEALTHY"
}
}
resource "google_compute_region_health_check" "https-region-health-check" {
name = "https-region-health-check"
timeout_sec = 1
check_interval_sec = 1
https_health_check {
port = "443"
}
}
resource "google_compute_region_health_check" "https-region-health-check" {
name = "https-region-health-check"
description = "Health check via https"
timeout_sec = 1
check_interval_sec = 1
healthy_threshold = 4
unhealthy_threshold = 5
https_health_check {
port_name = "health-check-port"
port_specification = "USE_NAMED_PORT"
host = "1.2.3.4"
request_path = "/mypath"
proxy_header = "NONE"
response = "I AM HEALTHY"
}
}
resource "google_compute_region_health_check" "http2-region-health-check" {
name = "http2-region-health-check"
timeout_sec = 1
check_interval_sec = 1
http2_health_check {
port = "443"
}
}
resource "google_compute_region_health_check" "http2-region-health-check" {
name = "http2-region-health-check"
description = "Health check via http2"
timeout_sec = 1
check_interval_sec = 1
healthy_threshold = 4
unhealthy_threshold = 5
http2_health_check {
port_name = "health-check-port"
port_specification = "USE_NAMED_PORT"
host = "1.2.3.4"
request_path = "/mypath"
proxy_header = "NONE"
response = "I AM HEALTHY"
}
}
resource "google_compute_region_health_check" "grpc-region-health-check" {
name = "grpc-region-health-check"
timeout_sec = 1
check_interval_sec = 1
grpc_health_check {
port = "443"
}
}
resource "google_compute_region_health_check" "grpc-region-health-check" {
name = "grpc-region-health-check"
timeout_sec = 1
check_interval_sec = 1
grpc_health_check {
port_name = "health-check-port"
port_specification = "USE_NAMED_PORT"
grpc_service_name = "testservice"
}
}
The following arguments are supported:
name
-
(Required)
Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and
match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?
which means
the first character must be a lowercase letter, and all following
characters must be a dash, lowercase letter, or digit, except the
last character, which cannot be a dash.check_interval_sec
-
(Optional)
How often (in seconds) to send a health check. The default value is 5
seconds.
description
-
(Optional)
An optional description of this resource. Provide this property when
you create the resource.
healthy_threshold
-
(Optional)
A so-far unhealthy instance will be marked healthy after this many
consecutive successes. The default value is 2.
unhealthy_threshold
-
(Optional)
A so-far healthy instance will be marked unhealthy after this many
consecutive failures. The default value is 2.
timeout_sec
-
(Optional)
How 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.
http_health_check
-
(Optional)
A nested object resource
Structure is documented below.
https_health_check
-
(Optional)
A nested object resource
Structure is documented below.
tcp_health_check
-
(Optional)
A nested object resource
Structure is documented below.
ssl_health_check
-
(Optional)
A nested object resource
Structure is documented below.
http2_health_check
-
(Optional)
A nested object resource
Structure is documented below.
grpc_health_check
-
(Optional)
A nested object resource
Structure is documented below.
log_config
-
(Optional)
Configure logging on this health check.
Structure is documented below.
region
-
(Optional)
The Region in which the created health check should reside.
If it is not provided, the provider region is used.
project
- (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
The http_health_check
block supports:
host
-
(Optional)
The value of the host header in the HTTP health check request.
If left empty (default value), the public IP on behalf of which this health
check is performed will be used.
request_path
-
(Optional)
The request path of the HTTP health check request.
The default value is /.
response
-
(Optional)
The bytes to match against the beginning of the response data. If left empty
(the default value), any response will indicate health. The response data
can only be ASCII.
port
-
(Optional)
The TCP port number for the HTTP health check request.
The default value is 80.
port_name
-
(Optional)
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
proxy_header
-
(Optional)
Specifies the type of proxy header to append before sending data to the
backend.
Default value is NONE
.
Possible values are: NONE
, PROXY_V1
.
port_specification
-
(Optional)
Specifies how port is selected for health checking, can be one of the
following values:
USE_FIXED_PORT
: The port number in port
is used for health checking.USE_NAMED_PORT
: The portName
is used for health checking.USE_SERVING_PORT
: For NetworkEndpointGroup, the port specified for each
network endpoint is used for health checking. For other backends, the
port or named port specified in the Backend Service is used for health
checking.
If not specified, HTTP health check follows behavior specified in port
and
portName
fields.
Possible values are: USE_FIXED_PORT
, USE_NAMED_PORT
, USE_SERVING_PORT
.The https_health_check
block supports:
host
-
(Optional)
The value of the host header in the HTTPS health check request.
If left empty (default value), the public IP on behalf of which this health
check is performed will be used.
request_path
-
(Optional)
The request path of the HTTPS health check request.
The default value is /.
response
-
(Optional)
The bytes to match against the beginning of the response data. If left empty
(the default value), any response will indicate health. The response data
can only be ASCII.
port
-
(Optional)
The TCP port number for the HTTPS health check request.
The default value is 443.
port_name
-
(Optional)
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
proxy_header
-
(Optional)
Specifies the type of proxy header to append before sending data to the
backend.
Default value is NONE
.
Possible values are: NONE
, PROXY_V1
.
port_specification
-
(Optional)
Specifies how port is selected for health checking, can be one of the
following values:
USE_FIXED_PORT
: The port number in port
is used for health checking.USE_NAMED_PORT
: The portName
is used for health checking.USE_SERVING_PORT
: For NetworkEndpointGroup, the port specified for each
network endpoint is used for health checking. For other backends, the
port or named port specified in the Backend Service is used for health
checking.
If not specified, HTTPS health check follows behavior specified in port
and
portName
fields.
Possible values are: USE_FIXED_PORT
, USE_NAMED_PORT
, USE_SERVING_PORT
.The tcp_health_check
block supports:
request
-
(Optional)
The application data to send once the TCP connection has been
established (default value is empty). If both request and response are
empty, the connection establishment alone will indicate health. The request
data can only be ASCII.
response
-
(Optional)
The bytes to match against the beginning of the response data. If left empty
(the default value), any response will indicate health. The response data
can only be ASCII.
port
-
(Optional)
The TCP port number for the TCP health check request.
The default value is 80.
port_name
-
(Optional)
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
proxy_header
-
(Optional)
Specifies the type of proxy header to append before sending data to the
backend.
Default value is NONE
.
Possible values are: NONE
, PROXY_V1
.
port_specification
-
(Optional)
Specifies how port is selected for health checking, can be one of the
following values:
USE_FIXED_PORT
: The port number in port
is used for health checking.USE_NAMED_PORT
: The portName
is used for health checking.USE_SERVING_PORT
: For NetworkEndpointGroup, the port specified for each
network endpoint is used for health checking. For other backends, the
port or named port specified in the Backend Service is used for health
checking.
If not specified, TCP health check follows behavior specified in port
and
portName
fields.
Possible values are: USE_FIXED_PORT
, USE_NAMED_PORT
, USE_SERVING_PORT
.The ssl_health_check
block supports:
request
-
(Optional)
The application data to send once the SSL connection has been
established (default value is empty). If both request and response are
empty, the connection establishment alone will indicate health. The request
data can only be ASCII.
response
-
(Optional)
The bytes to match against the beginning of the response data. If left empty
(the default value), any response will indicate health. The response data
can only be ASCII.
port
-
(Optional)
The TCP port number for the SSL health check request.
The default value is 443.
port_name
-
(Optional)
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
proxy_header
-
(Optional)
Specifies the type of proxy header to append before sending data to the
backend.
Default value is NONE
.
Possible values are: NONE
, PROXY_V1
.
port_specification
-
(Optional)
Specifies how port is selected for health checking, can be one of the
following values:
USE_FIXED_PORT
: The port number in port
is used for health checking.USE_NAMED_PORT
: The portName
is used for health checking.USE_SERVING_PORT
: For NetworkEndpointGroup, the port specified for each
network endpoint is used for health checking. For other backends, the
port or named port specified in the Backend Service is used for health
checking.
If not specified, SSL health check follows behavior specified in port
and
portName
fields.
Possible values are: USE_FIXED_PORT
, USE_NAMED_PORT
, USE_SERVING_PORT
.The http2_health_check
block supports:
host
-
(Optional)
The value of the host header in the HTTP2 health check request.
If left empty (default value), the public IP on behalf of which this health
check is performed will be used.
request_path
-
(Optional)
The request path of the HTTP2 health check request.
The default value is /.
response
-
(Optional)
The bytes to match against the beginning of the response data. If left empty
(the default value), any response will indicate health. The response data
can only be ASCII.
port
-
(Optional)
The TCP port number for the HTTP2 health check request.
The default value is 443.
port_name
-
(Optional)
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
proxy_header
-
(Optional)
Specifies the type of proxy header to append before sending data to the
backend.
Default value is NONE
.
Possible values are: NONE
, PROXY_V1
.
port_specification
-
(Optional)
Specifies how port is selected for health checking, can be one of the
following values:
USE_FIXED_PORT
: The port number in port
is used for health checking.USE_NAMED_PORT
: The portName
is used for health checking.USE_SERVING_PORT
: For NetworkEndpointGroup, the port specified for each
network endpoint is used for health checking. For other backends, the
port or named port specified in the Backend Service is used for health
checking.
If not specified, HTTP2 health check follows behavior specified in port
and
portName
fields.
Possible values are: USE_FIXED_PORT
, USE_NAMED_PORT
, USE_SERVING_PORT
.The grpc_health_check
block supports:
port
-
(Optional)
The port number for the health check request.
Must be specified if portName and portSpecification are not set
or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
port_name
-
(Optional)
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
port_specification
-
(Optional)
Specifies how port is selected for health checking, can be one of the
following values:
USE_FIXED_PORT
: The port number in port
is used for health checking.USE_NAMED_PORT
: The portName
is used for health checking.USE_SERVING_PORT
: For NetworkEndpointGroup, the port specified for each
network endpoint is used for health checking. For other backends, the
port or named port specified in the Backend Service is used for health
checking.
If not specified, gRPC health check follows behavior specified in port
and
portName
fields.
Possible values are: USE_FIXED_PORT
, USE_NAMED_PORT
, USE_SERVING_PORT
.grpc_service_name
-
(Optional)
The gRPC service name for the health check.
The value of grpcServiceName has the following meanings by convention:
The log_config
block supports:
enable
-
(Optional)
Indicates whether or not to export logs. This is false by default,
which means no health check logging will be done.In addition to the arguments listed above, the following computed attributes are exported:
id
- an identifier for the resource with format projects/{{project}}/regions/{{region}}/healthChecks/{{name}}
creation_timestamp
-
Creation timestamp in RFC3339 text format.
type
-
The type of the health check. One of HTTP, HTTP2, HTTPS, TCP, or SSL.
self_link
- The URI of the created resource.This resource provides the following Timeouts configuration options:
create
- Default is 20 minutes.update
- Default is 20 minutes.delete
- Default is 20 minutes.RegionHealthCheck can be imported using any of these accepted formats:
projects/{{project}}/regions/{{region}}/healthChecks/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}}
In Terraform v1.5.0 and later, use an import
block to import RegionHealthCheck using one of the formats above. For example:
import {
id = "projects/{{project}}/regions/{{region}}/healthChecks/{{name}}"
to = google_compute_region_health_check.default
}
When using the terraform import
command, RegionHealthCheck can be imported using one of the formats above. For example:
$ terraform import google_compute_region_health_check.default projects/{{project}}/regions/{{region}}/healthChecks/{{name}}
$ terraform import google_compute_region_health_check.default {{project}}/{{region}}/{{name}}
$ terraform import google_compute_region_health_check.default {{region}}/{{name}}
$ terraform import google_compute_region_health_check.default {{name}}
This resource supports User Project Overrides.