sensu-plugins-consul-magec 2.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4664c93f956375d6da0ba008a75bf0ed645af87b
+  data.tar.gz: 8a873cf4cf0998ad7b0f5eaa2f8c485514054901
+SHA512:
+  metadata.gz: 84653760d23291dbe703782d9db4491705ad1144ad73b9807b595c9c43b76e700d5e19e07eb37ff53e9bf28d0e4bced120d1828d6d6102518b65a47190df5548
+  data.tar.gz: cb9559419ed49ee3887514a6330b89cbb161292530ad6c7bc9ec2dda62a6b22ac468e5c3d949a162e5ccd0cf3feeed3947e173be436b51c56a6f021e0bc9e148

data/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## [Unreleased]
+
+## [2.2.1] - 2018-10-01
+### Fixed
+- check-consul-failures: use a put when requesting to remove a node from the agent api (@majormoses)
+
+## [2.2.0] - 2018-06-11
+### Added
+- add ACL support to all consul checks (@scalp42)
+
+## [2.1.1] - 2018-05-31
+### Fixed
+- `check-consul-leader.rb`: Timeout option must be an integer (@scalp42)
+
+## [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)
+
+### Changed
+- appeased the cops (@majormoses)
+
+## [2.0.0] - 2018-03-07
+### Security
+- updated rubocop dependency to `~> 0.51.0` per: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-8418. (@majormoses)
+
+### Breaking Changes
+- removed ruby `< 2.1` support (@majormoses)
+
+### Changed
+- appeased the cops (@majormoses)
+
+## [1.6.1] - 2018-03-02
+### Fixed
+- Bug fix for `check-consul-servers` so timeout option works (@joshbenner)
+
+## [1.6.0] - 2017-09-30
+### Added
+- `check-consul-leader`, `check-consul-members`, and `check-consul-servers` now accept `--insecure`, `--capath`, `--timeout` arguments (@akatch)
+
+### Changed
+- update Changelog guideline location (@majormoses)
+
+## [1.5.0] - 2017-08-09
+### Added
+- `check-consul-failures` now accepts `--keep-failures` and `--critical` arguments (@psyhomb)
+
+## [1.4.1] 2017-08-06
+### Fixed
+- Bug fix for `check-consul-service-health` [#26](https://github.com/sensu-plugins/sensu-plugins-consul/pull/26) (@psyhomb)
+
+### Added
+- ruby 2.4.1 testing (@majormoses)
+
+## [1.4.0] 2017-08-05
+### Added
+- `check-consul-service-health` now accept a `--node` argument that will check all autodiscovered consul services running on the specified node (@psyhomb)
+
+## [1.3.0] 2017-05-05
+### Added
+- `check-consul-failures`, `check-consul-leader`, `check-consul-members`, and `check-consul-servers` now accept a --scheme parameter (@akatch)
+- Add consul maintenance check @okushchenko
+
+## [1.2.0] - 2017-01-26
+### Added
+- `check-consul-service-health` and `check-service-consul` now accept a --tags filter (@wg-tsuereth)
+
+### Fixed
+- check-service-consul should look for 'critical' instead of 'failing' (@mattcl)
+
+## [1.1.0] - 2016-08-03
+### Added
+- check-consul-service-health and check-service-consul now accept a --fail-if-not-found argument @wg-tsuereth
+
+## [1.0.0] - 2016-06-28
+### Fixed
+- Fixed check-consul-service-health and check-service-consul --all argument @wg-tsuereth
+
+### Added
+- check-consul-service-health and check-service-consul now accept a --consul argument to specify a server @wg-tsuereth
+- Support for Ruby 2.3.0
+
+### Removed
+- Support for Ruby 1.9.3
+
+## [0.1.7] - 2016-04-03
+### Added
+- check-consul-service-health will check the health of a specific service (Yieldbot)
+- check-consul-kv-ttl will check Consul KV namespace for timed out global operations (Yieldbot)
+- Added check to alert on consul cluster members, supports querying wan members @aianchici
+
+## [0.0.7] - 2015-11-12
+### Changed
+- Consul checks with UNKNOWN status should fail gracefully
+
+### Fixed
+- Consul service check fixes
+
+## [0.0.6] - 2015-09-29
+### Changed
+- Bug fixes for check-consul-servers.rb
+
+## [0.0.5] - 2015-09-28
+### Added
+- Added check to alert on consul peer servers
+
+## [0.0.4] - 2015-07-14
+### Added
+- Adding script to remove failed consul nodes prior to 72 hour consul window.
+
+## [0.0.3] - 2015-07-14
+### Changed
+- updated sensu-plugin gem to 1.2.0
+
+### Fixed
+- Added check to support removing of failed consul nodes from the cluster
+
+## [0.0.2] - 2015-06-02
+### Fixed
+- added binstubs
+
+### Changed
+- removed cruft from /lib
+
+## [0.0.1] - 2015-05-21
+
+### Added
+- initial release
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.2.1...HEAD
+[2.2.1]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.2.0...2.2.1
+[2.2.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.1.1...2.2.0
+[2.1.1]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.1.0...2.1.1
+[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
+[1.6.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.5.0...1.6.0
+[1.5.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.4.1...1.5.0
+[1.4.1]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.4.0...1.4.1
+[1.4.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.3.0...1.4.0
+[1.3.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/2.1.0...1.3.0
+[1.2.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.1.0...1.2.0
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/1.0.0...1.1.0
+[1.0.0]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.1.7...1.0.0
+[0.1.7]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.7...0.1.7
+[0.0.7]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.6...0.0.7
+[0.0.6]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.5...0.0.6
+[0.0.5]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.4...0.0.5
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-consul/compare/0.0.1...0.0.2

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,29 @@
+## Sensu-Plugins-consul
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-consul.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-consul)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-consul.svg)](http://badge.fury.io/rb/sensu-plugins-consul)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-consul/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-consul)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-consul/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-consul)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-consul.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-consul)
+
+## Functionality
+
+## Files
+ * bin/check-consul-kv-ttl.rb
+ * bin/check-consul-service-health.rb
+ * bin/check-consul-failures.rb
+ * bin/check-consul-leader.rb
+ * bin/check-consul-servers.rb
+ * 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
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes

data/bin/check-consul-failures.rb

@@ -0,0 +1,103 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# Consul returns the numerical values for consul members state, which the
+# numbers used are defined in : https://github.com/hashicorp/serf/blob/master/serf/serf.go
+#
+# StatusNone MemberStatus = iota  (0, "none")
+# StatusAlive                     (1, "alive")
+# StatusLeaving                   (2, "leaving")
+# StatusLeft                      (3, "left")
+# StatusFailed                    (4, "failed")
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+
+class ConsulStatus < 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',
+         default: '8500'
+
+  option :scheme,
+         description: 'consul listener scheme',
+         short: '-S SCHEME',
+         long: '--scheme SCHEME',
+         default: 'http'
+
+  option :keep_failures,
+         description: 'do not remove failing nodes',
+         short: '-k',
+         long: '--keep-failures',
+         boolean: true,
+         default: false
+
+  option :critical,
+         description: 'set state to critical',
+         short: '-c',
+         long: '--critical',
+         boolean: true,
+         default: false
+
+  option :token,
+         description: 'ACL token',
+         long: '--token ACL_TOKEN'
+
+  def run
+    r = RestClient::Resource.new(
+      "#{config[:scheme]}://#{config[:server]}:#{config[:port]}/v1/agent/members",
+      timeout: 5,
+      headers: { 'X-Consul-Token' => config[:token] }
+    ).get
+    if r.code == 200
+      failing_nodes = JSON.parse(r).find_all { |node| node['Status'] == 4 }
+      if !failing_nodes.nil? && !failing_nodes.empty?
+        nodes_names = []
+        failing_nodes.each_entry do |node|
+          nodes_names.push(node['Name'])
+          next if config[:keep_failures]
+          puts "Removing failed node: #{node['Name']}"
+          RestClient::Resource.new(
+            "#{config[:scheme]}://#{config[:server]}:#{config[:port]}/v1/agent/force-leave/#{node['Name']}",
+            timeout: 5,
+            headers: { 'X-Consul-Token' => config[:token] }
+          ).put
+          nodes_names.delete(node['Name'])
+        end
+        ok 'All clear' if nodes_names.empty?
+        critical "Found failed nodes: #{nodes_names}" if config[:critical]
+        warning "Found failed nodes: #{nodes_names}"
+      else
+        ok 'All nodes are alive'
+      end
+    else
+      critical 'Consul is not responding'
+    end
+  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

data/bin/check-consul-kv-ttl.rb

@@ -0,0 +1,176 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+#   check-consul-kv-ttl
+#
+# DESCRIPTION:
+#   This plugin assists in checking a Consul KV namespace for timed out global operations
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: diplomat
+#
+# USAGE:
+#   ./check-consul-kv-ttl -kv 'ttl/service/tag' -w 30 -c 60
+#   ./check-consul-kv-ttl -kv 'ttl/service/tag' -w 30 -c 60 -j -t 'date'
+#   ./check-consul-kv-ttl -kv 'ttl/service/tag' -w 30 -c 60 -j -t 'date' -s 'status'
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2015 Yieldbot, Inc. <devops@yieldbot.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'diplomat'
+require 'json'
+require 'time'
+
+class Hash
+  def dig(dotted_path)
+    parts = dotted_path.split '.', 2
+    match = self[parts[0]]
+    if !parts[1] || match.nil? # rubocop:disable Style/GuardClause
+      return match
+    else
+      return match.dig(parts[1])
+    end
+  end
+end
+
+#
+# Service Status
+#
+class CheckConsulKvTTL < Sensu::Plugin::Check::CLI
+  option :consul,
+         description: 'consul server',
+         long: '--consul SERVER',
+         default: 'http://localhost:8500'
+
+  option :kv,
+         description: 'kv namespace to pull data from',
+         short: '-k NAMESPACE',
+         long: '--kv NAMESPACE',
+         required: true
+
+  option :json,
+         description: 'Process the value as JSON',
+         short: '-j',
+         long: '--json',
+         default: true
+
+  option :timestamp_key,
+         description: 'Use the given dotted path to alert based on the time(ISO8601), if processing as JSON',
+         short: '-t PATH',
+         long: '--timestamp PATH',
+         default: nil
+
+  option :status_key,
+         description: 'Use the given dotted path to alert based on the status, if processing as JSON',
+         short: '-s PATH',
+         long: '--status PATH',
+         default: nil
+
+  option :warning,
+         description: 'Warning TTL Threshold',
+         short: '-w THRESHOLD',
+         long: '--warning THRESHOLD',
+         proc: proc { |a| a.to_i },
+         default: 30
+
+  option :critical,
+         description: 'Critical TTL Threshold',
+         short: '-c THRESHOLD',
+         long: '--critical THRESHOLD',
+         proc: proc { |a| a.to_i },
+         default: 60
+
+  option :token,
+         description: 'ACL token',
+         long: '--token ACL_TOKEN'
+
+  # Do work
+  def run
+    Diplomat.configure do |dip|
+      dip.url = config[:consul]
+      dip.acl_token = config[:token]
+    end
+
+    begin
+      # Retrieve the kv
+      data = Diplomat::Kv.get(config[:kv])
+    rescue Faraday::ResourceNotFound, Diplomat::KeyNotFound
+      critical %(Key/value pair "#{config[:kv]}" does not exist in Consul.)
+    rescue Diplomat::UnknownStatus => e
+      if e.message.include?('403')
+        critical %(ACL token is not authorized to access "#{config[:kv]}")
+      else
+        critical "Unhandled exception(#{e.class}) -- #{e.message}"
+      end
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      critical "Unhandled exception(#{e.class}) -- #{e.message}"
+    end
+
+    # Check if the data is JSON or a timestamp
+    if config[:json]
+      begin
+        # Convert the data to JSON
+        json_data = JSON.parse(data)
+
+        # If the status is set add that to the processing chain
+        if config[:status_key]
+          # Dig to the status
+          kv_status = json_data.dig(config[:status_key])
+
+          # Critical if we can not retrieve the status
+          critical "Unable to retrieve status from JSON data: #{data}" if kv_status.nil?
+
+          # Downcase to ease integration
+          kv_status = kv_status.downcase
+
+          # Flag based off of status
+          warning 'Warning status detected!'    if %w[warning].include? kv_status
+          critical 'Critical status detected!'  if %w[critical unknown].include? kv_status
+        end
+
+        # Dig to the time
+        kv_time = json_data.dig(config[:timestamp_key])
+
+        # Critical if we can not retrieve the time
+        critical "Unable to retrieve time from JSON data: #{data}" if kv_time.nil?
+      rescue JSON::ParserError => e # rubocop:disable Lint/UselessAssignment
+        critical "Unable to parse JSON data: #{data}"
+      end
+    else
+      kv_time = data
+    end
+
+    # Timestamp calculation
+    begin
+      # Convert the time into ISO8601 DateTime object
+      start_time = Time.iso8601(kv_time)
+
+      # Get the current time UTC
+      end_time = Time.now.utc
+
+      # Get diff in seconds between start and end time
+      elapsed_seconds = (end_time - start_time).to_i
+
+      critical "TTL calculation issue -- check date formats -- elapsed seconds is negative(#{elapsed_seconds})" if elapsed_seconds <= -1
+      critical "TTL Expired! Elapsed Time: #{elapsed_seconds}"                if elapsed_seconds > config[:critical]
+      warning  "TTL Expiration Approaching! Elapsed Time: #{elapsed_seconds}" if elapsed_seconds > config[:warning]
+      ok
+    rescue StandardError
+      critical 'Unable to process DateTime objects!'
+    end
+  end
+end