app_status 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Alex Dean
+
+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,115 @@
+# AppStatus
+
+AppStatus is a Rails engine which makes it easy to expose application status
+data in a way easily consumed by Nagios or other monitoring packages.
+
+## Installation
+
+### `Gemfile`
+
+```ruby
+gem 'app_status'
+```
+
+### `config/routes.rb`
+
+Wire it up.
+
+```ruby
+mount AppStatus::Engine, at: "/status"
+```
+
+This exposes the following URLs
+  - `http://localhost:3000/status`
+    renders html or json according to Accept headers. Defaults to JSON.
+  - `http://localhost:3000/status/index.json`
+  - `http://localhost:3000/status/index.html` <-- fugly
+
+
+### `config/initializers/app_status.rb`
+
+This is where you set up the checks which you want to be run when
+someone hits the URL above. Set up some calls which evaluate the health
+of your application and call `add` for each one.
+
+```ruby
+AppStatus::CheckCollection.configure do |c|
+  value = some_service_check
+  c.add(:name => 'some_service', :status => :ok, :details => value)
+end
+```
+
+The checks that you set up here are not run when you configure them. They're
+run whenever someone hits the check URL.
+
+Status values (in ascending order of seriousness)
+  - :ok
+  - :warning
+  - :critical
+  - :unknown
+
+These are set up to be compatible with Nagios.
+
+Details doesn't have to be a string. It can be anything which is serializable
+as JSON.
+
+## Usage
+
+`$ curl -H 'Accept: application/json' http://localhost:3000/status`
+
+Output will look something like this:
+```json
+{
+  "status": "critical",
+  "status_code": 2,
+  "run_time_ms": 52,
+  "finished": "2013-10-03T21:28:10Z",
+  "details": {
+    "some_service": {
+      "status": "ok",
+      "status_code": 0,
+      "details": "Looks good!"
+    },
+    "failing_service": {
+      "status": "critical",
+      "status_code": 2,
+      "details": "Oh noes!"
+    }
+  }
+}
+```
+
+The overall status will be the worst status which is actually observed in your
+individual checks.
+
+## Nagios Integration
+
+[bin/check_app_status.rb](https://github.com/alexdean/app_status/blob/master/bin/check_app_status.rb)
+is a Nagios check script which can be used to monitor the output from `app_status`
+
+```
+$ bin/check_app_status.rb --help
+Nagios check script for app_status. See https://github.com/alexdean/app_status
+    -v, --verbose                    Output more information
+    -V, --version                    Output version information
+    -h, --help                       Display this screen
+    -u, --url VAL                    Url to monitor
+    -a, --auth VAL                   HTTP basic auth in the form 'user:password'
+    -t, --timeout VAL                Timeout after waiting this long for a response.
+```
+
+The script's exit status is derived from the overall status returned by the
+server. Individual detail items will be grouped by status for display.
+(Unknowns are displayed together, then criticals, then warnings, then OKs.)
+
+Sample output (using verbose mode)
+
+```
+$ bin/check_app_status.rb --url http://localhost:3000/status -v
+2013-10-03T20:54:16-05:00  options: {:timeout=>10, :url=>"http://localhost:3000/status"}
+2013-10-03T20:54:16-05:00  timeout: 10s
+2013-10-03T20:54:16-05:00  response body: {"status":"warning","status_code":1,"run_time_ms":0,"finished":"2013-10-04T01:54:16Z","details":{"some_service":{"status":"ok","status_code":0,"details":"Looks good!"},"failing_service":{"status":"warning","status_code":1,"details":"Oh noes!"}}}
+
+WARN: failing_service:'Oh noes!'
+OK: some_service:'Looks good!'
+```

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AppStatus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/app_status/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/app_status/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/app_status/application_controller.rb

@@ -0,0 +1,4 @@
+module AppStatus
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/app_status/status_controller.rb

@@ -0,0 +1,13 @@
+module AppStatus
+  class StatusController < ApplicationController
+    def index
+      @checks = CheckCollection.new
+      @checks.evaluate!
+
+      respond_to do |format|
+        format.json { render json: @checks.as_json}
+        format.html
+      end
+    end
+  end
+end

data/app/helpers/app_status/application_helper.rb

@@ -0,0 +1,4 @@
+module AppStatus
+  module ApplicationHelper
+  end
+end

data/app/models/app_status/check_collection.rb

@@ -0,0 +1,106 @@
+# collect a variety of checks for reporting to nagios
+
+module AppStatus
+
+  class CheckCollection
+
+    @@config_proc = nil
+
+    # Add checks here.
+    #
+    # These checks are re-run whenever evaluate! is called on an instance.
+    # They aren't run at configure time.
+    #
+    # The block recieves an instance of AppStatus::CheckCollection as an
+    # argument.
+    #
+    # example (put this in config/initalizers/app_status.rb):
+    #
+    #   AppStatus::CheckCollection.configure do |c|
+    #
+    #     value = some_service_check
+    #     status = value > 100 ? :ok : :critical
+    #     c.add(:name => 'some_service', :status => status, :details => value)
+    #
+    #   end
+    def self.configure(&block)
+      @@config_proc = block
+    end
+
+    def self.clear_checks!
+      @@config_proc = nil
+    end
+
+    def initialize
+      @valid_status = {
+              ok: 0,
+         warning: 1,
+        critical: 2,
+         unknown: 3
+      }.freeze
+
+      @checks = HashWithIndifferentAccess.new
+      @eval_finished = nil
+      @eval_time = 0
+    end
+
+    # add the results of a check to the collection.
+    # this should describe the health of some portion of your application
+    #
+    # example:
+    #   value = some_service_check
+    #   c.add(:name => 'some_service', :status => :ok, :details => value)
+    def add(options={})
+      raise ArgumentError, ":name option is required." if ! options[:name]
+      raise ArgumentError, ":status option is required." if ! options[:status]
+
+      name = options[:name].to_sym
+      status = options[:status].to_sym
+      details = options[:details].to_s
+
+      # blow up if someone sends us options we don't understand.
+      other_options = options.keys - [:name, :status, :details]
+      if other_options.size > 0
+        raise ArgumentError, "Unrecognized option(s) for '#{name}' check: #{other_options.join(',')}"
+      end
+
+      raise ArgumentError, "'#{status}' is not a valid status for check '#{name}'." if ! valid_status?(status)
+      raise ArgumentError, "Check name '#{name}' has already been added." if @checks.keys.include?(name)
+
+      @checks[name] = {status: status, status_code: @valid_status[status], details: details}
+    end
+
+    def valid_status?(status)
+      @valid_status.keys.include?(status)
+    end
+
+    # run the checks added via configure
+    # results of the checks are available via as_json
+    def evaluate!
+      start = Time.now
+      @checks = {}
+      @@config_proc.call(self) if @@config_proc
+      @eval_finished = Time.now.utc
+      @eval_time = (Time.now - start) * 1000
+    end
+
+    def as_json
+      if @checks.size == 0
+        max_status = :unknown
+        max_int = @valid_status[max_status]
+      else
+        max_int = @checks.inject([]){ |memo,val| memo << val[1][:status_code]; memo}.max
+        max_status = @valid_status.invert[max_int]
+      end
+
+      HashWithIndifferentAccess.new({
+        status: max_status,
+        status_code: max_int,
+        run_time_ms: @eval_time.to_i,
+        finished: @eval_finished.iso8601,
+        checks: @checks
+      })
+    end
+  end
+
+end

data/app/views/app_status/status/index.html.haml

@@ -0,0 +1,16 @@
+- data = @checks.as_json
+
+%div
+  Overall Status
+  = data[:status]
+
+%div
+  %table.table
+    - data[:details].each do |key,data|
+      %tr
+        %td
+          =key
+        %td
+          =data[:status]
+        %td
+          =data[:details]

data/app/views/layouts/app_status/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>App Status</title>
+  <%= stylesheet_link_tag    "app_status/application", :media => "all" %>
+  <%= javascript_include_tag "app_status/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')

data/bin/haml

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'haml' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('haml', 'haml')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('railties', 'rails')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rdoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rdoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'rdoc')

data/bin/ri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'ri')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/sprockets

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sprockets', 'sprockets')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/bin/tt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('treetop', 'tt')

data/config/routes.rb

@@ -0,0 +1,4 @@
+AppStatus::Engine.routes.draw do
+  root :to => 'status#index', :defaults => {:format => 'json'}
+  match "/index" => 'status#index'
+end

data/lib/app_status/engine.rb

@@ -0,0 +1,12 @@
+module AppStatus
+  class Engine < ::Rails::Engine
+    isolate_namespace AppStatus
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      #g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/app_status/version.rb

@@ -0,0 +1,3 @@
+module AppStatus
+  VERSION = "0.1.0"
+end

data/lib/app_status.rb

@@ -0,0 +1,5 @@
+require "app_status/engine"
+require "haml"
+
+module AppStatus
+end

data/lib/tasks/app_status_tasks.rb

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :app_status do
+#   # Task goes here
+# end