babysitter 0.0.4 → 0.0.6

data/README.md

@@ -28,13 +28,27 @@ Or install it yourself as:
 
 The default logger does nothing, override if you want to see log output.
 
+### Amazon Simple Notification Service Integration
+
+Babysitter can also make use of Amazons Simple Notification Service to provide notifications of when exceptions occur.
+
+    Babysitter.configure do |c|
+      c.enable_simple_notification_service(
+        access_key_id: "YOUR_ACCESS_KEY_ID",
+        secret_address_key: "YOUR_SECRET_ADDRESS_KEY",
+        topic_arn: "my-topic-arn"
+      )
+    end
+
 ### Monitoring
 
     monitor = Babysitter.monitor("statsd.bucket.name")
-    monitor.start("Workername: description") do |progress|
+    monitor.start("Workername: description") do |tracker|
        things_to_do.each do |work|
           do_some work
-          progress.inc("Workername: {{count}} tasks completed", 1, counting: :work_things) # report progress here
+          tracker.error(:badness,'Something bad happened') if something_bad?
+          tracker.warn(:suspicions,'Something supicious happenedd') if something_bad?
+          tracker.inc("Workername: {{count}} tasks completed", 1, counting: :things_to_do) # report progress here
        end
     end
 
@@ -42,10 +56,15 @@ The default logger does nothing, override if you want to see log output.
 This will send statistics to StatsD in the supplied bucket name and will generate logs like this:
 
 
-    INFO -- : Start: update.combinations Matcher generating possible combinations
+    INFO -- : Start: statsd.bucket.name Matcher generating possible combinations
     INFO -- : Done:  100 combinations generated
     INFO -- : Rate:  20746.88796680498 combinations per second
-    INFO -- : End:  update.combinations
+    INFO -- : End:   statsd.bucket.name 
+
+Logging statistics will incremented for bucket names
+
+    statsd.bucket.name.badness.errors
+    statsd.bucket.name.suspicions.warnings
 
 
 Any exceptions that occur will be logged nicely. Exceptions will abort the process.

data/babysitter.gemspec

@@ -6,8 +6,8 @@ require 'babysitter/version'
 Gem::Specification.new do |gem|
   gem.name          = "babysitter"
   gem.version       = Babysitter::VERSION
-  gem.authors       = ["Nicolas Overloop", "Paul Grayson", "Andy Roberts"]
-  gem.email         = ["noverloop@gmail.com", "paul.grayson@lonelyplanet.com", "coder@onesandthrees.com"]
+  gem.authors       = ["Nicolas Overloop", "Paul Grayson", "Andy Roberts", "Mike Wagg"]
+  gem.email         = ["noverloop@gmail.com", "paul.grayson@lonelyplanet.com", "coder@onesandthrees.com", "michael@guerillatactics.co.uk"]
   gem.description   = %q{Babysits long-running processes and reports progress or failures}
   gem.summary       = %q{Babysits long-running processes and reports progress or failures}
   gem.homepage      = ""
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.add_dependency 'fozzie'
   gem.add_dependency 'timecop'
+  gem.add_dependency 'aws-sdk'
 
   gem.add_development_dependency 'awesome_print'
   gem.add_development_dependency 'rspec'

data/lib/babysitter.rb

@@ -4,9 +4,11 @@ require_relative "babysitter/version"
 require_relative "babysitter/null_logger"
 require_relative "babysitter/configuration"
 require_relative "babysitter/logging"
-require_relative "babysitter/progress"
+require_relative "babysitter/logger_with_stats"
+require_relative "babysitter/tracker"
 require_relative "babysitter/monitor"
 require_relative "babysitter/counter"
+require_relative "babysitter/exception_notifiers"
 require 'fozzie'
 
 module Babysitter
@@ -27,5 +29,8 @@ module Babysitter
     configuration.logger
   end
 
+  def self.exception_notifiers
+    configuration.exception_notifiers
+  end
 
 end

data/lib/babysitter/configuration.rb

@@ -3,11 +3,24 @@ module Babysitter
   class Configuration
 
     attr_writer :logger
+    attr_reader :exception_notifiers
+
+    def initialize
+      @exception_notifiers = []
+    end
 
     def logger
       @logger ||= NullLogger.new
     end
 
