sensu-plugins-consul 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c42f06da46292439afdd1dc4fd8a8b8e332d9e405df5675b414fd9d1cd617c6d
-  data.tar.gz: 19fc38700fc27fe665acc2f1e292273482b77791f3825cd8215998a3827d31c1
+  metadata.gz: c7c1ef8f95efae49bd9e72c798be02494c70fb337c8494b874e95a746d3f3208
+  data.tar.gz: e17a0003846a9a8d0369c787c02c708a81d99e3e9cb1006be03dd39cdf15bee7
 SHA512:
-  metadata.gz: 7ace706ab7e8fc0a4d7ee396b00602004d067a868190afae22eca72651967b44046bc9a7ffd004cfc206a410ec01b779e9b8f945f756329101e3ffbd2607af63
-  data.tar.gz: e63d2a3fe6bc2cbeab4d02036148474ac8375ea1199026675ee110dfbf8023fd6eb4699af27d8108a92d72b56be21f6e7b46937019faa6cfd880c5819a981dd4
+  metadata.gz: 054f69b81bd27515f83eca13b9ad4bf6b4b937801e4593219eaf38ddd77100464b49ecfa55ce6507bedff57e423423e5d95ae91cc41a74d09ef35fc38562f909
+  data.tar.gz: 11c947c6fb23a653d124e8486e0d0860dc24f0895e8fe556643bc7c129b13006d1e867fa45493605844277096440fc731753cb84c4e023a288af3d9ddd9ac5f0

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [2.1.0] - 2018-03-29
+### Added
+- `check-consul-quorum.rb`: Check how many servers can be lost while maintaining quorum (@roboticcheese)
+- `check-consul-stale-peers.rb`: Check for stale peers in the raft configuration (@roboticcheese)
+
 ## [2.0.1] - 2018-03-27
 ### Security
 - updated yard dependency to `~> 0.9.11` per: https://nvd.nist.gov/vuln/detail/CVE-2017-17042 (@majormoses)
