sigdump 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/*

data/ChangeLog

@@ -0,0 +1,5 @@
+
+2013-04-23 version 0.1.0:
+
+* First release
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Sadayuki Furuhashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,22 @@
+# sigdump
+
+Server applications (like Rails app) cause performance problems, deadlock or memory swapping from time to time. But it's painful to reproduce such kind of problems. If we can get information from a running process without restarting it, and it's really helpful.
+
+`sigdump` gem installs a signal handler which dumps backtrace of running threads and number of allocated objects per class.
+
+# Install
+
+Just install one gem `sigdump` and require `sigdump/setup`:
+
+    gem 'sigdump', :require => 'sigdump/setup'
+
+# Usage
+
+Send `SIGCONT` signal to dump backtrace and heap status to `/tmp/sigdump-<pid>.log`:
+
+    $ kill -CONT <pid>
+
+Set `SIGDUMP_SIGNAL` environment variable to change the signal (default: SIGCONT).
+
+Set `SIGDUMP_PATH` environment variable to change the output path (default: /tmp/sigdump-\<pid\>.log). You can set "-" here to dump to STDOUT, "+" to dump to STDERR.
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+task :default => [:build]

data/lib/sigdump.rb

@@ -0,0 +1,102 @@
+module Sigdump
+  VERSION = "0.1.0"
+
+  def self.install_thread_dump_handler(signal, path=nil)
+    Kernel.trap(signal) do
+      begin
+        _open_dump_path(path) do |io|
+          io.write "Sigdump at #{Time.now} process #{Process.pid} (#{$0})\n"
+          dump_all_thread_backtrace(io)
+          dump_object_count(io)
+        end
+      rescue
+      end
+    end
+  end
+
+  def self.dump_all_thread_backtrace(io)
+    Thread.list.each do |thread|
+      dump_backtrace(thread, io)
+    end
+    nil
+  end
+
+  def self.dump_backtrace(thread, io)
+    status = thread.status
+    if status == nil
+      status = "finished"
+    elsif status == false
+      status = "error"
+    end
+
+    backtrace = thread.backtrace
+
+    io.write "  Thread #{thread} status=#{status} priority=#{thread.priority}\n"
+    backtrace.each {|bt|
+      io.write "      #{bt}\n"
+    }
+
+    io.flush
+    nil
+  end
+
+  def self.dump_object_count(io)
+    io.write "  Built-in objects:\n"
+    ObjectSpace.count_objects.sort_by {|k,v| -v }.each {|k,v|
+      io.write "%10s: %s\n" % [_fn(v), k]
+    }
+
+    string_size = 0
+    array_size = 0
+    hash_size = 0
+    cmap = {}
+    ObjectSpace.each_object {|o|
+      c = o.class
+      cmap[c] = (cmap[c] || 0) + 1
+      if c == String
+        string_size += o.bytesize
+      elsif c == Array
+        array_size = o.size
+      elsif c == Hash
+        hash_size = o.size
+      end
+    }
+
+    io.write "  All objects:\n"
+    cmap.sort_by {|k,v| -v }.each {|k,v|
+      io.write "%10s: %s\n" % [_fn(v), k]
+    }
+
+    io.write "  String #{_fn(string_size)} bytes\n"
+    io.write "   Array #{_fn(array_size)} elements\n"
+    io.write "    Hash #{_fn(hash_size)} pairs\n"
+
+    io.flush
+    nil
+  end
+
+  def self._fn(num)
+    s = num.to_s
+    if formatted = s.gsub!(/(\d)(?=(?:\d{3})+(?!\d))/, "\\1,")
+      formatted
+    else
+      s
+    end
+  end
+
+  def self._open_dump_path(path, &block)
+    case path
+    when nil, ""
+      path = "/tmp/sigdump-#{Process.pid}.log"
+      File.open(path, "a", &block)
+    when IO
+      yield path
+    when "-"
+      yield STDIN
+    when "+"
+      yield STDERR
+    else
+      File.open(path, "a", &block)
+    end
+  end
+end

data/lib/sigdump/setup.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../../sigdump', __FILE__)
+
+signal = ENV['SIGDUMP_SIGNAL'] || 'SIGCONT'
+path = ENV['SIGDUMP_PATH'] || ''
+
+Sigdump.install_thread_dump_handler(signal, path)
+

data/sigdump.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'sigdump'
+
+Gem::Specification.new do |gem|
+  gem.name        = "sigdump"
+  gem.description = "Setup signal handler which dumps backtrace of running threads and number of allocated objects per class. Require 'sigdump/setup', send SIGCONT, and see /tmp/sigdump-<pid>.log."
+  gem.homepage    = "https://github.com/frsyuki/sigdump"
+  gem.summary     = gem.description
+  gem.version     = Sigdump::VERSION
+  gem.authors     = ["Sadayuki Furuhashi"]
+  gem.email       = ["frsyuki@gmail.com"]
+  gem.has_rdoc    = false
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency "rake", ">= 0.9.2"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sigdump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sadayuki Furuhashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Setup signal handler which dumps backtrace of running threads and number
+  of allocated objects per class. Require 'sigdump/setup', send SIGCONT, and see /tmp/sigdump-<pid>.log.
+email:
+- frsyuki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- ChangeLog
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sigdump.rb
+- lib/sigdump/setup.rb
+- sigdump.gemspec
+homepage: https://github.com/frsyuki/sigdump
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Setup signal handler which dumps backtrace of running threads and number
+  of allocated objects per class. Require 'sigdump/setup', send SIGCONT, and see /tmp/sigdump-<pid>.log.
+test_files: []
+has_rdoc: false