rt_health_monitor 0.8.0.pre.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13cb464b9e81668abf4c5dc72a0f48c6e1834e0ebb4e19dcbe51a73ee5a1cb5e
+  data.tar.gz: 66d0c9256a656bbf89ffa4abb59ba4bb5ee81cb38be3281effc4899fb44bac3b
+SHA512:
+  metadata.gz: 6f26b2584e91dfd22b718412fcbbb7d970e074e78b844cd494628b0f0a322f308297840440aac31fbc1cbea32a89598a5023e063722d8d3a0a46dd987188d2b4
+  data.tar.gz: '092792193524f8f4f553299cbed038f4371daf1bba63ec6d42d4d2ec807891aa6e2bdcf9152c69e41b15c813f5024ef020efc77886584d05ac65e405b282af80'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Changelog.md

@@ -0,0 +1,19 @@
+Changelog
+===
+
+master
+
+v0.7.2
+---
+
+* Require sidekiq/api to be able to use Sidekiq::ProcessSet
+
+v0.7.1
+---
+
+* Fix scoping issue
+
+v0.7.0
+---
+
+* Restructured the gem, added sidekiq health check task

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in health_monitor.gemspec
+gemspec

data/README.md

@@ -0,0 +1,121 @@
+Purpose
+=======
+
+* Get information about your applications health status easily
+
+Usage
+=====
+
+Add the gem to your Gemfile
+
+    gem 'rt_health_monitor', require: 'health_monitor'
+
+Add the middleware to your config.
+
+### Rails
+
+Add to you Rails configuration (config/application.rb)
+
+    module <ApplicationName>
+      class Application < Rails::Application
+        config.middleware.use ::HealthMonitorMiddleware, "your_application_name"
+      end
+    end
+
+### Sinatra
+
+Add to config.ru
+
+    use HealthMonitorMiddleware, "your_application_name"
+
+### Padrino
+
+Add to config/apps.rb
+
+    Padrino.use(HealthMonitorMiddleware, "your_application_name")
+
+
+## Configure your dependencies
+
+Put into some place which is loaded on startup, like config/initializer/health_monitor_initializer.rb
+
+    HealthMonitorMiddleware.add("simple", name: "MySQL") { User.where{id > 0}.limit(1) }
+  
+    HealthMonitorMiddleware.add("service", name: 'some_service_name') { RestClient.get(File.join(service-url, 'healthmonitor')) }
+
+Simple-Monitor needs some block which returns true or false for up an down state. Service-Monitor needs an block which returns a complete status response in JSON format. This may be just the health-monitor used by a service.
+
+## Outcome
+
+As soon as the middleware is configured and your application is running, you can acess the health monitor status page adding 'healthmonitor' to your url. It does not depend on the given path.
+
+    http://your_application_url_with_some_path/healthmonitor
+
+This would lead to the following output f.e.:
+
+    {
+      status: "down",
+      name: "my app",
+      simple: [
+      {
+        status: "up",
+        name: "MySQL",
+        time: 0.2758502960205078
+      },
+      {
+        status: "up",
+        name: "Memcached",
+        time: 1.4078617095947266
+      },
+      {
+        status: "up",
+        name: "Resque",
+        time: 3.2737255096435547
+      }
+      ],
+      service: [
+      {
+        status: "down",
+        name: "routes",
+        time: 1295.3431606292725
+      },
+      {
+        status: "up",
+        name: "appendix",
+        info: {
+          simple: [
+            {
+              status: "up",
+              name: "MongoDB",
+              time: 6.000041961669922
+            },
+            {
+              status: "up",
+              name: "MySQL",
+              time: 0
+            }
+          ]
+        },
+        time: 23.989439010620117
+      },
+    ...
+    }
+
+
+## Sidekiq Health Check Task
+
+A task for performing a Sidekiq health check is also included. To use that, just add the following line to your `Rakefile`
+
+```ruby
+require "health_monitor/rake_task"
+```
+
+You must have a `environment` task in your `Rakefile` which loads the environment.  Rails already provides such a task.
+
+A simple environment task looks like this:
+
+```ruby
+task :environment do
+  require_relative "./config/environment" if File.exists?("./config/environment")
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "health_monitor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/health_monitor.rb

@@ -0,0 +1,6 @@
+require 'benchmark'
+require 'health_monitor/monitors/health_monitor'
+require 'health_monitor/monitors/simple_health_monitor'
+require 'health_monitor/monitors/service_health_monitor'
+require 'health_monitor/middleware/health_monitor_middleware'
+require 'health_monitor/version'

data/lib/health_monitor/middleware/health_monitor_middleware.rb

@@ -0,0 +1,48 @@
+require 'rack'
+require 'json'
+
+class HealthMonitorMiddleware
+
+  @@monitor = HealthMonitor.new(name: nil)
+
+  def initialize(app, name, uri = nil)
+    @app = app
+    @uri = uri || "health_monitor"
+    @@monitor.name = name
+  end
+
+  def call(env)
+    return @app.call(env) unless env["REQUEST_URI"] =~ /#{@uri}/
+    request = Rack::Request.new(env)
+
+    stime = Time.now
+    data = @@monitor.get_status(request.params)
+    data[:time] = (Time.now - stime)
+
+    make_response(env, data)
+  end
+
+  def self.add(type, params, &block)
+    @@monitor.send("add_#{type}", params, &block)
+  end
+
+  private def response_code(data)
+    return 503 unless data[:status] == :up
+    200
+  end
+
+  private def xml_response(data)
+    status = (data[:status] == :up) ? 'OK' : 'FAILED'
+    '<pingdom_http_custom_check>' \
+    "<status>#{status}</status>" \
+    "<response_time>#{data[:time].round(3)}</response_time>" \
+    '</pingdom_http_custom_check>'
+  end
+
+  private def make_response(env, data)
+    if env['REQUEST_URI'] =~ /pingdom/
+      return [response_code(data), { 'Content-Type' => 'application/xml' }, [xml_response(data)]]
+    end
+    [response_code(data), { 'Content-Type' => 'application/json' }, [data.to_json]]
+  end
+end

data/lib/health_monitor/monitors/health_monitor.rb

@@ -0,0 +1,55 @@
+class HealthMonitor
+
+  attr_accessor :name, :config, :status, :info, :time
+
+  def initialize(params = {})
+    params.each do |k,v|
+      self.send("#{k}=",v) if self.respond_to?("#{k}=")
+    end
+    @targets ||= []
+  end
+
+  def get_status(params = {})
+    self.status = :up
+
+    check = params["check"].try(:split,',') || @targets.map(&:name)
+    check = check.map{ |t| t.downcase }
+
+    dont_check = params["dont_check"].try(:split,',') || []
+    dont_check = dont_check.map{ |t| t.downcase }
+
+    result = { status: status, name: name }
+    result[:time] = time if time
+    result[:info] = info.slice("simple","service") if info
+
+    (@targets || []).each do |target|
+
+      next unless check.include?(target.name.downcase)
+      next if dont_check.include?(target.name.downcase)
+
+      res = target.get_status
+
+      result[target.type] ||= []
+      result[target.type] << res
+
+      result[:status] = :down if res[:status].to_sym == :down
+    end
+
+    self.status = result[:status]
+
+    result
+  end
+
+  def add_target(target)
+    @targets << target
+  end
+
+  def add_simple(opts, &block)
+    add_target(SimpleHealthMonitor.new(opts, &block))
+  end
+
+  def add_service(opts, &block)
+    add_target(ServiceHealthMonitor.new(opts, &block))
+  end
+
+end

data/lib/health_monitor/monitors/service_health_monitor.rb

@@ -0,0 +1,32 @@
+class ServiceHealthMonitor < HealthMonitor
+  def type
+    :service
+  end
+  
+  def initialize(params = {}, &block)
+    params.each do |k,v|
+      self.send("#{k}=",v) if self.respond_to?("#{k}=")
+    end
+    
+    @block = block
+  end
+
+  def get_status
+    self.info = nil
+
+    begin
+      self.time = Benchmark.measure do
+        self.info = JSON.parse(@block.call)  if @block
+      end.real * 1000
+      self.status = self.info["status"]
+    rescue 
+      self.status = :down
+    end
+    
+    result = { status: status, name: name }
+    result[:info] = info.slice("simple","service") if info
+    result[:time] = time if time
+
+    result
+  end
+end

data/lib/health_monitor/monitors/simple_health_monitor.rb

@@ -0,0 +1,33 @@
+class SimpleHealthMonitor < HealthMonitor
+  def type
+    :simple
+  end
+
+  def info
+  end
+
+  def initialize(params = {}, &block)
+    params.each do |k,v|
+      self.send("#{k}=",v) if self.respond_to?("#{k}=")
+    end
+
+    @block = block
+  end
+
+  def get_status
+    begin
+      self.time = Benchmark.measure do
+        self.status = !!@block.call if @block
+      end.real * 1000
+    rescue
+      self.status = false
+    end
+
+    self.status = (self.status ? :up : :down)
+
+    result = { status: status, name: name }
+    result[:time] = time if time
+
+    result
+  end
+end

data/lib/health_monitor/rake_task.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rake"
+
+class RakeTask
+  include Rake::DSL if defined? Rake::DSL
+
+  def install_tasks
+    desc "Check if Sidekiq is running"
+    task "health_monitor:sidekiq:health" => :environment do
+      require "sidekiq/api"
+      hostname = ENV["HOSTNAME"] || `hostname -f`.strip
+      ps = ::Sidekiq::ProcessSet.new
+      up = ps.any? { |p| p["hostname"] == hostname && p["quiet"] == "false" }
+
+      if up
+        puts "UP"
+        exit 0
+      end
+
+      puts "DOWN"
+      exit 1
+    end
+  end
+end
+
+RakeTask.new.install_tasks

data/lib/health_monitor/version.rb

@@ -0,0 +1,3 @@
+class HealthMonitor
+  VERSION = "0.8.0.pre.rc1"
+end

data/rt_health_monitor.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "health_monitor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rt_health_monitor"
+  spec.version       = HealthMonitor::VERSION
+  spec.authors       = ["Martin Fuehrlinger", "0xdco", "Georg Gadinger"]
+  spec.email         = ["maf@runtastic.com", "wv@0xd.co", "nilsding@nilsding.org"]
+
+  spec.summary       = "Monitor your db and services health!"
+  spec.description   = "Monitoring"
+  spec.homepage      = "https://github.com/runtastic/health_monitor"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rt_health_monitor
+version: !ruby/object:Gem::Version
+  version: 0.8.0.pre.rc1
+platform: ruby
+authors:
+- Martin Fuehrlinger
+- 0xdco
+- Georg Gadinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Monitoring
+email:
+- maf@runtastic.com
+- wv@0xd.co
+- nilsding@nilsding.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Changelog.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/health_monitor.rb
+- lib/health_monitor/middleware/health_monitor_middleware.rb
+- lib/health_monitor/monitors/health_monitor.rb
+- lib/health_monitor/monitors/service_health_monitor.rb
+- lib/health_monitor/monitors/simple_health_monitor.rb
+- lib/health_monitor/rake_task.rb
+- lib/health_monitor/version.rb
+- rt_health_monitor.gemspec
+homepage: https://github.com/runtastic/health_monitor
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Monitor your db and services health!
+test_files: []