Elasticsearch healthcheck tool
1.1K
This gem is a pluggable library for creating health checks for Elasticsearch.
Add this line to your application's Gemfile:
gem 'eshealth'
And then execute:
$ bundle
Or install it yourself as:
$ gem install eshealth
Usage: eshealth [OPTIONS]
-u, --url=http://your_url:9200 URL to ES server
-p, --period=N Number of seconds between checks
-f, --failures=N Number of consecutive failures to trigger an alert
-c, --condition=STRING String matching a successful healthcheck
-q, --quell=N Amount of time to quell between alerts
-k, --key=SERVICEKEY PagerDuty service key
-n, --check=CHECKNAME Name of check to perform, default: clusterhealth, options: clusterhealth,clusterconfig,clusterfs,metrics
--percentage Percentage to alert about when the check is a percentage based check (default 20).
--alertmethod METHOD The method to alert default: pagerduty, options: email, pagerduty, graphite
--from_email FROM_EMAIL Email to send alerts from if using email alerts
--to_email TO_EMAIL Email to send alerts to if using email alerts
--smtp SMTP_SERVER SMTP server to send email through if using email alerts (default 'localhost')
--user USERNAME Username if needed for notification method
--password PASSWORD Password if needed for notification method
--logintype LOGINTYPE Login type if needed for notification method default: login, options: plain, login, cram_md5
--metrics 1metric,2metric,3metric
List of metrics you want pulled from ES
--host HOSTNAME For alert methods that require a hostname
--port PORT For alert methods that require a port
--prefix PREFIX For metrics, prefix to prepend to graphites stats
https://hub.docker.com/r/searchspring/eshealth/
docker pull searchspring/eshealth
docker run --rm searchspring/eshealth -u http://ES_SERVER_HOSTNAME:9200/ -p 1 -c green -q 1 -f 1 -k PAGERDUTY_SERVICE_KEY
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/SearchSpring/EsHealth . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Content type
Image
Digest
Size
103.9 MB
Last updated
almost 10 years ago
docker pull searchspring/eshealth