Repository is archived
No commit activity in last 3 years
No release in over 3 years
This plugin provides native ElasticSearch instrumentation for monitoring and metrics collection, including: service health and metrics for cluster, node, and more.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

< 2.3.0, ~> 2.2
~> 0.10
~> 10.0
~> 3.2
~> 3.1
~> 0.51.0
~> 1.16.0
~> 0.9.11
~> 2.1

Runtime

>= 2.1.14, < 2.5, ~> 2.1
~> 1.0.14
 Project Readme

Sensu-Plugins-elasticsearch

Gem Version Sensu Bonsai Asset

This is an unofficial fork

Due to the lack of activity from owners of sensu-plugins-elasticsearch I have created this fork. It is automatically tested, built and published to RubyGems and Bonsai. It includes some improvements. Please check the changelog at the GitHub Releases page.

Sensu Asset

The Sensu assets packaged from this repository are built against the Sensu ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator or handler), make sure you include the corresponding Sensu ruby runtime asset in the list of assets needed by the resource. The current ruby-runtime assets can be found here in the Bonsai Asset Index.

Functionality

Files

  • /bin/check-es-circuit-breakers.rb
  • /bin/check-es-cluster-health.rb
  • /bin/check-es-cluster-status.rb
  • /bin/check-es-file-descriptors.rb
  • /bin/check-es-heap.rb
  • /bin/check-es-indices-field-count.rb
  • /bin/check-es-indexes.rb
  • /bin/check-es-indicies-sizes.rb
  • /bin/check-es-node-status.rb
  • /bin/check-es-query-count.rb
  • /bin/check-es-query-exists.rb
  • /bin/check-es-query-ratio.rb
  • /bin/check-es-shard-allocation-status.rb
  • /bin/handler-es-delete-indices.rb
  • /bin/metrics-es-cluster.rb
  • /bin/metrics-es-node.rb
  • /bin/metrics-es-node-graphite.rb

Usage

Installation

Installation and Setup

Notes

When using handler-es-delete-indices.rb with Sensu Go, you will need to use the event mapping commandline option, see handler-es-delete-indices.rb --help for details. And please read the sensu-plugin README for more information on the event mapping functionality.

Testing

This repository uses the Kitchen suite for it's tests.

Note: The test suite uses an elasticsearch instance in order to have passing tests. Execute the following command to create a mock elasticsearch 7 instance:

docker run -d --name sensu-elasticsearch-7 docker.elastic.co/elasticsearch/elasticsearch:7.1.1

Running the tests:

bundle install --path vendor/bundle
bundle exec kitchen test

You can find sample output for all tests running successfully in this gist.