+    def enable_simple_notification_service(opts = {})
+      [:access_key_id, :secret_access_key, :topic_arn].each do |key|
+        raise ArgumentError, "#{key} is required" unless opts.has_key?(key)
+      end
+
+      @exception_notifiers << ExceptionNotifiers::SimpleNotificationService.new(opts)
+    end
+
   end
 
-end
+end

data/lib/babysitter/exception_notifiers.rb

@@ -0,0 +1 @@
+require_relative "exception_notifiers/simple_notification_service"

data/lib/babysitter/exception_notifiers/simple_notification_service.rb

@@ -0,0 +1,25 @@
+require 'aws-sdk'
+
+module Babysitter
+  module ExceptionNotifiers
+    class SimpleNotificationService
+      def initialize(opts)
+        access_key = opts.delete :access_key_id
+        secret_access_key = opts.delete :secret_access_key
+        @sns = AWS::SNS.new(access_key_id: access_key, secret_access_key: secret_access_key)
+        @topic = @sns.topics[opts.delete(:topic_arn)]
+        validate_topic
+      end
+
+      def notify(subject, msg)
+        @topic.publish(msg, subject: subject)
+      end
+
+      private
+
+      def validate_topic
+        @topic.display_name
+      end
+    end
+  end
+end

data/lib/babysitter/logger_with_stats.rb

@@ -0,0 +1,43 @@
+module Babysitter
+  class LoggerWithStats
+    include Logging
+
+    attr_accessor :stat_name_prefix
+
+    STATS_SUFFIX_BY_METHOD = { warn: :warnings, error: :errors, fatal: :fatals }
+
+    def initialize(stat_name_prefix) 
+      @stat_name_prefix = stat_name_prefix 
+    end
+
+    def method_missing(meth, *opts)
+      unless %w{ info debug error fatal}.include?(meth.to_s)
+        super
+        return
+      end
+      stats_suffix_from_method(meth).tap{ |suffix| increment(suffix) if suffix }
+      logger.send(meth, *opts)
+    end
+
+    def warn(*opts)
+      increment(stats_suffix_from_method(:warn))
+      logger.warn(*opts)
+    end
+
+    private
+
+    def stats_suffix_from_method(meth)
+      STATS_SUFFIX_BY_METHOD[meth]
+    end
+
+    def increment(stat_name_suffix)
+      Stats.increment full_stat_name(stat_name_suffix)
+    end
+
+    def full_stat_name(stat_name_suffix)
+      stat_name_prefix + [stat_name_suffix]
+    end
+
+  end
+
+end

data/lib/babysitter/monitor.rb

@@ -11,21 +11,21 @@ module Babysitter
     def start(msg=nil, log_every=100, &blk)
       raise ArgumentError, "Stats bucket name must not be blank" if stat_name.nil? or stat_name.empty?
       log_msg = format_log_message(msg)
-      progress = Progress.new(log_every, stat_name)
+      tracker = Tracker.new(log_every, stat_name)
       logger.info "Start: #{log_msg}"
 
       begin
         result = Stats.time_to_do stat_name+[:overall] do
-          blk.call(progress)
+          blk.call(tracker)
         end
       rescue Exception => e
-        progress.final_report rescue nil
-        log_exception_details( log_msg, e )
+        tracker.final_report rescue nil
+        log_exception_details(log_msg, e)
         raise
       end
 
-      progress.send_total_stats
-      progress.final_report
+      tracker.send_total_stats
+      tracker.final_report
       logger.info "End:   #{log_msg}"
       result
     end
@@ -45,11 +45,12 @@ module Babysitter
       stat_name.is_a?(Array) ? stat_name : stat_name.split('.') unless stat_name.nil? or stat_name.empty?
     end
 
-    def log_exception_details( msg, exception )
-      logger.error "Aborting: #{msg} due to exception #{exception.class}: #{exception}"
-      if exception.backtrace
-        exception.backtrace.each { |line| logger.error "    #{line}" }
-      end
+    def log_exception_details(msg, exception)
+      lines = ["Aborting: #{msg} due to exception #{exception.class}: #{exception}"]
+      lines.concat(exception.backtrace) if exception.backtrace
+
+      lines.each { |line| logger.error(line) }
+      Babysitter.exception_notifiers.each { |notifier| notifier.notify(exception.to_s, lines.join("\n")) }
     end
   end
 

