sidekiq-cluster 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da72edd26d09ba063231b3b73a06ce891ed34fd2
-  data.tar.gz: 3dc9fcb9359f7626a26b62a1694c20365ccdd5ed
+  metadata.gz: 9bd053636c77d2a9013f9eb4eaa7e0ebd387ca4e
+  data.tar.gz: 2a70abcf93df422f9dd27c2ddc9b06ca9182d5b1
 SHA512:
-  metadata.gz: 14fedbc8f6500d3c27dfc7821bf4582ef931187b6ccf24314184ff060f2bd70f187203b54ca819c7cd384d7dea3cca03d2f42bca2f502d4db89492b020978862
-  data.tar.gz: 2222f7178526b52c8bd8e925e1c6ea72ac63c7f0d38c06a1208b33af4accad001f64fa1e7c73eb99222a9efb33999fbd591a92bb863f6ed264506690d87cfefd
+  metadata.gz: 1652ee6f5eb02205b29db3387d5d8b5b040018827416e87f5c219fe0a82837743a69840d4e162f12e1fc158d7c3888cab4342a34da7a76e5525937d28699f66b
+  data.tar.gz: b9bb74bca5603651e1e461a2853a3fc7e23e2d1e02aadf73a1a79aa110a48c182088de889430d74cf2dfb65ba48c85f36ba27983d5be3a2fc1ea2d9db7704713

data/README.md

@@ -2,18 +2,37 @@
 
 ## Sidekiq Cluster
 
