rhebok 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 408023b452e82e718cae736b0a03205cee740e09
-  data.tar.gz: 219ddba59885e2acd71d3829d4a3ec4b3c6681d9
+  metadata.gz: 352364eef1390ca74ce23d703ef8b1e0c5f61973
+  data.tar.gz: 124b53abfdbb2c8b3b419e1de3b19ef32d579ea7
 SHA512:
-  metadata.gz: 1544c2d60309ca69227fdcb66005f498f3873cf316c75789bcd50dc1a5439b05ef76962df996136c503b5cb1e3f23c13f86a7b3b362787c3a01456290d8e842a
-  data.tar.gz: fa141f438502c30119178b4d1831b17a6d44901512a8c29d77db374c6e7cde83697fc624afe53942af5153933db42ad63a194d4888b94ba6b870b79fc1cbec86
+  metadata.gz: eb08e008694d337388b70d95d6d00bbe4e58df13c74818af1b9f5b4965e7129867cca5a84eac30b7bf46d233bcc7066d8aef9ef05d5b292a8af9c130b5d2f2fc
+  data.tar.gz: 051d9924237070aa7745f2b3daec76738c851cbc3ae70ab543158d6cba6557d6c8369fb0bb19b11073d04f23c06b8a18da56f6669690cfdef1a4efc95085c867

data/Changes

@@ -1,3 +1,8 @@
+0.2.0 2014-12-26T11:40:23Z
+
+    - support ConfigFile
+    - changed default MaxWorkers to 5
+
 0.1.2 2014-12-25T17:33:59Z
 
     - oops. status_code.to_i is required

data/README.md

@@ -32,7 +32,7 @@ Or install it yourself as:
 
 ## Usage
 
-    $ rackup -s Rhebok -O Port=8080 -O MaxWorkers=10 -O MaxRequestPerChild=1000 -O OobGC=yes -E production config.ru
+    $ rackup -s Rhebok --port 8080 -O MaxWorkers=5 -O MaxRequestPerChild=1000 -O OobGC=yes -E production config.ru
 
 ## Sample configuration with Nginx
 
@@ -55,10 +55,14 @@ nginx.conf
 command line of running Rhebok
 
     $ start_server --path /path/to/app.sock --backlog 16384 -- rackup -s Rhebok \
-      -O MaxWorkers=10 -O MaxRequestPerChild=1000 -E production config.ru
+      -O MaxWorkers=5 -O MaxRequestPerChild=1000 -E production config.ru
 
 ## Options
 
+### ConfigFile
+
+filename to load options. For details, please read `Config File` section
+
 ### Host
 
 hostname or ip address to bind (default: 0.0.0.0)
@@ -77,7 +81,7 @@ specifies a listen backlog parameter
 
 ### MaxWorkers
 
-number of worker processes (default: 10)
+number of worker processes (default: 5)
 
 ### MaxRequestPerChild
 
@@ -108,7 +112,73 @@ If set, randomizes the number of request before invoking GC between the number o
 
 ### SpawnInterval
 
-if set, worker processes will not be spawned more than once than every given seconds. Also, when SIGHUP is being received, no more than one worker processes will be collected every given seconds. This feature is useful for doing a "slow-restart". See http://blog.kazuhooku.com/2011/04/web-serverstarter-parallelprefork.html for more information. (default: none)
+if set, worker processes will not be spawned more than once than every given seconds. Also, when SIGUSR1 is being received, no more than one worker processes will be collected every given seconds. This feature is useful for doing a "slow-restart". See http://blog.kazuhooku.com/2011/04/web-serverstarter-parallelprefork.html for more information. (default: none)
+
+## Config File
+
+load options from specified config file. If same options are exists in command line and the config file, options written in the config file will take precedence.
+
+```
+$ cat rhebok_config.rb
+host '127.0.0.1'
+port 9292
+max_workers ENV["WEB_CONCURRENCY"] || 3
+before_fork {
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
+}
+after_fork {
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.establish_connection
+}
+$ rackup -s Rhebok -O ConfigFile=rhebok_config.rb -O port 8080 -O OobGC -E production
+Rhebok starts Listening on 127.0.0.1:9292 Pid:11892
+```
+
+Supported options in config file are below.
+
+### host
+
+### port
+
+### path
+
+### backlog
+
+### max_workers
+
+### timeout
+
+### max_request_per_child
+
+### min_request_per_child
+
+### oobgc
+
+### max_gc_per_request
+
+### min_gc_per_request
+
+### spawn_interval
+
+### before_fork
+
+proc object. This block will be called by a master process before forking each worker
+
+### after_fork
+
+proc object. This block will be called by a worker process after forking
+
+## Signal Handling
+
+### Master process
+
+- TERM, HUP: If the master process received TERM or HUP signal, Rhebok will shutdown gracefully
+- USR1: If set SpawnInterval, Rhebok will collect workers every given seconds and exit
+
+### worker process
+
+- TERM: If the worker process received TERM, exit after finishing current request
 
 ## Benchmark
 
