nogara-resque-statsd 0.0.4

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  # gem "rspec"
+  gem "yard"
+  gem "jeweler"
+  # gem "rcov", ">= 0"
+end
+
+gem 'jamster-statsd'

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jamster-statsd (0.1.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jamster-statsd
+  jeweler
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jason Amster
+
+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.mdown

@@ -0,0 +1,89 @@
+# resque-statsd
+
+Resque Statsd is a Resque plugin that will collect and send data samples from your Resque Jobs.  It samples 4 statistics for any Job for which the plugin extends, enqueue count, completion count, failure count, and the time to process.  It will monitor for each specific job, in addition to the totals for all jobs (not including timing stats)
+
+## CURRENT STATUS
+
+This is a fork of jamster's original gem designed to make it easier to run with Bundler and Rails 3.0.
+
+## Final Outcome
+
+![Graph of a Job](https://img.skitch.com/20110323-ghsnyg8nhs6hta8etea63q6965.jpg "Report Running Job Stats")
+
+
+
+## Usage
+
+### Install
+
+Add this to your Gemfile:
+
+    gem "resque-statsd", :git => "git://github.com/cloudability/resque-statsd.git"
+
+### Rails Setup
+
+in an initializer, set up the Statsd
+
+    touch  config/initializers/resque-statsd.rb
+
+in file add code
+
+    require 'enqueue_time'
+
+    module Resque
+      include Resque::EnqueueTime
+    end
+
+    StatsdHelper.graphite_host = 'graphite.YOUR_HOST.com'
+    StatsdHelper.namespace = "YOUR_APP.#{Rails.env.development? ? ENV['USER'] : Rails.env}.resque"
+
+Change `YOUR_HOST` and `YOUR_APP` accordingly.
+
+### In Your Code
+
+Extend your class like this:
+
+    class MyJob
+      extend Resque::Plugins::Statsd
+      def self.perform(*payload)
+        # ..
+      end
+    end
+
+## Background Reading
+
+### Graphite
+
+http://graphite.wikidot.com/
+
+### StatsD Comes From Etsy
+
+The folks at Etsy (kastner) have come up with a neat node.js app to listen for Graphite stats.
+
+* http://codeascraft.etsy.com/2010/12/08/track-every-release/
+* http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/
+* https://github.com/etsy/statsd
+
+### Ruby StatsD Client
+
+I've required a particular version (jnunemaker's) of the ruby StatsD client
+Read the post here
+
+* http://railstips.org/blog/archives/2011/03/21/hi-my-name-is-john/
+* A Ruby statsd client (https://github.com/etsy/statsd)
+
+## Contributing to resque-statsd
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Jason Amster. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "resque-statsd"
+  gem.homepage = "http://github.com/cloudability/resque-statsd"
+  gem.license = "MIT"
+  gem.summary = %Q{Adds simple counters and timers for statsd into your Resque jobs}
+  gem.description = %Q{Will add a counter for enqueuing, performing, failing and timing Jobs}
+  gem.email = "engineering@cloudability.com"
+  gem.authors = ["Jon Frisby", "Jason Amster"]
+  gem.require_path = 'lib'
+
+  gem.files.reject! do |fn|
+    fn =~ /^\.(rvmrc|rspec|document|gitignore)$/ ||
+    fn =~ /^VERSION$/ ||
+    fn =~ /^(spec|features)\//
+  end
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# require 'rspec/core'
+# require 'rspec/core/rake_task'
+# RSpec::Core::RakeTask.new(:spec) do |spec|
+#   spec.pattern = FileList['spec/**/*_spec.rb']
+# end
+#
+# RSpec::Core::RakeTask.new(:rcov) do |spec|
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+#
+# task :default => :spec
+
+# require 'yard'
+# YARD::Rake::YardocTask.new

data/lib/enqueue_time.rb

@@ -0,0 +1,49 @@
+# Monkey-patch to record queue length since resque doesn't have hooks that give access to the
+# redis stored object, so we can add metadata
+# Ideal solution: contribute to the resque project to add hooks for the push and perform action:
+# https://github.com/defunkt/resque/issues/464
+
+module Resque
+  module EnqueueTime
+
+    def self.included(base)
+      base.class_eval do
+        alias_method :push_without_enqueued_at, :push
+        # Wrapper for the original Resque push method, which adds
+        # enqueued_at time
+        def push(queue, item)
+          begin
+            if item.respond_to?(:[]=)
+              item[:enqueued_at] = Time.now
+            end
+          rescue Exception => e
+            Rails.logger.error "Error in Resque::EnqueueTime: #{e.message}"
+          end
+          push_without_enqueued_at queue, item
+        end
+      end
+    end
+
+  end
+end
+
+
+module Resque
+  class Job
+    alias_method :perform_without_enqueue_time, :perform
+
+    def perform
+      begin
+        if payload['enqueued_at']
+           queue_time = (Time.now - DateTime.parse(payload['enqueued_at'])) * 1000.0
+           StatsdHelper.statsd.timing("queues.#{queue}.queue_time", queue_time)
+           StatsdHelper.statsd.timing("total.queue_time", queue_time)
+         end
+      rescue Exception => e
+        Rails.logger.error "Error in Resque::EnqueueTime in recording queue_time in statsd: #{e.message}"
+      end
+      perform_without_enqueue_time
+    end
+
+  end
+end

data/lib/resque-statsd.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'statsd' # Really Jnunemakers's mine branch of statsd
+require 'resque/plugins/statsd'
+
+class StatsdHelper
+  def self.graphite_host
+    return @graphite_host || ENV['GRAPHITE_HOST'] || 'localhost'
+  end
+  def self.graphite_host=(val)
+    @graphite_host = val
+  end
+
+  def self.graphite_port
+    return @graphite_port || ENV['GRAPHITE_PORT'] || 8125
+  end
+  def self.graphite_port=(val)
+    @graphite_port = val
+  end
+
+  def self.namespace
+    return @namespace || ENV['GRAPHITE_NAMESPACE'] || 'resque'
+  end
+  def self.namespace=(val)
+    @namespace = val
+  end
+
+  # Set up the client lazily, to minimize order-of-operations headaches.
+  def self.statsd
+    if(@stats.nil?)
+      @statsd = Statsd.new(graphite_host, graphite_port)
+      @statsd.namespace = namespace
+    end
+    return @statsd
+  end
+end
+
+module Resque
+  module Plugins
+    module Statsd
+      VERSION = "0.0.4"
+    end
+  end
+end

data/lib/resque/plugins/statsd.rb

@@ -0,0 +1,80 @@
+module Resque
+  module Plugins
+    module Statsd
+      def after_enqueue_statsd(*args)
+        StatsdHelper.statsd.increment("queues.#{@queue}.enqueued")
+        StatsdHelper.statsd.increment("jobs.#{self.name}.enqueued")
+        StatsdHelper.statsd.increment("total.enqueued")
+      rescue SocketError => se
+        # Common cause of this is failure of getaddrinfo (I.E. can't route to
+        # statsd server or some such).  This may happen in development, when
+        # your net connection isn't in a good way, for example.
+        #
+        # Ignoring this because we don't want unreachability of statsd to
+        # impair the ability of an app to actually operate.
+      end
+
+      def before_perform_statsd(*args)
+        StatsdHelper.statsd.increment("queues.#{@queue}.started")
+        StatsdHelper.statsd.increment("jobs.#{self.name}.started")
+        StatsdHelper.statsd.increment("total.started")
+      rescue SocketError => se
+        # Common cause of this is failure of getaddrinfo (I.E. can't route to
+        # statsd server or some such).  This may happen in development, when
+        # your net connection isn't in a good way, for example.
+        #
+        # Ignoring this because we don't want unreachability of statsd to
+        # impair the ability of an app to actually operate.
+      end
+
+      def after_perform_statsd(*args)
+        StatsdHelper.statsd.increment("queues.#{@queue}.finished")
+        StatsdHelper.statsd.increment("jobs.#{self.name}.finished")
+        StatsdHelper.statsd.increment("total.finished")
+      rescue SocketError => se
+        # Common cause of this is failure of getaddrinfo (I.E. can't route to
+        # statsd server or some such).  This may happen in development, when
+        # your net connection isn't in a good way, for example.
+        #
+        # Ignoring this because we don't want unreachability of statsd to
+        # impair the ability of an app to actually operate.
+      end
+
+      def on_failure_statsd(*args)
+        StatsdHelper.statsd.increment("queues.#{@queue}.failed")
+        StatsdHelper.statsd.increment("jobs.#{self.name}.failed")
+        StatsdHelper.statsd.increment("total.failed")
+      rescue SocketError => se
+        # Common cause of this is failure of getaddrinfo (I.E. can't route to
+        # statsd server or some such).  This may happen in development, when
+        # your net connection isn't in a good way, for example.
+        #
+        # Ignoring this because we don't want unreachability of statsd to
+        # impair the ability of an app to actually operate.
+      end
+
+      def around_perform_statsd(*args)
+        # We don't want to swallow a SocketError if it didn't actually come
+        # from our attempts to talk to statsd.
+        failure_is_in_app = true
+        StatsdHelper.statsd.time("queues.#{@queue}.processed") do
+          StatsdHelper.statsd.time("jobs.#{self.name}.processed") do
+            yield
+            failure_is_in_app = false
+          end
+        end
+      rescue SocketError => se
+        # Common cause of this is failure of getaddrinfo (I.E. can't route to
+        # statsd server or some such).  This may happen in development, when
+        # your net connection isn't in a good way, for example.
+        #
+        # Ignoring this iff it's statsd-related because we don't want
+        # unreachability of statsd to impair the ability of an app to actually
+        # operate.
+        raise se if(failure_is_in_app)
+      end
+    end
+  end
+end
+
+

data/resque-statsd.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "nogara-resque-statsd"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jon Frisby", "Jason Amster"]
+  s.date = "2012-03-23"
+  s.description = "Will add a counter for enqueuing, performing, failing and timing Jobs"
+  s.email = "engineering@cloudability.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.mdown"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mdown",
+    "Rakefile",
+    "lib/enqueue_time.rb",
+    "lib/resque-statsd.rb",
+    "lib/resque/plugins/statsd.rb",
+    "resque-statsd.gemspec"
+  ]
+  s.homepage = "http://github.com/cloudability/resque-statsd"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.13"
+  s.summary = "Adds simple counters and timers for statsd into your Resque jobs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<statsd-ruby>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<statsd-ruby>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<statsd-ruby>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: nogara-resque-statsd
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Jon Frisby
+- Jason Amster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  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: yard
+  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: jeweler
+  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: Will add a counter for enqueuing, performing, failing and timing Jobs
+email: engineering@cloudability.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.mdown
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.mdown
+- Rakefile
+- lib/enqueue_time.rb
+- lib/resque-statsd.rb
+- lib/resque/plugins/statsd.rb
+- resque-statsd.gemspec
+homepage: http://github.com/cloudability/resque-statsd
+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.24
+signing_key: 
+specification_version: 3
+summary: Adds simple counters and timers for statsd into your Resque jobs
+test_files: []