data/lib/babysitter/null_logger.rb

@@ -8,4 +8,4 @@ module Babysitter
 
   end
 
-end
+end

data/lib/babysitter/{progress.rb → tracker.rb}

@@ -1,5 +1,5 @@
 module Babysitter
-  class Progress
+  class Tracker
     include Logging
 
     attr_reader :counting, :stat_name, :counter
@@ -24,29 +24,29 @@ module Babysitter
       counter.log_counter_messsage if counter.final_report?
     end
 
-    def warn(partial_bucket_name, message)
-      logger.warn(message)
-      send_warning_stat(partial_bucket_name)
+    def warn(topic_name, message)
+      logger_with_stats_for(topic_name).warn(message)
     end
 
-    def error(partial_bucket_name, message)
-      logger.error(message)
-      send_error_stat(partial_bucket_name)
+    def error(topic_name, message)
+      logger_with_stats_for(topic_name).error(message)
     end
 
     def send_total_stats
       counter.send_total_stats
     end
 
-    private
-
-    def send_warning_stat(partial_bucket_name)
-      Stats.increment stat_name+[partial_bucket_name, :warnings] unless stat_name.nil?
+    def logger_with_stats_for(topic_name)
+      @loggers ||= {}
+      @loggers[topic_name] ||= LoggerWithStats.new(stats_prefix_for_topic(topic_name))
     end
 
-    def send_error_stat(partial_bucket_name)
-      Stats.increment stat_name+[partial_bucket_name, :errors] unless stat_name.nil?
+    private
+
+    def stats_prefix_for_topic(topic_name)
+      stat_name+[topic_name] 
     end
 
   end
+
 end

data/lib/babysitter/version.rb

@@ -1,3 +1,3 @@
 module Babysitter
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/spec/lib/babysitter/configuration_spec.rb

@@ -11,7 +11,52 @@ module Babysitter
         subject.logger.should === null_logger
       end
 
+      it 'has no exception notifiers' do
+        subject.exception_notifiers.should be_empty
+      end
+
+    end
+
+    describe 'enabling Amazon simple notification service integration' do
+      let (:sns_exception_notifier) { double }
+      let (:valid_params) { { 
+        access_key_id: "an-access-key",
+        secret_access_key: "a-secret-address-key",
+        topic_arn: "my-topic-arn" 
+      } }
+
+      before :each do
+        Babysitter::ExceptionNotifiers::SimpleNotificationService.stub(:new).and_return(sns_exception_notifier)
+      end
+
+      it 'requires an access key id' do
+        valid_params.delete :access_key_id
+        -> { subject.enable_simple_notification_service(valid_params) }.should raise_error(ArgumentError, /access_key_id/)
+      end
+
+      it 'requires a secret address key' do
+        valid_params.delete :secret_access_key
+        -> { subject.enable_simple_notification_service(valid_params) }.should raise_error(ArgumentError, /secret_access_key/)
+      end
+
+      it 'requires a topic arn' do
+        valid_params.delete :topic_arn
+        -> { subject.enable_simple_notification_service(valid_params) }.should raise_error(ArgumentError, /topic_arn/)
+      end
+
+      it 'adds an exception notifier' do
+        subject.enable_simple_notification_service(valid_params)
+
+        subject.exception_notifiers.should_not be_empty
+        subject.exception_notifiers.first.should eql(sns_exception_notifier)
+      end
+
+      it 'configures the exception notifier' do
+        ExceptionNotifiers::SimpleNotificationService.should_receive(:new).with(hash_including(valid_params))
+
+        subject.enable_simple_notification_service(valid_params)
+      end
     end
 
   end
-end
+end

