Using the official check plugin pack for check monitoring

Using the official plugin pack for check monitoring, you can easily monitor processes, logs, and other types of checks in Mackerel.

Installing the official check plugin pack(for Linux OS)

To install, we recommend using either the yum repository or the apt repository in accordance with the environment you are using. For how to configure the repository, please refer to the mackerel-agent installation page. If you would like to directly obtain the rpm and deb file, please refer to GitHub Releases.

If installing with the rpm package

sudo yum install mackerel-check-plugins

Updates can be performed using the following command.

sudo yum update mackerel-check-plugins

If installing with the deb package

sudo apt-get install mackerel-check-plugins

Updates can be performed using the following command.。

sudo apt-get update
sudo apt-get install mackerel-check-plugins

Installing the official plugin pack(for Windows Server)

When using the official plugin pack on a Windows Server, we recommend using a plugin that comes bundled with the agent. (For details on how to install the agent, refer to Installing Mackerel Agent.)

For a list of the bundled plugins, refer to the GitHub Repository Bundled Plugin List. Plugins that are not included in this list are not officially supported and must be built independently.

Updating the agent will also update the bundled plugins. For more information on how to update, refer to Installing mackerel-agent on Windows.

Using the official plugin pack(for Linux OS)

Each plugin will be installed in /usr/bin, so you will need to add the item shown below to the mackerel-agent settings file for the plugins you will be using. To apply the settings, you will need to restart the mackerel-agent.

If you wanted to, for example, use the process monitoring plugin to monitor crond, you would add the following item.

[plugin.checks.check_cron]
command = ["check-procs", "-p", "crond"]

Using the official plugin pack(for Windows Server)

As mentioned above, when using the official plugin pack on a Windows Server, we recommend using a plugin that comes bundled with the agent. When using a bundled plugin, each is stored in the agent's installation folder and run through pass. Add the following configuration according to the plugin of use in the mackerel-agent configuration file. Then restart mackerel-agent to apply the configuration.

To monitor the process "foobar" using the process monitoring plugin, use the following description.

[plugin.checks.check_foobar]
command = ["check-procs", "-p", "foobar"]

Usage example

The plugin pack source code

The source code for the official plugin pack is publicly available here: GitHub - mackerelio/go-check-plugins: Check Plugins for monitoring written in golang. We are always happy to receive your pull requests for things like plugins to support new middleware.

For information about making plugins, please refer to Adding monitors for script checks.