rails_monitor 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kevin Radloff <radsaq@gmail.com>
+
+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,49 @@
+# RailsMonitor
+
+This gem allows a rails application developer to simply and easily create an
+application status page with a set of app checks that can double as monitoring
+endpoints for nagios or other systems.
+
+This gem has been developed with the generous support of [LightCastle Technical
+Consulting](http://www.lightcastletech.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_monitor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_monitor
+
+## Usage
+
+Include the monitoring mixin in your controller:
+
+    include RailsMonitor::Monitoring
+
+Define one or more tabs of status checks:
+
+    status_tab :database, [:mysql_is_connected]
+
+Define the accompanying endpoints:
+
+    boolean_status :mysql_is_connected do
+      true
+    end
+
+If your application is using jquery and bootstrap, this is all you should need
+to do.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/views/rails_monitor/status.html.haml

@@ -0,0 +1,38 @@
+.container
+  .row
+    #status_container.settings.span12
+      .row
+        #status_list.span10.offset1.content
+          %h2 Site Status
+
+          %ul.nav.nav-tabs{'data-tabs' => 'tabs'}
+            - first = true
+            - @statuses.each_key do |category|
+              %li{:class => (first ? 'active' : nil)}
+                = link_to(category.to_s.humanize, {:anchor => category}, {'data-toggle' => 'tab'})
+                - first = false
+
+          .tab-content
+            - first = true
+            - @statuses.each do |category, names|
+              .tab-pane{:id => category, :class => (first ? 'active' : nil)}
+                - names.each do |name|
+                  .status_wrapper
+                    = name.to_s.humanize
+                    .status{:id => "status_#{name}", 'data-name' => name}
+                      %pre
+                - first = false
+
+:javascript
+  var updateStatuses = function() {
+    jQuery.each($('.status'), function(ii, status) {
+      var name = $(status).data('name');
+      var elem = $(status).find('pre');
+      elem.html("Loading...");
+      jQuery.ajax(document.location.pathname + "/" + name, {timeout: 10000}).done(function(text) {
+        elem.html(text);
+      });
+    });
+    setTimeout(updateStatuses, 10000);
+  };
+  updateStatuses();

data/lib/rails_monitor/version.rb

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

data/lib/rails_monitor.rb

@@ -0,0 +1,60 @@
+require 'rails_monitor/version'
+require 'active_support/concern'
+
+module RailsMonitor
+  module Monitoring
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_view_path(File.join(File.dirname(__FILE__), '..', 'app', 'views'))
+      @@statuses ||= {}
+      cattr_reader :statuses
+    end
+
+    def index
+      @statuses = self.statuses
+
+      respond_to do |format|
+        format.html do
+          render 'rails_monitor/status'
+        end
+      end
+    end
+
+    module ClassMethods
+      def status_tab(anchor, statuses_to_show = [])
+        self.statuses[anchor] = statuses_to_show
+      end
+
+      def boolean_status(name)
+        raise ArgumentError('No block given') unless block_given?
+
+        define_method(name) do
+          result = yield
+
+          if result
+            render :text => "OK: #{result}"
+          else
+            render :text => "ERROR: #{result}"
+          end
+        end
+      end
+    
+      def numeric_status(name, warn_threshold = nil, error_threshold = nil)
+        raise ArgumentError('No block given') unless block_given?
+    
+        define_method(name) do
+          result = yield.to_i
+
+          if error_threshold && result >= error_threshold
+            render :text => "ERROR: #{result}"
+          elsif warn_threshold && result >= warn_threshold
+            render :text => "WARN: #{result}"
+          else
+            render :text => "OK: #{result}"
+          end
+        end
+      end
+    end
+  end
+end

data/rails_monitor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_monitor"
+  spec.version       = RailsMonitor::VERSION
+  spec.authors       = ["Kevin Radloff"]
+  spec.email         = ["radsaq@gmail.com"]
+  spec.description   = %q{Easily monitor your rails application}
+  spec.summary       = %q{Easily monitor your rails application from a convenient web page, or define endpoints for 3rd party software like nagios.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'actionpack', '>= 3.1.0'
+  spec.add_dependency 'jquery-rails'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rails_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Radloff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily monitor your rails application
+email:
+- radsaq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/rails_monitor/status.html.haml
+- lib/rails_monitor.rb
+- lib/rails_monitor/version.rb
+- rails_monitor.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Easily monitor your rails application from a convenient web page, or define
+  endpoints for 3rd party software like nagios.
+test_files: []