simple_monitor 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rspec

data/Gemfile

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

data/README.md

@@ -0,0 +1,74 @@
+SimpleMonitor
+=============
+
+Send alerts based on simple monitored conditions in your app.
+
+It provides a basic skeleton for writing unique but consistent
+monitoring checks for your application.  Examples of such checks
+are a Delayed::Job queue that is too full, too many failed logins
+in the last 5 minutes, or a remote service being unreachable.
+
+Installation
+------------
+
+install it via rubygems:
+
+```
+gem install simple_monitor
+```
+
+or put it in your Gemfile:
+
+```ruby
+# Gemfile
+gem 'simple_monitor'
+```
+
+Usage
+-----
+
+SimpleMonitor should be mixed in to a SomeConditionMonitor class
+
+```ruby
+require "simple_monitor"
+
+class HighJobMonitor
+  include SimpleMonitor
+
+  def needs_alert?
+    Queue.jobs.count > options[:job_count_threshold]
+  end
+
+  def send_alert
+    # Alert sending method of your choice.  SimpleMonitor
+    # leaves this up to you
+    Mailer.deliver_high_job_alert(Queue.jobs.count)
+  end
+end
+
+monitor = HighJobMonitor.new(:job_count_threshold => 99)
+monitor.check
+```
+
+For a typical application, it could be desireable to define an
+AppMonitor class with a default send_alert method, and have your
+individual monitor classes inherit from that.
+
+A monitor class can take options on initialization; this is recommended
+for passing in thresholds, email addresses, or other dependencies.
+
+Logging
+-------
+
+SimpleMonitor defaults its logger to a new Logger instance, or
+Rails.logger if that is defined.  If you want to override this,
+do so in your class or via the `logger=` instance method.
+
+When running a `check`, the logger will be warned or provided
+with info whether an alert was needed.  Note this is in addition
+to sending out an alert.
+
+#### Copyright
+
+Copyright (c) (2012) Brendon Murphy. See license.txt for details.
+

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/simple_monitor/version.rb

@@ -0,0 +1,3 @@
+module SimpleMonitor
+  VERSION = "0.0.1"
+end

data/lib/simple_monitor.rb

@@ -0,0 +1,92 @@
+require "simple_monitor/version"
+
+module SimpleMonitor
+  attr_reader :options
+  attr_accessor :logger
+
+  LOG_METHODS = %w[info warn error debug].freeze
+
+  def initialize(options = {})
+    @options = options
+  end
+
+  # Runs the check and sends an alert if needed
+  #
+  # Returns false if the check failed, true if passed
+  def check
+    if needs_alert?
+      warn_alert
+      send_alert
+      false
+    else
+      info_passed
+      true
+    end
+  end
+
+  def warn_alert
+    warn(alert_log_message)
+  end
+
+  # Public: Message to log in case of an alert
+  #
+  # Override this in your monitors to inject data
+  #
+  # Returns: String
+  def alert_log_message
+    "check generated an alert"
+  end
+
+  def info_passed
+    info(passed_log_message)
+  end
+
+  # Public: Message to log in case of a check passing
+  #
+  # Override this in your monitors to inject data
+  #
+  # Returns: String
+  def passed_log_message
+    "check passed"
+  end
+
+  # Public: Conditional method to check if the alert should be sent
+  #
+  # This should be overridden in your individual monitor classes
+  #
+  # Returns a boolean
+  def needs_alert?
+    false
+  end
+
+  # Public: Send out an alert
+  #
+  # This should be overridden in your individual monitor classes,
+  # or base monitor class.  This might be to send an SMS, email
+  # or IRC message
+  def send_alert
+    #no-op
+  end
+
+  # A memoized logger.
+  #
+  # Returns: a logger that responds to warn, info, debug, and error
+  def logger
+    @logger ||=
+      if defined?(Rails)
+        Rails.logger
+      else
+        require "logger"
+        Logger.new(STDOUT)
+      end
+  end
+
+  # Generated methods delegated to the logger.  This is for convenience
+  # as well as for prefixing the monitor class name into the message
+  LOG_METHODS.each do |method|
+    define_method method do |message|
+      message = [self.class.name, message.to_s].join(" -- ")
+      logger.send(method, message)
+    end
+  end
+end

