sidekiq-nag 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+
+vendor/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gary Greyling
+
+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,48 @@
+# Sidekiq::Nag
+
+A Sidekiq extention that posts messages in Campfire when queues move slowly. A great way to prempt support calls and keep things flowing :)
+
+## How it works
+
+Sidekiq-nag adds middleware to Sidekiq that timestamps jobs as they enter the queue. When the nag rake task is run it inspects the oldest job in the queue and checks whether its been waiting in the queue for longer than the number of minutes you've configured as the timeout.
+If the job has been in the queue for longer than the timeout then Sidekiq-nag posts a message in Campfire letting you know that things aren't as great as you'd like them to be :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-nag'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-nag
+
+## Configuration
+
+Add a `sidekiq-nag.yml` file to the `config/` directory that looks like this:
+
+    queues:
+      foo_app_critical_queue: 10
+      foo_app_low_priority_queue: 30
+
+    campfire:
+      token: NoaTOEX23...
+      subdomain: foo3
+      room: TheZone
+
+The timeout entered next to each queue name is specified in minutes.
+
+Nag provides you with a rake task that runs the queue checking and Campfire notification.
+The final step in getting it to work is to setup a cron that runs `rake sidekiq-nag:nag` at intervals smaller than the timeouts you've specified in the config file. We run it once every 2 minutes :)
+
+## 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/lib/sidekiq-nag/config.rb

@@ -0,0 +1,27 @@
+module Sidekiq::Nag
+  class Config
+    attr_reader :queues, :campfire
+
+    def initialize
+      @queues = raw_yaml['queues']
+      @campfire = raw_yaml['campfire']
+    end
+
+    def room
+      campfire['room']
+    end
+
+    def token
+      campfire['token']
+    end
+
+    def subdomain
+      campfire['subdomain']
+    end
+
+    private
+      def raw_yaml
+        @raw_yaml ||= YAML::load_file(Rails.root + 'config/sidekiq-nag.yml')
+      end
+  end
+end

data/lib/sidekiq-nag/middleware/timestamper.rb

@@ -0,0 +1,12 @@
+module Sidekiq
+  module Nag
+    module Middleware
+      class Timestamper
+        def call(worker, msg, queue)
+          msg.merge!('enqueued_at' => Time.now.to_f.to_s)
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq-nag/nagger.rb

@@ -0,0 +1,42 @@
+class Sidekiq::Nag::Nagger
+  def nag
+    Sidekiq.redis do |conn|
+      Sidekiq::Nag::Config.new.queues.each do |queue_name, timeout|
+        queue = NaggableQueue.new(conn, queue_name)
+
+        next unless queue.exists?
+        next unless queue.oldest_job_has_timestamp?
+
+        if queue.oldest_job_timestamp.to_f < (Time.now - timeout.to_i.minutes).to_f
+          Sidekiq::Nag::Notifier.new.nag_about_queue(queue_name, timeout)
+        end
+      end
+    end
+  end
+
+  class NaggableQueue
+    def initialize(connection, queue_name)
+      @conn = connection
+      @queue = queue_name
+    end
+
+    def exists?
+      conn.exists("queue:#{queue}")
+    end
+
+    def oldest_job_timestamp
+      oldest_job['enqueued_at']
+    end
+
+    def oldest_job_has_timestamp?
+      oldest_job.has_key? 'enqueued_at'
+    end
+
+    def oldest_job
+      @oldest_job ||= JSON.parse(conn.lindex("queue:#{queue}", conn.llen("queue:#{queue}") - 1))
+    end
+
+    private
+      attr_reader :conn, :queue
+  end
+end

data/lib/sidekiq-nag/notifier.rb

@@ -0,0 +1,17 @@
+class Sidekiq::Nag::Notifier
+  def initialize
+    campfire = Tinder::Campfire.new(config.subdomain, :token => config.token)
+    @room = campfire.find_room_by_name(config.room)
+  end
+
+  def nag_about_queue(queue, timeout)
+    room.speak(":no_good: excuse me, the '#{queue}' queue has been chilling for at least #{timeout} minutes...")
+  end
+
+  private
+    attr_reader :room
+
+    def config
+      @config ||= Sidekiq::Nag::Config.new
+    end
+end

data/lib/sidekiq-nag/railtie.rb

@@ -0,0 +1,21 @@
+class Sidekiq::Nag::Railtie < Rails::Railtie
+  require 'sidekiq-nag/middleware/timestamper'
+
+  initializer :after do
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Sidekiq::Nag::Middleware::Timestamper
+      end
+    end
+
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add Sidekiq::Nag::Middleware::Timestamper
+      end
+    end
+  end
+
+  rake_tasks do
+    load "tasks/nag.rake"
+  end
+end

data/lib/sidekiq-nag/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Nag
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq-nag.rb

@@ -0,0 +1,9 @@
+module Sidekiq
+  module Nag
+    require "sidekiq-nag/version"
+    require "sidekiq-nag/config"
+    require "sidekiq-nag/notifier"
+    require "sidekiq-nag/nagger"
+    require "sidekiq-nag/railtie" if defined?(Rails)
+  end
+end

data/lib/tasks/nag.rake

@@ -0,0 +1,6 @@
+namespace :'sidekiq-nag' do
+  desc "Nags Sidekiq and lets you know when things aren't moving as fast you'd like"
+  task :nag => :environment do
+    Sidekiq::Nag::Nagger.new.nag
+  end
+end

data/sidekiq-nag.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq-nag/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sidekiq-nag"
+  gem.version       = Sidekiq::Nag::VERSION
+  gem.authors       = ["Gary Greyling"]
+  gem.email         = ["greyling.gary@gmail.com"]
+  gem.description   = %q{A Sidekiq extension that will notify you of queues that take too long to process}
+  gem.summary       = %q{Campfire notification of stationary Sidekiq queues}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('rails')
+  gem.add_dependency('whenever')
+
+  gem.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-nag
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary Greyling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rails
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: whenever
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rspec
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: A Sidekiq extension that will notify you of queues that take too long
+  to process
+email:
+- greyling.gary@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-nag.rb
+- lib/sidekiq-nag/config.rb
+- lib/sidekiq-nag/middleware/timestamper.rb
+- lib/sidekiq-nag/nagger.rb
+- lib/sidekiq-nag/notifier.rb
+- lib/sidekiq-nag/railtie.rb
+- lib/sidekiq-nag/version.rb
+- lib/tasks/nag.rake
+- sidekiq-nag.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Campfire notification of stationary Sidekiq queues
+test_files: []