-This is a tiny gem that allows starting sidekiq using multiple processes. 
+This is a tiny gem that allows starting sidekiq using multiple processes. It is originally based on the wonderful [Honebadger Cluster Script](http://blog.honeybadger.io/introducing-our-sidekiq-cluster-script/). 
 
-It does not depend on any particular version of sidekiq, as long as the CLI class of Sidekiq remains named the same.
+Features:
+
+ * It does not depend on any particular version of sidekiq, as long as the CLI class of Sidekiq remains named the same.
+
+ * It does not attempt to replicate Sidekiq's command line options. Script itself can be controlled with its own CLI options preceeding the double dash `--`. Options to Sidekiq are expected after the double dash.
+ 
+ * You can specify **max number of processes** and **max total RAM used by this cluster** (expressed as a percentage of total). If one of the Sidekiq processes exceeeds it, it is automatically restarted. 
 
 ### Usage
 
-Install the gem:
+The easiest way to use Sidekiq Cluster is to add it to your Gemfile:
 
+```ruby
+gem 'sidekiq-cluster', require: false
 ```
-gem install sidekiq-cluster
+
+Run `bundle`, and then start Sidekiq cluster like so (this starts exactly two Sidekiq Processes):
+
+```bash
+# this starts sidekiq with default options
+$ bundle exec sidekiq-cluster -N 2
+
+# this starts sidekiq with custom options
+$ bundle exec sidekiq-cluster -N 2 -- -r $(pwd) -q default,10 -q high,100
 ```
 
+### Command Line Options
+
+
 Then try running it with `--help`:
 
 ```
@@ -24,7 +43,7 @@ USAGE
 
 EXAMPLES
     $ cd rails_app
-    $ bundle exec sidekiq-cluster -N 2 -- -c 10 -q default,12 -l log/sidekiq.log
+    $ bundle exec sidekiq-cluster -N 2 -- -c 10 -q default,12 -L log/sidekiq.log
  
 SIDEKIQ CLUSTER OPTIONS
     -n, --name=NAME                  the name of this cluster, used when 
@@ -33,7 +52,7 @@ SIDEKIQ CLUSTER OPTIONS
     -P, --pidfile=FILE               Pidfile prefix, 
                                      eg "/var/www/shared/config/sidekiq.pid"
                                       
-    -l, --logfile=FILE               Logfile for the cluster script
+    -L, --logfile=FILE               Logfile for the cluster script
                                       
     -M, --max-memory=PERCENT         Maximum percent RAM that this
                                      cluster should not exceed. Defaults to 80%.
@@ -54,13 +73,13 @@ SIDEKIQ CLUSTER OPTIONS
 $ cd rails-app
 $ echo "gem 'sidekiq-cluster'" >> Gemfile
 $ bundle install
-$ bundle exec sidekiq-cluster \
-    -P /var/pids/sidekiq.pid \  # these are arguments to sidekiq-cluster
-    -n default \
-    -M 90 \
-    -L /var/log/sidekiq-cluster.log \
-    -N 2 \  
-    -- \                        # these are arguments for sidekiq.
+$ bundle exec sidekiq-cluster \        # these arguments are for sidekiq-cluster:
+    --pidfile /var/pids/sidekiq.pid \  
+    --name default \
+    --max-memory 90 \
+    --logfile /var/log/sidekiq-cluster.log \
+    --num-processes 2 \  
+    -- \                               # these arguments are for sidekiq:
     -L /var/log/sidekiq.log -c 10 -e production -q default,10 -q critical,20
 ```
 

data/lib/sidekiq/cluster/cli.rb

@@ -24,8 +24,15 @@ module Sidekiq
                     :logger
 
       def initialize(argv = ARGV.dup)
-        self.argv         = argv
-        self.sidekiq_argv = []
+        self.argv                    = argv
+        self.name                    = 'default'
+        self.pid_prefix              = '/tmp/sidekiq.pid'
+        self.sidekiq_argv            = []
+        self.log_device              = STDOUT
+        self.memory_percentage_limit = MAX_RAM_PCT
+        self.process_count           = Etc.nprocessors - 1
+        self.processes               = {}
+        self.pids                    = []
       end
 
       def per_process_memory_limit
@@ -39,7 +46,6 @@ module Sidekiq
       end
 
       def start_main_loop!
-        self.processes = {}
         start_children.each do |descriptor|
           processes[descriptor.pid] = descriptor
         end
@@ -47,7 +53,7 @@ module Sidekiq
         self.pids           = processes.keys
         self.watch_children = true
 
-        initiate_main_loop
+        main
         setup_signal_traps
 
         Process.waitall
@@ -68,11 +74,6 @@ module Sidekiq
         else
           split_argv! if argv.include?('--')
         end
-
-        self.log_device              = STDOUT
-        self.memory_percentage_limit = MAX_RAM_PCT
-        self.process_count           = Etc.nprocessors - 1
-
         init_logger!
         parse_args!
       end
@@ -102,7 +103,7 @@ module Sidekiq
         end
       end
 
-      def initiate_main_loop
+      def main
         Thread.new do
           info 'watching for outsized Sidekiq processes...'
           loop do
@@ -138,7 +139,7 @@ module Sidekiq
 
         Process.fork do
           process_argv = sidekiq_argv.dup << '-P' << pid_file(index)
-          process_argv << '--tag' << "sidekiq.#{name}"
+          process_argv << '--tag' << "sidekiq.#{name}.#{index + 1}"
           info "starting up sidekiq instance #{index} with ARGV: 'bundle exec sidekiq #{process_argv.join(' ')}'"
           begin
             cli = Sidekiq::CLI.instance
@@ -154,7 +155,7 @@ module Sidekiq
       end
 
       def pid_file(index)
-        "#{pid_prefix}.#{index}"
+        "#{pid_prefix}.#{index + 1}"
       end
 
       def start_children
@@ -239,7 +240,7 @@ module Sidekiq
                   'eg "/var/www/shared/config/sidekiq.pid"', ' ') do |v|
             self.pid_prefix = v
           end
-          opts.on('-l', '--logfile=FILE',
+          opts.on('-L', '--logfile=FILE',
                   'Logfile for the cluster script', ' ') do |v|
             self.log_device = v
             init_logger!

data/lib/sidekiq/cluster/version.rb

@@ -1,6 +1,6 @@
 module Sidekiq
   module Cluster
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cluster
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul