sidekiq 2.7.5 → 2.8.0

data/Changes.md

@@ -1,3 +1,24 @@
+2.8.0
+-----------
+
+- I18n support!  Sidekiq can optionally save and restore the Rails locale
+  so it will be properly set when your jobs execute.  Just include
+  `require 'sidekiq/middleware/i18n'` in your sidekiq initializer. [#750]
+- Fix bug which could lose messages when using namespaces and the message
+needs to be requeued in Redis. [#744]
+- Refactor Redis namespace support [#747].  The redis namespace can no longer be
+  passed via the config file, the only supported way is via Ruby in your
+  initializer:
+
+```ruby
+sidekiq_redis = { :url => 'redis://localhost:3679', :namespace => 'foo' }
+Sidekiq.configure_server { |config| config.redis = sidekiq_redis }
+Sidekiq.configure_client { |config| config.redis = sidekiq_redis }
+```
+
+A warning is printed out to the log if a namespace is found in your sidekiq.yml.
+
+
 2.7.5
 -----------
 

data/lib/sidekiq/cli.rb

@@ -325,6 +325,11 @@ module Sidekiq
         # allow a non-existent config file so Sidekiq
         # can be deployed by cap with just the defaults.
       end
+      ns = opts.delete(:namespace)
+      if ns
+        Sidekiq.logger.warn("namespace should be set in your ruby initializer, is ignored in config file")
+        Sidekiq.logger.warn("config.redis = { :url => ..., :namespace => '#{ns}' }")
+      end
       opts
     end
 

data/lib/sidekiq/fetch.rb

@@ -78,13 +78,13 @@ module Sidekiq
       Sidekiq.logger.debug { "Re-queueing terminated jobs" }
       jobs_to_requeue = {}
       inprogress.each do |unit_of_work|
-        jobs_to_requeue[unit_of_work.queue] ||= []
-        jobs_to_requeue[unit_of_work.queue] << unit_of_work.message
+        jobs_to_requeue[unit_of_work.queue_name] ||= []
+        jobs_to_requeue[unit_of_work.queue_name] << unit_of_work.message
       end
 
       Sidekiq.redis do |conn|
         jobs_to_requeue.each do |queue, jobs|
-          conn.rpush(queue, jobs)
+          conn.rpush("queue:#{queue}", jobs)
         end
       end
       Sidekiq.logger.info("Pushed #{inprogress.size} messages back to Redis")
@@ -101,7 +101,7 @@ module Sidekiq
 
       def requeue
         Sidekiq.redis do |conn|
-          conn.rpush(queue, message)
+          conn.rpush("queue:#{queue_name}", message)
         end
       end
     end

data/lib/sidekiq/middleware/i18n.rb

@@ -0,0 +1,35 @@
+module Sidekiq::Middleware::I18n
+  # Get the current locale and store it in the message
+  # to be sent to Sidekiq.
+  class Client
+    def call(worker_class, msg, queue)
+      msg['locale'] = I18n.locale
+      yield
+    end
+  end
+
+  # Pull the msg locale out and set the current thread to use it.
+  class Server
+    def call(worker, msg, queue)
+      I18n.locale = msg['locale'] || I18n.default_locale
+      yield
+    ensure
+      I18n.locale = nil
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::I18n::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::I18n::Client
+  end
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::I18n::Server
+  end
+end

data/lib/sidekiq/redis_connection.rb

@@ -9,7 +9,7 @@ module Sidekiq
       driver = options[:driver] || 'ruby'
       # need a connection for Fetcher and Retry
       size = options[:size] || (Sidekiq.server? ? (Sidekiq.options[:concurrency] + 2) : 5)
-      namespace = options[:namespace] || Sidekiq.options[:namespace]
+      namespace = options[:namespace]
 
       ConnectionPool.new(:timeout => 1, :size => size) do
         build_client(url, namespace, driver)

data/lib/sidekiq/testing.rb

@@ -60,7 +60,7 @@ module Sidekiq
 
       def client_push(opts)
         jobs << opts
-        true
+        opts.object_id
       end
 
       # Jobs queued for this worker

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "2.7.5"
+  VERSION = "2.8.0"
 end

data/sidekiq.gemspec

@@ -5,16 +5,15 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Mike Perham"]
   gem.email         = ["mperham@gmail.com"]
   gem.description   = gem.summary = "Simple, efficient message processing for Ruby"
-  gem.homepage      = "http://mperham.github.com/sidekiq"
+  gem.homepage      = "http://sidekiq.org"
   gem.license       = "LGPL-3.0"
 
   gem.executables   = ['sidekiq', 'sidekiqctl']
-  gem.files         = `git ls-files | grep -v myapp`.split("\n")
+  gem.files         = `git ls-files | grep -Ev '^(myapp|examples)'`.split("\n")
   gem.test_files    = `git ls-files -- test/*`.split("\n")
   gem.name          = "sidekiq"
   gem.require_paths = ["lib"]
   gem.version       = Sidekiq::VERSION
-  gem.cert_chain    = ['.public_cert.pem']
   gem.add_dependency                  'redis', '~> 3'
   gem.add_dependency                  'redis-namespace'
   gem.add_dependency                  'connection_pool', '~> 1.0'

data/test/config.yml

@@ -4,6 +4,7 @@
 :require:      ./test/fake_env.rb
 :pidfile:      /tmp/sidekiq-config-test.pid
 :logfile:      /tmp/sidekiq.log
+:namespace:    sidekiq
 :concurrency:  50
 :queues:
   - [<%="very_"%>often, 2]

data/test/test_fetch.rb

@@ -4,6 +4,7 @@ require 'sidekiq/fetch'
 class TestFetcher < MiniTest::Unit::TestCase
 
   def setup
+    Sidekiq.redis = { :namespace => 'fuzzy' }
     Sidekiq.redis do |conn|
       conn.flushdb
       conn.rpush('queue:basic', 'msg')
@@ -35,7 +36,7 @@ class TestFetcher < MiniTest::Unit::TestCase
     assert_equal 0, q1.size
     assert_equal 0, q2.size
     uow = Sidekiq::BasicFetch::UnitOfWork
-    Sidekiq::BasicFetch.bulk_requeue([uow.new('queue:foo', 'bob'), uow.new('queue:foo', 'bar'), uow.new('queue:bar', 'widget')])
+    Sidekiq::BasicFetch.bulk_requeue([uow.new('fuzzy:queue:foo', 'bob'), uow.new('fuzzy:queue:foo', 'bar'), uow.new('fuzzy:queue:bar', 'widget')])
     assert_equal 2, q1.size
     assert_equal 1, q2.size
   end

data/test/test_middleware.rb

@@ -99,4 +99,28 @@ class TestMiddleware < MiniTest::Unit::TestCase
       assert_equal [], recorder
     end
   end
+
+  describe 'i18n' do
+    before do
+      require 'i18n'
+      require 'sidekiq/middleware/i18n'
+    end
+
+    it 'saves and restores locale' do
+      I18n.locale = 'fr'
+      msg = {}
+      mw = Sidekiq::Middleware::I18n::Client.new
+      mw.call(nil, msg, nil) { }
+      assert_equal :fr, msg['locale']
+
+      msg['locale'] = 'jp'
+      I18n.locale = nil
+      assert_equal :en, I18n.locale
+      mw = Sidekiq::Middleware::I18n::Server.new
+      mw.call(nil, msg, nil) do
+        assert_equal :jp, I18n.locale
+      end
+      assert_equal :en, I18n.locale
+    end
+  end
 end

data/test/test_redis_connection.rb

@@ -11,30 +11,16 @@ class TestRedisConnection < MiniTest::Unit::TestCase
     end
 
     describe "namespace" do
-      before do
-        Sidekiq.options[:namespace] = "xxx"
-      end
-
-      after do
-        Sidekiq.options[:namespace] = nil
-      end
-
       it "uses a given :namespace" do
         pool = Sidekiq::RedisConnection.create(:namespace => "xxx")
         assert_equal "xxx", pool.checkout.namespace
       end
 
-      it "uses :namespace from Sidekiq.options" do
-        pool = Sidekiq::RedisConnection.create
-        assert_equal "xxx", pool.checkout.namespace
-      end
-
       it "uses given :namespace over :namespace from Sidekiq.options" do
         Sidekiq.options[:namespace] = "xxx"
         pool = Sidekiq::RedisConnection.create(:namespace => "yyy")
         assert_equal "yyy", pool.checkout.namespace
       end
-
     end
   end
 

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.7.5
+  version: 2.8.0
   prerelease: 
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
-cert_chain:
-- .public_cert.pem
-date: 2013-02-25 00:00:00.000000000 Z
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -198,7 +197,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .public_cert.pem
 - .travis.yml
 - COMM-LICENSE
 - Changes.md
@@ -210,24 +208,6 @@ files:
 - bin/sidekiq
 - bin/sidekiqctl
 - config.ru
-- examples/chef/cookbooks/sidekiq/README.rdoc
-- examples/chef/cookbooks/sidekiq/recipes/default.rb
-- examples/chef/cookbooks/sidekiq/templates/default/monitrc.conf.erb
-- examples/chef/cookbooks/sidekiq/templates/default/sidekiq.erb
-- examples/chef/cookbooks/sidekiq/templates/default/sidekiq.yml.erb
-- examples/clockwork.rb
-- examples/config.yml
-- examples/monitrc.conf
-- examples/por.rb
-- examples/runit/README.md
-- examples/runit/log/run
-- examples/runit/run
-- examples/scheduling.rb
-- examples/sidekiq
-- examples/sinkiq.rb
-- examples/upstart/sidekiq.conf
-- examples/upstart/workers.conf
-- examples/web-ui.png
 - lib/sidekiq.rb
 - lib/sidekiq/api.rb
 - lib/sidekiq/capistrano.rb
@@ -244,6 +224,7 @@ files:
 - lib/sidekiq/logging.rb
 - lib/sidekiq/manager.rb
 - lib/sidekiq/middleware/chain.rb
+- lib/sidekiq/middleware/i18n.rb
 - lib/sidekiq/middleware/server/active_record.rb
 - lib/sidekiq/middleware/server/logging.rb
 - lib/sidekiq/middleware/server/retry_jobs.rb
@@ -304,7 +285,7 @@ files:
 - web/views/retries.slim
 - web/views/retry.slim
 - web/views/scheduled.slim
-homepage: http://mperham.github.com/sidekiq
+homepage: http://sidekiq.org
 licenses:
 - LGPL-3.0
 post_install_message: 

data/.public_cert.pem

@@ -1,20 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDMDCCAhigAwIBAgIBADANBgkqhkiG9w0BAQUFADA+MRAwDgYDVQQDDAdtcGVy
-aGFtMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
-HhcNMTMwMTMwMTkyODU3WhcNMTQwMTMwMTkyODU3WjA+MRAwDgYDVQQDDAdtcGVy
-aGFtMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
-ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC/rvUwLpOQEsPfi1T/QtRj
-dc7+0DE8ljILJqJ+sUkZ881Uxit6M+8ZZoqNkwa2e2RCWRBdNx625RQh2bX4utpY
-kloTWQ6PBbrDDVHVRAkuwDbaH4wE8rtwXDcKuto4xaHjN+EYWf2rHBNC4+qMX+ev
-CD3MRBG7xOURthDpRTKBXTnDA6qPlFH+4BONLyUOPgz2j0hzVQbA/795KJXpIih9
-goEiaWzvvqs8upsdFGQoVvaFUKE/Zr79Zm0kNC7dDtG0toHll0XMFUL/JjJT2Rh2
-cALDwIxwVdL7r6l2O4qeuXL7HKSC5ZyNqx3JoVwrxfXk2I2DOGBqrGSJJFWUq3i1
-AgMBAAGjOTA3MAkGA1UdEwQCMAAwHQYDVR0OBBYEFNGAnRmrLLc4NFfTSL2PjpAx
-GJnfMAsGA1UdDwQEAwIEsDANBgkqhkiG9w0BAQUFAAOCAQEAf9vqK2frmnKcyDE7
-dt9eLthYUxZ8HlctLSXDs4tjlEKKfwkD1Yalu4PNzhjrHqXa8hYTxqHPfWmV771q
-qT/OLVvL4ofjrXmAG+hqwzcT7grSbYDAK14ITY8M8DpC2jvuGR3MnyChi9ep0pLa
-E9Jy35lxa3UFBjr0neI9QxowMilmjUHnPDzVHbzmWAQxPoc18uiU9PXd0h+Jsx2F
-y8Ix+zZ1LIOWk9O9WnMdLOTjUFnA/zutM3Nzv8zNBnUJjH5/A5igCIAL+6vU7+su
-sLF+JCFPbBgvRqL5hX03CKuyOUNmUVT5AnCDnfIDUV/kJhX7Wfr6IqaUHmUcy/jn
-ey6hlw==
------END CERTIFICATE-----

data/examples/chef/cookbooks/sidekiq/README.rdoc

@@ -1,11 +0,0 @@
-= DESCRIPTION:
-
-Sidekiq is a Redis-backed Ruby library for creating background jobs, placing those jobs on multiple queues, and processing them later.
-
-= USAGE: 
-
-add require_recipe "sidekiq" to main/recipes/default.rb
-
-= NOTES:
-
-I setup a basic size for the Sidekiq workers based on the instance_type, if you need more or less workers please modify the recipe itself.  

data/examples/chef/cookbooks/sidekiq/recipes/default.rb

@@ -1,55 +0,0 @@
-#
-# Cookbook Name:: sidekiq
-# Recipe:: default
-#
-role = node[:instance_role]
-if role == 'solo' || (role == 'util' && node[:name] =~ /sidekiq/)
-
-  # for now
-  worker_count = 1
-
-  node[:applications].each do |app, data|
-    template "/etc/monit.d/sidekiq_#{app}.monitrc" do 
-      owner 'root' 
-      group 'root' 
-      mode 0644 
-      source "monitrc.conf.erb" 
-      variables({ 
-        :num_workers => worker_count,
-        :app_name => app, 
-        :rails_env => node[:environment][:framework_env] 
-      }) 
-    end
-
-    template "/engineyard/bin/sidekiq" do
-      owner 'root'
-      group 'root' 
-      mode 0755
-      source "sidekiq.erb" 
-    end
-
-    worker_count.times do |count|
-      template "/data/#{app}/shared/config/sidekiq_#{count}.yml" do
-        owner node[:owner_name]
-        group node[:owner_name]
-        mode 0644
-        source "sidekiq.yml.erb"
-        variables({
-          :require => "/data/#{app}/current"
-        })
-      end
-    end
-
-    execute "ensure-sidekiq-is-setup-with-monit" do 
-      command %Q{ 
-        monit reload 
-      } 
-    end
-
-    execute "restart-sidekiq" do 
-      command %Q{ 
-        echo "sleep 20 && monit -g #{app}_sidekiq restart all" | at now 
-      }
-    end
-  end 
-end

data/examples/chef/cookbooks/sidekiq/templates/default/monitrc.conf.erb

@@ -1,8 +0,0 @@
-<% (@num_workers || 1).times do |num| %>
-check process sidekiq_<%= @app_name %>_<%= num %>
-  with pidfile /var/run/engineyard/sidekiq/<%= @app_name %>/sidekiq_<%= num %>.pid
-  start program = "/engineyard/bin/sidekiq <%= @app_name %> start <%= @rails_env  %> sidekiq_<%= num %>.yml" with timeout 90 seconds
-  stop program = "/engineyard/bin/sidekiq <%= @app_name %> stop <%= @rails_env  %> sidekiq_<%= num %>.yml" with timeout 90 seconds
-  if totalmem is greater than 300 MB for 2 cycles then restart # eating up memory?
-  group <%= @app_name %>_sidekiq
-<% end %>

data/examples/chef/cookbooks/sidekiq/templates/default/sidekiq.erb

@@ -1,180 +0,0 @@
-#!/bin/sh
-#
-# This script starts and stops the Sidekiq daemon
-# This script belongs in /engineyard/bin/sidekiq
-#
-
-PATH=/bin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:$PATH
-CURDIR=`pwd`
-
-usage() {
-  echo "Usage: $0 <appname> {start|stop|quit} <environment> <conf_file>"
-  echo -e "\nstop)     is a synonym for quit"
-  echo "quit)     issues -INT to request the worker to stop"
-  echo -e "\nSee http://mperham.github.com/sidekiq/ for more details"
-  exit 1
-}
-
-rm_lockfile(){
-  if [ -e $LOCK_FILE ]; then
-   logger -t "monit-sidekiq[$$]" "removing $LOCK_FILE for `cat $LOCK_FILE`"
-   rm $LOCK_FILE
-  fi
-}
-
-exit_cleanly() {
-  cd $CURDIR
-  logger -t "monit-sidekiq[$$]" "exiting wrapper cleanly with $RESULT"
-  exit $RESULT
-}
-
-unlock_and_exit_cleanly(){
-  rm_lockfile
-  exit_cleanly
-}
-
-set_pid_from_file(){
-  export PID=`cat $PID_FILE`
-}
-
-signal_worker() {
-  RESULT=0
-  if [ -f $PID_FILE ]; then
-    set_pid_from_file
-    logger -t "monit-sidekiq[$$]" "Issuing kill with -$SIG $PID"
-    kill -$SIG $PID 
-  fi
-}
-
-lock(){
-  RESULT=0
-  if [ -e $LOCK_FILE ]; then
-    LAST_LOCK_PID=`cat $LOCK_FILE`
-    if [ -n $LAST_LOCK_PID -a -z "`ps axo pid|grep $LAST_LOCK_PID`" -a -f $LOCK_FILE ];then
-      sleep 1
-      logger -t "monit-sidekiq[$$]" "Removing stale lock file for $WORKER_REF ($LAST_LOCK_PID)"
-      rm $LOCK_FILE 2>&1
-    else
-      logger -t "monit-sidekiq[$$]" "Monit already messing with $WORKER_REF ($LAST_LOCK_PID)"
-      RESULT=1
-      exit_cleanly 
-    fi
-  fi
-  echo $$ > $LOCK_FILE
-}
-
-legacy_fix() {
- #In the transition from 0.18.2 to 0.18.3 of ey monit scripts the way 
- #the pid file is used to find the process to kill has changed. 
- #To avert problems being left behind after an upgrade of this package,
-  if [ -f $PID_FILE ]; then
-    set_pid_from_file
-    if [ -n "`ps axo pid,command|grep $PID|grep 'su -c'`" ];then
-      logger -t "monit-sidekiq[$$]" "Monit Scripts have just been upgraded, killing old style workers"
-      for child in $(ps axo pid,ppid| awk "{ if ( \$2 == $PID ) { print \$1 }}");
-      do
-        kill -TERM $child 2> /dev/null
-        while [ -e /proc/$child ]; do
-          logger -t "monit-sidekiq[$$]" "killing legacy worker: $child"
-          [ -e /proc/$child ] && kill -9 $child 2> /dev/null
-	  sleep 1 
-        done
-      done
-      [ -e /proc/$PID   ] && kill -9 $PID   2> /dev/null
-      rm $PID_FILE
-      unlock_exit_cleanly  
-    fi
-  fi
-}
-
-if [ $# -lt 4 ]; then usage; fi
-
-if [ "`whoami`" != "root" ]; then
-  logger -t `basename $0` -s "Must be run as root" 
-  exit 1
-fi
-
-#Baisc Setup of default values
-APP=$1 ; ACTION=$2; RACK_ENV=$3; CONF_FILE=$4;
-
-APP_DIR="/data/${APP}"
-APP_ROOT="${APP_DIR}/current"
-APP_SHARED="${APP_DIR}/shared"
-APP_CONFIG="${APP_SHARED}/config"
-
-if [ -e "${APP_CONFIG}/${CONF_FILE}" ]; then
-  logger -t "sidekiq_${APP}" -s "Good, found a conf file. Proceeding..."
-else
-  logger -t "sidekiq_${APP}" -s "/data/${APP}/shared/config/${CONF_FILE} not found for app: ${APP}"
-  exit 1
-fi
-
-WORKER_REF=`echo $CONF_FILE | sed s/.yml//`
-LOG_FILE="$APP_ROOT/log/$WORKER_REF.log"
-LOCK_FILE="/tmp/$WORKER_REF.monit-lock"
-PID_FILE="/var/run/engineyard/sidekiq/$APP/$WORKER_REF.pid"
-GEMFILE="$APP_ROOT/Gemfile"
-SIDEKIQ="sidekiq"
-if [ -f $GEMFILE ];then
-  SIDEKIQ="$APP_ROOT/ey_bundler_binstubs/sidekiq"
-fi
-
-if [ -d $APP_ROOT ]; then
-  USER=$(stat -L -c"%U" $APP_ROOT)
-  export HOME="/home/$USER" 
-
-  # Fix for SD-3786 - stop sending in VERBOSE= and VVERBOSE= by default
-  if declare -p VERBOSE >/dev/null 2>&1; then export V="VERBOSE=$VERBOSE"; fi
-  if declare -p VVERBOSE >/dev/null 2>&1; then export VV="VVERBOSE=$VVERBOSE"; fi
-
-  # Older versions of sudo need us to call env for the env vars to be set correctly
-  COMMAND="/usr/bin/env $V $VV APP_ROOT=${APP_ROOT} RACK_ENV=${RACK_ENV} RAILS_ENV=${RACK_ENV} $SIDEKIQ -e ${RACK_ENV} -C ${APP_CONFIG}/${CONF_FILE}"
-  
-  if [ ! -d /var/run/engineyard/sidekiq/$APP ]; then
-    mkdir -p /var/run/engineyard/sidekiq/$APP
-  fi
-
-  # handle the second param, don't start if already existing
-
-  logger -t "monit-sidekiq[$$]" "${ACTION}ing Sidekiq worker $WORKER_REF"
-  case "$ACTION" in
-    start)
-      lock
-      cd $APP_ROOT
-      if [ -f $PID_FILE ]; then
-        set_pid_from_file
-        if [ -d /proc/$PID ]; then
-          logger -t "monit-sidekiq[$$]" "Sidekiq worker $WORKER_REF is already running with $PID."
-          RESULT=1
-        else
-          rm -f $PID_FILE
-          logger -t "monit-sidekiq[$$]" "Removing stale pid file ($PID_FILE) for pid $PID"
-        fi
-      fi
-      if [ ! -f $PID_FILE ]; then
-        sudo -u $USER -H $COMMAND  >> $LOG_FILE 2>&1 &
-        RESULT=$?
-        logger -t "monit-sidekiq[$$]" "Started with pid $! and exit $RESULT"
-        echo $! > $PID_FILE
-        sleep .1
-      fi
-      unlock_and_exit_cleanly 
-      ;;
-    stop|quit)
-      legacy_fix
-      lock
-      SIG="INT"
-      signal_worker
-      [ -e "$LOCK_FILE" ] && rm $LOCK_FILE
-      unlock_and_exit_cleanly  
-      ;;
-    *)
-      usage
-      exit_cleanly      
-      ;;
-  esac
-else
-  echo "/data/$APP/current doesn't exist."
-  usage
-fi
-

data/examples/chef/cookbooks/sidekiq/templates/default/sidekiq.yml.erb

@@ -1,22 +0,0 @@
----
-<% if @verbose %>
-:verbose: <%= @verbose %>
-<% end %>
-<% if @environment %>
-:environment: <%= @environment %>
-<% end %>
-<% if @require %>
-:require: <%= @require %>
-<% end %>
-<% if @pidfile %>
-:pidfile: <%= @pidfile %>
-<% end %>
-<% if @concurrency %>
-:concurrency: <%= @concurrency %>
-<% end %>
-<% if @queues %>
-:queues:
-  <% @queues.each do |name, priority| %>
-  - [<%= name %>, <%= priority %>]
-  <% end %>
-<% end %>

data/examples/clockwork.rb

@@ -1,44 +0,0 @@
-# Sidekiq defers scheduling to other, better suited gems.
-# If you want to run a job regularly, here's an example
-# of using the 'clockwork' gem to push jobs to Sidekiq
-# regularly.
-
-# require boot & environment for a Rails app
-# require_relative "../config/boot"
-# require_relative "../config/environment"
-require "clockwork"
-
-class MyWorker
-  include Sidekiq::Worker
-
-  def perform(count)
-    puts "Job ##{count}: Late night, so tired..."
-  end
-
-  def self.late_night_work
-    10.times do |x|
-      perform_async(x)
-    end
-  end
-end
-
-class HourlyWorker
-  include Sidekiq::Worker
-
-  def perform
-    cleanup_database
-    format_hard_drive
-  end
-end
-
-module Clockwork
-  # Kick off a bunch of jobs early in the morning
-  every 1.day, 'my_worker.late_night_work', :at => '4:30 am' do
-    MyWorker.late_night_work
-  end
-
-  every 1.hour do
-    HourlyWorker.perform_async
-  end
-end
-

data/examples/config.yml

@@ -1,12 +0,0 @@
-# Sample configuration file for Sidekiq.
-# Options here can still be overridden by cmd line args.
-#   sidekiq -C config.yml
----
-:verbose: false
-:pidfile: ./tmp/pids/sidekiq.pid
-:namespace: sidekiq_namespace
-:concurrency:  25
-:queues:
-  - [often, 7]
-  - [default, 5]
-  - [seldom, 3]

data/examples/monitrc.conf

@@ -1,6 +0,0 @@
-check process sidekiq_myapp
-  with pidfile /path/to/sidekiq.pid
-  start program = "bundle exec sidekiq -C /path/to/sidekiq_conf.yml -P /path/to/sidekiq.pid" with timeout 90 seconds
-  stop program = "kill -s INT `cat /path/to/sidekiq.pid`" with timeout 90 seconds
-  if totalmem is greater than 200 MB for 2 cycles then restart # eating up memory?
-  group myapp_sidekiq

data/examples/por.rb

@@ -1,27 +0,0 @@
-require 'sidekiq'
-
-# If your client is single-threaded, we just need a single connection in our Redis connection pool
-Sidekiq.configure_client do |config|
-  config.redis = { :namespace => 'x', :size => 1, :url => 'redis://redis.host:1234/14' }
-end
-
-# Sidekiq server is multi-threaded so our Redis connection pool size defaults to concurrency (-c)
-Sidekiq.configure_server do |config|
-  config.redis = { :namespace => 'x', :url => 'redis://redis.host:1234/14' }
-end
-
-# Start up sidekiq via
-# ./bin/sidekiq -r ./examples/por.rb
-# and then you can open up an IRB session like so:
-# irb -r ./examples/por.rb
-# where you can then say
-# PlainOldRuby.perform_async "like a dog", 3
-#
-class PlainOldRuby
-  include Sidekiq::Worker
-
-  def perform(how_hard="super hard", how_long=1)
-    sleep how_long
-    puts "Workin' #{how_hard}"
-  end
-end

data/examples/runit/README.md

@@ -1,16 +0,0 @@
-This is a "service" directory for sidekiq. You should probably modify
-the relevant paths in the run script, and the log/run script, if
-necessary. It assumes a "sidekiq" user is created that will run the
-sidekiq process. To supervise under runit, link this directory to the
-runsvdir for your system (e.g., `/etc/service` on Debian/Ubuntu).
-
-If you're using Chef, use the
-[example cookbook](https://github.com/mperham/sidekiq/tree/master/examples/chef/cookbooks/sidekiq)
-(modified for your environment), and Opscode's
-[runit cookbook](http://ckbk.it/runit) to set up the service.
-
-Author: Joshua Timberman <joshua@opscode.com>
-
-Runit is written by Gerrit Pape.
-
-* http://smarden.org/runit

data/examples/runit/log/run

@@ -1,2 +0,0 @@
-#!/bin/sh
-exec svlogd -tt /var/log/sidekiq

data/examples/runit/run

@@ -1,4 +0,0 @@
-#!/bin/sh
-cd /path/to/sidekiq
-exec 2>&1
-exec chpst -usidekiq bundle exec sidekiq -e production -P /var/run/sidekiq/sidekiq.pid

data/examples/scheduling.rb

@@ -1,37 +0,0 @@
-# Sidekiq defers scheduling cron-like tasks to other, better suited gems.
-# If you want to run a job regularly, here's an example
-# of using the 'whenever' gem to push jobs to Sidekiq
-# regularly.
-
-class MyWorker
-  include Sidekiq::Worker
-
-  def perform(count)
-    puts "Job ##{count}: Late night, so tired..."
-  end
-
-  def self.late_night_work
-    10.times do |x|
-      perform_async(x)
-    end
-  end
-end
-
-# Kick off a bunch of jobs early in the morning
-every 1.day, :at => '4:30 am' do
-  runner "MyWorker.late_night_work"
-end
-
-
-class HourlyWorker
-  include Sidekiq::Worker
-
-  def perform
-    cleanup_database
-    format_hard_drive
-  end
-end
-
-every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
-  runner "HourlyWorker.perform_async"
-end

data/examples/sidekiq

@@ -1,92 +0,0 @@
-#!/bin/bash
-# sidekiq    Init script for Sidekiq
-# chkconfig: 345 100 75
-#
-# Description: Starts and Stops Sidekiq message processor for Stratus application.
-#
-# User-specified exit parameters used in this script:
-#
-# Exit Code 5 - Incorrect User ID
-# Exit Code 6 - Directory not found
-
-
-#Variable Set
-APP="stratus"
-APP_DIR="/opt/railsapps/${APP}"
-APP_CONFIG="${APP_DIR}/config"
-LOG_FILE="$APP_DIR/log/sidekiq.log"
-LOCK_FILE="$APP_DIR/${APP}-lock"
-PID_FILE="$APP_DIR/${APP}.pid"
-GEMFILE="$APP_DIR/Gemfile"
-SIDEKIQ="sidekiq"
-APP_ENV="production"
-BUNDLE="bundle"
-
-START_CMD="$BUNDLE exec $SIDEKIQ -e $APP_ENV -P $PID_FILE"
-RETVAL=0
-
-
-start() {
-
-  status
-  if [ $? -eq 1 ]; then
-
-    [ `id -u` == '0' ] || (echo "$SIDEKIQ runs as root only .."; exit 5)
-    [ -d $APP_DIR ] || (echo "$APP_DIR not found!.. Exiting"; exit 6)
-    cd $APP_DIR
-    echo "Starting $SIDEKIQ message processor .. "
-    $START_CMD >> $LOG_FILE 2>&1 &
-    RETVAL=$?
-    #Sleeping for 8 seconds for process to be precisely visible in process table - See status ()
-    sleep 8
-    [ $RETVAL -eq 0 ] && touch $LOCK_FILE
-    return $RETVAL
-  else
-    echo "$SIDEKIQ message processor is already running .. "
-  fi
-
-
-}
-
-stop() {
-
-    echo "Stopping $SIDEKIQ message processor .."
-    SIG="INT"
-    kill -$SIG `cat  $PID_FILE`
-    RETVAL=$?
-    [ $RETVAL -eq 0 ] && rm -f $LOCK_FILE
-    return $RETVAL
-}
-
-
-status() {
-
-  ps -ef | grep 'sidekiq [0-9].[0-9].[0-9]' | grep -v grep
-  return $?
-}
-
-
-case "$1" in
-    start)
-        start
-        ;;
-    stop)
-        stop
-        ;;
-    status)
-        status
-
-        if [ $? -eq 0 ]; then
-             echo "$SIDEKIQ message processor is running .."
-             RETVAL=0
-         else
-             echo "$SIDEKIQ message processor is stopped .."
-             RETVAL=1
-         fi
-        ;;
-    *)
-        echo "Usage: $0 {start|stop|status}"
-        exit 0
-        ;;
-esac
-exit $RETVAL

data/examples/sinkiq.rb

@@ -1,60 +0,0 @@
-# Make sure you have Sinatra installed, then start sidekiq with
-# ./bin/sidekiq -r ./examples/sinkiq.rb
-# Simply run Sinatra with
-# ruby examples/sinkiq.rb
-# and then browse to http://localhost:4567
-#
-require 'sinatra'
-require 'sidekiq'
-require 'redis'
-
-$redis = Redis.connect
-
-class SinatraWorker
-  include Sidekiq::Worker
-
-  def perform(msg="lulz you forgot a msg!")
-    $redis.lpush("sinkiq-example-messages", msg)
-  end
-end
-
-get '/' do
-  stats = Sidekiq::Stats.new
-  @failed = stats.failed
-  @processed = stats.processed
-  @messages = $redis.lrange('sinkiq-example-messages', 0, -1)
-  erb :index
-end
-
-post '/msg' do
-  SinatraWorker.perform_async params[:msg]
-  redirect to('/')
-end
-
-__END__
-
-@@ layout
-<html>
-  <head>
-    <title>Sinatra + Sidekiq</title>
-    <body>
-      <%= yield %>
-    </body>
-</html>
-
-@@ index
-  <h1>Sinatra + Sidekiq Example</h1>
-  <h2>Failed: <%= @failed %></h2>
-  <h2>Processed: <%= @processed %></h2>
-
-  <form method="post" action="/msg">
-    <input type="text" name="msg">
-    <input type="submit" value="Add Message">
-  </form>
-
-  <a href="/">Refresh page</a>
-
-  <h3>Messages</h3>
-  <% @messages.each do |msg| %>
-    <p><%= msg %></p>
-  <% end %>

data/examples/upstart/sidekiq.conf

@@ -1,46 +0,0 @@
-# /etc/init/sidekiq.conf - Sidekiq config
-
-# This example config should work with Ubuntu 12.04+.  It
-# allows you to manage multiple Sidekiq instances with
-# Upstart, Ubuntu's native service management tool.
-#
-# See workers.conf for how to manage all Sidekiq instances at once.
-#
-# Save this config as /etc/init/sidekiq.conf then mange sidekiq with:
-#   sudo start sidekiq index=0
-#   sudo stop sidekiq index=0
-#   sudo status sidekiq index=0
-#
-# or use the service command:
-#   sudo service sidekiq {start,stop,restart,status}
-#
-
-description "Sidekiq Background Worker"
-
-# no "start on", we don't want to automatically start
-stop on (stopping workers or runlevel [06])
-
-# change to match your deployment user
-setuid deploy
-setgid deploy
-
-respawn
-respawn limit 3 30
-
-instance $index
-
-script
-# this script runs in /bin/sh by default
-# respawn as bash so we can source in rbenv
-exec /bin/bash <<EOT
-  # use syslog for logging
-  exec &> /dev/kmsg
-
-  # pull in system rbenv
-  export HOME=/home/deploy
-  source /etc/profile.d/rbenv.sh
-
-  cd /opt/theclymb/current
-  exec bin/sidekiq -i ${index} -e production -C config/sidekiq.yml -P tmp/pids/sidekiq-${index}.pid
-EOT
-end script

data/examples/upstart/workers.conf

@@ -1,30 +0,0 @@
-# /etc/init/workers.conf - manage a set of Sidekiqs
-
-# This example config should work with Ubuntu 12.04+.  It
-# allows you to manage multiple Sidekiq instances with
-# Upstart, Ubuntu's native service management tool.
-#
-# See sidekiq.conf for how to manage a single Sidekiq instance.
-#
-# Use "stop workers" to stop all Sidekiq instances.
-# Use "start workers" to start all instances.
-# Use "restart workers" to restart all instances.
-# Crazy, right?
-#
-
-description "manages the set of sidekiq processes"
-
-# This starts upon bootup and stops on shutdown
-start on runlevel [2345]
-stop on runlevel [06]
-
-# Set this to the number of Sidekiq processes you want
-# to run on this machine
-env NUM_WORKERS=2
-
-pre-start script
-  for i in `seq 0 $((${NUM_WORKERS} - 1))`
-  do
-    start sidekiq index=$i
-  done
-end script