librato-sidekiq 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/History.md

@@ -0,0 +1,8 @@
+librato-sidekiq changelog
+=====================
+
+HEAD
+=======
+- Initial commit
+- Each completed job measures current stats, timing, and increments processed for queue and worker name
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Scott Klein <scott@statuspage.io>
+
+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,86 @@
+librato-sidekiq
+=====
+
+librato-sidekiq is a simple gem to stick Sidekiq stats and granular processing counts/times into [Librato Metrics](http://metrics.librato.com/)
+
+
+Requirements and Compatibility
+------------
+
+Gems:
+
+ * sidekiq
+ * librato-rails
+
+Compatibility (tested):
+
+ * Ruby 2.0.0
+
+(if you can confirm another version of Ruby, email me at scott@statuspage.io)
+
+
+Usage with Rails 3.x
+---------------------------
+
+In your Gemfile:
+
+```ruby
+gem 'librato-sidekiq'
+```
+
+In `config/environments/librato_sidekiq.rb`:
+
+```ruby
+# only needed for fine-tuning, gem will enable all metrics by default
+Librato::Sidekiq::Middleware.configure do |c|
+  # only enable for production
+  c.enabled = Rails.env.production?
+
+  # only allow these 3 queues
+  c.whitelist_queues = %w(default cron notifications)
+
+  # ignore these worker classes
+  c.blacklist_classes = %w(CronSchedulerWorker NotificationCheckerWorker)
+end
+```
+
+
+Configuration
+------------------------
+Librato::Sidekiq accepts the following options.
+
+**enabled**: Boolean, true by default
+
+**whitelist_queues**: Array, list of queue names that will be the only ones sent to Librato (optional)
+
+**blacklist_queues**: Array, list of queue names that will not be sent to Librato (optional)
+
+**whitelist_classes**: Array, list of worker classes that will be the only ones sent to Librato (optional)
+
+**blacklist_queues**: Array, list of worker classes that will not be sent to Librato (optional)
+
+
+Contributing
+-------------
+
+If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update History.md with a one sentence description of your fix so you get credit as a contributor.
+
+
+Thanks
+------------
+
+Mike Perham - for creating [Sidekiq](http://github.com/mperham/sidekiq), a fantastic contribution to the ruby world
+
+Librato - for a great [metrics service](http://metrics.librato.com)
+
+
+Author
+----------
+
+Scott Klein, scott@statuspage.io, [statuspage.io](https://www.statuspage.io),  If you like and use this project, please check out the [StatusPage.io service](https://www.statuspage.io/tour) for your project or company
+
+
+Copyright
+-----------
+
+Copyright (c) 2013 Scott Klein. See LICENSE for details.

data/lib/librato-sidekiq.rb

@@ -0,0 +1,3 @@
+require 'librato-sidekiq/middleware'
+
+Librato::Sidekiq::Middleware.configure

data/lib/librato-sidekiq/middleware.rb

@@ -0,0 +1,85 @@
+module Librato
+  module Sidekiq
+    class Middleware
+      cattr_accessor :enabled do
+        true
+      end
+
+      cattr_accessor :whitelist_queues, :blacklist_queues, :whitelist_classes, :blacklist_classes do
+        []
+      end
+
+      def initialize(options = {})
+        self.reconfigure
+      end
+
+      def self.configure
+        yield(self) if block_given?
+        self.new # will call reconfigure
+      end
+
+      def options
+        {
+          :enabled => self.enabled,
+          :whitelist_queues => self.whitelist_queues, 
+          :blacklist_queues => self.blacklist_queues, 
+          :whitelist_classes => self.whitelist_classes, 
+          :blacklist_classes => self.blacklist_classes
+        }
+      end
+
+      def reconfigure
+        # puts "Reconfiguring with: #{options}"
+        ::Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.remove self.class
+            chain.add self.class, self.options
+          end
+        end
+      end
+
+      def call(worker_instance, msg, queue)
+        unless self.enabled
+          # puts "Gem not enabled"
+          yield
+          return
+        end
+
+        t = Time.now
+        yield
+        elapsed = (Time.now - t).to_f
+
+        queue_in_whitelist = self.whitelist_queues.nil? || self.whitelist_queues.empty? || self.whitelist_queues.include?(queue.to_s)
+        queue_in_blacklist = self.blacklist_queues.include?(queue.to_s)
+        class_in_whitelist = self.whitelist_classes.nil? || self.whitelist_classes.empty? || self.whitelist_classes.include?(worker_instance.class.to_s)
+        class_in_blacklist = self.blacklist_classes.include?(worker_instance.class.to_s)
+
+        # puts "#{worker_instance} #{queue} qw:#{queue_in_whitelist} qb:#{queue_in_blacklist} cw:#{class_in_whitelist} cb:#{class_in_blacklist}"
+
+        Librato.group 'sidekiq' do |sidekiq|
+          stats = ::Sidekiq::Stats.new
+
+          sidekiq.increment 'processed'
+
+          [:enqueued, :failed].each do |m|
+            sidekiq.measure m.to_s, stats.send(m)
+          end
+
+          return unless class_in_whitelist && !class_in_blacklist && queue_in_whitelist && !queue_in_blacklist
+          # puts "doing Librato insert"
+
+          sidekiq.group queue.to_s do |q|
+            q.increment 'processed'
+            q.timing 'time', elapsed
+            q.measure 'enqueued', stats.queues[queue]
+
+            q.group msg["class"].underscore do |w|
+              w.increment 'processed'
+              w.timing 'time', elapsed
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/librato-sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Librato
+  module Sidekiq
+    VERSION = "0.1.0"
+  end
+end

data/librato-sidekiq.gemspec

@@ -0,0 +1,27 @@
+require './lib/librato-sidekiq/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{librato-sidekiq}
+  s.version = Librato::Sidekiq::VERSION
+  s.license = "MIT"
+
+  s.authors = ["Scott Klein"]
+  s.description = %q{Sidekiq hooks to push stats into Librato}
+  s.email = %q{scott@statuspage.io}
+  s.files = Dir.glob("lib/**/*") + [
+     "LICENSE",
+     "README.md",
+     "History.md",
+     "Gemfile",
+     "librato-sidekiq.gemspec",
+  ]
+  s.homepage = %q{http://github.com/StatusPage/librato-sidekiq}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.summary = %q{Sidekiq hooks to push stats into Librato}
+  s.test_files = Dir.glob("test/**/*")
+  s.add_dependency(%q<sidekiq>, [">= 0"])
+  s.add_dependency(%q<librato-rails>, [">= 0"])
+  s.add_development_dependency(%q<mini_shoulda>, [">= 0"])
+  s.add_development_dependency(%q<mocha>, [">= 0"])
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: librato-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Klein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: librato-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: mini_shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: Sidekiq hooks to push stats into Librato
+email: scott@statuspage.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/librato-sidekiq/middleware.rb
+- lib/librato-sidekiq/version.rb
+- lib/librato-sidekiq.rb
+- LICENSE
+- README.md
+- History.md
+- Gemfile
+- librato-sidekiq.gemspec
+homepage: http://github.com/StatusPage/librato-sidekiq
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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: Sidekiq hooks to push stats into Librato
+test_files: []