Scripts Plugin¶
canaryd
can execute scripts uploaded to your servers, normally located in the /etc/canaryd/scripts/available
directory. These scripts follow the same rules as Nagios & Sensu scripts:
- Exit code 1 generates a warning issue
- Exit codes 2+ generate a critical issue
Any output from the scripts will be used as the issue description. It is highly recommended to use a configuration management tool such as pyinfra or Ansible to distribute scripts across your infrastructure.
Enable & disable scripts¶
canaryctl
can be used to manage scripts:
# List scripts
canaryctl scripts
# Enable a script
canaryctl scripts enable <script_name.ext>
# Disable a script
canaryctl scripts disable <script_name.ext>