resque-job-stats 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@resque-job-stats

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'resque', '~> 1.17.0'
+
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'mynyml-redgreen', '~> 0.7.1'
+  gem 'ruby-debug19', :require => 'ruby-debug'
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.4)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.3)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    minitest (2.3.1)
+    mynyml-redgreen (0.7.1)
+      term-ansicolor (>= 1.0.4)
+    rack (1.3.0)
+    rake (0.9.2)
+    rcov (0.9.9)
+    redis (2.2.1)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+    resque (1.17.1)
+      json (>= 1.4.6, < 1.6)
+      redis-namespace (~> 1.0.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    term-ansicolor (1.0.5)
+    tilt (1.3.2)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  minitest
+  mynyml-redgreen (~> 0.7.1)
+  rcov
+  resque (~> 1.17.0)
+  ruby-debug19

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alan Peabody
+
+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.rdoc

@@ -0,0 +1,70 @@
+= resque-job-stats
+
+Job centric stats for Resque.
+
+Stats are tracked per Job type (class/module) in addition to the worker based stats Resque provides.
+
+Stats tracked are:
+
+* Jobs performed
+* Jobs failed
+* Duration of last x jobs completed
+* Average job duration over last x jobs completed
+* Longest job duration over last x jobs completed
+
+This information can be used to help track performance and diagnose specific bottlenecks.
+
+We are sending this information to Nagios for graphing and alerts (via a custom rake task).
+
+== Installation
+
+*Requires resque '~> 1.17.0'*
+
+In your Gemfile add:
+
+  gem 'resque-job-stats'
+
+== Usage
+
+Simply extend your class
+
+  class MyJob
+    extend Resque::Plugins::JobStats
+    
+    def self.perform(*payload)
+      # ..
+    end
+  end
+
+And you will have a set of keys starting with 'stats:jobs:my_job' inside your Resque redis namespace.
+
+Alternatively you can include just the metric you wish to record.
+
+  class MyVerbosJob
+    extend Resque::Plugins::JobStats::Performed
+    extend Resque::Plugins::JobStats::Failed
+    extend Resque::Plugins::JobStats::Duration
+    extend Resque::Plugins::JobStats::Duration::Maximum
+    extend Resque::Plugins::JobStats::Duration::Average
+    
+    record_job_duration_of_last 100
+
+    def self.perform(*payload)
+      # ...
+    end
+  end
+
+== Contributing to resque-job-stats
+ 
+* 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 Alan Peabody. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "resque-job-stats"
+  gem.homepage = "http://github.com/alanpeabody/resque-job-stats"
+  gem.license = "MIT"
+  gem.summary = %Q{Job-centric stats for Resque}
+  gem.email = "gapeabody@gmail.com"
+  gem.authors = ["alanpeabody"]
+  gem.description = %Q{Tracks jobs performed, failed, and the duration of the last 100 jobs for each job type.}
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque-job-stats #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/resque-job-stats.rb

@@ -0,0 +1 @@
+require 'resque/plugins/job_stats'

data/lib/resque/plugins/job_stats.rb

@@ -0,0 +1,14 @@
+require 'resque'
+require 'resque/plugins/job_stats/performed'
+require 'resque/plugins/job_stats/failed'
+require 'resque/plugins/job_stats/duration'
+
+module Resque
+  module Plugins
+    module JobStats
+      include Resque::Plugins::JobStats::Performed
+      include Resque::Plugins::JobStats::Failed
+      include Resque::Plugins::JobStats::Duration
+    end
+  end
+end

data/lib/resque/plugins/job_stats/duration.rb

@@ -0,0 +1,40 @@
+module Resque
+  module Plugins
+    module JobStats
+      module Duration
+
+        # Resets all job durations
+        def reset_job_durations
+          Resque.redis.del(jobs_duration_key)
+        end
+
+        # Returns the number of jobs failed
+        def job_durations
+          Resque.redis.lrange(jobs_duration_key,0,job_durations_to_track).map(&:to_f)
+        end
+
+        # Returns the key used for tracking job durations
+        def jobs_duration_key
+          @jobs_failed_key ||= "stats:jobs:#{self.name}:duration"
+        end
+
+        # Increments the failed count when job is complete
+        def around_perform_job_stats_duration(*payload)
+          start = Time.now
+          yield
+          duration = Time.now - start
+
+          Resque.redis.multi do
+            Resque.redis.lpush(jobs_duration_key, duration)
+            Resque.redis.ltrim(jobs_duration_key, 0, job_durations_to_track)
+          end
+        end
+
+        def job_durations_to_track
+          100
+        end
+
+      end
+    end
+  end
+end

data/lib/resque/plugins/job_stats/failed.rb

@@ -0,0 +1,32 @@
+module Resque
+  module Plugins
+    module JobStats
+
+      # Extend your job with this module to track how many 
+      # jobs fail
+      module Failed
+
+        # Sets the number of jobs failed
+        def jobs_failed=(int)
+          Resque.redis.set(jobs_failed_key,int)
+        end
+
+        # Returns the number of jobs failed
+        def jobs_failed
+          Resque.redis.get(jobs_failed_key).to_i
+        end
+
+        # Returns the key used for tracking jobs failed
+        def jobs_failed_key
+          @jobs_failed_key ||= "stats:jobs:#{self.name}:failed"
+        end
+
+        # Increments the failed count when job is complete
+        def on_failure_job_stats_failed(e,*payload)
+          Resque.redis.incr(jobs_failed_key)
+        end
+
+      end
+    end
+  end
+end

data/lib/resque/plugins/job_stats/performed.rb

@@ -0,0 +1,32 @@
+module Resque
+  module Plugins
+    module JobStats
+
+      # Extend your job with this module to track how many 
+      # jobs are performed successfully
+      module Performed
+
+        # Sets the number of jobs performed
+        def jobs_performed=(int)
+          Resque.redis.set(jobs_performed_key,int)
+        end
+
+        # Returns the number of jobs performed
+        def jobs_performed
+          Resque.redis.get(jobs_performed_key).to_i
+        end
+
+        # Returns the key used for tracking jobs performed
+        def jobs_performed_key
+          @jobs_performed_key ||= "stats:jobs:#{self.name}:performed"
+        end
+
+        # Increments the performed count when job is complete
+        def after_perform_job_stats_performed(*payload)
+          Resque.redis.incr(jobs_performed_key)
+        end
+
+      end
+    end
+  end
+end

data/resque-job-stats.gemspec

@@ -0,0 +1,73 @@
+# 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 = %q{resque-job-stats}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["alanpeabody"]
+  s.date = %q{2011-07-09}
+  s.description = %q{Tracks jobs performed, failed, and the duration of the last 100 jobs for each job type.}
+  s.email = %q{gapeabody@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/resque-job-stats.rb",
+    "lib/resque/plugins/job_stats.rb",
+    "lib/resque/plugins/job_stats/duration.rb",
+    "lib/resque/plugins/job_stats/failed.rb",
+    "lib/resque/plugins/job_stats/performed.rb",
+    "resque-job-stats.gemspec",
+    "test/helper.rb",
+    "test/test_job_stats.rb"
+  ]
+  s.homepage = %q{http://github.com/alanpeabody/resque-job-stats}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Job-centric stats for Resque}
+
+  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<resque>, ["~> 1.17.0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mynyml-redgreen>, ["~> 0.7.1"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+    else
+      s.add_dependency(%q<resque>, ["~> 1.17.0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mynyml-redgreen>, ["~> 0.7.1"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["~> 1.17.0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mynyml-redgreen>, ["~> 0.7.1"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,26 @@
+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 'minitest/unit'
+require 'redgreen'
+require 'resque'
+
+Resque.redis = 'localhost:6379'
+Resque.redis.namespace = 'resque:job_stats'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'resque-job-stats'
+
+
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

data/test/test_job_stats.rb

@@ -0,0 +1,71 @@
+require 'helper'
+
+class BaseJob
+  @queue = :test
+
+  def self.perform(sleep_time=0.01)
+    sleep sleep_time
+  end
+end
+
+class SimpleJob < BaseJob
+  extend Resque::Plugins::JobStats
+  @queue = :test
+end
+
+class FailJob < BaseJob
+  extend Resque::Plugins::JobStats::Failed
+  @queue = :test
+
+  def self.perform(*payload)
+    raise 'fail'
+  end
+end
+
+class TestResqueJobStats < MiniTest::Unit::TestCase
+
+  def setup
+    @worker = Resque::Worker.new(:test)
+  end
+
+  def test_lint
+    Resque::Plugin.lint(Resque::Plugins::JobStats)
+    assert_equal true, true
+  rescue => e
+    assert_equal false, e
+  end
+
+  def test_jobs_performed
+    assert_equal 'stats:jobs:SimpleJob:performed', SimpleJob.jobs_performed_key
+    SimpleJob.jobs_performed = 0
+    3.times do
+      Resque.enqueue(SimpleJob)
+      @worker.work(0)
+    end
+    assert_equal 3, SimpleJob.jobs_performed
+  end
+
+  def test_jobs_failed
+    assert_equal 'stats:jobs:FailJob:failed', FailJob.jobs_failed_key
+    FailJob.jobs_failed = 0
+    3.times do
+      Resque.enqueue(FailJob)
+      @worker.work(0)
+    end
+    assert_equal 3, FailJob.jobs_failed
+  end
+
+  def test_duration
+    assert_equal 'stats:jobs:SimpleJob:duration', SimpleJob.jobs_duration_key
+    SimpleJob.reset_job_durations
+    3.times do |i|
+      d = (i + 1)/10.0
+      Resque.enqueue(SimpleJob,d)
+      @worker.work(0)
+    end
+    assert_in_delta 0.3, SimpleJob.job_durations[0], 0.01
+    assert_in_delta 0.2, SimpleJob.job_durations[1], 0.01
+    assert_in_delta 0.1, SimpleJob.job_durations[2], 0.01
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: resque-job-stats
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- alanpeabody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-09 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &11381140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *11381140
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &11380000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11380000
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &11378600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *11378600
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &11377480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *11377480
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &11376400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11376400
+- !ruby/object:Gem::Dependency
+  name: mynyml-redgreen
+  requirement: &11374840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *11374840
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &11347340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11347340
+description: Tracks jobs performed, failed, and the duration of the last 100 jobs
+  for each job type.
+email: gapeabody@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/resque-job-stats.rb
+- lib/resque/plugins/job_stats.rb
+- lib/resque/plugins/job_stats/duration.rb
+- lib/resque/plugins/job_stats/failed.rb
+- lib/resque/plugins/job_stats/performed.rb
+- resque-job-stats.gemspec
+- test/helper.rb
+- test/test_job_stats.rb
+has_rdoc: true
+homepage: http://github.com/alanpeabody/resque-job-stats
+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'
+      segments:
+      - 0
+      hash: 3802864521302634812
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Job-centric stats for Resque
+test_files: []