fluent-rubyprof 0.0.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a39b11208c6b56b2e344c89bbf955dfc645c4c94
-  data.tar.gz: 8ff204c9322cd2bf16d4ce9308e5e2538f7e881b
+SHA256:
+  metadata.gz: 3e9007c7738a7ea50f10d65f25839bcea13a2f1444d2e238d0c0404d40239dd6
+  data.tar.gz: d708dd7e5d27e9938cdbb998e146fa5a8a7a731f06afe998c769e3da43567804
 SHA512:
-  metadata.gz: 81de9e6eb2a8fb23023654c86b4e87b95f9b96595113fc5c556f68f84a7840baf1f97b229b3c447d6e394dd241158036c967865fc4124ff4246e4f9558c39198
-  data.tar.gz: ecde003870cd35f7fa592c7f2795619538137a298b6c766a79e357cf28d19149b7c5e19214f70a731bf12132a4d2a2bbbc2b75c76b7327bd4aa8146a03cdcb90
+  metadata.gz: 3261542f9662711b20ce5ddd0744be04295c3167ca6737669cf4cfc87037cb212e3a25e88d8aea72aaf64eb8e73e8690a575cdc7d60ad66f5326e9aa20024025
+  data.tar.gz: 96ecae12b9e548bd4793cd27cf577b5f96fa569aec48a15461bb83d9447aed88603b46a1c213389e8a00e93789420b399d98d685d4987622319be2eb5b598d59

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.2.0 (2018/11/21)
+
+Enhancements:
+
+* Add `--printer` option (thanks to Fujimoto Seiji)
+
+# 0.1.0 (2014/08/01)
+
+Enhancements:
+
+* Support ruby-prof measure_mode
+
 # 0.0.2 (2014/08/01)
 
 Changes:

data/README.md

@@ -1,12 +1,6 @@
 # Fluent::Rubyprof
 
-Using fluent-rubyprof, you can start and stop ruby-prof dynamically from outside of fluentd without any configuration changes.
-
-## Installation
-
-```
-$ fluent-gem install fluent-rubyprof
-```
+Using fluent-rubyprof, you can start and stop [ruby-prof](https://github.com/ruby-prof/ruby-prof) dynamically from outside of fluentd without any configuration changes.
 
 ## Prerequisite
 
@@ -15,6 +9,7 @@ $ fluent-gem install fluent-rubyprof
 ```
 <source>
   type debug_agent
+  port 24230
 </source>
 ```
 
@@ -24,18 +19,24 @@ And, `ruby-prof` gem is required.
 $ fluent-gem install ruby-prof
 ```
 
+## Installation
+
+```
+$ fluent-gem install fluent-rubyprof
+```
+
 ## Usage
 
 Start
 
 ```
-$ fluent-rubyprof start
+$ fluent-rubyprof start -h localhost -p 24230
 ```
 
 Stop and write a profiling result.
 
 ```
-$ fluent-rubyprof stop -o /tmp/fluent-rubyprof.txt
+$ fluent-rubyprof stop -h localhost -p 24230 -o /tmp/fluent-rubyprof.txt
 ```
 
 ## Options
@@ -43,9 +44,15 @@ $ fluent-rubyprof stop -o /tmp/fluent-rubyprof.txt
 |parameter|description|default|
 |---|---|---|
 |-h, --host HOST|fluent host|127.0.0.1|
-|-p, --port PORT|debug_agent|24230|
+|-p, --port PORT|debug_agent port|24230|
 |-u, --unix PATH|use unix socket instead of tcp||
 |-o, --output PATH|output file|/tmp/fluent-rubyprof.txt|
+|-m, --measure_mode MEASURE_MODE|ruby-prof measure mode. See [ruby-prof#measurements](https://github.com/ruby-prof/ruby-prof#measurements)|PROCESS_TIME|
+|-P, --printer PRINTER|ruby-prof print format. See [ruby-prof#printers](https://github.com/ruby-prof/ruby-prof#printers)|flat|
+
+## Further Reading
+
+* [Fluentd の debug_agent 経由で ruby-prof を起動する](http://qiita.com/sonots/items/749280547176d82f3e2c) (Japanese)
 
 ## ChangeLog
 

data/bin/fluent-rubyprof

@@ -4,3 +4,4 @@ require 'rubygems' unless defined?(gem)
 here = File.dirname(__FILE__)
 $LOAD_PATH << File.expand_path(File.join(here, '..', 'lib'))
 require 'fluent/rubyprof'
+Fluent::Rubyprof.new.run

data/fluent-rubyprof.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-rubyprof"
-  spec.version       = "0.0.2"
+  spec.version       = "0.2.0"
   spec.authors       = ["Naotoshi Seo"]
   spec.email         = ["sonots@gmail.com"]
   spec.summary       = %q{Tools for start/stop ruby-prof dynamically from outside of fluentd}

data/lib/fluent/rubyprof.rb

@@ -1,89 +1,121 @@
 require 'optparse'
 require 'drb/drb'
 
-def parse_options
-  op = OptionParser.new
-  op.banner += ' <start/stop> [output_file]'
-
-  (class<<self;self;end).module_eval do
-    define_method(:usage) do |msg|
-      puts op.to_s
-      puts "error: #{msg}" if msg
-      exit 1
-    end
-  end
+module Fluent
+  class Rubyprof
+
+    PRINTERS = {
+      'flat' => 'FlatPrinter',
+      'flat_with_line_numbers' => 'FlatPrinterWithLineNumbers',
+      'graph' => 'GraphPrinter',
+      'graph_html' => 'GraphHtmlPrinter',
+      'call_tree' => 'CallTreePrinter',
+      'call_stack' => 'CallStackPrinter',
+      'dot' => 'DotPrinter',
+      'multi' => 'MultiPrinter',
+    }
+
+    def parse_options(argv = ARGV)
+      op = OptionParser.new
+      op.banner += ' <start/stop> [output_file]'
+
+      (class<<self;self;end).module_eval do
+        define_method(:usage) do |msg|
+          puts op.to_s
+          puts "error: #{msg}" if msg
+          exit 1
+        end
+      end
+
+      opts = {
+        host: '127.0.0.1',
+        port: 24230,
+        unix: nil,
+        command: nil, # start or stop
+        output: '/tmp/fluent-rubyprof.txt',
+        measure_mode: 'PROCESS_TIME',
+        printer: 'flat',
+      }
 
-  opts = {
-    host: '127.0.0.1',
-    port: 24230,
-    unix: nil,
-    command: nil, # start or stop
-    output: '/tmp/fluent-rubyprof.txt'
-  }
-
-  op.on('-h', '--host HOST', "fluent host (default: #{opts[:host]})") {|v|
-    opts[:host] = v
-  }
-
-  op.on('-p', '--port PORT', "debug_agent tcp port (default: #{opts[:host]})", Integer) {|v|
-    opts[:port] = v
-  }
-
-  op.on('-u', '--unix PATH', "use unix socket instead of tcp") {|v|
-    opts[:unix] = v
-  }
-
-  op.on('-o', '--output PATH', "output path (default: #{opts[:output]})") {|v|
-    opts[:output] = v
-  }
-
-  begin
-    op.parse!(ARGV)
-    opts[:command] = ARGV.shift
-    unless %w[start stop].include?(opts[:command])
-      usage "`start` or `stop` must be specified as the 1st argument"
-    end
-  rescue
-    usage $!.to_s
-  end
+      op.on('-h', '--host HOST', "fluent host (default: #{opts[:host]})") {|v|
+        opts[:host] = v
+      }
 
-  opts
-end
+      op.on('-p', '--port PORT', "debug_agent tcp port (default: #{opts[:host]})", Integer) {|v|
+        opts[:port] = v
+      }
 
-def main
-  opts = parse_options
+      op.on('-u', '--unix PATH', "use unix socket instead of tcp") {|v|
+        opts[:unix] = v
+      }
 
-  unless opts[:unix].nil?
-    uri = "drbunix:#{opts[:unix]}"
-  else
-    uri = "druby://#{opts[:host]}:#{opts[:port]}"
-  end
+      op.on('-o', '--output PATH', "output path (default: #{opts[:output]})") {|v|
+        opts[:output] = v
+      }
 
-  $remote_engine = DRb::DRbObject.new_with_uri(uri)
-
-  case opts[:command]
-  when 'start'
-    remote_code = <<-CODE
-      require 'ruby-prof'
-      RubyProf.start
-    CODE
-  when 'stop'
-    remote_code = <<-"CODE"
-      result = RubyProf.stop
-      File.open('#{opts[:output]}', 'w') {|f|
-        RubyProf::FlatPrinter.new(result).print(f)
+      op.on('-m', '--measure_mode MEASURE_MODE', "ruby-prof measure mode (default: #{opts[:measure_mode]})") {|v|
+        opts[:measure_mode] = v
       }
-    CODE
-  end
 
-  $remote_engine.method_missing(:instance_eval, remote_code)
+      op.on('-P', '--printer PRINTER', PRINTERS.keys,
+                "ruby-prof print format (default: #{opts[:printer]})",
+                "currently one of: #{PRINTERS.keys.join(', ')}") {|v|
+        opts[:printer] = v
+      }
+      op.parse!(argv)
+
+      opts[:command] = argv.shift
+      unless %w[start stop].include?(opts[:command])
+        raise OptionParser::InvalidOption.new("`start` or `stop` must be specified as the 1st argument")
+      end
+
+      measure_modes = %w[PROCESS_TIME WALL_TIME CPU_TIME ALLOCATIONS MEMORY GC_RUNS GC_TIME] 
+      unless measure_modes.include?(opts[:measure_mode])
+        raise OptionParser::InvalidOption.new("-m allows one of #{measure_modes.join(', ')}")
+      end
 
-  case opts[:command]
-  when 'start'
-    $stdout.puts 'fluent-rubyprof: started'
-  when 'stop'
-    $stdout.puts "fluent-rubyprof: outputs to #{opts[:output]}"
+      opts
+    end
+
+    def run
+      begin
+        opts = parse_options
+      rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
+        usage e.message
+      end
+
+      unless opts[:unix].nil?
+        uri = "drbunix:#{opts[:unix]}"
+      else
+        uri = "druby://#{opts[:host]}:#{opts[:port]}"
+      end
+
+      $remote_engine = DRb::DRbObject.new_with_uri(uri)
+
+      case opts[:command]
+      when 'start'
+        remote_code = <<-CODE
+        require 'ruby-prof'
+        RubyProf.measure_mode = eval("RubyProf::#{opts[:measure_mode]}")
+        RubyProf.start
+        CODE
+      when 'stop'
+        remote_code = <<-"CODE"
+        result = RubyProf.stop
+        File.open('#{opts[:output]}', 'w') {|f|
+          RubyProf::#{PRINTERS[opts[:printer]]}.new(result).print(f)
+        }
+        CODE
+      end
+
+      $remote_engine.method_missing(:instance_eval, remote_code)
+
+      case opts[:command]
+      when 'start'
+        $stdout.puts 'fluent-rubyprof: started'
+      when 'stop'
+        $stdout.puts "fluent-rubyprof: outputs to #{opts[:output]}"
+      end
+    end
   end
 end
-
-main

data/spec/fluent-rubyprof/rubyprof_spec.rb

@@ -1,28 +1,53 @@
 require 'json'
 require 'spec_helper'
+require 'fluent/rubyprof'
 
-describe 'Fluent::Rubyprof' do
+describe Fluent::Rubyprof do
   CONFIG_PATH = File.join(File.dirname(__FILE__), 'fluent.conf')
   BIN_DIR = File.join(ROOT, 'bin')
   OUTPUT_FILE = File.join(File.dirname(__FILE__), 'test.txt')
 
-  before :all do
-    @fluentd_pid = spawn('fluentd', '-c', CONFIG_PATH, out: '/dev/null')
-    sleep 2
+  context '#parse_options' do
+    it 'incorrect subcommand' do
+      expect { Fluent::Rubyprof.new.parse_options(['foo']) }.to raise_error(OptionParser::InvalidOption)
+    end
 
-    system("#{File.join(BIN_DIR, 'fluent-rubyprof')} start")
-    sleep 2
+    it 'correct measure_mode' do
+      expect { Fluent::Rubyprof.new.parse_options(['start', '-m', 'CPU_TIME']) }.not_to raise_error
+    end
 
-    system("#{File.join(BIN_DIR, 'fluent-rubyprof')} stop -o #{OUTPUT_FILE}")
-    sleep 1
-  end
+    it 'incorrect measure_mode' do
+      expect { Fluent::Rubyprof.new.parse_options(['start', '-m', 'foo']) }.to raise_error(OptionParser::InvalidOption)
+    end
+
+    it 'correct printer' do
+      expect { Fluent::Rubyprof.new.parse_options(['start', '-P', 'graph']) }.not_to raise_error
+    end
 
-  after :all do
-    Process.kill(:TERM, @fluentd_pid)
-    Process.waitall
+    it 'incorrect printer' do
+      expect { Fluent::Rubyprof.new.parse_options(['start', '-P', 'bar']) }.to raise_error(OptionParser::InvalidArgument)
+    end
   end
 
-  it 'outputs profiling result' do
-    expect(File.size?(OUTPUT_FILE)).to be_truthy
+  context 'profiling' do
+    before :all do
+      @fluentd_pid = spawn('fluentd', '-c', CONFIG_PATH, out: '/dev/null')
+      sleep 2
+
+      system("#{File.join(BIN_DIR, 'fluent-rubyprof')} start")
+      sleep 2
+
+      system("#{File.join(BIN_DIR, 'fluent-rubyprof')} stop -o #{OUTPUT_FILE}")
+      sleep 1
+    end
+
+    after :all do
+      Process.kill(:TERM, @fluentd_pid)
+      Process.waitall
+    end
+
+    it 'should output' do
+      expect(File.size?(OUTPUT_FILE)).to be_truthy
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-rubyprof
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Tools for start/stop ruby-prof dynamically from outside of fluentd