healthDetection

Property Manager name: Origin Health Detection
Behavior version: The latest rule format supports the healthDetection behavior v1.1.
Rule format status: Beta, possible breaking changes
Access: Read/Write
Allowed in includes: Not available for latest rule format

Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable.

When client requests are forwarded to the origin, the edge server tracks the number of attempts to connect to each IP address. It cycles through IP addresses in least-recently-tested order to avoid hitting the same one twice in a row. If the number of consecutive unsuccessful tests reaches a threshold you specify, the behavior identifies the address as faulty and stops sending requests. The edge server returns an error message to the end user or else triggers any failAction behavior you specify.

Option Type Description Requires

Option	Type	Description
`retryCount`	number	The number of consecutive connection failures that mark an IP address as faulty.	{"displayType":"number","tag":"input","type":"number"}
`retryInterval`	string (duration)	Specifies the amount of time the edge server will wait before trying to reconnect to an IP address it has already identified as faulty.	{"displayType":"string","tag":"input","type":"text"}
`maximumReconnects`	number	Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, `maximumReconnects` effectively overrides the value of `retryCount`.	{"displayType":"number","tag":"input","type":"number"}

retryCount

number

The number of consecutive connection failures that mark an IP address as faulty.

{"displayType":"number","tag":"input","type":"number"}

retryInterval

string (duration)

Specifies the amount of time the edge server will wait before trying to reconnect to an IP address it has already identified as faulty.

{"displayType":"string","tag":"input","type":"text"}

maximumReconnects

number

Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.

{"displayType":"number","tag":"input","type":"number"}