sensu-plugins-rancher-service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ad2adc6afdbfb158abd3b7a6825d550e0559e14
+  data.tar.gz: 9039e88c737b03887cb9b2ce3930dff4ab5b7238
+SHA512:
+  metadata.gz: 8c689efdcdd3669af40645f2f92a97b5efa99efe1884f843ae4ec594397a052d52b0409b3e9053fb13478888972f4f6018ed2f149bb16628e519d885c4e4a9a6
+  data.tar.gz: 5c0e4ecafb91af6a4879bf4c1d530c375c42b77814297e83d75f84c40bac7d56b8f2ed692ae7574de90b49c6501a0f96cea0ee14fbc29c40e473cb2eefdfab80

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased
+
+## [0.0.1] - 2016-01-08
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Matteo Cerutti
+
+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,36 @@
+# Sensu plugin for monitoring services running in Rancher
+
+A sensu plugin to monitor the health state of services running in Rancher.
+
+The plugin leverages the Sensu JIT clients feature (https://sensuapp.org/docs/latest/clients#jit-clients) to create a client for every
+Rancher service discovered. The client name is in the format: \<stack_name>_\<service_name>.rancher.internal.
+
+It then generates for every instance (container) running in the service OK/WARN/CRIT/UNKNOWN events via the sensu client socket
+(https://sensuapp.org/docs/latest/clients#client-socket-input), reporting whether the instance is not monitored (WARN), healthy (OK) or unhealthy (CRITICAL).
+
+You can optionally disable monitoring for a service by placing in the rancher-compose service metadata the following:
+
+```
+service:
+  metadata:
+    sensu:
+      monitored: false
+```
+
+## Usage
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-rancher-service.rb (options)
+        --api-url <URL>              Rancher Metadata API URL (default: http://rancher-metadata/2015-07-25)
+        --dryrun                     Do not send events to sensu client socket
+    -w, --warn                       Warn instead of throwing a critical failure
+```
+
+## Deployment
+
+In order to run this check, you might want to deploy a sensu-client running as a container in Rancher, acting as a "sensu proxy".
+
+## Author
+Matteo Cerutti - <matteo.cerutti@hotmail.co.uk>

data/bin/check-rancher-service.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+#
+# check-rancher-service.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-plugin/check/cli'
+require 'net/http'
+require 'json'
+
+class CheckRancherService < Sensu::Plugin::Check::CLI
+  option :api_url,
+         :description => "Rancher Metadata API URL (default: http://rancher-metadata/2015-07-25)",
+         :long => "--api-url <URL>",
+         :proc => proc { |s| s.gsub(/\/$/, '') },
+         :default => "http://rancher-metadata/2015-07-25"
+
+  option :warn,
+         :description => "Warn instead of throwing a critical failure",
+         :short => "-w",
+         :long => "--warn",
+         :boolean => true,
+         :default => false
+
+  option :dryrun,
+         :description => "Do not send events to sensu client socket",
+         :long => "--dryrun",
+         :boolean => true,
+         :default => false
+
+  def initialize()
+    super
+  end
+
+  def send_client_socket(data)
+    if config[:dryrun]
+      puts data.inspect
+    else
+      sock = UDPSocket.new
+      sock.send(data + "\n", 0, "127.0.0.1", 3030)
+    end
+  end
+
+  def send_ok(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 0, "output" => "OK: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_warning(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 1, "output" => "WARNING: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_critical(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 2, "output" => "CRITICAL: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def send_unknown(check_name, source, msg)
+    event = {"name" => check_name, "source" => source, "status" => 3, "output" => "UNKNOWN: #{msg}", "handler" => config[:handler]}
+    send_client_socket(event.to_json)
+  end
+
+  def is_error?(data):
+    if data.is_a?(Hash) and data.has_key?('code') and data['code'] == 404
+      return true
+    else
+      return false
+
+  def api_get(query)
+    begin
+      uri = URI.parse("#{config[:api_url]}#{query}")
+      req = Net::HTTP::Get.new(uri.path, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      resp = Net::HTTP.new(uri.host, uri.port).request(req)
+      data = JSON.parse(resp.body)
+
+      if is_error?(data)
+        return nil
+      else
+        return data
+      end
+    rescue
+      raise "Failed to query Rancher Metadata API - Caught exception (#{$!})"
+    end
+  end
+
+  def get_services()
+    api_get("/services")
+  end
+
+  def get_container(name)
+    api_get("/containers/#{name}")
+  end
+
+  def run
+    services.each do |service|
+      source = "#{service['stack_name']}_#{service['name']}.rancher.internal"
+
+      if service['metadata'].has_key?('sensu') and service['metadata']['sensu'].has_key?('monitored')
+        monitored = service['metadata']['sensu']['monitored']
+      else
+        monitored = true
+      end
+
+      # get containers
+      service['containers'].each do |container_name|
+        check_name = "rancher-container-#{container_name}-health_state"
+        msg = "Instance #{container_name}"
+
+        unless monitored
+          send_ok(check_name, source, "#{msg} not monitored (disabled)")
+        else
+          health_state = get_container(container_name)['health_state']
+          case health_state
+            when 'healthy'
+              send_ok(check_name, source, "#{msg} is healthy")
+
+            when nil
+              send_warning(check_name, source, "#{msg} not monitored")
+
+            else
+              send_critical(check_name, source, "#{msg} is not healthy")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sensu-plugins-rancher-service.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-rancher-service/version'

data/lib/sensu-plugins-rancher-service/version.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-rancher-service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-08 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: This plugin provides facilities for monitoring services running in Rancher
+email: "<matteo.cerutti@hotmail.co.uk>"
+executables:
+- check-rancher-service.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-rancher-service.rb
+- lib/sensu-plugins-rancher-service.rb
+- lib/sensu-plugins-rancher-service/version.rb
+homepage: https://github.com/m4ce/sensu-plugins-rancher-service
+licenses:
+- MIT
+metadata:
+  maintainer: "@m4ce"
+  development_status: active
+  production_status: stable
+  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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for monitoring rancher-service
+test_files: []