resque-job_logger 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Todd Thomas
+
+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,49 @@
+# Resque Job Logger
+
+Resque Job Logger adds log entries which indicate the start and elapsed
+run time of each job's perform method, like so:
+
+    [2013-03-20T17:28:34.316202000] 77415: [INFO] LoggedJob([1127520]) started
+    [2013-03-20T17:28:34.316268000] 77415: [INFO] summing 1..1127520
+    [2013-03-20T17:28:34.357921000] 77415: [INFO] LoggedJob([1127520]) completed in 0.041629 seconds
+
+(The middle entry is supplied by the example job's perform method.)
+
+This example also shows the style of resque-job_logger's own formatter,
+Resque::Plugins::JobLogger::Formatter (see Usage below).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-job_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-job_logger
+
+## Usage
+
+Just bundle it! Or if you're not using bundler, just require it:
+
+    require 'resque-job_logger'
+
+resque-job_logger includes a resque before_fork hook which automatically adds its
+features to each of your jobs. This may be a bad thing.
+
+resque-job_logger also has its own formatter which it sets on
+Resque.logger by default. To use another formatter do
+
+    Resque.logger.formatter = MyFavoriteFormatter.new
+
+## 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/resque/plugins/job_logger/formatter.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Resque::Plugins
+  module JobLogger
+    class Formatter
+      def call(severity, time, progname, msg)
+        "[#{time.strftime("%Y-%m-%dT%H:%M:%S.%N")}] #$$: [#{severity}] #{msg}\n"
+      end
+    end
+  end
+end

data/lib/resque/plugins/job_logger/job_logger.rb

@@ -0,0 +1,46 @@
+require_relative 'formatter'
+require 'benchmark'
+
+module Resque::Plugins
+  module JobLogger
+    def around_perform_log_job(*args)
+      logger.info "#{self}(#{args}) started"
+      time = Benchmark.realtime do
+        yield
+      end
+      logger.info "#{self}(#{args}) completed in #{time} seconds"
+    end
+
+    def self.enabled?
+      @enabled ||= true
+    end
+
+    def self.enabled=(enabled)
+      @enabled = enabled
+    end
+
+    def logger=(logger)
+      @@logger = logger
+    end
+
+    def logger
+      @@logger ||= Resque.logger
+    end
+  end
+
+  Resque.before_first_fork do
+    # You get our awesome formatter by default if you're using Resque.logger.
+    Resque.logger.formatter = Resque::Plugins::JobLogger::Formatter.new
+  end
+
+  # Extend job class dynamically for each instance (if enabled).
+  # For some reason extending the job class when it is defined does not
+  # seem to be effective at the point at which the worker runs an instance
+  # of the job.
+  Resque.before_fork do |job|
+    if Resque::Plugins::JobLogger.enabled? && 
+      !(job.payload_class.kind_of?(Resque::Plugins::JobLogger))
+      job.payload_class.send(:extend, Resque::Plugins::JobLogger)
+    end
+  end
+end

data/lib/resque/plugins/job_logger/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module JobLogger
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/resque-job_logger.rb

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

data/resque-job_logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/plugins/job_logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "resque-job_logger"
+  gem.version       = Resque::Plugins::JobLogger::VERSION
+  gem.authors       = ["Todd Thomas"]
+  gem.email         = ["todd.thomas@openlogic.com"]
+  gem.description   = %q{A resque plugin which logs the time it takes a job's perform method to run.}
+  gem.summary       = %q{A resque plugin which logs the time it takes a job's perform method to run.}
+  gem.homepage      = "https://github.com/toddthomas/resque-job_logger"
+
+  gem.add_dependency "resque", "~> 1.23.1"
+
+  gem.add_development_dependency "rspec"
+
+  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"]
+end

data/spec/resque-job_logger_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Resque::Plugins::JobLogger do
+include PerformJob
+
+  it "complies with recommended practices" do
+    expect { Resque::Plugin.lint(Resque::Plugins::JobLogger) }.to_not raise_error
+  end
+
+  it "supplies the around_perform_log_job hook" do
+    LoggedJob.methods.should include :around_perform_log_job
+  end
+
+  let(:logger) { Logger.new('log') }
+
+  before(:each) do
+    LoggedJob.logger = logger
+    LoggedJob.logger.formatter = Resque::Plugins::JobLogger::Formatter.new
+  end
+
+  after(:each) do
+    logger.close
+    File.unlink('log')
+  end
+
+  let(:last) { rand(1_000_000..1_500_000) }
+
+  it "logs job class and args at start of perform" do
+    perform_job(LoggedJob, last)
+    IO.read('log').should match /LoggedJob\(\[#{last}\]\) started/
+  end
+
+  it "writes elapsed run time to log" do
+    perform_job(LoggedJob, last)
+    IO.read('log').should match /LoggedJob\(\[#{last}\]\) completed in [0-9\.e-]+ seconds/
+  end
+
+  it "allows arbitrary log messages to be written via the logger method" do
+    perform_job(LoggedJob, last)
+    IO.read('log').should match /summing 1..#{last}/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'resque'
+require 'resque-job_logger'
+
+##
+# Helper to perform job classes (borrowed from resque's test_helper.rb).
+#
+module PerformJob
+  def perform_job(klass, *args)
+    resque_job = Resque::Job.new(:testqueue, 'class' => klass, 'args' => args)
+    resque_job.perform
+  end
+end
+
+class LoggedJob
+  extend Resque::Plugins::JobLogger
+
+  def self.perform(last)
+    logger.info "summing 1..#{last}"
+    (1..last).reduce(:+)
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: resque-job_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Todd Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.23.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A resque plugin which logs the time it takes a job's perform method to
+  run.
+email:
+- todd.thomas@openlogic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque-job_logger.rb
+- lib/resque/plugins/job_logger/formatter.rb
+- lib/resque/plugins/job_logger/job_logger.rb
+- lib/resque/plugins/job_logger/version.rb
+- resque-job_logger.gemspec
+- spec/resque-job_logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/toddthomas/resque-job_logger
+licenses: []
+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.25
+signing_key: 
+specification_version: 3
+summary: A resque plugin which logs the time it takes a job's perform method to run.
+test_files:
+- spec/resque-job_logger_spec.rb
+- spec/spec_helper.rb