data/spec/lib/babysitter/exception_notifiers/simple_notification_service_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Babysitter
+  module ExceptionNotifiers
+    describe SimpleNotificationService do
+      subject { SimpleNotificationService.new(valid_opts) }
+      let(:valid_opts) { {
+        access_key_id: 'an-access-key-id',
+        secret_access_key: 'a-secret-address-key',
+        topic_arn: 'my-topic-arn'
+      } }
+      let(:sns) { double :sns, topics: { 'my-topic-arn' => topic } }
+      let(:topic) { double :topic, publish: nil, display_name: "A topic" }
+      before :each do
+        AWS::SNS.stub(:new).and_return(sns)
+      end
+
+      it 'uses the options passed to configure the credentials for sns' do
+        AWS::SNS.should_receive(:new).with(valid_opts.reject { |key| key == :topic_arn } )
+        subject
+      end
+
+      it 'validates the topic by checking it has a display name' do
+        topic.should_receive(:display_name)
+        subject
+      end
+
+      describe '.notify' do
+        let(:message) { "the message" }
+        let(:notification_subject) { "the subject" }
+
+        it 'publishes to the topic specified' do
+          topic.should_receive(:publish)
+
+          subject.notify(notification_subject, message)
+        end
+
+        it 'publishes the message' do
+          topic.should_receive(:publish).with(message, hash_including(subject: notification_subject))
+
+          subject.notify(notification_subject, message)
+        end
+      end
+    end
+  end
+end

data/spec/lib/babysitter/monitor_spec.rb

@@ -121,11 +121,14 @@ module Babysitter
               monitor.warn(:my_warning_bucket, 'my warning message')
             end
           end
+          before(:each) do
+            Babysitter.stub(:logger).and_return(logger)
+            logger.stub!(:warn)
+            Stats.stub!(:increment)
+          end
 
           it 'calls logger.info with the warning message' do
-            Progress.any_instance.stub(:logger).and_return(logger)
             logger.should_receive(:warn).with( "my warning message")
-            Stats.stub!(:increment)
             subject.start(&start_block_with_warning)
           end
 
@@ -142,11 +145,14 @@ module Babysitter
               monitor.error(:my_error_bucket, 'my error message')
             end
           end
+          before(:each) do
+            Babysitter.stub(:logger).and_return(logger)
+            logger.stub!(:error)
+            Stats.stub!(:increment)
+          end
 
           it 'calls logger.error with the error message' do
-            Progress.any_instance.stub(:logger).and_return(logger)
             logger.should_receive(:error).with( "my error message")
-            Stats.stub!(:increment)
             subject.start(&start_block_with_error)
           end
 
@@ -157,6 +163,46 @@ module Babysitter
           end
         end
 
