sensu-plugins-elasticsearch 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43a77c2890ac390f9a87543c86a1897318dac09570490a3f5fa9b6fc751feee2
-  data.tar.gz: 6dda58f8156f3d22e5b9edc66172d0dd104cd1fc6ff42fd1acefb8e7cefa877b
+  metadata.gz: f4c7f8edc916e17c7ba571ef98759d0baaa87e911775ae2937add42081d731ba
+  data.tar.gz: 824f94d88b00f0fe2d0c569e4e081c9e6963b24a2bc2ef178f57a0918a4f35e6
 SHA512:
-  metadata.gz: 7337b49b8aa4e86faf4dc5b5987d4cbf57e637b1945d137fb5e9dd0b0c621ce5c4d512fa4c54f501370e12d7b5f307da7e804e3c432fa1a5d0db66c0ef7acff5
-  data.tar.gz: ad46dc14ab20e5424e5004f4a226b21e0ef6a32811de528fd943238eb7d36bf2a8b867230558f31050c61917a0f1ebab537c2dacefcf1f9eb0898dba3653f20a
+  metadata.gz: 50443d93f7171a791e8ed2c766407137c956d138ae5adbed7fb3138c1985e130aeda6133521b7ef711fb7a94ff2bd083fc18fb01d693b282b8b705c0abdd8c18
+  data.tar.gz: bdc41027de05096a2b75146cc4c36bcedb89e11004204026c2d062422c6a5849d220a6050f868b5416744d395c857a34b87e09dd57964b4dfb769c53a5f4da23

data/CHANGELOG.md

@@ -5,6 +5,12 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [1.12.0] - 2018-03-01
+### Added
+- check-es-indices-field-number.rb: check if the number of fields in index(es) is approaching limit (default to 1000 in ES) (@huynt1979)
+### Changed
+- Address a couple of rubocop style violations (@huynt1979)
+
 ## [1.11.1] - 2018-02-27
 ### Changed
 - this is a no-op release to test the CI pipeline's ability to publish gems
@@ -230,7 +236,9 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 - initial release
 
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.11.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.12.0...HEAD
+[1.12.0]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.11.1...1.12.0
+[1.11.1]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.11.0...1.11.1
 [1.11.0]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.10.0...1.11.0
 [1.10.0]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.9.0...1.10.0
 [1.9.0]: https://github.com/sensu-plugins/sensu-plugins-elasticsearch/compare/1.8.1...1.9.0

data/README.md

@@ -14,6 +14,7 @@
  * /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
