sensu-plugins-elasticsearch 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ed1e5b2be5e2312ace43d768501b9dc7ee06998
-  data.tar.gz: 247045e2d44a0fdf7e72d9d6ab7fccaf9ec799eb
+  metadata.gz: 688a6c3a44c0b90345fcfb6d3a4e557300ecc2ed
+  data.tar.gz: fcc7ae8b297550825127dd780ac5311785ba5aa9
 SHA512:
-  metadata.gz: da755db21691233c63e64a7fb51979ccf616e502f8e4935726bae4592258a915d27c4a24eef4f4fbf71d07640efcff82e0d5ce99de7de50b922fbda1de50577d
-  data.tar.gz: 9d29e89be06ab137540eed13ab6e0c753167069b333d3a277ed7e872e468662bb8066e535b5570be19b6b1ad3a7d9438cb814e46f9b0d04daa1ec2555205591d
+  metadata.gz: 4a904263acfbd9efa5749f33375b18de707800711bff06644b0913fc5ae9e1ea3f61bad2a7f6e90f3f37d7a3ee3305eb572f759856fb3c60972f940dd4f105dd
+  data.tar.gz: 521346128d10b9fe848100f96584174c86976b3f907cffcf0d77e083f6f518769dbf0da9be6ab2e93fd168ef4076967df9500fddc5ac39032f2ffdc9439deabb

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased][unreleased]
 
+## [0.2.0] - 2015-10-15
+### Changed
+- cluster-status check: added a new `status_timeout` option that will use elasticsearch's [`wait_for_status` parameter](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html#request-params) and wait up to the given number of seconds for the cluster to be green. This pervents false alerting during normal elasticsearch operations.
+
 ## [0.1.2] - 2015-08-11
 ### Added
 - add parameters for elasticsearch auth

data/README.md

@@ -14,6 +14,8 @@
  * /bin/check-es-file-descriptors.rb
  * /bin/check-es-heap.rb
  * /bin/check-es-node-status.rb
+ * /bin/check-es-query-count.rb
+ * /bin/check-es-query-exists.rb
  * /bin/metrics-es-cluster.rb
  * /bin/metrics-es-node.rb
  * /bin/metrics-es-node-graphite.rb

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

@@ -62,6 +62,12 @@ class ESClusterStatus < Sensu::Plugin::Check::CLI
          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',
@@ -105,7 +111,11 @@ class ESClusterStatus < Sensu::Plugin::Check::CLI
   end
 
   def acquire_status
-    health = get_es_resource('/_cluster/health')
+    if config[:status_timeout]
+      health = get_es_resource("/_cluster/health?wait_for_status=green&timeout=#{config[:status_timeout]}s")
+    else
+      health = get_es_resource('/_cluster/health')
+    end
     health['status'].downcase
   end
 

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

@@ -0,0 +1,199 @@
+#! /usr/bin/env ruby
+#
+#   check-es-query
+#
+# DESCRIPTION:
+#   This plugin checks an ElasticSearch query.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: elasticsearch
+#
+# USAGE:
+#   This example checks that the count of special_type logs matching a query of
+#       anything (*) at the host elasticsearch.service.consul for the past 90 minutes
+#       will warn if there are under 100 and go critical if the result count is below 1
+#       (The invert flag warns if counts are _below_ the critical and warning values)
+#   check-es-query-count.rb -h elasticsearch.service.consul -q "*" --invert
+#           --types special_type -d 'logging-%Y.%m.%d' --minutes-previous 90 -p 9200 -c 1 -w 100
+#
+# 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 'time'
+
+require_relative 'sensu-plugins-elasticsearch'
+
+#
+# ES Heap
+#
+class ESQueryCount < 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 :types,
+         description: 'Elasticsearch types to limit searches to, comma separated list.',
+         long: '--types TYPES'
+
+  option :minutes_previous,
+         description: 'Minutes before now to check @timestamp against query.',
+         long: '--minutes-previous MINUTES_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :hours_previous,
+         description: 'Hours before now to check @timestamp against query.',
+         long: '--hours-previous HOURS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :days_previous,
+         description: 'Days before now to check @timestamp against query.',
+         long: '--days-previous DAYS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :weeks_previous,
+         description: 'Weeks before now to check @timestamp against query.',
+         long: '--weeks-previous WEEKS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :months_previous,
+         description: 'Months before now 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 :query,
+         description: 'Elasticsearch query',
+         short: '-q QUERY',
+         long: '--query 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',
+         default: 'https'
+
+  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
+
+  def run
+    response = client.count(build_request_options)
+    if config[:invert]
+      if response['count'] < config[:crit]
+        critical 'Query count was below critical threshold'
+      elsif response['count'] < config[:warn]
+        warning 'Query count was below warning threshold'
+      else
+        ok
+      end
+    else
+      if response['count'] > config[:crit]
+        critical 'Query count was above critical threshold'
+      elsif response['count'] > config[:warn]
+        warning 'Query count was above warning threshold'
+      else
+        ok
+      end
+    end
+rescue Elasticsearch::Transport::Transport::Errors::NotFound
+  if config[:invert]
+    if response['count'] < config[:crit]
+      critical 'Query count was below critical threshold'
+    elsif response['count'] < config[:warn]
+      warning 'Query count was below warning threshold'
+    else
+      ok
+    end
+  else
+    ok 'No results found, count was below thresholds'
+  end
+  end
+end

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

