sensu-plugins-elasticsearch-boutetnico 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c78a7a41d888f48500399ed36bea486e5b26cbca
+  data.tar.gz: a86a9c2155e8fbf9d72511dcada8a817c8273584
+SHA512:
+  metadata.gz: 5042cf0cb9e54c3b3d74a85b0fc68570f2c82c1be7ee8ffbc7f4ebdf7b21520d83ba7d5be7d63570e09ea4cc9d58c1fbe89440b6a62f6db54ea73fc25e18faed
+  data.tar.gz: 8b8e53c6b1e4d01d4c5832fe035da4316bd6e2efb77ad861dc742377f92fbd43ca531573553c9b3e7f03369cc8654a108b886d05a02219e3f08dc854d31ad287

data/CHANGELOG.md

@@ -0,0 +1 @@
+Can be found at [https://github.com/boutetnico/sensu-plugins-elasticsearch/releases](https://github.com/boutetnico/sensu-plugins-elasticsearch/releases).

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+## Sensu-Plugins-elasticsearch
+
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-elasticsearch-boutetnico.svg)](https://badge.fury.io/rb/sensu-plugins-elasticsearch-boutetnico.svg)
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/boutetnico/sensu-plugins-elasticsearch)
+
+## This is an unofficial fork
+
+Due to the lack of activity from owners of [sensu-plugins-elasticsearch](https://github.com/sensu-plugins/sensu-plugins-elasticsearch) I have created this fork. It is automatically tested, built and published to [RubyGems](https://rubygems.org/gems/sensu-plugins-elasticsearch-boutetnico/) and [Bonsai](https://bonsai.sensu.io/assets/boutetnico/sensu-plugins-elasticsearch). It includes some improvements. Please check the changelog at the [GitHub Releases page](https://github.com/boutetnico/sensu-plugins-elasticsearch/releases).
+
+## 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](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the [Bonsai Asset Index](bonsai.sensu.io).
+
+## 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](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## 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](https://github.com/sensu-plugins/sensu-plugin#sensu-go-enablement) for more information on the event mapping functionality.
+
+## Testing
+
+This repository uses the [Kitchen](https://kitchen.ci/) 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:
+
+```bash
+docker run -d --name sensu-elasticsearch-7 docker.elastic.co/elasticsearch/elasticsearch:7.1.1
+```
+
+Running the tests:
+
+```bash
+bundle install --path vendor/bundle
+bundle exec kitchen test
+```
+
+You can find sample output for all tests running successfully in [this gist](https://gist.github.com/alexandrustaetu/d19feea1296d2ce7e367542265252d7a).

data/bin/check-es-circuit-breakers.rb

@@ -0,0 +1,151 @@
+#! /usr/bin/env ruby
+#
+#  check-es-circuit-breakers
+#
+# DESCRIPTION:
+#   This plugin checks whether the ElasticSearch circuit breakers have been tripped,
+#   using the node stats API.
+#   Works with ES 0.9x and ES 1.x
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   check-es-circuit-breakers --help
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+require 'base64'
+
+class ESCircuitBreaker < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'Elasticsearch host',
+         short: '-h HOST',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'Elasticsearch port',
+         short: '-p PORT',
+         long: '--port PORT',
+         proc: proc(&:to_i),
+         default: 9200
+
+  option :timeout,
+         description: 'Sets the connection timeout for REST client',
+         short: '-t SECS',
+         long: '--timeout SECS',
+         proc: proc(&:to_i),
+         default: 30
+
+  option :user,
+         description: 'Elasticsearch User',
+         short: '-u USER',
+         long: '--user USER'
+
+  option :password,
+         description: 'Elasticsearch Password',
+         short: '-P PASS',
+         long: '--password PASS'
+
+  option :https,
+         description: 'Enables HTTPS',
+         short: '-e',
+         long: '--https'
+
+  option :cert_file,
+         description: 'Cert file to use',
+         long: '--cert-file CERT'
+
+  option :localhost,
+         description: 'only check local node',
+         short: '-l',
+         long: '--localhost',
+         boolean: true,
+         default: false
+
+  def get_es_resource(resource)
+    headers = {}
+    if config[:user] && config[:password]
+      auth = 'Basic ' + Base64.strict_encode64("#{config[:user]}:#{config[:password]}").chomp
+      headers = { 'Authorization' => auth }
+    end
+
+    protocol = if config[:https]
+                 'https'
+               else
+                 'http'
+               end
+
+    r = if config[:cert_file]
+          RestClient::Resource.new("#{protocol}://#{config[:host]}:#{config[:port]}#{resource}",
+                                   ssl_ca_file: config[:cert_file].to_s,
+                                   timeout: config[:timeout],
+                                   headers: headers)
+        else
+          RestClient::Resource.new("#{protocol}://#{config[:host]}:#{config[:port]}#{resource}",
+                                   timeout: config[:timeout],
+                                   headers: headers)
+        end
+    JSON.parse(r.get)
+  rescue Errno::ECONNREFUSED
+    critical 'Connection refused'
+  rescue RestClient::RequestTimeout
+    critical 'Connection timed out'
+  rescue RestClient::ServiceUnavailable
+    warning 'Service is unavailable'
+  rescue Errno::ECONNRESET
+    critical 'Connection reset by peer'
+  end
+
+  def breaker_status
+    breakers = {}
+    status = if config[:localhost]
+               get_es_resource('/_nodes/_local/stats/breaker')
+             else
+               get_es_resource('/_nodes/stats/breaker')
+             end
+    status['nodes'].each_pair do |_node, stat|
+      host = stat['host']
+      breakers[host] = {}
+      breakers[host]['breakers'] = []
+      stat.each_pair do |key, val|
+        if key == 'breakers'
+          val.each_pair do |bk, bv|
+            if bv['tripped'] != 0
+              breakers[host]['breakers'] << bk
+            end
+          end
+        end
+      end
+    end
+    breakers
+  end
+
+  def run
+    breakers = breaker_status
+    tripped = false
+    breakers.each_pair { |_k, v| tripped = true unless v['breakers'].empty? }
+    if tripped
+      critical "Circuit Breakers: #{breakers.each_pair { |k, _v| k }} trippped!"
+    else
+      ok 'All circuit breakers okay'
+    end
+  end
+end

data/bin/check-es-cluster-health.rb

@@ -0,0 +1,132 @@
+#! /usr/bin/env ruby
+#
+#   check-es-cluster-health
+#
+# DESCRIPTION:
+#   This plugin checks the ElasticSearch cluster health and status.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: elasticsearch
+#   gem: aws_es_transport
+#
+# USAGE:
+#   Checks against the ElasticSearch api for cluster health using the
+#     elasticsearch gem
+#
+# NOTES:
+#
+# LICENSE:
+#   Brendan Gibat <brendan.gibat@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'elasticsearch'
+require 'aws_es_transport'
+require 'sensu-plugins-elasticsearch'
+
+#
+# ES Cluster Health
+#
+class ESClusterHealth < Sensu::Plugin::Check::CLI
+  include ElasticsearchCommon
+
+  option :transport,
+         long: '--transport TRANSPORT',
+         description: 'Transport to use to communicate with ES. Use "AWS" for signed AWS transports.'
+
+  option :region,
+         long: '--region REGION',
+         description: 'Region (necessary for AWS Transport)'
+
+  option :host,
+         description: 'Elasticsearch host',
+         short: '-h HOST',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :level,
+         description: 'Level of detail to check returend information ("cluster", "indices", "shards").',
+         short: '-l LEVEL',
+         long: '--level LEVEL'
+
+  option :local,
+         description: 'Return local information, do not retrieve the state from master node.',
+         long: '--local',
+         boolean: true
+
+  option :port,
+         description: 'Elasticsearch port',
+         short: '-p PORT',
+         long: '--port PORT',
+         proc: proc(&:to_i),
+         default: 9200
+
+  option :scheme,
+         description: 'Elasticsearch connection scheme, defaults to https for authenticated connections',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME'
+
+  option :password,
+         description: 'Elasticsearch connection password',
+         short: '-P PASSWORD',
+         long: '--password PASSWORD'
+
+  option :user,
+         description: 'Elasticsearch connection user',
+         short: '-u USER',
+         long: '--user USER'
+
+  option :timeout,
+         description: 'Elasticsearch query timeout in seconds',
+         short: '-t TIMEOUT',
+         long: '--timeout TIMEOUT',
+         proc: proc(&:to_i),
+         default: 30
+
+  option :alert_status,
+         description: 'Only alert when status matches given RED/YELLOW/GREEN or if blank all statuses',
+         long: '--alert-status STATUS',
+         default: '',
+         in: ['RED', 'YELLOW', 'GREEN', '']
+
+  def run
+    options = {}
+    unless config[:level].nil?
+      options[:level] = config[:level]
+    end
+    unless config[:local].nil?
+      options[:local] = config[:local]
+    end
+    unless config[:index].nil?
+      options[:index] = config[:index]
+    end
+    health = client.cluster.health options
+    case health['status']
+    when 'yellow'
+      if ['YELLOW', ''].include? config[:alert_status]
+        warning 'Cluster state is Yellow'
+      else
+        ok 'Not alerting on yellow'
+      end
+    when 'red'
+      if ['RED', ''].include? config[:alert_status]
+        critical 'Cluster state is Red'
+      else
+        ok 'Not alerting on red'
+      end
+    when 'green'
+      ok
+    else
+      unknown "Cluster state is in an unknown health: #{health['status']}"
+    end
+  end
+end

data/bin/check-es-cluster-status.rb

@@ -0,0 +1,177 @@
+#! /usr/bin/env ruby
+#
+#  check-es-cluster-status
+#
+# DESCRIPTION:
+#   This plugin checks the ElasticSearch cluster status, using its API.
+#   Works with ES 0.9x and ES 1.x
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2012 Sonian, Inc <chefs@sonian.net>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+require 'base64'
+
+#
+# ES Cluster Status
+#
+class ESClusterStatus < Sensu::Plugin::Check::CLI
+  option :host,
+         description: 'Elasticsearch host',
+         short: '-h HOST',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'Elasticsearch port',
+         short: '-p PORT',
+         long: '--port PORT',
+         proc: proc(&:to_i),
+         default: 9200
+
+  option :master_only,
+         description: 'Use master Elasticsearch server only',
+         short: '-m',
+         long: '--master-only',
+         default: false
+
+  option :timeout,
+         description: 'Sets the connection timeout for REST client',
+         short: '-t SECS',
+         long: '--timeout SECS',
+         proc: proc(&:to_i),
+         default: 30
+
+  option :status_timeout,
+         description: 'Sets the time to wait for the cluster status to be green',
+         short: '-T SECS',
+         long: '--status_timeout SECS',
+         proc: proc(&:to_i)
+
+  option :user,
+         description: 'Elasticsearch User',
+         short: '-u USER',
+         long: '--user USER'
+
+  option :password,
+         description: 'Elasticsearch Password',
+         short: '-P PASS',
+         long: '--password PASS'
+
+  option :https,
+         description: 'Enables HTTPS',
+         short: '-e',
+         long: '--https'
+
+  option :cert_file,
+         description: 'Cert file to use',
+         long: '--cert-file CERT_FILE'
+
+  option :alert_status,
+         description: 'Only alert when status matches given RED/YELLOW/GREEN or if blank all statuses',
+         long: '--alert-status STATUS',
+         default: '',
+         in: ['RED', 'YELLOW', 'GREEN', '']
+
+  def get_es_resource(resource)
+    headers = {}
+    if config[:user] && config[:password]
+      auth = 'Basic ' + Base64.strict_encode64("#{config[:user]}:#{config[:password]}").chomp
+      headers = { 'Authorization' => auth }
+    end
+
+    protocol = if config[:https]
+                 'https'
+               else
+                 'http'
+               end
+
+    r = if config[:cert_file]
+          RestClient::Resource.new("#{protocol}://#{config[:host]}:#{config[:port]}#{resource}",
+                                   ssl_ca_file: config[:cert_file].to_s,
+                                   timeout: config[:timeout],
+                                   headers: headers)
+        else
+          RestClient::Resource.new("#{protocol}://#{config[:host]}:#{config[:port]}#{resource}",
+                                   timeout: config[:timeout],
+                                   headers: headers)
+        end
+    JSON.parse(r.get)
+  rescue Errno::ECONNREFUSED
+    critical 'Connection refused'
+  rescue RestClient::RequestTimeout
+    critical 'Connection timed out'
+  rescue RestClient::ServiceUnavailable
+    critical 'Service is unavailable'
+  rescue Errno::ECONNRESET
+    critical 'Connection reset by peer'
+  end
+
+  def acquire_es_version
+    info = get_es_resource('/')
+    info['version']['number']
+  end
+
+  def master?
+    if Gem::Version.new(acquire_es_version) >= Gem::Version.new('1.0.0')
+      master = get_es_resource('/_cluster/state/master_node')['master_node']
+      local = get_es_resource('/_nodes/_local')
+    else
+      master = get_es_resource('/_cluster/state?filter_routing_table=true&filter_metadata=true&filter_indices=true')['master_node']
+      local = get_es_resource('/_cluster/nodes/_local')
+    end
+    local['nodes'].keys.first == master
+  end
+
+  def acquire_status
+    health = if config[:status_timeout]
+               get_es_resource("/_cluster/health?wait_for_status=green&timeout=#{config[:status_timeout]}s")
+             else
+               get_es_resource('/_cluster/health')
+             end
+    health['status'].downcase
+  end
+
+  def run
+    if !config[:master_only] || master?
+      case acquire_status
+      when 'green'
+        ok 'Cluster is green'
+      when 'yellow'
+        if ['YELLOW', ''].include? config[:alert_status]
+          warning 'Cluster state is Yellow'
+        else
+          ok 'Not alerting on yellow'
+        end
+      when 'red'
+        if ['RED', ''].include? config[:alert_status]
+          critical 'Cluster state is Red'
+        else
+          ok 'Not alerting on red'
+        end
+      end
+    else
+      ok 'Not the master'
+    end
+  end
+end