@@ -162,7 +232,7 @@ config.ru
 command to run
 
     $ start_server --path /path/to/app.sock  -- rackup -s Rhebok \
-      -O MaxWorkers=8 -O MaxRequestPerChild=1000000 -E production config.ru
+      -O MaxWorkers=8 -O MaxRequestPerChild=0 -E production config.ru
 
 result
 

data/lib/rack/handler/rhebok.rb

@@ -10,6 +10,7 @@ require 'rack/utils'
 require 'io/nonblock'
 require 'prefork_engine'
 require 'rhebok'
+require 'rhebok/config'
 
 $RACK_HANDLER_RHEBOK_GCTOOL = true
 begin
@@ -26,7 +27,7 @@ module Rack
         :Host => '0.0.0.0',
         :Port => 9292,
         :Path => nil,
-        :MaxWorkers => 10,
+        :MaxWorkers => 5,
         :Timeout => 300,
         :MaxRequestPerChild => 1000,
         :MinRequestPerChild => nil,
@@ -36,6 +37,8 @@ module Rack
         :MaxGCPerRequest => 5,
         :MinGCPerRequest => nil,
         :BackLog => nil,
+        :BeforeFork => nil,
+        :AfterFork => nil,
       }
       NULLIO  = StringIO.new("").set_encoding('BINARY')
 
@@ -57,6 +60,12 @@ module Rack
           options[:OobGC] = options[:OobGC].match(/^(true|yes|1)$/i) ? true : false
         end
         @options = DEFAULT_OPTIONS.merge(options)
+        if @options[:ConfigFile] != nil
+          puts "loading from config_file:#{options[:ConfigFile]}"
+          config = ::Rhebok::Config.new
+          config.instance_eval(::File.read @options.delete(:ConfigFile))
+          @options.merge!(config.retrieve)
+        end
         @server = nil
         @_is_tcp = false
         @_using_defer_accept = false
@@ -127,12 +136,20 @@ module Rack
         if @options[:ErrRespawnInterval]
           pm_args["err_respawn_interval"] = @options[:ErrRespawnInterval].to_i
         end
+        if @options[:BeforeFork]
+          pm_args["before_fork"] = proc { |pe2|
+            @options[:BeforeFork].call
+          }
+        end
         Signal.trap('INT','SYSTEM_DEFAULT') # XXX
 
         pe = PreforkEngine.new(pm_args)
         while !pe.signal_received.match(/^(TERM|USR1)$/)
           pe.start do
             srand
+            if @options[:AfterFork]
+              @options[:AfterFork].call
+            end
             self.accept_loop(app)
           end
         end

data/lib/rhebok/config.rb

@@ -0,0 +1,71 @@
+class Rhebok
+  class Config
+    def initialize(options={})
+      @config = options
+    end
+
+    def host(val)
+      @config[:Host] = val
+    end
+
+    def port(val)
+      @config[:Port] = val
+    end
+
+    def path(val)
+      @config[:Path] = val
+    end
+
+    def max_workers(val)
+      @config[:MaxWorkers] = val
+    end
+
+    def timeout(val)
+      @config[:Timeout] = val
+    end
+
+    def max_request_per_child(val)
+      @config[:MaxRequestPerChild] = val
+    end
+
+    def min_request_per_child(val)
+      @config[:MinRequestPerChild] = val
+    end
+
+    def spawn_interval(val)
+      @config[:SpawnInterval] = val
+    end
+
+    def err_respawn_interval(val)
+      @config[:ErrRespawnInterval] = val
+    end
+
+    def oobgc(val)
+      @config[:OobGC] = val
+    end
+
+    def max_gc_per_request(val)
+      @config[:MaxGCPerRequest] = val
+    end
+
+    def min_gc_per_request(val)
+      @config[:MinGCPerRequest] = val
+    end
+
+    def backlog(val)
+      @config[:BackLog] = val
+    end
+
+    def before_fork(&block)
+      @config[:BeforeFork] = block
+    end
+
+    def after_fork(&block)
+      @config[:AfterFork] = block
+    end
+
+    def retrieve
+      @config
+    end
+  end
+end

data/lib/rhebok/version.rb

@@ -1,3 +1,3 @@
 class Rhebok
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/test/spec_04_hook.rb

@@ -0,0 +1,39 @@
+require 'rack'
+require File.expand_path('../testrequest', __FILE__)
+require 'timeout'
+require 'rack/handler/rhebok'
+
+describe Rhebok do
+  extend TestRequest::Helpers
+  begin
+
+    @host = '127.0.0.1'
+    @port = 9202
+    @app = Rack::Lint.new(TestRequest.new)
+    @pid = fork
+    if @pid == nil
+      #child
+      Rack::Handler::Rhebok.run(@app, :Host=>'127.0.0.1', :Port=>9202, :MaxWorkers=>1,
+                                :BeforeFork => proc { ENV["TEST_FOO"] = "FOO" },
+                                :AfterFork => proc { ENV["TEST_BAR"] = "BAR" },
+                                )
+      exit!(true)
+    end
+    sleep 1
+
+    # test
+    should "hook env" do
+      GET("/")
+      response["TEST_FOO"].should.equal "FOO"
+      response["TEST_BAR"].should.equal "BAR"
+    end
+
+  ensure
+    sleep 1
+    if @pid != nil
+      Process.kill(:TERM, @pid)
+      Process.wait()
+    end
+  end
+
+end

data/test/spec_05_config.rb

@@ -0,0 +1,36 @@
+require 'rack'
+require File.expand_path('../testrequest', __FILE__)
+require 'timeout'
+require 'rack/handler/rhebok'
+
+describe Rhebok do
+  extend TestRequest::Helpers
+  begin
+
+    @host = '127.0.0.1'
+    @port = 9202
+    @app = Rack::Lint.new(TestRequest.new)
+    @pid = fork
+    if @pid == nil
+      #child
+      Rack::Handler::Rhebok.run(@app, :BeforeFork=>proc { ENV["TEST_FOO"]="BAZ" }, :ConfigFile=>File.expand_path('../testconfig.rb', __FILE__))
+      exit!(true)
+    end
+    sleep 1
+
+    # test
+    should "hook env" do
+      GET("/")
+      response["TEST_FOO"].should.equal "FOO"
+      response["TEST_BAR"].should.equal "BAR"
+    end
+
+  ensure
+    sleep 1
+    if @pid != nil
+      Process.kill(:TERM, @pid)
+      Process.wait()
+    end
+  end
+
+end

data/test/testconfig.rb

@@ -0,0 +1,9 @@
+host '127.0.0.1'
+port 9202
+max_workers 1
+before_fork {
+  ENV["TEST_FOO"] = "FOO"
+}
+after_fork {
+  ENV["TEST_BAR"] = "BAR"
+}

data/test/testrequest.rb

@@ -19,6 +19,8 @@ class TestRequest
     minienv = env.dup
     # This may in the future want to replace with a dummy value instead.
     minienv.delete_if { |k,v| NOSERIALIZE.any? { |c| v.kind_of?(c) } }
+    ENV.has_key?("TEST_FOO") and minienv["TEST_FOO"] = ENV["TEST_FOO"]
+    ENV.has_key?("TEST_BAR") and minienv["TEST_BAR"] = ENV["TEST_BAR"]
     body = minienv.to_yaml
     size = body.respond_to?(:bytesize) ? body.bytesize : body.size
     res_header = {"Content-Type" => "text/yaml", "Content-Length" => size.to_s, "X-Foo" => "Foo\nBar", "X-Bar"=>"Foo\n\nBar", "X-Baz"=>"\nBaz", "X-Fuga"=>"Fuga\n"}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rhebok
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Masahiro Nagano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2014-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,11 +109,15 @@ files:
 - ext/rhebok/rhebok.c
 - lib/rack/handler/rhebok.rb
 - lib/rhebok.rb
+- lib/rhebok/config.rb
 - lib/rhebok/version.rb
 - rhebok.gemspec
 - test/spec_01_basic.rb
 - test/spec_02_server.rb
 - test/spec_03_unix.rb
+- test/spec_04_hook.rb
+- test/spec_05_config.rb
+- test/testconfig.rb
 - test/testrequest.rb
 homepage: https://github.com/kazeburo/rhebok
 licenses:
@@ -143,4 +147,7 @@ test_files:
 - test/spec_01_basic.rb
 - test/spec_02_server.rb
 - test/spec_03_unix.rb
+- test/spec_04_hook.rb
+- test/spec_05_config.rb
+- test/testconfig.rb
 - test/testrequest.rb