sensu-plugins-elasticsearch 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 916ac07d3bae1f72dfe1b147803712caf0051397
-  data.tar.gz: 49eb92c702d9b07a3f7d607f0cf412e32acf230d
+  metadata.gz: 4ed5007f08f3c8b041dbdefc02e3048eedea4344
+  data.tar.gz: bae5313f706c29f0ac15b9c6f1d14ca5f62ec548
 SHA512:
-  metadata.gz: 6e1845230c4cf9911e5843f032d56bfee2cbdeccc370bf43ed5d0873665dca17b1e3c51b01416b5aac9ca008f77ae619da5804f095edbd925b76975c57c46f29
-  data.tar.gz: 80a2ea4fc5e0ebe877eb57f76d4510fee044fa95c1bd871c9813195109233462b890dc06957c887c197ad73fa455ee417a699b99d662f279787de8d087460f82
+  metadata.gz: 4c98a9beafb8521e83dbfe30a1d2899f06408637f87e5541f3e21c517cde5de050c9edbb2e2e153f2a31f35b3c667457e197ff9e3867de29ba8140f24a14a349
+  data.tar.gz: 063d44a9119a86445aa315e2d192c62e0ade50722482be8b7a15103b845a83d5f7eef000fb055a79b4fa54ed4b0f5cf5798e40347019e4184b9a6205bca1f461

data/CHANGELOG.md

@@ -5,6 +5,18 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.1.0] - 2016-11-14
+### Changed
+- Changed check-es-heap.rb to be compatible with Elasticsearch 5.0 (@christianherro)
+
+### Added
+- Added check-es-query-ratio.tb to support ratio-type checks (@alcasim)
+- Added direct support to check-es-indices-size.rb to delete indicies without the handler-es-delete-indices.rb
+
+### Fixed
+- aws-sdk 2.5.x breaks aws-es-transport (@sstarcher)
+- check-es-indicies-size - fix array mapping by (@nyxcharon)
+
 ## [1.0.0] - 2016-07-29
 ### Added
 - Added AWS transport gem and configuration for check-es-query-* sensu calls to use --transport=AWS (@brendangibat)
@@ -26,6 +38,9 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Changed
 - Update to Rubocop 0.40 and cleanup (@eheydrick)
 
+### Fixed
+- check-es-indicies-size.rb - broken for newer updates
+
 ## [0.5.3] - 2016-04-02
 ### Added
 - check-es-indexes (check for dup indexes) (Yieldbot)
@@ -107,7 +122,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/0.5.3...1.0.0
 [0.5.3]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/0.4.3...0.5.3
 [0.4.3]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/0.4.2...0.4.3

data/README.md

@@ -19,6 +19,7 @@
  * /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

data/bin/check-es-heap.rb

@@ -122,9 +122,9 @@ class ESHeap < Sensu::Plugin::Check::CLI
 
   def acquire_heap_data(return_max = false)
     stats = if Gem::Version.new(acquire_es_version) >= Gem::Version.new('1.0.0')
-              acquire_es_resource('/_nodes/_local/stats?jvm=true')
+              acquire_es_resource('/_nodes/_local/stats')
             else
-              acquire_es_resource('/_cluster/nodes/_local/stats?jvm=true')
+              acquire_es_resource('/_cluster/nodes/_local/stats')
             end
     node = stats['nodes'].keys.first
     begin

data/bin/check-es-indices-sizes.rb

@@ -99,6 +99,13 @@ class ESCheckIndicesSizes < Sensu::Plugin::Check::CLI
          long: '--pattern-regex PATTERN_REGEX',
          default: '^(?<pattern>.*)-(?<year>\d\d\d\d)\.(?<month>\d\d?).(?<day>\d\d?)$'
 
+  option :delete,
+         description: 'Instead of alerting deletes the indicies',
+         short: '-d',
+         long: '--delete',
+         boolean: true,
+         default: false
+
   def get_indices_to_delete(starting_date, total_bytes_to_delete, indices_with_sizes)
     total_bytes_deleted = 0
     curr_date = DateTime.now
@@ -109,13 +116,13 @@ class ESCheckIndicesSizes < Sensu::Plugin::Check::CLI
     while total_bytes_deleted < total_bytes_to_delete && starting_date < curr_date
       same_day_indices = indices_with_sizes.values.map do |pattern|
         pattern.select do |index|
-          index['date'] == starting_date
+          index[:date] == starting_date
         end
       end.flatten
       same_day_indices.each do |index|
         if total_bytes_deleted < total_bytes_to_delete
-          indices_to_delete.push(index['index'])
-          total_bytes_deleted += index['size']
+          indices_to_delete.push(index[:index])
+          total_bytes_deleted += index[:size]
         end
       end
       starting_date += 1