@@ -119,7 +124,8 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.0.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.1.0...HEAD
+[2.1.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.6.1...2.0.0
 [1.6.1]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.6.0...1.6.1

data/README.md

@@ -17,6 +17,8 @@
  * bin/check-consul-members.rb
  * bin/check-service-consul.rb
  * bin/check-consul-maintenance.rb
+ * bin/check-consul-quorum.rb
+ * bin/check-consul-stale-peers.rb
 
 ## Usage
 

data/bin/check-consul-quorum.rb

@@ -0,0 +1,91 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   check-consul-quorum
+#
+# DESCRIPTION:
+#   This plugin checks how many nodes the cluster will be able to lose while
+#   still maintaining quorum.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   Connect to localhost, go critical when the cluster is at its minimum for
+#   quorum:
+#     ./check-consul-quorum
+#
+#   Connect to a remote Consul server over HTTPS:
+#     ./check-consul-quorum -s 192.168.42.42 -p 4443 -P https
+#
+#   Go critical when the cluster can lose one more server and keep quorum:
+#     ./check-consul-quorum -W 2 -C 1
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018, Jonathan Hartman <j@hartman.io>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-consul/check/base'
+
+#
+# Consul quorum status
+#
+class ConsulQuorumStatus < SensuPluginsConsul::Check::Base
+  option :warning,
+         description: 'Warn when the cluster has this many spare servers ' \
+                      'beyond the minimum for quorum',
+         short: '-W NUMBER_OF_SPARE_SERVERS',
+         long: '--warning NUMBER_OF_SPARE_SERVERS',
+         proc: proc(&:to_i),
+         default: 1
+
+  option :critical,
+         description: 'Go critical when the cluster has this many spare ' \
+                      'servers beyond the minimum for quorum',
+         short: '-C NUMBER_OF_SPARE_SERVERS',
+         long: '--critical NUMBER_OF_SPARE_SERVERS',
+         proc: proc(&:to_i),
+         default: 0
+
+  def run
+    raft = consul_get('operator/raft/configuration')
+    members = consul_get('agent/members')
+
+    total = raft['Servers'].select { |s| s['Voter'] == true }.length
+    required = total / 2 + 1
+    alive = members.select do |m|
+      m.key?('Tags') && m['Tags']['role'] == 'consul' && m['Status'] == 1
+    end.length
+
+    spares = alive - required
+
+    msg = "Cluster has #{alive}/#{total} servers alive and"
+    msg = if spares < 0
+            "#{msg} has lost quorum"
+          elsif spares.zero?
+            "#{msg} has the minimum required for quorum"
+          else
+            "#{msg} can lose #{spares} more without losing quorum"
+          end
+
+    if spares < 0 || spares <= config[:critical]
+      critical msg
+    elsif spares <= config[:warning]
+      warning msg
+    else
+      ok msg
+    end
+  end
+end

data/bin/check-consul-stale-peers.rb

@@ -0,0 +1,73 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   check-consul-stale-peers
+#
+# DESCRIPTION:
+#   This plugin checks the raft configuration for stale ("unknown") peers.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   Connect to localhost, go critical when there are any stale peers:
+#     ./check-consul-stale-peers
+#
+#   Connect to a remote Consul server over HTTPS:
+#     ./check-consul-stale-peers -s 192.168.42.42 -p 4443 -P https
+#
+#   Go critical when the cluster has two or more stale peers:
+#     ./check-consul-stale-peers -W 1 -C 2
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018, Jonathan Hartman <j@hartman.io>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-consul/check/base'
+
+#
+# Consul stale peers
+#
+class ConsulStalePeers < SensuPluginsConsul::Check::Base
+  option :warning,
+         description: 'Warn when there are this many stale peers',
+         short: '-W NUMBER_OF_PEERS',
+         long: '--warning NUMBER_OF_PEERS',
+         proc: proc(&:to_i),
+         default: 1
+
+  option :critical,
+         description: 'Go critical when there are this many stale peers',
+         short: '-C NUMBER_OF_PEERS',
+         long: '--critical NUMBER_OF_PEERS',
+         proc: proc(&:to_i),
+         default: 1
+
+  def run
+    raft = consul_get('operator/raft/configuration')
+
+    res = raft['Servers'].select { |s| s['Node'] == '(unknown)' }.length
+
+    msg = "Cluster contains #{res} stale peer#{'s' unless res == 1}"
+
+    if res >= config[:critical]
+      critical msg
+    elsif res >= config[:warning]
+      warning msg
+    else
+      ok msg
+    end
+  end
+end

data/lib/sensu-plugins-consul/check/base.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: false
+
+#
+#   sensu-plugins-consul/check/base
+#
+# DESCRIPTION:
+#   This class defines some of the common config options and helper methods for
+#   other Consul plugins to use.
+#
+# OUTPUT:
+#   N/A
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   Import this file and create subclasses of the included plugin class.
+#     require 'sensu-plugins-consul/check/base'
+#     class ConsulTestStatus < SensuPluginsConsul::Check::Base
+#       ...
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018, Jonathan Hartman <j@hartman.io>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'json'
+require 'rest-client'
+require 'sensu-plugin/check/cli'
+
+#
+# Consul shared base plugin
+#
+module SensuPluginsConsul
+  class Check
+    class Base < Sensu::Plugin::Check::CLI
+      option :server,
+             description: 'Consul server',
+             short: '-s SERVER',
+             long: '--server SERVER',
+             default: '127.0.0.1'
+
+      option :port,
+             description: 'Consul HTTP port',
+             short: '-p PORT',
+             long: '--port PORT',
+             proc: proc(&:to_i),
+             default: 8500
+
+      option :protocol,
+             description: 'Consul listener protocol',
+             short: '-P PROTOCOL',
+             long: '--protocol PROTOCOL',
+             in: %w[http https],
+             default: 'http'
+
+      option :insecure,
+             description: 'Set this flag to disable SSL verification',
+             short: '-k',
+             long: '--insecure',
+             boolean: true,
+             default: false
+
+      option :capath,
+             description: 'Absolute path to an alternative CA file',
+             short: '-c CAPATH',
+             long: '--capath CAPATH'
+
+      option :timeout,
+             description: 'Connection will time out after this many seconds',
+             short: '-t TIMEOUT_IN_SECONDS',
+             long: '--timeout TIMEOUT_IN_SECONDS',
+             proc: proc(&:to_i),
+             default: 5
+
+      #
+      # Fetch and return the parsed JSON data from a specified Consul API endpoint.
+      #
+      def consul_get(endpoint)
+        url = "#{config[:protocol]}://#{config[:server]}:#{config[:port]}/" \
+              "v1/#{endpoint}"
+        options = { timeout: config[:timeout],
+                    verify_ssl: !config[:insecure],
+                    ssl_ca_file: config[:capath] }
+
+        JSON.parse(RestClient::Resource.new(url, options).get)
+      rescue Errno::ECONNREFUSED
+        critical 'Consul is not responding'
+      rescue RestClient::RequestTimeout
+        critical 'Consul connection timed out'
+      rescue RestClient::Exception => e
+        unknown "Consul returned: #{e}"
+      end
+    end
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-consul
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -189,8 +189,10 @@ executables:
 - check-consul-leader.rb
 - check-consul-maintenance.rb
 - check-consul-members.rb
+- check-consul-quorum.rb
 - check-consul-servers.rb
 - check-consul-service-health.rb
+- check-consul-stale-peers.rb
 - check-service-consul.rb
 extensions: []
 extra_rdoc_files: []
@@ -203,10 +205,13 @@ files:
 - bin/check-consul-leader.rb
 - bin/check-consul-maintenance.rb
 - bin/check-consul-members.rb
+- bin/check-consul-quorum.rb
 - bin/check-consul-servers.rb
 - bin/check-consul-service-health.rb
+- bin/check-consul-stale-peers.rb
 - bin/check-service-consul.rb
 - lib/sensu-plugins-consul.rb
+- lib/sensu-plugins-consul/check/base.rb
 - lib/sensu-plugins-consul/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-consul
 licenses: