resque-stats 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque-stats.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    resque-stats (0.1.0)
+      resque (~> 1.10.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    rack (1.2.1)
+    redis (2.1.1)
+    redis-namespace (0.8.0)
+      redis (< 3.0.0)
+    resque (1.10.0)
+      json (~> 1.4.6)
+      redis-namespace (~> 0.8.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    sinatra (1.1.0)
+      rack (~> 1.1)
+      tilt (~> 1.1)
+    tilt (1.1)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  resque (~> 1.10.0)
+  resque-stats!
+  rspec (~> 2.2.0)

data/README.md

@@ -0,0 +1,68 @@
+# Resque::Plugins::Stats
+
+<http://github.com/jrom/resque-stats> by Jordi Romero
+
+If you want to keep track of the number of executions per
+Job, extend it with this module.
+
+## Usage
+
+    require 'resque/plugins/stats'
+    class HardJob
+      extend Resque::Plugins::Stats
+      @queue = :hard_job
+      def self.perform(something)
+        do_work
+      end
+    end
+
+This will keep a historical count of jobs executed *hourly*,
+*daily* and *monthly*.
+
+### Hourly
+
+`HardJob.hourly` will return an array with the count of jobs executed
+every hour during **today**. Indexes go from 0 to 23 hour.
+
+### Daily
+
+`HardJob.daily` will return an array with the count of jobs executed
+every day during the **current month**. Indexes go from 0 (unused)
+to current_month.days_in_month (max 31).
+
+### Monthly
+
+`HardJob.monthly` will return a hash with the count of jobs executed
+every month. The key is the year/month pair and the value is the count
+of executed jobs during that month. The format of the key is "year:month"
+with 4 digit year and 1/2 digit month.
+
+## Example
+
+    Resque.enque HardJob, 123
+    # Work this job...
+    Time.now
+    # => Mon Dec 06 00:34:12 +0100 2010
+    HardJob.hourly
+    # => [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    HardJob.daily
+    # => [0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    HardJob.monthly
+    # => {"2010:12"=>1}
+
+## Contributing
+
+If you want to improve resque-stats
+
+1. Fork the repo
+2. Create a topic branch `git checkout -b my_feature`
+3. Push it! `git push origin my_feature`
+4. Open a pull request
+
+Make sure you add specs for your changes and document them.
+Any contribution will be appreciated, both fixing some typo or
+adding the coolest feature ever.
+
+## Issues
+
+<http://github.com/jrom/resque-stats/issues>

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/resque/plugins/stats.rb

@@ -0,0 +1,97 @@
+module Resque # :nodoc:
+  module Plugins # :nodoc:
+    # If you want to keep track of the number of executions per
+    # Job, extend it with this module.
+    #
+    # Example:
+    #
+    #   require 'resque/plugins/stats'
+    #   class HardJob
+    #     extend Resque::Plugins::Stats
+    #     @queue = :hard_job
+    #     def self.perform(something)
+    #       do_work
+    #     end
+    #   end
+    #
+    # This will keep a historical count of jobs executed *hourly*,
+    # *daily* and *monthly*.
+    #
+    # Hourly records will only persist for 24 hours, daily will
+    # be available for one month, and monthly counters will be
+    # there forever.
+    module Stats
+      include Resque::Helpers
+      # Hook that will increment the counters after the job has
+      # been executed. Also, will set expiration dates for the
+      # hourly and daily counters.
+      def after_perform_do_stats(*args)
+        Stats.increx hourly_key, 3600 * 24 # 24h
+        Stats.increx daily_key, 3600 * 24 * 31 # 31d
+        redis.incr monthly_key
+      end
+
+      # Returns an array of executed jobs hourly for today.
+      # Indexes go from 0 to 23 hour.
+      def hourly
+        (0..23).collect { |h| redis.get("#{prefix_hourly}:#{Time.now.year}:#{Time.now.month}:#{Time.now.day}:#{h}").to_i }
+      end
+
+      # Returns an array of executed jobs daily for the current month.
+      # Indexes go from 0 (unused) to current_month.days_in_month (max 31).
+      def daily
+        (0..Stats.days_in_month).collect { |d| redis.get("#{prefix_daily}:#{Time.now.year}:#{Time.now.month}:#{d}").to_i }
+      end
+
+      # Returns a hash where the key is the year/month pair and the value
+      # is the count of executed jobs during that month. The format of the
+      # key is "year:month" with 4 digit year and 1/2 digit month.
+      def monthly
+        keys = redis.keys("#{prefix_monthly}:*")
+        keys.zip(redis.mget(keys)).inject({}) { |t,p| t.merge(p.first.sub("#{prefix_monthly}:", '') => p.last.to_i) }
+      end
+
+      private
+      def hourly_key # :nodoc:
+        "#{prefix_hourly}:#{Time.now.year}:#{Time.now.month}:#{Time.now.day}:#{Time.now.hour}"
+      end
+
+      def daily_key # :nodoc:
+        "#{prefix_daily}:#{Time.now.year}:#{Time.now.month}:#{Time.now.day}"
+      end
+
+      def monthly_key # :nodoc:
+        "#{prefix_monthly}:#{Time.now.year}:#{Time.now.month}"
+      end
+
+      def prefix # :nodoc:
+        "plugin:stats:#{name}"
+      end
+
+      def prefix_hourly # :nodoc:
+        "#{prefix}:hourly"
+      end
+
+      def prefix_daily # :nodoc:
+        "#{prefix}:daily"
+      end
+
+      def prefix_monthly # :nodoc:
+        "#{prefix}:monthly"
+      end
+
+      def self.days_in_month # :nodoc:
+        month, year = Time.now.month, Time.now.year
+        (Date.new(year,12,31) << 12 - month).day
+      end
+
+      # Increments a key even if it's volatile, by fetching it
+      # first and then setting the incremented value with a new
+      # expiration.
+      def self.increx(key, seconds)
+        tmp = Resque.redis.get key
+        Resque.redis.setex key, seconds, (tmp.to_i + 1)
+      end
+    end
+  end
+end

data/resque-stats.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "resque-stats"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jordi Romero"]
+  s.email       = ["jordi@jrom.net"]
+  s.homepage    = "http://github.com/jrom/resque-stats"
+  s.summary     = %q{Keep track of the number of executions for a Resque job}
+  s.description = %q{If you want to graph the workload created by your different Resque jobs, extend them with this plugin and use the data generated to know exactly the amount of jobs executed.}
+
+  s.files         = `git ls-files`.split("\n") - %w(.gitignore .rspec)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "resque", "~> 1.10.0"
+  s.add_development_dependency "rspec", "~> 2.2.0"
+
+end

data/spec/redis-test.conf

@@ -0,0 +1,30 @@
+daemonize yes
+pidfile ./spec/redis.pid
+port 6378
+
+timeout 300
+loglevel debug
+logfile stdout
+databases 16
+
+save 900 1
+save 300 10
+save 60 10000
+rdbcompression yes
+
+dbfilename dump.rdb
+dir ./spec/
+
+appendonly no
+appendfsync everysec
+
+vm-enabled no
+vm-swap-file /tmp/redis.swap
+vm-max-memory 0
+vm-page-size 32
+vm-pages 134217728
+vm-max-threads 4
+glueoutputbuf yes
+hash-max-zipmap-entries 64
+hash-max-zipmap-value 512
+activerehashing yes

data/spec/resque_stats_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Job
+  extend Resque::Plugins::Stats
+  @queue = :job
+  def self.perform(*args)
+    # work
+  end
+end
+
+describe Resque::Plugins::Stats do
+  describe "compliance of Resque Plugins guidelines" do
+    it "should be valid" do
+      lambda{ Resque::Plugin.lint(Resque::Plugins::Stats) }.should_not raise_error
+    end
+  end
+
+  describe "initial status" do
+    it "should return an empty hourly counter" do
+      Job.hourly.should == Array.new(24, 0)
+    end
+
+    it "should return an empty daily counter" do
+      daily = Job.daily
+      daily.size.should <= 32 # because we start at 0
+      daily.size.should >= 28
+      daily.uniq.should == [0]
+    end
+
+    it "should return an empty monthly counter" do
+      Job.monthly.should == {}
+    end
+  end
+
+  describe "counters" do
+    before do
+      Resque.enqueue(Job)
+      Resque::Worker.new(:job).work(0) # Work off the enqueued job
+    end
+
+    it "should increment the hourly counter" do
+      hourly = Job.hourly
+      hourly.size.should == 24
+      hourly[Time.now.hour].should == 1
+    end
+
+    it "should increment the daily counter" do
+      daily = Job.daily
+      daily.size.should >= 28
+      daily.size.should <= 32
+      daily[Time.now.day].should == 1
+    end
+
+    it "should increment the monthly counter" do
+      monthly = Job.monthly
+      monthly.size.should == 1
+      monthly["#{Time.now.year}:#{Time.now.month}"].should == 1
+    end
+
+    it "should increment the counter multiple times" do
+      6.times { Resque.enqueue(Job) }
+      Resque::Worker.new(:job).work(0)
+      Job.hourly[Time.now.hour].should == 7
+      Job.daily[Time.now.day].should == 7
+      Job.monthly["#{Time.now.year}:#{Time.now.month}"].should == 7
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+Bundler.require(:default, :development)
+require 'lib/resque/plugins/stats'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    if !system('which redis-server')
+      puts "\ncan't find `redis-server` in your path"
+      abort
+    end
+    `redis-server #{File.dirname(File.expand_path(__FILE__))}/redis-test.conf` # run Redis with local config
+    puts  "Starting test redis server: redis-server #{File.dirname(File.expand_path(__FILE__))}/redis-test.conf"
+    Resque.redis = 'localhost:6378' # port specified in redis-test.conf
+  end
+
+  config.before(:each) do
+    Resque.redis.flushall # Drop all keys between examples
+  end
+
+  config.after(:all) do
+    pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+    puts "\nKilling test redis server PID #{pid}..."
+    `rm -f #{File.dirname(File.expand_path(__FILE__))}/dump.rdb` # file specified in redis-test.conf
+    Process.kill("KILL", pid.to_i)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: resque-stats
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jordi Romero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 10
+        - 0
+        version: 1.10.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id002
+description: If you want to graph the workload created by your different Resque jobs, extend them with this plugin and use the data generated to know exactly the amount of jobs executed.
+email: 
+- jordi@jrom.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/resque/plugins/stats.rb
+- resque-stats.gemspec
+- spec/redis-test.conf
+- spec/resque_stats_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jrom/resque-stats
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Keep track of the number of executions for a Resque job
+test_files: 
+- spec/redis-test.conf
+- spec/resque_stats_spec.rb
+- spec/spec_helper.rb