Sensu Check Elasticsearch Health

Table of Contents

• Overview
• Files
• Usage examples
• Configuration
  • Asset registration
  • Check definition
• Installation from source
• Additional notes
• Contributing

Overview

check-elasticsearch-health is a Sensu Check that reports on the health on an Elasticsearch
cluster, it will warn on "Yellow" status and critical on a "Red" status.

Like all Sensu plugins this one will run on anything that supports Nagios plugin output.

This is also my first Go project and I hardly know the language, so please go easy on me in the Issues
and Pull requests.

Configuration

Asset registration

Sensu Assets are the best way to make use of this plugin. If you're not using an asset, please
consider doing so! If you're using sensuctl 5.13 with Sensu Backend 5.13 or later, you can use the
following command to add the asset:

sensuctl asset add barryorourke/check-elasticsearch-health

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/barryorourke/check-elasticsearch-health].

Check definition

---
type: CheckConfig
api_version: core/v2
metadata:
  name: check-elasticsearch-health
  namespace: default
spec:
  command: check-elasticsearch-health
  subscriptions:
  - system
  runtime_assets:
  - barryorourke/check-elasticsearch-health

Installation from source

The preferred way of installing and deploying this plugin is to use it as an Asset. If you would
like to compile and install the plugin from source or contribute to it, download the latest version
or create an executable script from this source.

From the local path of the check-elasticsearch-health repository:

go build

Contributing

For more information about contributing to this plugin, see Contributing.