+        context 'when the block raises an error' do
+          let(:error) { RuntimeError.new(error_message) }
+          let(:backtrace) { 3.times.map { |i| "Line #{i}"} }
+          let(:error_message) { 'A big fat error' }
+          let(:expected_message) { "Aborting: #{bucket_name} due to exception RuntimeError: #{error_message}" }
+          let(:start_block_with_error) { Proc.new { raise error } }
+          before(:each) do
+            error.stub(:backtrace).and_return(backtrace)
+            Babysitter.stub(:logger).and_return(logger)
+            Babysitter.stub(:exception_notifiers).and_return(2.times.map { double notify: nil  })
+            logger.stub!(:error)
+            Stats.stub!(:increment)
+          end
+
+          it 'calls logger.error with the exeption details' do
+            logger.should_receive(:error).with(expected_message)
+            backtrace.each do |line|
+              logger.should_receive(:error).with(/\w*#{line}/)
+            end
+
+            begin
+              subject.start(&start_block_with_error)
+            rescue
+            end
+          end
+          
+          it 'calls each exception notifier with the exception details' do
+            message = [expected_message].concat(backtrace).join("\n")
+
+            Babysitter.exception_notifiers.each do |exception_notifier|
+              exception_notifier.should_receive(:notify).with(error_message, message)
+            end
+
+            begin
+              subject.start(&start_block_with_error)
+            rescue
+            end
+          end
+        end
+
         context 'when the block increments 2 times at intervals of 2 seconds' do
           let(:start_block_for_timing) do
             Proc.new do |counter|

data/spec/lib/babysitter/tracker_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Babysitter
+  describe Tracker do
+
+    subject{ Tracker.new(log_interval, stat_bucket_prefix) }
+    let(:log_interval) { 5 }
+    let(:stat_bucket_prefix) { [:my, :stat, :bucket, :prefix] }
+    let(:logger) { double('boring old vanilla babysitter logger') }
+    before(:each) do
+      Babysitter.stub(:logger).and_return(logger)
+    end
+
+    describe '#logger_with_stats_for' do
+
+      it 'returns the same logger when passed the same symbol twice' do
+        l1 = subject.logger_with_stats_for(:lodgings)
+        l2 = subject.logger_with_stats_for(:lodgings)
+        l1.should be_equal(l2)
+      end
+
+      it 'returns different loggers when passed different symbols' do
+        l = subject.logger_with_stats_for(:lodgings)
+        p = subject.logger_with_stats_for(:places)
+        l.should_not be_equal(p)
+      end
+
+    end # describe '#logger_with_stats' do
+
+    describe 'logger returned by logger_with_stats_for(some_topic)' do
+      subject{ Tracker.new(log_interval, stat_bucket_prefix).logger_with_stats_for(some_topic) }
+      let(:some_topic) { :some_topic }
+      let(:text_of_the_message) {'the message we want in the logs'}
+
+      { warn: :warnings, error: :errors, fatal: :fatals }.each do |message_type, stats_bucket_suffix|
+        describe "##{message_type}" do
+          before(:each) do
+            logger.stub(message_type)
+            Stats.stub!(:increment)
+          end
+
+          it 'logs the message' do
+            logger.should_receive(message_type).with(text_of_the_message)
+            subject.send(message_type, text_of_the_message)
+          end
+
+          it 'sends the stats' do
+            expected_stats_bucket = stat_bucket_prefix + [some_topic, stats_bucket_suffix] 
+            Stats.should_receive(:increment).with(expected_stats_bucket) 
+            subject.send(message_type, text_of_the_message)
+          end
+        end
+
+      end
+
+      [:info, :debug].each do |message_type|
+        describe "##{message_type}" do
+          before(:each) do
+            logger.stub(message_type)
+            Stats.stub!(:increment)
+          end
+
+          it 'logs the message' do
+            logger.should_receive(message_type).with(text_of_the_message)
+            subject.send(message_type, text_of_the_message)
+          end
+
+          it 'sends no stats' do
+            Stats.should_not_receive(:increment)
+            subject.send(message_type, text_of_the_message)
+          end
+        end
+
+      end
+
+    end # describe 'logger returned by logger_with_stats_for(:something)' do
+
+  end
+end
+
+

data/spec/lib/babysitter_spec.rb

@@ -38,4 +38,13 @@ describe Babysitter do
     end
   end
 
+  describe '.exception_notifiers' do
+    let(:exception_notifiers) { double('notifiers').as_null_object}
+
+    it 'returns the notifiers from the configuration' do
+      Babysitter::Configuration.any_instance.stub(:exception_notifiers).and_return(exception_notifiers)
+      Babysitter.exception_notifiers.should eql(exception_notifiers)
+    end
+  end
+
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: babysitter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
 - Nicolas Overloop
 - Paul Grayson
 - Andy Roberts
+- Mike Wagg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fozzie
@@ -45,6 +46,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +99,7 @@ email:
 - noverloop@gmail.com
 - paul.grayson@lonelyplanet.com
 - coder@onesandthrees.com
+- michael@guerillatactics.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,13 +113,18 @@ files:
 - lib/babysitter.rb
 - lib/babysitter/configuration.rb
 - lib/babysitter/counter.rb
+- lib/babysitter/exception_notifiers.rb
+- lib/babysitter/exception_notifiers/simple_notification_service.rb
+- lib/babysitter/logger_with_stats.rb
 - lib/babysitter/logging.rb
 - lib/babysitter/monitor.rb
 - lib/babysitter/null_logger.rb
-- lib/babysitter/progress.rb
+- lib/babysitter/tracker.rb
 - lib/babysitter/version.rb
 - spec/lib/babysitter/configuration_spec.rb
+- spec/lib/babysitter/exception_notifiers/simple_notification_service_spec.rb
 - spec/lib/babysitter/monitor_spec.rb
+- spec/lib/babysitter/tracker_spec.rb
 - spec/lib/babysitter_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -124,12 +147,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Babysits long-running processes and reports progress or failures
 test_files:
 - spec/lib/babysitter/configuration_spec.rb
+- spec/lib/babysitter/exception_notifiers/simple_notification_service_spec.rb
 - spec/lib/babysitter/monitor_spec.rb
+- spec/lib/babysitter/tracker_spec.rb
 - spec/lib/babysitter_spec.rb
 - spec/spec_helper.rb