sensu-plugins-habitat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78f83a717bdfd6489442ff6b8ecf5a9827bf75790418bb89cc9dfad4f1e6ebe8
+  data.tar.gz: 4e18e2eade59f650897c2866f68ce96ba9570ad88ff59e4c60dfdc1005242479
+SHA512:
+  metadata.gz: 5ff0ad6acbe87ef80973d755a723e08a1f09b57277b29bcf3bd68dda9fa6c93b354b039a4cf37b0909f12e2976bb4dea93b581f541434dde14bec5e85ed78cbb
+  data.tar.gz: 58e24650b0639c26b9f4bf0819d821547b027d3ad301d532a1178f72c9ee34a5297e403dac55587206ab8b0b257cc22deaa103b25102e7e426fa9bb815bce701

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## [0.1.0] - 2017-10-09
+### Added
+- Initial release
+
+[0.1.0]: https://github.com/socrata-platform/sensu-plugins-habitat/tree/v0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 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,52 @@
+# Sensu Plugins Habitat
+
+[![Build Status](https://img.shields.io/travis/com/socrata-platform/sensu-plugins-habitat.svg)][travis]
+[![Gem Version](https://img.shields.io/gem/v/sensu-plugins-habitat.svg)][rubygems]
+
+[travis]: https://travis-ci.com/socrata-platform/sensu-plugins-habitat
+[rubygems]: https://rubygems.org/gems/sensu-plugins-habitat
+
+A set of Sensu plugins for monitoring Habitat.
+
+## Functionality
+
+This gem includes a plugin for monitoring Habitat services' health check statuses via a supervisor API.
+
+## Files
+
+* bin/check-habitat-service-health.rb
+
+## Usage
+
+***check-habitat-service-health.rb***
+
+With only default options, the `check-habitat-service-health.rb` script assumes a Habitat supervisor on `127.0.0.1:9631`, iterates over all services running under that supervisor, and returns a CRITICAL result for any services with a failing health check.
+
+```shell
+check-habitat-service-health.rb
+```
+
+If the Habitat supervisor is on another host:
+
+```shell
+> check-habitat-service-health.rb -H 192.168.0.4
+> check-habitat-service-health.rb --host 192.168.0.4
+```
+
+If the Habitat supervisor is on another port:
+
+```shell
+> check-habitat-service-health.rb -P 4242
+> check-habitat-service-health.rb --port 4242
+```
+
+To check only a particular set of services running under the Habitat supervisor:
+
+```shell
+> check-habitat-service-health.rb -s service1.default,service2.default
+> check-habitat-service-health.rb --services service1.default,service2.default
+```
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/check-habitat-service-health.rb

@@ -0,0 +1,205 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   check-habitat-service-health.rb
+#
+# DESCRIPTION:
+#   This check queries a Habitat supervisor's API to monitor the health status
+#   of its servies.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# Query a Habitat supervisor on 127.0.0.1:9631 and check all running services:
+#
+#   check-habitat-service-health.rb
+#
+# Query a Habitat supervisor on a non-default host and/or port:
+#
+#
+#   > check-habitat-service-health.rb -H 192.168.0.4
+#   > check-habitat-service-health.rb --host 192.168.0.4
+#   > check-habitat-service-health.rb -P 4242
+#   > check-habitat-service-health.rb --port 4242
+#   > check-habitat-service-health.rb -H 1.2.3.4 -P 5678
+#
+# Check a specific set of services instead of all running ones:
+#
+#   > check-habitat-service-health.rb -s svc1.default,svc2.default
+#   > check-habitat-service-health.rb --services svc1.default,svc2.default
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018, Tyler Technologies <sysadmin@socrata.com>
+#
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'net/http'
+require_relative '../lib/sensu_plugins_habitat/check/base'
+
+#
+# Check Habitat service health.
+#
+class CheckHabitatServiceHealth < SensuPluginsHabitat::Check::Base
+  option :services,
+         short: '-s COMMA,SEPARATED,SERVICE,LIST',
+         long: '--services COMMA,SEPARATED,SERVICE,LIST',
+         description: 'Check specific services instead of all running ones'
+
+  #
+  # - If any monitored services are not OK, print their status strings.
+  # - Print a summary line tallying the number of services in each status.
+  # - Exit with the worst status of the services checked; i.e., if at least one
+  #   service is currently CRITICAL, exit as CRITICAL.
+  #
+  def run
+    puts results_str unless results_str.empty?
+    stat = %i[critical warning unknown].find { |s| !results[s].empty? } || :ok
+    send(stat, summary_str)
+  end
+
+  #
+  # Construct a check result body that lists the output of every service that
+  # isn't in an OK state, to be joined with the summary string for the complete
+  # check output.
+  #
+  # @return [String] a long string of all the non-ok service statuses
+  #
+  def results_str
+    %i[unknown warning critical].map do |stat|
+      results[stat].map { |r| "#{stat.upcase}: #{r}" }
+    end.flatten.compact.join("\n")
+  end
+
+  #
+  # Construct a summary line to display at the end of the check output,
+  # tallying how many services there are of each result status.
+  #
+  # @return [String] a summary status of all the service statuses
+  #
+  def summary_str
+    "Results: #{results[:critical].size} critical, " \
+      "#{results[:warning].size} warning, " \
+      "#{results[:unknown].size} unknown, #{results[:ok].size} ok"
+  end
+
+  #
+  # Turn every health check result into a status string and group them by
+  # result status, structured as:
+  #
+  #   {
+  #     ok: [
+  #       'service_name.service_group: stdout: "output"; stderr: "output"'
+  #     ],
+  #     warning: [],
+  #     critical: [],
+  #     unknown: []
+  #   }
+  #
+  # @return [Hash] the health check data organized by status
+  #
+  def results
+    @results ||= %i[unknown ok warning critical]
+                 .each_with_object({}) do |stat, hsh|
+      data = health_statuses.select { |h| h[:status] == stat.to_s.upcase }
+      hsh[stat] = data.map do |d|
+        "#{d[:service]}: stdout: \"#{d[:stdout].strip}\"; " \
+          "stderr: \"#{d[:stderr].strip}\""
+      end
+    end
+  end
+
+  #
+  # Fetch, save, and return the health check data for every service that we're
+  # supposed to be monitoring, structued as:
+  #
+  #   [
+  #     {
+  #       service: 'service_name.service_group',
+  #       status: 'health_check_status',
+  #       stdout: 'health_check_stdout',
+  #       stderr: 'health_check_stderr'
+  #     }
+  #   ]
+  #
+  # Note that empty outputs in stdout or stderr are returned as empty strings,
+  # not nil/null values.
+  #
+  # @return [Array<Hash>] an array of service health check data
+  #
+  def health_statuses
+    @health_statuses ||= services.map do |svc|
+      { service: svc }.merge(health_of_service(svc))
+    end
+  end
+
+  #
+  # Fetch and return the health of a given service from the supervisor API. If
+  # a service is not found (404, not running at all), consider it a critical
+  # status.
+  #
+  # The supervisor API returns the following HTTP responses for check results:
+  #
+  # * OK => 200 => Net::HTTPOK
+  # * WARNING => 200 => Net::HTTPOK
+  # * CRITICAL => 503 => Net::HTTPServiceUnavailable
+  # * UNKNOWN => 500 => Net::HTTPInternalServerError
+  # * Not running => 404 => Net::HTTPNotFound
+  #
+  # @param service [String] 'svc_name.svc_group'
+  # @return [Hash] the parsed JSON from that service's /health endpoint
+  #
+  def health_of_service(service)
+    resp = hab_get("/services/#{service.tr('.', '/')}/health")
+
+    if resp.is_a?(Net::HTTPNotFound)
+      { status: 'CRITICAL', stdout: '', stderr: 'Service is not running' }
+    else
+      JSON.parse(resp.body, symbolize_names: true)
+    end
+  end
+
+  #
+  # Return an array of the services we should be monitoring, either fed in via
+  # config[:services] or fetched from the supervisor API.
+
+  #
+  # @return [Array<String>] an array of the services to be monitored
+  #
+  def services
+    @services ||= if config[:services]
+                    config[:services].split(',')
+                  else
+                    hab_get_services
+                  end.sort
+  end
+
+  # Fetch and parse the /services endpoint from the supervisor API. If it can't
+  # be fetched for whatever reason, go CRITICAL immediately.
+  #
+  # @return [Array<String>] an array of service names.groups
+  # @raise [CRITICAL] if the services can't be fetched
+  #
+  def hab_get_services
+    resp = hab_get('/services')
+
+    if resp.is_a?(Net::HTTPOK)
+      JSON.parse(resp.body).map { |svc| svc['service_group'] }
+    else
+      critical('Failed to fetch /services from the supervisor ' \
+               "API: #{resp.code}")
+    end
+  end
+end

data/lib/sensu_plugins_habitat/check/base.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: false
+
+#
+#   sensu_plugins_habitat/check/base.rb
+#
+# DESCRIPTION:
+#   This class defines some of the common config options and helper methods for
+#   Habitat 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_habitat/check/base'
+#     class CheckHabitatTest < SensuPluginsHabitat::Check::Base
+#       ...
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018, Tyler Technologies <sysadmin@socrata.com>
+#
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'json'
+require 'net/http'
+require 'openssl'
+require 'sensu-plugin/check/cli'
+require 'uri'
+
+module SensuPluginsHabitat
+  #
+  # Habitat shared base plugin.
+  #
+  class Check
+    # A base class with some common options that the actual plugins can inherit
+    # from.
+    class Base < Sensu::Plugin::Check::CLI
+      option :host,
+             short: '-H HOST',
+             long: '--host HOST',
+             description: 'Host the Habitat supervisor is listening on on',
+             default: '127.0.0.1'
+
+      option :port,
+             short: '-P PORT',
+             long: '--port PORT',
+             description: 'Port the Habitat supervisor is listening on',
+             proc: proc(&:to_i),
+             default: 9631
+
+      option :protocol,
+             short: '-p PROTOCOL',
+             long: '--protocol PROTOCOL',
+             description: 'Switch to HTTPS if supervisor is SSL-ified',
+             default: 'http'
+
+      option :insecure,
+             description: 'Set this flag to disable SSL verification',
+             short: '-i',
+             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
+
+      #
+      # This should never be run, but Sensu complains if we don't define a run
+      # method with an exit.
+      #
+      def run
+        exit 0
+      end
+
+      #
+      # Fetch and return a given endpoint from the Habitat supervisor API.
+      #
+      # @param endpoint [String] an API endpoint
+      # @return [Net::HTTPResponse]
+      #
+      def hab_get(endpoint)
+        server = "#{config[:protocol]}://#{config[:host]}:#{config[:port]}"
+        get(File.join(server, endpoint))
+      end
+
+      #
+      # Use net/http to do a GET on a URL and return the response object. If
+      # the connection is refused or times out, consider it an automatic
+      # CRITICAL, since the check presumably won't be able to proceed.
+      #
+      # @param url [String] the full URL to GET
+      # @return [Net::HTTPResponse] the HTTP response object for processing
+      # raise [CRITICAL] if the connection fails
+      #
+      def get(url)
+        uri = URI(url)
+
+        resp = Net::HTTP.start(*http_params_for(uri)).get(uri)
+
+        resp.is_a?(Net::HTTPRedirection) ? get(resp.header['location']) : resp
+      rescue Errno::ECONNREFUSED, Net::OpenTimeout => e
+        critical("Connection to the supervisor API failed: #{e.message}")
+      end
+
+      #
+      # Assemble the array of params for Net::HTTP.start, according to the
+      # check config and URI object being retrieved.
+      #
+      # @param uri [URI] the URI object being fetched
+      # @return [Array] the array of params for Net::HTTP.start
+      #
+      def http_params_for(uri)
+        conn_opts = {
+          use_ssl: uri.scheme == 'https',
+          open_timeout: config[:timeout],
+          read_timeout: config[:timeout],
+          verify_mode: (OpenSSL::SSL::VERIFY_NONE if config[:insecure]),
+          ca_file: config[:capath]
+        }.compact
+
+        [uri.host, uri.port, conn_opts]
+      end
+    end
+  end
+end

data/lib/sensu_plugins_habitat/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: false
+
+module SensuPluginsHabitat
+  # The version of this Sensu plugin.
+  module Version
+    # The major version.
+    MAJOR = 0
+    # The minor version.
+    MINOR = 1
+    # The patch version.
+    PATCH = 0
+    # Concat them into a version string
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/sensu_plugins_habitat.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: false
+
+require 'sensu_plugins_habitat/check/base'
+require 'sensu_plugins_habitat/version'

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-habitat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Technologies
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: This plugin monitors services under a Habitat supervisor
+email: "<sysadmin@socrata.com>"
+executables:
+- check-habitat-service-health.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-habitat-service-health.rb
+- lib/sensu_plugins_habitat.rb
+- lib/sensu_plugins_habitat/check/base.rb
+- lib/sensu_plugins_habitat/version.rb
+homepage: https://github.com/socrata-platform/sensu-plugins-habitat
+licenses:
+- MIT
+metadata:
+  maintainer: tyler-technologies
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring Habitat services
+test_files: []