data/license.txt

@@ -0,0 +1,23 @@
+licensed under MIT License:
+
+Copyright (c) 2012 Brendon Murphy
+
+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/simple_monitor.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_monitor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_monitor"
+  s.version     = SimpleMonitor::VERSION
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.licenses    = ["MIT"]
+  s.homepage    = ""
+  s.summary     = %q{Send alerts based on simple monitored conditions in your app}
+  s.description = s.description
+
+  s.rubyforge_project = "simple_monitor"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/spec/simple_monitor_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+class TestMonitor
+  include SimpleMonitor
+
+  attr_reader :last_alert
+
+  def needs_alert?
+    options[:force_alert]
+  end
+
+  def send_alert
+    @last_alert = "Test Monitor Alert"
+  end
+end
+
+describe SimpleMonitor do
+  it "is initialized with optional options" do
+    monitor = TestMonitor.new
+    monitor = TestMonitor.new(:foo => :bar)
+    monitor.options[:foo].should == :bar
+  end
+end
+
+describe SimpleMonitor, "logger" do
+  subject { TestMonitor.new }
+
+  it "is defaulted to Logger.new(STDOUT)" do
+    subject.logger.should be_kind_of(Logger)
+  end
+
+  # Problem, what if its vendored and rails and run in a spec run
+  # that boots rails?
+  it "is defaulted to the Rails.logger if present" do
+    module Rails
+      def self.logger
+        :rails_logger
+      end
+    end
+
+    subject.logger.should == :rails_logger
+
+    Object.send(:remove_const, :Rails)
+  end
+
+  it "sends info, warn, error, and debug methods to it prefixed by the class name" do
+    stub_logger = stub('logger')
+    subject.logger = stub_logger
+    %w[info warn error debug].each do |log_method|
+      stub_logger.should_receive(log_method).with("TestMonitor -- #{log_method}")
+      subject.send(log_method, log_method)
+    end
+  end
+end
+
+describe SimpleMonitor, "running the check" do
+  subject { TestMonitor.new }
+  let(:logger) { stub('logger', :warn => nil, :info => nil) }
+  before { subject.logger = logger }
+
+  context "when an alert needs sending" do
+    before { subject.options[:force_alert] = true }
+
+    it "logs a warning that the check is in alert" do
+      logger.should_receive(:warn).with(/TestMonitor --.*alert/)
+      subject.check
+    end
+
+    it "sends an alert" do
+      subject.check
+      subject.last_alert.should == "Test Monitor Alert"
+    end
+
+    it "returns false" do
+      subject.check.should == false
+    end
+  end
+
+  context "when no alert needs sending" do
+    before { subject.options[:force_alert] = false }
+
+    it "logs info that the check passed" do
+      logger.should_receive(:info).with(/TestMonitor --.*passed/)
+      subject.check
+    end
+
+    it "doesn't send an alert" do
+      subject.check
+      subject.last_alert.should be_nil
+    end
+
+    it "returns true" do
+      subject.check.should == true
+    end
+  end
+end
+
+describe SimpleMonitor, "supports a class including SimpleMonitor" do
+  class ChildTestMonitor < TestMonitor
+    def needs_alert?
+      true
+    end
+
+    def send_alert
+      @last_alert = "CHILD HERE"
+    end
+  end
+
+  subject { ChildTestMonitor.new }
+  let(:logger) { stub('logger', :warn => nil, :info => nil) }
+  before { subject.logger = logger }
+
+  it "to be inherited" do
+    subject.check
+    subject.last_alert.should == "CHILD HERE"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require File.expand_path("../../lib/simple_monitor", __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: simple_monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-21 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2160677420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160677420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160677000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160677000
+description: ''
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/simple_monitor.rb
+- lib/simple_monitor/version.rb
+- license.txt
+- simple_monitor.gemspec
+- spec/simple_monitor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+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: simple_monitor
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Send alerts based on simple monitored conditions in your app
+test_files:
+- spec/simple_monitor_spec.rb
+- spec/spec_helper.rb