Reference#
healthchecks_decorator#
Healthchecks Decorator.
- healthchecks_decorator.healthcheck(func=None, *, url=None, send_start=None, send_diagnostics=None)#
Healthcheck decorator.
- Parameters:
func (t.Union[WrappedFn, None], optional) – The function to decorate. Defaults to None.
url (str) – The ping URL (e.g.: “https://hc-ping.com/<uuid>”). Must start with http.
send_start (bool, optional) – Whether to send a ‘/start’ signal. Defaults to False.
send_diagnostics (bool, optional) – When enabled, send the wrapped function returned value as diagnostics information. Defaults to False.
- Returns:
A wrapped function.
- Return type:
t.Union[WrappedFn, t.Callable[[WrappedFn], WrappedFn]]