@@ -175,11 +182,16 @@ class ESCheckIndicesSizes < Sensu::Plugin::Check::CLI
 
     indices_with_sizes = build_indices_with_sizes
 
-    oldest = indices_with_sizes.values.flatten.map { |index| index['date'] }.min
+    oldest = indices_with_sizes.values.flatten.map { |index| index[:date] }.min
     indices_to_delete = get_indices_to_delete(oldest, total_bytes_to_delete, indices_with_sizes)
 
-    critical "Not enough space, #{total_bytes_to_delete} bytes need to be deleted. Used space in bytes: " \
+    if config[:delete]
+      client.indices.delete index: indices_to_delete
+      ok "Cleaned up space: #{total_bytes_to_delete}"
+    else
+      critical "Not enough space, #{total_bytes_to_delete} bytes need to be deleted. Used space in bytes: " \
       "#{used_in_bytes}, Total in bytes: #{total_in_bytes}. Indices to delete: " \
       "#{indices_to_delete.sort.map { |i| "INDEX[#{i}]" }.join(', ')}"
+    end
   end
 end

data/bin/check-es-query-ratio.rb

@@ -0,0 +1,290 @@
+#! /usr/bin/env ruby
+#
+#   check-es-query
+#
+# DESCRIPTION:
+#   This plugin checks ratio between results of two Elasticsearch queries
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: elasticsearch
+#   gem: aws_es_transport
+#
+# USAGE:
+#   This example checks the ratio from the count of two different queries
+#   as dividend and divisor at the host elasticsearch.service.consul for the past 90 minutes
+#   will warn if percentage is lower than 10 and critical if percentage is lower than 5
+#   (The invert flag warns if results are _below_ the critical and warning values)
+#   check-es-query-ratio.rb -h elasticsearch.service.consul -Q "orders:*"
+#     -q "orders:OK" --invert --types special_type -d 'logging-%Y.%m.%d'
+#     --minutes-previous 90 -p 9200 -c 5 -w 10
+#
+#
+# NOTES:
+#
+# LICENSE:
+#
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'elasticsearch'
+require 'time'
+require 'uri'
+require 'aws_es_transport'
+require 'sensu-plugins-elasticsearch'
+
+#
+# ES Query Count
+#
+class ESQueryRatio < Sensu::Plugin::Check::CLI
+  include ElasticsearchCommon
+
+  option :index,
+         description: 'Elasticsearch indices to query.
+         Comma-separated list of index names to search.
+         Use `_all` or empty string to perform the operation on all indices.
+         Accepts wildcards',
+         short: '-i INDEX',
+         long: '--indices INDEX'
+
+  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 :types,
+         description: 'Elasticsearch types to limit searches to, comma separated list.',
+         long: '--types TYPES'
+
+  option :timestamp_field,
+         description: 'Field to use instead of @timestamp for query.',
+         long: '--timestamp-field FIELD_NAME',
+         default: '@timestamp'
+
+  option :offset,
+         description: 'Seconds before offset to end @timestamp against query.',
+         long: '--offset OFFSET',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :ignore_unavailable,
+         description: 'Ignore unavailable indices.',
+         long: '--ignore-unavailable',
+         boolean: true,
+         default: true
+
+  option :minutes_previous,
+         description: 'Minutes before offset to check @timestamp against query.',
+         long: '--minutes-previous MINUTES_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :hours_previous,
+         description: 'Hours before offset to check @timestamp against query.',
+         long: '--hours-previous HOURS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :days_previous,
+         description: 'Days before offset to check @timestamp against query.',
+         long: '--days-previous DAYS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :weeks_previous,
+         description: 'Weeks before offset to check @timestamp against query.',
+         long: '--weeks-previous WEEKS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :months_previous,
+         description: 'Months before offset to check @timestamp against query.',
+         long: '--months-previous MONTHS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :date_index,
+         description: 'Elasticsearch time based index.
+            Accepts format from http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime',
+         short: '-d DATE_INDEX',
+         long: '--date-index DATE_INDEX'
+
+  option :date_repeat_daily,
+         description: 'Elasticsearch date based index repeats daily.',
+         long: '--repeat-daily',
+         boolean: true,
+         default: true
+
+  option :date_repeat_hourly,
+         description: 'Elasticsearch date based index repeats hourly.',
+         long: '--repeat-hourly',
+         boolean: true,
+         default: false
+
+  option :search_field,
+         description: 'The Elasticsearch document field to search for your query string.',
+         short: '-f FIELD',
+         long: '--field FIELD',
+         required: false,
+         default: 'message'
+
+  option :dividend,
+         description: 'Elasticsearch query where percentage is calculated for',
+         short: '-Q QUERY',
+         long: '--dividend QUERY',
+         required: true
+
+  option :divisor,
+         description: 'Elasticsearch query where percentage is calculated from',
+         short: '-q QUERY',
+         long: '--divisor QUERY',
+         required: true
+
+  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 :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 :warn,
+         short: '-w N',
+         long: '--warn N',
+         description: 'Result count WARNING threshold',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :crit,
+         short: '-c N',
+         long: '--crit N',
+         description: 'Result count CRITICAL threshold',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :invert,
+         long: '--invert',
+         description: 'Invert thresholds',
+         boolean: true
+
+  option :kibana_url,
+         long: '--kibana-url KIBANA_URL',
+         description: 'Kibana URL query prefix that will be in critical / warning response output.'
+
+  def kibana_info
+    kibana_date_format = '%Y-%m-%dT%H:%M:%S.%LZ'
+    unless config[:kibana_url].nil?
+      index = config[:index]
+      unless config[:date_index].nil?
+        date_index_partition = config[:date_index].split('%')
+        index = "[#{date_index_partition.first}]" \
+          "#{date_index_partition[1..-1].join.sub('Y', 'YYYY').sub('y', 'YY').sub('m', 'MM').sub('d', 'DD').sub('j', 'DDDD').sub('H', 'hh')}"
+      end
+      end_time = Time.now.utc.to_i
+      start_time = end_time
+      if config[:minutes_previous] != 0
+        start_time -= (config[:minutes_previous] * 60)
+      end
+      if config[:hours_previous] != 0
+        start_time -= (config[:hours_previous] * 60 * 60)
+      end
+      if config[:days_previous] != 0
+        start_time -= (config[:days_previous] * 60 * 60 * 24)
+      end
+      if config[:weeks_previous] != 0
+        start_time -= (config[:weeks_previous] * 60 * 60 * 24 * 7)
+      end
+      if config[:months_previous] != 0
+        start_time -= (config[:months_previous] * 60 * 60 * 24 * 7 * 31)
+      end
+      "Kibana logs: #{config[:kibana_url]}/#/discover?_g=" \
+      "(refreshInterval:(display:Off,section:0,value:0),time:(from:'" \
+      "#{URI.escape(Time.at(start_time).utc.strftime kibana_date_format)}',mode:absolute,to:'" \
+      "#{URI.escape(Time.at(end_time).utc.strftime kibana_date_format)}'))&_a=(columns:!(_source),index:" \
+      "#{URI.escape(index)},interval:auto,query:(query_string:(analyze_wildcard:!t,query:'" \
+      "#{URI.escape(config[:query])}')),sort:!('@timestamp',desc))&dummy"
+    end
+  end
+
+  def run
+    dividend_query = config[:dividend]
+    divisor_query = config[:divisor]
+    config.delete(:dividend)
+    config.delete(:divisor)
+    config[:query] = dividend_query
+    dividend = client.count(build_request_options)
+    config[:query] = divisor_query
+    divisor = client.count(build_request_options)
+    if divisor == 0
+      critical 'Divisor is 0, ratio check cannot be performed, raising an alert'
+    else
+      response = {}
+      response['count'] = (dividend['count'] / divisor['count']).round
+    end
+    if config[:invert]
+      if response['count'] < config[:crit]
+        critical "Query count (#{response['count']}) was below critical threshold. #{kibana_info}"
+      elsif response['count'] < config[:warn]
+        warning "Query count (#{response['count']}) was below warning threshold. #{kibana_info}"
+      else
+        ok "Query count (#{response['count']}) was ok"
+      end
+    elsif response['count'] > config[:crit]
+      critical "Query count (#{response['count']}) was above critical threshold. #{kibana_info}"
+    elsif response['count'] > config[:warn]
+      warning "Query count (#{response['count']}) was above warning threshold. #{kibana_info}"
+    else
+      ok "Query count (#{response['count']}) was ok"
+    end
+  rescue Elasticsearch::Transport::Transport::Errors::NotFound
+    if config[:invert]
+      if response['count'] < config[:crit]
+        critical "Query count (#{response['count']}) was below critical threshold. #{kibana_info}"
+      elsif response['count'] < config[:warn]
+        warning "Query count (#{response['count']}) was below warning threshold. #{kibana_info}"
+      else
+        ok "Query count (#{response['count']}) was ok"
+      end
+    else
+      ok 'No results found, count was below thresholds'
+    end
+  end
+end

data/lib/sensu-plugins-elasticsearch/version.rb

@@ -1,7 +1,7 @@
 module SensuPluginsElasticsearch
   module Version
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -53,33 +53,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: sensu-plugin
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.5'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.5'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +234,7 @@ executables:
 - check-es-node-status.rb
 - check-es-query-count.rb
 - check-es-query-exists.rb
+- check-es-query-ratio.rb
 - check-es-shard-allocation-status.rb
 - handler-es-delete-indices.rb
 - metrics-es-cluster.rb
@@ -243,6 +256,7 @@ files:
 - 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
@@ -278,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for elasticsearch