@@ -0,0 +1,173 @@
+#! /usr/bin/env ruby
+#
+#   check-es-query-exists
+#
+# DESCRIPTION:
+#   This plugin checks an ElasticSearch query that documents exist.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: elasticsearch
+#
+# USAGE:
+#   This example checks that the count of special_type logs matching a query of
+#       "docker.args:special AND *specialstring* AND _exists_:key.name"
+#       at the host elasticsearch.service.consul and port 9200 for the past 3 minutes
+#       will go critical if there are NO results for that period.
+#       This check is to ensure that events are happening at all.
+#   check-es-query-exists.rb -h elasticsearch.service.consul
+#           -q "docker.args:special AND *specialstring* AND _exists_:key.name" --invert
+#           --types special_type -d 'logging-%Y.%m.%d' --minutes-previous 3 -p 9200
+#
+# 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 'sensu-plugins-elasticsearch'
+
+#
+# ES Heap
+#
+class ESQueryExists < 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 :types,
+         description: 'Elasticsearch types to limit searches to, comma separated list.',
+         long: '--types TYPES'
+
+  option :minutes_previous,
+         description: 'Minutes before now to check @timestamp against query.',
+         long: '--minutes-previous MINUTES_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :hours_previous,
+         description: 'Hours before now to check @timestamp against query.',
+         long: '--hours-previous DAYS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :days_previous,
+         description: 'Days before now to check @timestamp against query.',
+         long: '--days-previous DAYS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :weeks_previous,
+         description: 'Weeks before now to check @timestamp against query.',
+         long: '--weeks-previous WEEKS_PREVIOUS',
+         proc: proc(&:to_i),
+         default: 0
+
+  option :months_previous,
+         description: 'Months before now 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 :query,
+         description: 'Elasticsearch query',
+         short: '-q QUERY',
+         long: '--query 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',
+         default: 'https'
+
+  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
+
+    def run # rubocop:disable all
+      client.exists(build_request_options)
+      ok
+  rescue Elasticsearch::Transport::Transport::Errors::NotFound
+    critical
+    end
+end

data/bin/metrics-es-node-graphite.rb

@@ -123,7 +123,7 @@ class ESNodeGraphiteMetrics < Sensu::Plugin::Metric::CLI::Graphite
     info['version']['number']
   end
 
-  def run # rubocop:disable all
+  def run
     # invert various stats depending on if some flags are set
     os_stat = !config[:disable_os_stats]
     process_stats = !config[:disable_process_stats]

data/lib/sensu-plugins-elasticsearch.rb

@@ -1 +1,3 @@
 require 'sensu-plugins-elasticsearch/version'
+require 'sensu-plugins-elasticsearch/elasticsearch-common'
+require 'sensu-plugins-elasticsearch/elasticsearch-query'

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

