Pyng: BOOL check

Description

BOOL check always succeeds or always fails.

BOOL requires true and false commands to be present in $PATH.

Options

BOOL supports following options, which may be used upon creation of a new check object:

true

Set to False to request that check fails

In addition, BOOL supports following generic check settings:

desc

Check description

silent

Information about check runs is not output by certain runners

interval

Number of seconds between check runs

alert

Callable (or a list of callables) to run in order to alert of check status changes

notify

Callable (or a list of callables) to run in order to notify of changes in check's output

run_condition

Callable to run to decide if check run should be skipped

run_threshold

Threshold for mean run time in order to consider check to be degraded

result_filter

Callable to run to filter check command output lines prior to matching check results

on_result

on_first

on_up

on_down

on_degrade

on_restore

on_change

Callable to run with the result of the check on the specified events

Example

# always succeed, run once
BOOL(
  interval=0
)

# always fail, run once
BOOL(
    true=False,
    interval=0,
)