ProbeSettings Class

Settings on how to probe an endpoint.

Constructor

ProbeSettings(*, failure_threshold: int | None = None, success_threshold: int | None = None, timeout: int | None = None, period: int | None = None, initial_delay: int | None = None)

Keyword-Only Parameters

Name Description
failure_threshold
int

Threshold for probe failures, defaults to 30

Default value: None
success_threshold
int

Threshold for probe success, defaults to 1

Default value: None
timeout
int

timeout in seconds, defaults to 2

Default value: None
period
int

How often (in seconds) to perform the probe, defaults to 10

Default value: None
initial_delay
int

How long (in seconds) to wait for the first probe, defaults to 10

Default value: None