@@ -42,13 +43,13 @@ Note: The test suite uses an elasticsearch instance in order to have passing tes
 
 ```bash
 docker run -d --name sensu-elasticsearch-6 docker.elastic.co/elasticsearch/elasticsearch:6.2.2
-``` 
+```
 
 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). 
+You can find sample output for all tests running successfully in [this gist](https://gist.github.com/alexandrustaetu/d19feea1296d2ce7e367542265252d7a).

data/bin/check-es-indices-field-count.rb

@@ -0,0 +1,194 @@
+#! /usr/bin/env ruby
+#
+#   check-es-indices-field-count
+#
+# DESCRIPTION:
+#   This plugin checks if the number of fields in ES index(es) is approaching limit. ES by default
+#   puts this limit at 1000 fields per index.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   This example checks if the number of fields for an index is reaching its limit set in
+#   index.mapping.total_fields.limit. This check takes as paramater the index name or
+#   comma-separated list of indices, and optionally the type to check on. If type is not specified,
+#   all types in index are examined.
+#   You can also specify an optional value for the limit. When omitted, this will default to 1000.
+#
+#   check-es-indices-field-count.rb -h <hostname or ip> -p 9200
+#           -i <index1>,<index2> --types <type_in_index> -w <pct> -c <pct>
+#
+#   If any indices crossing the specified thresholds (warning/critical), beside the appropriate return code
+#   this check will also output a list of indices with the violated percentage for further troubleshooting.
+# NOTES:
+#
+# LICENSE:
+#   CloudCruiser <devops@hpe.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'elasticsearch'
+require 'sensu-plugins-elasticsearch'
+require 'json'
+
+#
+# ES Indices Field Count
+#
+class ESIndicesFieldCount < Sensu::Plugin::Check::CLI
+  include ElasticsearchCommon
+
+  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 :index,
+         description: 'Elasticsearch indices to check against.
+         Comma-separated list of index names to search.
+         Default to `_all` if omitted. Accepts wildcards',
+         short: '-i INDEX',
+         long: '--indices INDEX',
+         default: '_all'
+
+  option :types,
+         description: 'Elasticsearch types of index to check against.
+         Comma-separated list of types. When omitted, all types are checked against.',
+         short: '-T TYPES',
+         long: '--types TYPES'
+
+  option :limit,
+         description: 'Default number of fields limit to compare against.
+         Elasticsearch defaults this to 1000 if none is specied in index setting.',
+         short: '-l',
+         long: '--limit LIMIT',
+         proc: proc(&:to_i),
+         default: 1000
+
+  option :warn,
+         short: '-w PCT',
+         long: '--warn PCT',
+         description: 'WARNING threshold in percentage',
+         proc: proc(&:to_f),
+         default: 85.0
+
+  option :crit,
+         short: '-c N',
+         long: '--crit N',
+         description: 'CRITICAL threshold in percentage',
+         proc: proc(&:to_f),
+         default: 95.0
+
+  def indexfieldcount
+    index_field_count = {}
+    mappings = client.indices.get_mapping index: config[:index], type: config[:types]
+    mappings.each do |index, index_mapping|
+      unless index_mapping['mappings'].nil?
+        type_field_count = {}
+        index_mapping['mappings'].each do |type, type_mapping|
+          fieldcount = if type_mapping['properties'].nil?
+                         0
+                       else
+                         type_mapping['properties'].length
+                       end
+          type_field_count[type] = fieldcount
+        end
+
+        index_field_count[index] = type_field_count
+      end
+    end
+
+    index_field_count
+  end
+
+  def fieldlimitsetting
+    field_limit_setting = {}
+    settings = client.indices.get_settings index: config[:index]
+    settings.each do |index, index_setting|
+      index_field_limit = index_setting['settings']['index.mapping.total_fields.limit']
+      # when no index.mapping.total_fields.limit, use value of the limit parameter, which defaults to 1000.
+      index_field_limit = config[:limit] if index_field_limit.nil?
+      field_limit_setting[index] = { 'limit' => index_field_limit }
+    end
+
+    field_limit_setting
+  end
+
+  def run
+    fieldcounts = indexfieldcount
+    limits = fieldlimitsetting
+
+    warnings = {}
+    criticals = {}
+
+    if fieldcounts.empty?
+      unknown "Can't find any indices."
+    end
+
+    fieldcounts.each do |index, counts|
+      counts.each do |type, count|
+        pct = count.to_f / limits[index]['limit'] * 100
+
+        if config[:warn] <= pct && pct < config[:crit]
+          warnings[index] = {} if warnings[index].nil?
+          warnings[index][type] = pct.round(2)
+        end
+
+        if config[:crit] <= pct
+          criticals[index] = {} if criticals[index].nil?
+          criticals[index][type] = pct.round(2)
+        end
+      end
+    end
+
+    unless criticals.empty?
+      critical "Number of fields in indices is at critical level.
+#{JSON.pretty_generate(criticals)}"
+    end
+
+    unless warnings.empty?
+      warning "Number of fields in indices is at warning level.
+#{JSON.pretty_generate(warnings)}"
+    end
+
+    ok
+  end
+end

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

@@ -159,11 +159,12 @@ class ESCheckIndicesSizes < Sensu::Plugin::Check::CLI
   def run
     node_fs_stats = client.nodes.stats metric: 'fs,indices'
     nodes_being_used = node_fs_stats['nodes'].values.select { |node| node['indices']['store']['size_in_bytes'] > 0 }
+
     # TODO: come back and cleanup all these rubocop disables with a little refactor
-    # rubocop:disable Style/SingleLineBlockParams
-    used_in_bytes = nodes_being_used.map { |node| node['fs']['data'].map { |data| data['total_in_bytes'] - data['available_in_bytes'] }.flatten }.flatten.inject { |sum, x| sum + x } # rubocop:disable LineLength
+    # rubocop:disable Style/SingleLineBlockParams,Metrics/LineLength
+    used_in_bytes = nodes_being_used.map { |node| node['fs']['data'].map { |data| data['total_in_bytes'] - data['available_in_bytes'] }.flatten }.flatten.inject { |sum, x| sum + x }
     total_in_bytes = nodes_being_used.map { |node| node['fs']['data'].map { |data| data['total_in_bytes'] }.flatten }.flatten.inject { |sum, x| sum + x }
-    # rubocop:enable Style/SingleLineBlockParams LineLength
+    # rubocop:enable Style/SingleLineBlockParams,Metrics/LineLength
 
     if config[:maximum_megabytes] > 0
       target_bytes_used = config[:maximum_megabytes] * 1_000_000

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

@@ -134,11 +134,11 @@ module ElasticsearchQuery
   end
 
   def es_date_math_string(end_time)
-    if config[:minutes_previous] == 0 && \
-       config[:hours_previous] == 0 && \
-       config[:days_previous] == 0 && \
-       config[:weeks_previous] == 0 && \
-       config[:months_previous] == 0
+    if config[:minutes_previous].zero? && \
+       config[:hours_previous].zero? && \
+       config[:days_previous].zero? && \
+       config[:weeks_previous].zero? && \
+       config[:months_previous].zero?
       nil
     else
       es_math = "#{end_time.strftime '%Y-%m-%dT%H:%M:%S'}||"

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-es-transport
@@ -262,6 +262,7 @@ executables:
 - check-es-indices-sizes.rb
 - metrics-es-node-graphite.rb
 - check-es-circuit-breakers.rb
+- check-es-indices-field-count.rb
 - check-es-query-count.rb
 - check-es-query-exists.rb
 - check-es-shard-allocation-status.rb
@@ -281,6 +282,7 @@ files:
 - bin/check-es-file-descriptors.rb
 - bin/check-es-heap.rb
 - bin/check-es-indexes.rb
+- bin/check-es-indices-field-count.rb
 - bin/check-es-indices-sizes.rb
 - bin/check-es-node-status.rb
 - bin/check-es-query-average.rb