Install Sensu plugins

Extend Sensu’s functionality with plugins, which provide executables for performing status or metric checks, mutators for changing data to a desired format, and handlers for performing an action on a Sensu event.

Install plugins with assets

Assets are shareable, reusable packages that make it easier to deploy Sensu plugins. To start using and deploying assets, read Install plugins with assets to become familiar with workflows that involve assets.

Use Bonsai, the Sensu asset index

Bonsai, the Sensu asset index, is a centralized place for downloading and sharing plugin assets. Make Bonsai your first stop when you need to find an asset. Bonsai includes plugins, libraries, and runtimes you need to automate your monitoring workflows. You can also share your asset on Bonsai.

Install plugins with the sensu-install tool

To use community plugins that are not yet compatible with Sensu Go, use the sensu-install tool.

If you’ve used previous versions of Sensu, you’re probably familiar with the Sensu Community Plugins organization on GitHub. Although some of these plugins are enabled for Sensu Go, some do not include the components necessary to work with Sensu Go. Read each plugin’s instructions for information about whether it is compatibile with Sensu Go.

NOTE: Plugins in the Sensu Plugins GitHub organization are community-maintained: anyone can improve on them. To get started with adding to a plugin or sharing your own, head to the Sensu Community Slack channel. Maintainers are always happy to help answer questions and point you in the right direction.

The sensu-install tool comes with an embedded version of Ruby, so you don’t need to have Ruby installed on your system.

To install a Sensu Community plugin with Sensu Go:

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

  2. Run the sensu-install command to install plugins in the Sensu Community Plugins GitHub organization 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 InfluxDB plugin:

sudo sensu-install -p influxdb

To install a specific version of the Sensu InfluxDB plugin with sensu-install, run:

sudo sensu-install -p 'sensu-plugins-influxdb:2.0.0'

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

NOTE: If a plugin is not Sensu Go-enabled and there is no analogue on Bonsai, you can add the necessary functionality to make the plugin compatible with Sensu Go. Follow this discourse.sensu.io guide to walk through the process.

Troubleshoot the sensu-install tool

Some plugins require additional tools to install them successfully. An example is the Sensu disk checks plugin. Depending on the plugin, you may need to install developer tool packages.

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install build-essential

RHEL/CentOS:

sudo yum update
sudo yum groupinstall "Development Tools"