Resource

healthcheck-options

Options for register-dynamic-backend with healthchecks

resource healthcheck-options;

F host

host: func(value: string) -> result<_, error>;

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.

F method

method: func(value: string) -> result<_, error>;

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

Defaults to "GET".

F path

path: func(value: string) -> result<_, error>;

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 "/".

F expected-status

expected-status: func(value: u16) -> result<_, error>;

Sets the HTTP status code that signifies a healthy state.

Defaults to 200.

F window

window: func(value: u32) -> result<_, error>;

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

Defaults to 5.

F threshold

threshold: func(value: u32) -> result<_, error>;

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.

F initial

initial: func(value: u32) -> result<_, error>;

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.

F interval-ms

interval-ms: func(value: u64) -> result<_, error>;

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.

F timeout-ms

timeout-ms: func(value: u64) -> result<_, error>;

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.

F new

new: func(host: string) -> result<healthcheck-options, error>;

Constructs an options resource with default values for all other possible fields for the healthcheck except host which should be provided. Will return an error if the host is an invalid value.