Installing Sensu Plugins

Sensu’s functionality can be extended through the use of plugins. Plugins can provide executables for performing status or metric checks, mutators for changing data to a desired format, or handlers for performing an action on a Sensu event.

Installing plugins using Bonsai, the Sensu asset index

Assets are shareable, reusable packages that make it easy to deploy Sensu plugins. You can use assets to provide the plugins, libraries, and runtimes you need to automate your monitoring workflows. Visit Bonsai to discover, download, and share assets, and get started with these helpful resources.

Installing plugins using the sensu-install tool

You can find a number of plugins in the Sensu Plugins organization on GitHub.

NOTE: Plugins found in the Sensu Plugins GitHub organization are community-maintained, meaning that anyone can improve on a plugin found there. If you have a question about how you can get involved in adding to, or providing a plugin, head to the Sensu Community Slack channel. Maintainers are always happy to help answer questions and point you in the right direction.

To install a Sensu Community Plugin with Sensu Go:

  1. Install the sensu-plugins-ruby package from packagecloud.

  2. Use the sensu-install command to install any plugins in the Sensu Plugins organization on GitHub by repository name. Plugins are installed into /opt/sensu-plugins-ruby/embedded/bin.

sensu-install --help
Usage: sensu-install [options]
    -h, --help                       Display this message
    -v, --verbose                    Enable verbose logging
    -p, --plugin PLUGIN              Install a Sensu PLUGIN
    -P, --plugins PLUGIN[,PLUGIN]    PLUGIN or comma-delimited list of Sensu plugins to install
    -e, --extension EXTENSION        Install a Sensu EXTENSION
    -E, --extensions EXTENSION[,EXT] EXTENSION or comma-delimited list of Sensu extensions to install
    -s, --source SOURCE              Install Sensu plugins and extensions from a custom SOURCE
    -c, --clean                      Clean up (remove) other installed versions of the plugin(s) and/or extension(s)
    -x, --proxy PROXY                Install Sensu plugins and extensions via a PROXY URL

For example, to install the Sensu Disk Checks Plugin:

sudo sensu-install -p disk-checks

To install a specific version of the Sensu Disk Checks Plugin with sensu-install, run:

sudo sensu-install -p 'sensu-plugins-disk-checks:3.1.0'

We strongly recommend using a configuration management tool or using Sensu assets to pin the versions of any plugins installed in production.

NOTE: Sensu Go is compatible with all check executables in the Sensu Plugins organization. Handler and mutator executables are not yet compatible with Sensu Go.