stalin 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3aba1948f1211ea981734cb7eb62d1326536b0b
-  data.tar.gz: 694df9a4c8732561d328a26ce17f64fa12eec669
+  metadata.gz: 76e53770ae0769f7bd129d9e29d33b614dd01376
+  data.tar.gz: 963fad2ce29f887865a71872c9cd41e64e629fd7
 SHA512:
-  metadata.gz: 6b922bd545a388a1457220caa2fe3d308d82401b59a25e01b667db3810263a8019fb304a80c3031cb66a298928e57b33aa07c2d147ce64cfc77d5cb668d9085b
-  data.tar.gz: fc6067a0ada40c95060d978c6615b9d0054ea2abc37a0062a54b91be2367f3ac6bae06c073166b1c2715f59e8e0200ab23b03d30836bb35170b04e3461791b0a
+  metadata.gz: 816bfc278b02ecea85221413c145d35a9feaab69a2ab78739aba8d892119b7d5b81cd42a15d350f2860d72649509e2f36b520f2d69b1926c68d1e6fc34e78b7b
+  data.tar.gz: 8aca03b3fe8cda1dcf950314e6f28aa7fa76e928abff60ea0061e72fb628fc1136337a05eb050055c4ecfeb923b0b13d9b13e30e9b45982c08f045171c2baae5

data/README.md

@@ -26,20 +26,22 @@ Servers known NOT to work:
 As you can see, we are far short of our _goal_ to support many servers! More to come as needed;
 let me know what you need!
 
-# Installation
+# User's Guide
+
+## Installation
 
 Just include stalin in your Gemfile.
 
     gem 'stalin'
 
-# Usage
+## Usage
 
 Decide on which application server you will use. Add some lines to your `config.ru` to
 install a suitable Stalin middleware.
 
 Because different app servers have different signal-handling and restart semantics, we
-must specialize Stalin's behavior; this is done with a base class (Stalin::Adapter::Rack)
-plus one derived class per supported application server.
+must specialize Stalin's behavior; this is done with an abstract base class 
+(Stalin::Adapter::Rack) plus one derived class per supported application server.
  
     # Gem that kills app processes when their heap becomes too fragmented.
     require 'stalin'
@@ -50,17 +52,40 @@ plus one derived class per supported application server.
     # Each worker will shutdown at some point between 192MB and 256MB of memory usage.
     use Stalin::Adapter::Unicorn, (192*mb), (256*mb)
 
-If you instantiate Stalin::Adapter::Rack directly, you have two choices:
-  - Pass three parameters (app, graceful-shutdown signal and abrupt-shutdown signal) to decide on signalling behavior yourself
-  - Pass one parameter (app) to let Stalin decide which adapter to use based on which server is resident in memory
-  
-Instantiating the Rack middleware with one parameter is deprecated; we'd much rather you be
-explicit about your application server than rely on our heuristic!
-
-# Tuning
+## Tuning
 
 Consult the documentation for your adapter's `#initialize` to learn how to tune Stalin's behavior.
 
+# Developer's Guide
+
+This gem is a work in progress; the docs are okay, but test coverage is
+nonexistent. Whenever you make changes, please do some smoke tests by yourself.
+
+## Smoke Tests
+
+The `fixtures` subdirectory contains rackup files for both supported application
+servers; you can use these to test the three supported permutations.
+
+When you run puma or rainbows, it will begin listening on a port of its
+choosing; use curl or similar to send it Web requests and cause a large
+memory leak with every request. Each worker process should shutdown after the
+first request, because the leak is large and the hardcoded limit for puma is
+very small.
+
+Verify that stalin is restarting the app servers and that your requests all
+respond with 200 and not 502, 503 or other funny errors.
+
+### Unicorn
+
+    bundle exec unicorn fixtures/unicorn.ru 
+### Single-Process Puma
+
+    bundle exec puma fixtures/puma.ru
+    
+### Multi-Process Puma
+
+    bundle exec puma -w 1 fixtures/puma.ru
+
 # Special Thanks
 
 - [@kzk](http://github.com/kzk/) for the [unicorn-worker-killer] gem which this is derived from

data/Rakefile

@@ -9,6 +9,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Kill Web application workers based on arbitrary conditions.}
   gem.email = "xeger@xeger.net"
   gem.authors = ["Tony Spataro"]
+  gem.required_ruby_version = '~> 2.0'
   gem.files.exclude ".rspec"
   gem.files.exclude "Gemfile*"
   gem.files.exclude "fixtures/**/*"

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/stalin/adapter/rack.rb

@@ -1,43 +1,10 @@
 module Stalin::Adapter
-  # A low-tech but reliable solution that invokes stalin using Rack middleware.
-  # This is suitable for application srvers that use a master-and-workers
-  # process architecture, wohse workers respond to a graceful shutdown signal,
-  # and whose masters spawn new workers as needed.
-  #
-  # This functions as a base class for server-specific middlewares, and can be used if
+  # Abstract base class for server-specific Rack middlewares.
   # there is an app server that uses a signalling strategy not explicitly supported by Stalin.
   class Rack
     # Conversion constant for human-readable memory amounts in log messages.
     MB = Float(1024**2)
 
-    # Construct a new middleware. If all six arguments are passed, construct an instance
-    # of this class; otherwise, use a heuristic to construct an instance of a suitable
-    # derived class.
-    #
-    # @raise [ArgumentError] if an incorrect number of arguments is passed
-    # @raise [RuntimeError] if 0..5 arguments and the heuristic can't figure out which signals to use
-    def self.new(*args)
-      if self == Rack && args.length < 3 
-        # Warn that this shim will go away in v1
-        warn "Stalin::Adapter::Rack.new with fewer than 3 arguments is deprecated; please instantiate a derived class e.g. Unicorn or Puma"
-
-        # Use a heuristic to decide on the correct adapter and instantiate a derived class.
-        if defined?(::Unicorn)
-          middleware = Unicorn.allocate
-        elsif defined?(::Puma)
-          middleware = Puma.allocate
-        else
-          raise RuntimeError, "Cannot determine a suitable Stalin adapter; please instantiate this class with six arguments"
-        end
-
-        # Initialize our new object (ugh)
-        middleware.instance_eval { initialize(*args) }
-        middleware
-      else
-        super 
-      end
-    end
-
     # Create a middleware instance.
     #
     # @param [#call] app inner Rack application
@@ -48,7 +15,7 @@ module Stalin::Adapter
     # @param [Integer] cycle how frequently to check memory consumption (# requests)
     # @param [Boolean] verbose log extra information
     # @param [Array] signals pair of two Symbol signal-names: one for "graceful shutdown please" and one for "terminate immediately"
-    def initialize(app, graceful, abrupt, min=1024**3, max=2*1024**3, cycle=16, verbose=false)
+    def initialize(app, graceful, abrupt, min, max, cycle, verbose)
       @app      = app
       @graceful = graceful
       @abrupt   = abrupt
@@ -56,6 +23,7 @@ module Stalin::Adapter
       @max      = max
       @cycle    = cycle
       @verbose  = verbose
+      @req      = 0
     end
 
     def call(env)
@@ -64,22 +32,26 @@ module Stalin::Adapter
       logger = logger_for(env)
 
       begin
-        @lim     ||= @min + randomize(@max - @min + 1)
-        @req     ||= 0
-        @req     += 1
+        if @req == 0
+          # First-time initialization. Deferred until first request so we can
+          # ensure that init-time log output goes to the right place.
+          @lim     = @min + randomize(@max - @min + 1)
+          @req     = 0
+          @watcher = ::Stalin::Watcher.new(Process.pid)
+          @killer  = ::Stalin::Killer.new(Process.pid, @graceful, @abrupt)
+          logger.info "stalin (pid: %d) startup; limit=%.1f MB, graceful=SIG%s (abrupt=SIG%s after %d tries)" %
+                        [Process.pid, @lim / MB, @graceful, @abrupt, Stalin::Killer::MAX_GRACEFUL]
+        end
+
+        @req += 1
 
         if @req % @cycle == 0
-          @req = 0
-          @watcher ||= ::Stalin::Watcher.new(Process.pid)
-          @killer  ||= ::Stalin::Killer.new(Process.pid, @graceful, @abrupt)
           if (used = @watcher.watch) > @lim
             sig = @killer.kill
-            @watcher.watch
-            logger.info "stalin (pid: %d) send SIG%s; memory usage %.1f MB > %.1f MB" %
+            logger.info "stalin (pid: %d) send SIG%s; %.1f MB > %.1f MB" %
                           [Process.pid, sig, used / MB, @lim / MB]
-            @cycle = 2
           elsif @verbose
-            logger.info "stalin (pid: %d) soldiers on; memory usage %.1f MB < %.1f MB" %
+            logger.info "stalin (pid: %d) soldiers on; %.1f MB < %.1f MB" %
                            [Process.pid, used / MB, @lim / MB]
           end
         end
@@ -94,7 +66,7 @@ module Stalin::Adapter
     private
 
     def randomize(integer)
-      RUBY_VERSION > "1.9" ? Random.rand(integer.abs) : rand(integer)
+      Random.rand(integer.abs)
     end
 
     def logger_for(env)

data/stalin.gemspec

@@ -2,17 +2,20 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: stalin 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "stalin"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Tony Spataro"]
-  s.date = "2015-04-21"
+  s.date = "2015-08-17"
   s.description = "Kill Web application workers based on arbitrary conditions."
   s.email = "xeger@xeger.net"
   s.extra_rdoc_files = [
+    "CHANGELOG.md",
     "LICENSE",
     "README.md"
   ]
@@ -36,8 +39,8 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "https://github.com/xeger/stalin"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.14"
+  s.required_ruby_version = Gem::Requirement.new("~> 2.0")
+  s.rubygems_version = "2.4.5"
   s.summary = "Kill rack"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: stalin
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Spataro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: unicorn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
 description: Kill Web application workers based on arbitrary conditions.
@@ -99,6 +99,7 @@ email: xeger@xeger.net
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 files:
@@ -128,17 +129,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Kill rack