mongrel_proctitle 1.3

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2008, Ryan Tomayko 
+Copyright (c) 2007, Alexander Staubo
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are 
+permitted provided that the following conditions are met:
+
+  *  Redistributions of source code must retain the above copyright notice, this list of 
+     conditions and the following disclaimer.
+
+  *  Redistributions in binary form must reproduce the above copyright notice, this list 
+     of conditions and the following disclaimer in the documentation and/or other materials 
+     provided with the distribution.
+
+  *  The names of its contributors may be used to endorse or promote products derived from 
+     this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITHOUT ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,93 @@
+Mongrel process title GemPlugin
+===============================
+
+This is a simple plugin for Mongrel which changes the process title to reflect
+what it's currently doing. You can then determine a given Mongrel server's 
+status using "ps". 
+
+For example:
+
+  mongrel_rails [10010/2/358]: handling 127.0.0.1: HEAD /feed/cal/global/91/6de4, GET /feed/index
+                 |     | |     |        |          |
+                 |     | |     |        |          The current req (method / path)
+                 |     | |     |        |
+                 |     | |     |        The client IP
+                 |     | |     |
+                 |     | |     What it's doing
+                 |     | |     
+                 |     | Requests processed during server lifetime
+                 |     |
+                 |     Requests currently queued/being processed concurrently
+                 |
+                 The port that Mongrel is serving
+
+This is almost entirely based on Alexander Staubo's Rails plugin with the same 
+name:
+
+http://purefiction.net/mongrel_proctitle/
+
+The main difference is that the GemPlugin will automatically be loaded by all
+mongrels without additional code changes or configuration.
+
+Monitoring Mongrels
+-------------------
+
+Once the program is installed, you should be able to see the formatted process
+title by running:
+
+    $ ps -axwwo pid,command | grep mongrel_rails
+
+See ps(1) for more options. You may want to include %cpu, rsz, %mem, or other
+fields in output.
+
+There's also a `mongrel_top` executable included in the gem that works like
+top(1) but displays only mongrel processes:
+
+    $ mongrel_top
+
+By default, `mongrel_top` updates the display every 0.25 seconds and shows the
+pid and process title. You can select a different interval and fields with the
+-s and -o arguments, respectively: 
+
+    $ mongrel_top -s 0.1 -o pid,%cpu,rsz,command
+
+The "command" field must be included.
+
+Installation
+------------
+
+This version of the plugin is packaged specifically as a Mongrel GemPlugin. Install 
+using:
+
+   gem install mongrel_proctitle --source=http://tomayko.com
+
+Once installed, all new mongrels will automatically load the plugin during startup. If
+you would prefer to control which mongrels load the plugin, do not install this gem.
+Use the directions below instead.
+
+Installing into a specific Rails app only
+-----------------------------------------
+
+See Alexander Staubo's original project:
+
+http://purefiction.net/mongrel_proctitle/
+
+Showing your application-specific revision/release in the title
+-------------------------------------------------------------------
+
+In your application's start-up process, re-open Mongrel::Proctitler
+and define a get_app_revision method. In a Rails app, a good place
+to do this is in RAILS_ROOT/config/environments/production.rb. An
+example get_app_revision method might look like:
+
+  def get_app_revision
+    `cat ./REVISION`.chomp
+  end
+
+License
+-------
+
+I've included the LICENSE file from the original mongrel_proctitle distribution. It is
+the "New and Simplified BSD License". More information on this license can be found at:
+
+http://www.opensource.org/licenses/bsd-license.php

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+include FileUtils
+
+CLEAN.include [ "pkg", "lib/*.bundle", "*.gem", ".config", "**/*.log" ]
+
+desc "Build package"
+task :default => [:package]
+
+# Load gemspec like github to surface SAFE issues early
+require 'rubygems/specification'
+data = File.read('mongrel_proctitle.gemspec')
+spec = nil
+Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_zip = true
+  p.need_tar_gz = true
+end
+
+task :install => [:package] do
+  sh %{gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [:clean] do
+  sh %{gem uninstall #{name}}
+end
+
+desc 'Publish gem and tarball to rubyforge'
+task :release => [:package] do
+  pkg = "pkg/#{spec.name}-#{spec.version}"
+  sh <<-end
+    rubyforge add_release wink #{spec.name} #{spec.version} #{pkg}.gem &&
+    rubyforge add_file    wink #{spec.name} #{spec.version} #{pkg}.tar.gz
+  end
+end

data/bin/mongrel_top

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+$last_update = nil
+$clear_char = `tput clear`
+
+def usage
+  puts "usage: #{File.basename($0)} [-s delay] [-o fields]"
+end
+
+def die(*message)
+  STDERR.puts "fatal: #{format(*message)}" if message.any?
+  exit 1
+end
+
+# clear the terminal
+def clear_screen
+  STDOUT.write($clear_char)
+end
+
+# clear the terminal and then write output.
+def update_screen(output)
+  if output != $last_update
+    clear_screen
+    puts(output)
+  end
+end
+
+def terminal_columns
+  @terminal_columns ||=
+    if (cols = `tput cols`) == ""
+      80
+    else
+      cols.to_i
+    end
+end
+
+trap("INT") {
+  STDERR.puts "\nbailing ..."
+  exit 0
+}
+
+# time to wait between updates
+interval = 0.25
+
+# the fields to show in our display (see ps -o)
+fields = "pid,command"
+
+# parse arguments.
+# TODO: use getoptlong
+argv = ARGV.map { |a| a.split('=', 2) }.flatten
+while argv.any?
+  arg = argv.shift
+  case arg
+  when /^-(s|-delay)$/
+    interval = argv.shift.to_f
+  when /^-(o|-fields)$/
+    fields = argv.shift
+  when /^-(h|-help)$/
+    usage and exit(0)
+  else
+    usage and die
+  end
+end
+
+# Builds the process output display.
+def process_display(fields, interval)
+  now = Time.now.strftime('%a %b %d %H:%M:%S %Y')
+  cols = terminal_columns
+  processes =
+    `ps axww -o #{fields}`.grep(/mongrel_rails/).map do |line|
+      line.strip!
+      line.sub! /\s+SHELL=.*$/, ''                  # weird MacOS X issue
+      line.sub! /(?:ruby\d*: )?mongrel_rails /, ''  # remove $0 prefix
+      line.sub! /\(ruby\d*\)/, ''                   # remove (ruby) suffix
+      line[0,cols].chomp
+    end
+  output = [
+    (' ' * (cols - now.length)) + now + "\r" +
+    "Mongrel Top (delay: #{interval})",
+    "",
+    processes,
+    "",
+    "#{processes.length} process(es)"
+  ]
+  output.flatten.join("\n")
+end
+
+while true
+  output = process_display(fields, interval)
+  update_screen(output)
+  sleep(interval)
+end

data/lib/mongrel_proctitle.rb

@@ -0,0 +1,148 @@
+require 'mongrel'
+
+module Mongrel
+
+  # Mongrel process title modification.
+  class Proctitler
+
+    # Initializes titler.
+    def initialize(port, prefix)
+      @prefix = prefix
+      @port = port
+      @mutex = Mutex.new
+      @titles = []
+      @request_threads = []
+      @queue_length = 0
+      @request_count = 0
+    end
+
+    # Returns port used in title.
+    def port
+      @port
+    end
+
+    # Return port used in title.
+    def port=(new_port)
+      @port = new_port
+    end
+
+    # Returns revision used in title.
+    def revision
+      @revision ||= get_app_revision if self.respond_to?(:get_app_revision)
+    end
+
+    def request(&block)
+      titles, mutex = @titles, @mutex
+      mutex.synchronize do
+        @queue_length += 1
+        titles.push(self.title)
+      end
+      begin
+        yield
+      ensure
+        mutex.synchronize do
+          @queue_length -= 1
+          @request_count += 1
+          @request_threads.delete(Thread.current)
+          set_request_list_title
+        end
+      end
+    end
+
+    def set_request_list_title(excluding = nil)
+      if @request_threads.empty?
+        set_idle
+      else
+        if defined?(Rails)
+          # find the first awake/critical thread and put it in the front
+          running_thread = @request_threads.detect {|thread| thread.status == "run" && excluding != thread }
+          @request_threads.unshift(@request_threads.delete(running_thread)) if running_thread
+          # this isn't exact, but it works for most situations
+        end
+        self.title = "handling #{@request_threads.collect {|t| t[:request_str]}.join(', ')}"
+      end
+    end
+
+    # Reports process as being idle.
+    def set_idle
+      self.title = "idle"
+    end
+
+    # Reports process as handling a socket.
+    def set_processing(socket)
+      self.title = "handling #{socket.peeraddr.last}"
+    end
+
+    # Reports process as handling a socket.
+    def set_handling(request)
+      params = request.params
+      address = params['REMOTE_ADDR']
+      method = params['REQUEST_METHOD']
+      path = params['REQUEST_PATH']
+      path = "#{path[0, 60]}..." if path.length > 60
+      Thread.current[:request_str] = "#{address}: #{method} #{path}"
+      @request_threads.push(Thread.current)
+      set_request_list_title(Thread.current)
+    end
+
+    # Returns current title
+    def title
+      @title
+    end
+
+    # Sets process title.
+    def title=(title)
+      @title = title
+      update_process_title
+    end
+
+    # Updates the process title.
+    def update_process_title
+      title = "#{@prefix} ["
+      title << (@port ? "#{@port}" : "?")
+      title << (revision ? "/r#{revision}" : "")
+      title << "/#{@queue_length}"
+      title << "/#{@request_count}"
+      title << "]: #{@title}"
+      $0 = title
+    end
+
+  end
+
+  # Handler which sets process title before request.
+  class ProctitleHandler < HttpHandler
+    def initialize(titler)
+      @titler = titler
+    end
+
+    def process(request, response)
+      @titler.set_handling(request)
+    end
+  end
+
+  class HttpServer
+
+    def run_with_proctitle(*args)
+      @titler = Proctitler.new(self.port, File.basename($0))
+      @titler.set_idle
+      run_without_proctitle
+    end
+    alias_method :run_without_proctitle, :run
+    alias_method :run, :run_with_proctitle
+
+    def process_client_with_proctitle(client)
+      unless @handler
+        @handler = ProctitleHandler.new(@titler)
+        register("/", @handler, true)
+      end
+      @titler.request do
+        @titler.set_processing(client)
+        return process_client_without_proctitle(client)
+      end
+    end
+    alias_method :process_client_without_proctitle, :process_client
+    alias_method :process_client, :process_client_with_proctitle
+
+  end
+
+end

data/mongrel_proctitle.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name = 'mongrel_proctitle'
+  s.version = '1.3'
+  s.date = '2009-02-23'
+
+  s.platform = Gem::Platform::RUBY
+  s.summary = "The mongrel_proctitle GemPlugin"
+  s.description = s.summary
+
+  s.authors = ["Alexander Staubo", "Ryan Tomayko", "Arya Asemanfar"]
+  s.email = "r@tomayko.com"
+  s.homepage = "http://github.com/rtomayko/mongrel_proctitle"
+
+  s.add_dependency 'mongrel',    '>= 1.1'
+  s.add_dependency 'gem_plugin', '>= 0.2.3'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README"]
+
+  s.files = %w[
+    LICENSE
+    README
+    Rakefile
+    mongrel_proctitle.gemspec
+    lib/mongrel_proctitle.rb
+    bin/mongrel_top
+  ]
+
+  s.bindir = 'bin'
+  s.executables = %w[mongrel_top]
+  s.require_path = 'lib'
+
+  s.rubyforge_project = "wink"
+  s.rubygems_version = '1.1.1'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: mongrel_proctitle
+version: !ruby/object:Gem::Version 
+  version: "1.3"
+platform: ruby
+authors: 
+- Alexander Staubo
+- Ryan Tomayko
+- Arya Asemanfar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gem_plugin
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: 
+description: The mongrel_proctitle GemPlugin
+email: r@tomayko.com
+executables: 
+- mongrel_top
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- LICENSE
+- README
+- Rakefile
+- mongrel_proctitle.gemspec
+- lib/mongrel_proctitle.rb
+- bin/mongrel_top
+has_rdoc: true
+homepage: http://github.com/rtomayko/mongrel_proctitle
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: wink
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: The mongrel_proctitle GemPlugin
+test_files: []
+