@@ -0,0 +1,42 @@
+#
+# DESCRIPTION:
+#   Common helper methods
+#
+# DEPENDENCIES:
+#   gem: elasticsearch
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Brendan Gibat <brendan.gibat@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+require_relative 'elasticsearch-query.rb'
+
+module ElasticsearchCommon
+  include ElasticsearchQuery
+  def initialize
+    super()
+  end
+
+  def client
+    @client ||= begin
+      if !config[:user].nil? && !config[:pass].nil? && !config[:scheme].nil?
+        Elasticsearch::Client.new hosts: [{
+          host:               config[:host],
+          port:               config[:port],
+          user:               config[:user],
+          password:           config[:password],
+          scheme:             config[:scheme],
+          request_timeout:    config[:timeout]
+        }]
+      else
+        Elasticsearch::Client.new host: "#{config[:host]}:#{config[:port]}", request_timeout: config[:timeout]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+#
+# DESCRIPTION:
+#   Common search helper methods
+#
+# DEPENDENCIES:
+#   gem: elasticsearch
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Brendan Gibat <brendan.gibat@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+module ElasticsearchQuery
+  def initialize
+    super()
+  end
+
+  def indices
+    if !config[:index].nil?
+      return config[:index]
+    elsif !config[:date_index].nil?
+      indices = []
+      curr = Time.now.utc.to_i
+      start = curr
+
+      if config[:minutes_previous] != 0
+        start -= (config[:minutes_previous] * 60)
+      end
+      if config[:hours_previous] != 0
+        start -= (config[:hours_previous] * 60 * 60)
+      end
+      if config[:days_previous] != 0
+        start -= (config[:days_previous] * 60 * 60 * 24)
+      end
+      if config[:weeks_previous] != 0
+        start -= (config[:weeks_previous] * 60 * 60 * 24 * 7)
+      end
+      if config[:months_previous] != 0
+        start -= (config[:months_previous] * 60 * 60 * 24 * 7 * 31)
+      end
+      total = 60 * 60 * 24
+      if config[:date_repeat_hourly]
+        total = 60 * 60
+      end
+      (start.to_i..curr.to_i).step(total) do |step|
+        indices.push(Time.at(step).utc.strftime config[:date_index])
+      end
+      unless indices.include?(Time.at(curr).utc.strftime config[:date_index])
+        indices.push(Time.at(curr).utc.strftime config[:date_index])
+      end
+      return indices.join(',')
+    end
+    ['_all']
+  end
+
+  def build_request_options
+    options = {
+      index: indices,
+      ignore_unavailable: true
+    }
+    if !config[:body].nil?
+      options[:body] = config[:body]
+    else
+      es_date_filter = es_date_math_string
+      unless es_date_filter.nil?
+        options[:body] = {
+          'query' => {
+            'filtered' => {
+              'query' => {
+                'query_string' => {
+                  'default_field' => 'message',
+                  'query' => config[:query]
+                }
+              },
+              'filter' => {
+                'range' => {
+                  '@timestamp' => { 'gt' => es_date_filter }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+    unless config[:types].nil?
+      options[:type] = config[:types]
+    end
+    options
+  end
+
+  def es_date_math_string
+    if config[:minutes_previous] == 0 && \
+       config[:hours_previous] == 0 && \
+       config[:weeks_previous] == 0 && \
+       config[:months_previous] == 0
+      return nil
+    else
+      es_math = "#{Time.now.utc.strftime '%Y-%m-%dT%H:%M:%S'}||"
+      if config[:minutes_previous] != 0
+        es_math += "-#{config[:minutes_previous]}m"
+      end
+      if config[:hours_previous] != 0
+        es_math += "-#{config[:hours_previous]}h"
+      end
+      if config[:days_previous] != 0
+        es_math += "-#{config[:days_previous]}d"
+      end
+      if config[:weeks_previous] != 0
+        es_math += "-#{config[:weeks_previous]}w"
+      end
+      if config[:months_previous] != 0
+        es_math += "-#{config[:months_previous]}M"
+      end
+      return es_math
+    end
+  end
+end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -46,6 +46,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.12
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
@@ -186,12 +200,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: Sensu plugins for elasticsearch
+description: |-
+  This plugin provides native ElasticSearch instrumentation
+                                for monitoring and metrics collection, including:
+                                service health and metrics for cluster, node, and more
 email: "<sensu-users@googlegroups.com>"
 executables:
 - metrics-es-node.rb
 - metrics-es-node-graphite.rb
 - metrics-es-cluster.rb
+- check-es-query-exists.rb
+- check-es-query-count.rb
 - check-es-node-status.rb
 - check-es-heap.rb
 - check-es-file-descriptors.rb
@@ -206,10 +225,14 @@ files:
 - bin/check-es-file-descriptors.rb
 - bin/check-es-heap.rb
 - bin/check-es-node-status.rb
+- bin/check-es-query-count.rb
+- bin/check-es-query-exists.rb
 - bin/metrics-es-cluster.rb
 - bin/metrics-es-node-graphite.rb
 - bin/metrics-es-node.rb
 - lib/sensu-plugins-elasticsearch.rb
+- lib/sensu-plugins-elasticsearch/elasticsearch-common.rb
+- lib/sensu-plugins-elasticsearch/elasticsearch-query.rb
 - lib/sensu-plugins-elasticsearch/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-elasticsearch
 licenses: