log4r-exceptionable 0.5.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/dump.rdb
+spec/redis-server.log
+spec/redis.pid

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  # - rbx-18mode
+  # - rbx-19mode
+script: bundle exec rspec spec

data/CHANGELOG

@@ -0,0 +1,5 @@
+0.5.0
+-----
+
+Initial release created by merging graylog2-resque and graylog2_exceptions and modifying to send to log4r 
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matt Conway (matt@conwaysplace.com)
+
+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,45 @@
+graylog2-resque
+===============
+
+This gem provides failure handlers for [Resque][0] and [Rack][1] that logs all failures using [log4r][2].  It is expected that these logs will get sent elsewhere (e.g. [graylog][3]) by using log4r outputters (e.g. [log4r-gelf][4]).  It adds contextual information to the log message using Log4r::MDC, which is useful if you are using log4r-gelf since it sends all of those to graylog as custom attributes. 
+
+[![Build Status](https://secure.travis-ci.org/wr0ngway/log4r-exceptionable.png)](http://travis-ci.org/wr0ngway/log4r-exceptionable)
+
+Install
+-------
+
+    gem install log4r-exceptionable
+or add to your Gemfile 
+
+To use
+------
+
+Add to some initializer code:
+
+    Log4rExceptionable::Configuration.configure do |config|
+      # at least one logger needs to be set
+      config.rack_failure_logger = "rails::SomeRackLogger"
+      config.resque_failure_logger = "rails::SomeResqueLogger"
+    end
+  
+    Rails.application.config.middleware.use "Log4rExceptionable::RackFailureHandler"
+    Resque::Failure.backend = Log4rExceptionable::ResqueFailureHandler
+
+All failures will be logged using the given log4r logger name (or log4r logger instance if supplied instead)
+
+Author
+------
+
+Matt Conway :: matt@conwaysplace.com :: @mattconway
+
+Copyright
+---------
+
+Copyright (c) 2012 Matt Conway. See LICENSE for details.
+
+[0]: http://github.com/defunkt/resque
+[1]: http://rack.github.com/
+[2]: http://log4r.rubyforge.org/
+[3]: http://graylog2.org/
+[4]: http://github.com/wr0ngway/log4r-gelf
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/graylog2-resque.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "log4r-exceptionable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "log4r-exceptionable"
+  s.version     = Log4rExceptionable::VERSION
+  s.authors     = ["Matt Conway"]
+  s.email       = ["matt@conwaysplace.com"]
+  s.homepage    = ""
+  s.summary     = %q{Failure handlers for rack and resque that log failures using log4r}
+  s.description = %q{Failure handlers for rack and resque that log failures using log4r.  It is expected that these logs will get sent elsewhere (e.g. graylog) by using log4r outputters (e.g. log4r-gelf)}
+
+  s.rubyforge_project = "log4r-exceptionable"
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("awesome_print")
+  
+  s.add_development_dependency("rack-test")
+  s.add_development_dependency("resque")
+  s.add_dependency("log4r")
+end

data/lib/log4r-exceptionable.rb

@@ -0,0 +1,15 @@
+require "log4r"
+require "log4r-exceptionable/version"
+require "log4r-exceptionable/configuration"
+
+# optional if only using resque
+begin
+  require "log4r-exceptionable/rack_failure_handler"
+rescue LoadError
+end
+
+# optional if only using rack
+begin
+  require "log4r-exceptionable/resque_failure_handler"
+rescue LoadError
+end

data/lib/log4r-exceptionable/configuration.rb

@@ -0,0 +1,43 @@
+module Log4rExceptionable
+    
+  # Failure backends that log exceptions with log4r
+  #
+  # Log4rExceptionable::Configuration.configure do |config|
+  #   # required
+  #   config.resque_failure_logger = "rails::SomeLogger"
+  #   config.rack_failure_logger = "rails::SomeLogger"
+  # end
+  #
+  # Rails.application.config.middleware.use "Log4rExceptionable::RackFailureHandler"
+  # Resque::Failure.backend = Log4rExceptionable::ResqueFailureHandler
+  #
+  class Configuration
+
+    class << self
+      # required
+      attr_accessor :rack_failure_logger, :resque_failure_logger
+    end
+
+    def self.configure
+      yield self
+      raise "log4r-exceptionable requires a rack_failure_logger or resque_failure_logger" unless self.rack_failure_logger || self.resque_failure_logger
+
+      if self.rack_failure_logger
+        self.set_logger(:rack_failure_logger)
+      end
+      
+      if self.resque_failure_logger
+        self.set_logger(:resque_failure_logger)
+      end
+    end
+
+    def self.set_logger(accessor)
+      if ! self.send(accessor).instance_of?(Log4r::Logger)
+        name = self.send(accessor).to_s
+        self.send("#{accessor}=", Log4r::Logger[name] || Log4r::Logger.new(name))
+      end
+    end
+
+  end
+  
+end

data/lib/log4r-exceptionable/rack_failure_handler.rb

@@ -0,0 +1,82 @@
+
+module Log4rExceptionable
+    
+  # A rack middleware handler that logs exceptions with log4r
+  #
+  class RackFailureHandler
+    attr_reader :args
+  
+    def initialize(app, opts = {})
+      @app = app
+    end
+  
+    def logger
+      Log4rExceptionable::Configuration.rack_failure_logger
+    end
+    
+    def call(env)
+      # Make thread safe
+      dup._call(env)
+    end
+  
+    def _call(env)
+      begin
+        # Call the app we are monitoring
+        response = @app.call(env)
+      rescue => exception
+        # An exception has been raised. Send to log4r
+        send_to_log4r(exception, env)
+  
+        # Raise the exception again to pass back to app.
+        raise
+      end
+  
+      if env['rack.exception']
+        send_to_log4r(env['rack.exception'], env)
+      end
+  
+      response
+    end
+  
+    def send_to_log4r(exception, env=nil)
+      begin
+        mdc = Log4r::MDC
+        original_mdc = mdc.get_context
+        
+        begin
+          mdc.put('rack_exception', exception.class.name)
+          trace = Array(exception.backtrace)
+          if trace.size > 0
+            mdc.put('rack_exception_backtrace', trace.join("\n"))
+            file, line = trace[0].split(":")
+            mdc.put('rack_exception_file', file)
+            mdc.put('rack_exception_line', line)
+          end
+    
+          if env and env.size > 0
+            env.each do |k, v|
+              begin
+                mdc.put("rack_env_#{k}", v.inspect)
+              rescue
+              end
+            end
+          end
+          
+          message = "#{exception.class}: #{exception.message}"
+          logger.error(message)
+        ensure
+          # Since this is somewhat of a global map, clean the keys
+          # we put in so other log messages don't see them
+          mdc.get_context.keys.each do |k|
+            mdc.remove(k) unless original_mdc.has_key?(k)
+          end
+        end
+        
+      rescue Exception => e
+        puts "Log4r Exceptionable could not log rack exception: " + e.message
+      end
+    end
+  
+  end
+
+end

data/lib/log4r-exceptionable/resque_failure_handler.rb

@@ -0,0 +1,56 @@
+require 'resque'
+
+module Log4rExceptionable
+    
+  # A Resque Failure backend that logs exceptions with log4r
+  #
+  class ResqueFailureHandler < ::Resque::Failure::Base
+
+    def logger
+      Log4rExceptionable::Configuration.resque_failure_logger
+    end
+        
+    def save
+      begin
+        mdc = Log4r::MDC
+        original_mdc = mdc.get_context
+        
+        begin
+          mdc.put('rack_exception', exception.class.name)
+          trace = Array(exception.backtrace)
+          if trace.size > 0
+            mdc.put('resque_exception_backtrace', trace.join("\n"))
+            file, line = trace[0].split(":")
+            mdc.put('resque_exception_file', file)
+            mdc.put('resque_exception_line', line)
+          end
+          
+          mdc.put("resque_worker", worker.to_s)
+          mdc.put("resque_queue", queue.to_s)
+          mdc.put("resque_class", payload['class'].to_s)
+          mdc.put("resque_args", payload['args'].inspect.to_s)
+          
+          message = "#{exception.class}: #{exception.message}"
+          logger.error(message)
+        ensure
+          # Since this is somewhat of a global map, clean the keys
+          # we put in so other log messages don't see them
+          mdc.get_context.keys.each do |k|
+            mdc.remove(k) unless original_mdc.has_key?(k)
+          end
+        end
+        
+      rescue Exception => e
+        puts "Log4r Exceptionable could not log resque exception: " + e.message
+      end
+    end
+
+    def self.count
+      # We can't get the total # of errors from graylog so we fake it
+      # by asking Resque how many errors it has seen.
+      ::Resque::Stat[:failed]
+    end
+
+  end
+    
+end

data/lib/log4r-exceptionable/version.rb

@@ -0,0 +1,3 @@
+module Log4rExceptionable
+  VERSION = "0.5.0"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Log4rExceptionable::Configuration do
+
+  context "configure" do
+
+    it "should raise if no logger in config" do
+      lambda {
+        Log4rExceptionable::Configuration.configure do |config|
+        end
+      }.should raise_error("log4r-exceptionable requires a rack_failure_logger or resque_failure_logger")
+    end
+
+    it "should not raise if config valid" do
+      lambda {
+        Log4rExceptionable::Configuration.configure do |config|
+          config.rack_failure_logger = 'mylogger'
+        end
+      }.should_not raise_exception
+      Log4rExceptionable::Configuration.rack_failure_logger = nil
+      
+      lambda {
+        Log4rExceptionable::Configuration.configure do |config|
+          config.resque_failure_logger = 'mylogger'
+        end
+      }.should_not raise_exception
+    end
+    
+    it "should allow setting logger to string for pre-existing logger" do
+      logger = Log4r::Logger.new('existinglogger')
+      Log4rExceptionable::Configuration.configure do |config|
+        config.rack_failure_logger = logger
+      end
+      
+      Log4rExceptionable::Configuration.rack_failure_logger.should == Log4r::Logger['existinglogger']
+      Log4rExceptionable::Configuration.rack_failure_logger.should == logger
+    end
+    
+    it "should allow setting logger to string for non-existing logger" do
+      Log4r::Logger['newlogger'].should be_nil
+
+      Log4rExceptionable::Configuration.configure do |config|
+        config.rack_failure_logger = "newlogger"
+      end
+      
+      Log4rExceptionable::Configuration.rack_failure_logger.should == Log4r::Logger['newlogger']
+    end
+    
+    it "should allow setting logger to logger instance" do
+      Log4rExceptionable::Configuration.configure do |config|
+        config.rack_failure_logger = Log4r::Logger.new('otherlogger')
+      end
+      
+      Log4rExceptionable::Configuration.rack_failure_logger.should == Log4r::Logger['otherlogger']
+    end
+    
+  end
+  
+end

data/spec/rack_failure_handler_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Log4rExceptionable::RackFailureHandler do
+  include Rack::Test::Methods
+
+  class TestApp
+    def call(env)
+      if env['PATH_INFO'] =~ /error/
+        raise "I failed"
+      else
+        return [200, {"Content-Type" => "text"}, ["hello"]]
+      end
+    end
+  end
+  
+  def app
+    @app ||= Log4rExceptionable::RackFailureHandler.new(TestApp.new)
+  end
+
+  context "handling rack failures" do
+
+    before(:all) do
+      Log4rExceptionable::Configuration.configure do |config|
+        config.rack_failure_logger = 'racklogger'
+      end
+    end
+    
+    it "doesn't log a failure with normal usage" do
+      Log4r::Logger['racklogger'].should_not_receive(:error)
+      get "/"
+    end
+    
+    it "triggers failure handler" do
+      Log4r::Logger['racklogger'].should_receive(:error) do |msg|
+        msg.should == "RuntimeError: I failed"
+        Log4r::MDC.get('rack_exception_backtrace').should =~ /rack_failure_handler_spec.rb/
+        Log4r::MDC.get('rack_exception_backtrace').lines.to_a.size.should > 1
+        Log4r::MDC.get('rack_exception_line').should =~ /\d+/
+        Log4r::MDC.get('rack_exception_file').should =~ /rack_failure_handler_spec.rb/
+        Log4r::MDC.get('rack_env_PATH_INFO').should == '"/error"'
+      end
+      
+      lambda {
+        get "/error"
+      }.should raise_error("I failed")
+    end
+    
+  end
+  
+end

data/spec/redis-test.conf

@@ -0,0 +1,312 @@
+# Redis configuration file example
+
+# Note on units: when memory size is needed, it is possible to specifiy
+# it in the usual form of 1k 5GB 4M and so forth:
+#
+# 1k => 1000 bytes
+# 1kb => 1024 bytes
+# 1m => 1000000 bytes
+# 1mb => 1024*1024 bytes
+# 1g => 1000000000 bytes
+# 1gb => 1024*1024*1024 bytes
+#
+# units are case insensitive so 1GB 1Gb 1gB are all the same.
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in ./tmp/run/redis.pid when daemonized.
+daemonize yes
+
+# When running daemonized, Redis writes a pid file in ./tmp/run/redis.pid by
+# default. You can specify a custom pid file location here.
+pidfile ./redis.pid
+
+# Accept connections on the specified port, default is 6379
+port 6379
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for incoming connections.
+#
+bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# verbose (many rarely useful info, but not a mess like the debug level)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel verbose
+
+# Specify the log file name. Also 'stdout' can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile ./redis-server.log
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################ SNAPSHOTTING  #################################
+#
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+#
+#   Note: you can disable saving at all commenting all the "save" lines.
+
+save 900 1
+save 300 10
+save 60 10000
+
+# Compress string objects using LZF when dump .rdb databases?
+# For default that's set to 'yes' as it's almost always a win.
+# If you want to save some CPU in the saving child set it to 'no' but
+# the dataset will likely be bigger if you have compressible values or keys.
+rdbcompression yes
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# The working directory.
+#
+# The DB will be written inside this directory, with the filename specified
+# above using the 'dbfilename' configuration directive.
+# 
+# Also the Append Only File will be created inside this directory.
+# 
+# Note that you must specify a directory here, not a file name.
+dir .
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+#
+# slaveof <masterip> <masterport>
+
+# If the master is password protected (using the "requirepass" configuration
+# directive below) it is possible to tell the slave to authenticate before
+# starting the replication synchronization process, otherwise the master will
+# refuse the slave request.
+#
+# masterauth <master-password>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+# 
+# Warning: since Redis is pretty fast an outside user can try up to
+# 150k passwords per second against a good box. This means that you should
+# use a very strong password otherwise it will be very easy to break.
+#
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limits.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+#
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+#
+# maxmemory <bytes>
+
+############################## APPEND ONLY MODE ###############################
+
+# By default Redis asynchronously dumps the dataset on disk. If you can live
+# with the idea that the latest records will be lost if something like a crash
+# happens this is the preferred way to run Redis. If instead you care a lot
+# about your data and don't want to that a single record can get lost you should
+# enable the append only mode: when this mode is enabled Redis will append
+# every write operation received in the file appendonly.aof. This file will
+# be read on startup in order to rebuild the full dataset in memory.
+#
+# Note that you can have both the async dumps and the append only file if you
+# like (you have to comment the "save" statements above to disable the dumps).
+# Still if append only mode is enabled Redis will load the data from the
+# log file at startup ignoring the dump.rdb file.
+#
+# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
+# log file in background when it gets too big.
+
+appendonly no
+
+# The name of the append only file (default: "appendonly.aof")
+# appendfilename appendonly.aof
+
+# The fsync() call tells the Operating System to actually write data on disk
+# instead to wait for more data in the output buffer. Some OS will really flush 
+# data on disk, some other OS will just try to do it ASAP.
+#
+# Redis supports three different modes:
+#
+# no: don't fsync, just let the OS flush the data when it wants. Faster.
+# always: fsync after every write to the append only log . Slow, Safest.
+# everysec: fsync only if one second passed since the last fsync. Compromise.
+#
+# The default is "everysec" that's usually the right compromise between
+# speed and data safety. It's up to you to understand if you can relax this to
+# "no" that will will let the operating system flush the output buffer when
+# it wants, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting),
+# or on the contrary, use "always" that's very slow but a bit safer than
+# everysec.
+#
+# If unsure, use "everysec".
+
+# appendfsync always
+appendfsync everysec
+# appendfsync no
+
+################################ VIRTUAL MEMORY ###############################
+
+# Virtual Memory allows Redis to work with datasets bigger than the actual
+# amount of RAM needed to hold the whole dataset in memory.
+# In order to do so very used keys are taken in memory while the other keys
+# are swapped into a swap file, similarly to what operating systems do
+# with memory pages.
+#
+# To enable VM just set 'vm-enabled' to yes, and set the following three
+# VM parameters accordingly to your needs.
+
+vm-enabled no
+# vm-enabled yes
+
+# This is the path of the Redis swap file. As you can guess, swap files
+# can't be shared by different Redis instances, so make sure to use a swap
+# file for every redis process you are running. Redis will complain if the
+# swap file is already in use.
+#
+# The best kind of storage for the Redis swap file (that's accessed at random) 
+# is a Solid State Disk (SSD).
+#
+# *** WARNING *** if you are using a shared hosting the default of putting
+# the swap file under /tmp is not secure. Create a dir with access granted
+# only to Redis user and configure Redis to create the swap file there.
+vm-swap-file ./tmp/redis.swap
+
+# vm-max-memory configures the VM to use at max the specified amount of
+# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
+# is, if there is still enough contiguous space in the swap file.
+#
+# With vm-max-memory 0 the system will swap everything it can. Not a good
+# default, just specify the max amount of RAM you can in bytes, but it's
+# better to leave some margin. For instance specify an amount of RAM
+# that's more or less between 60 and 80% of your free RAM.
+vm-max-memory 0
+
+# Redis swap files is split into pages. An object can be saved using multiple
+# contiguous pages, but pages can't be shared between different objects.
+# So if your page is too big, small objects swapped out on disk will waste
+# a lot of space. If you page is too small, there is less space in the swap
+# file (assuming you configured the same number of total swap file pages).
+#
+# If you use a lot of small objects, use a page size of 64 or 32 bytes.
+# If you use a lot of big objects, use a bigger page size.
+# If unsure, use the default :)
+vm-page-size 32
+
+# Number of total memory pages in the swap file.
+# Given that the page table (a bitmap of free/used pages) is taken in memory,
+# every 8 pages on disk will consume 1 byte of RAM.
+#
+# The total swap size is vm-page-size * vm-pages
+#
+# With the default of 32-bytes memory pages and 134217728 pages Redis will
+# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
+#
+# It's better to use the smallest acceptable value for your application,
+# but the default is large in order to work in most conditions.
+vm-pages 134217728
+
+# Max number of VM I/O threads running at the same time.
+# This threads are used to read/write data from/to swap file, since they
+# also encode and decode objects from disk to memory or the reverse, a bigger
+# number of threads can help with big objects even if they can't help with
+# I/O itself as the physical device may not be able to couple with many
+# reads/writes operations at the same time.
+#
+# The special value of 0 turn off threaded I/O and enables the blocking
+# Virtual Memory implementation.
+vm-max-threads 4
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Hashes are encoded in a special way (much more memory efficient) when they
+# have at max a given numer of elements, and the biggest element does not
+# exceed a given threshold. You can configure this limits with the following
+# configuration directives.
+hash-max-zipmap-entries 64
+hash-max-zipmap-value 512
+
+# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
+# order to help rehashing the main Redis hash table (the one mapping top-level
+# keys to values). The hash table implementation redis uses (see dict.c)
+# performs a lazy rehashing: the more operation you run into an hash table
+# that is rhashing, the more rehashing "steps" are performed, so if the
+# server is idle the rehashing is never complete and some more memory is used
+# by the hash table.
+# 
+# The default is to use this millisecond 10 times every second in order to
+# active rehashing the main dictionaries, freeing memory when possible.
+#
+# If unsure:
+# use "activerehashing no" if you have hard latency requirements and it is
+# not a good thing in your environment that Redis can reply form time to time
+# to queries with 2 milliseconds delay.
+#
+# use "activerehashing yes" if you don't have such hard requirements but
+# want to free memory asap when possible.
+activerehashing yes
+
+################################## INCLUDES ###################################
+
+# Include one or more other config files here.  This is useful if you
+# have a standard template that goes to all redis server but also need
+# to customize a few per-server settings.  Include files can include
+# other files, so use this wisely.
+#
+# include /path/to/local.conf
+# include /path/to/other.conf

data/spec/resque_failure_handler_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Log4rExceptionable::ResqueFailureHandler do
+  include PerformJob
+
+  context "handling resque failures" do
+
+    class SomeJob
+      def self.perform(*args)
+        raise "I failed"
+      end
+    end
+
+    before(:all) do
+      Log4rExceptionable::Configuration.configure do |config|
+        config.resque_failure_logger = 'resquelogger'
+      end
+      
+      Resque::Failure.backend = Log4rExceptionable::ResqueFailureHandler
+    end
+    
+    it "triggers failure handler" do
+      
+      Log4r::Logger['resquelogger'].should_receive(:error) do |msg|
+        msg.should == "RuntimeError: I failed"
+        Log4r::MDC.get('resque_exception_backtrace').should =~ /resque_failure_handler_spec.rb/
+        Log4r::MDC.get('resque_exception_backtrace').lines.to_a.size.should > 1
+        Log4r::MDC.get('resque_exception_line').should =~ /\d+/
+        Log4r::MDC.get('resque_exception_file').should =~ /resque_failure_handler_spec.rb/
+        Log4r::MDC.get('resque_worker').should == ""
+        Log4r::MDC.get('resque_queue').should == "somequeue"
+        Log4r::MDC.get('resque_class').should == "SomeJob"
+        Log4r::MDC.get('resque_args').should == "[\"foo\"]"
+      end
+      
+      run_resque_job(SomeJob, 'foo', :queue => :somequeue, :inline => true)
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require "rack/test"
+require 'rspec'
+require 'resque'
+require 'log4r-exceptionable'
+require 'ap'
+
+# No need to start redis when running in Travis
+unless ENV['CI']
+
+  begin
+    Resque.queues
+  rescue Errno::ECONNREFUSED
+    spec_dir = File.dirname(File.expand_path(__FILE__))
+    REDIS_CMD = "redis-server #{spec_dir}/redis-test.conf"
+    
+    puts "Starting redis for testing at localhost..."
+    puts `cd #{spec_dir}; #{REDIS_CMD}`
+    
+    # Schedule the redis server for shutdown when tests are all finished.
+    at_exit do
+      puts 'Stopping redis'
+      pid = File.read("#{spec_dir}/redis.pid").to_i rescue nil
+      system ("kill -9 #{pid}") if pid.to_i != 0
+      File.delete("#{spec_dir}/redis.pid") rescue nil
+      File.delete("#{spec_dir}/redis-server.log") rescue nil
+      File.delete("#{spec_dir}/dump.rdb") rescue nil
+    end
+  end
+  
+end
+
+##
+# Helper to perform job classes
+#
+module PerformJob
+
+  def run_resque_job(job_class, *job_args)
+    opts = job_args.last.is_a?(Hash) ? job_args.pop : {}
+    queue = opts[:queue] || Resque.queue_from_class(job_class)
+
+    Resque::Job.create(queue, job_class, *job_args)
+
+    run_resque_queue(queue, opts)
+  end
+
+  def run_resque_queue(queue, opts={})
+    worker = Resque::Worker.new(queue)
+    worker.very_verbose = true if opts[:verbose]
+
+    # do a single job then shutdown
+    def worker.done_working
+      super
+      shutdown
+    end
+
+    if opts[:inline]
+      job = worker.reserve
+      worker.perform(job)
+    else
+      worker.work(0)
+    end
+  end
+
+  def dump_redis
+    result = {}
+    Resque.redis.keys("*").each do |key|
+      type = Resque.redis.type(key)
+      result[key] = case type
+        when 'string' then Resque.redis.get(key)
+        when 'list' then Resque.redis.lrange(key, 0, -1)
+        when 'set' then Resque.redis.smembers(key)
+        else type
+      end
+    end
+    return result
+  end
+
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: log4r-exceptionable
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: rack-test
+  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: resque
+  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: log4r
+  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'
+description: Failure handlers for rack and resque that log failures using log4r.  It
+  is expected that these logs will get sent elsewhere (e.g. graylog) by using log4r
+  outputters (e.g. log4r-gelf)
+email:
+- matt@conwaysplace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- graylog2-resque.gemspec
+- lib/log4r-exceptionable.rb
+- lib/log4r-exceptionable/configuration.rb
+- lib/log4r-exceptionable/rack_failure_handler.rb
+- lib/log4r-exceptionable/resque_failure_handler.rb
+- lib/log4r-exceptionable/version.rb
+- spec/configuration_spec.rb
+- spec/rack_failure_handler_spec.rb
+- spec/redis-test.conf
+- spec/resque_failure_handler_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: log4r-exceptionable
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Failure handlers for rack and resque that log failures using log4r
+test_files:
+- spec/configuration_spec.rb
+- spec/rack_failure_handler_spec.rb
+- spec/redis-test.conf
+- spec/resque_failure_handler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: