HealthcheckBuilder

Sets the HTTP status code that signifies a healthy state.

Defaults to 200.

Set the Host header to set when making the request (e.g. example.com).

A common mistake is setting the wrong host header, which causes the health check to fail.

Set the number of successes to assume are successful when beginning a health check. Must not be greater than the current window.

Defaults to 4.

Set the interval in milliseconds where a health check should be performed. Times must be 1 second to 1 hour inclusive. Must be less than the current timeout_ms.

Defaults to 15000ms.

Set an HTTP verb (i.e., HEAD, GET, or POST) to use when performing the health check.

Defaults to "GET".

Create a new health check builder for a dynamic backend.

The argument is a string describing the backend host on which to check health checks on. This can be of the form:

• "<ip address>"
• "<hostname>"
• "<ip address>:<port>"
• "<hostname>:<port>"

The builder will start with default values for all other possible fields for the health check, which can be overridden using the other methods provided. Use BackendBuilder::healthcheck to add the health check to a specific Dynamic Backend and call BackendBuilder::finish() to complete the construction of the dynamic backend.

Values for health checks have strict limits to prevent ill-use. If you create a health check with a value that breaks these limits, finish() will error with a BackendCreationError:InvalidHealthcheckValues

Set a path to visit on your origins when performing the check. Use a unique path. For example, use /website-healthcheck.txt, not / or /healthcheck.

Defaults to "/".

Set the number of health checks that must be successful within the window to be considered healthy. Must not be greater than the current window.

Defaults to 3.

Set the time in milliseconds in which to perform the health check. Note that querying the health check renews the timer. Must not be less than the current interval_ms.

Defaults to 5000ms.

Set the number of most recent health check queries to keep. Must not be greater than 15.

Defaults to 5.