fluent-stackprof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82a160fc8283e42ba170c8fcb9e725c74ec77167
+  data.tar.gz: 9239a270a426601eb6f3c6ebd6ae9317ade37a93
+SHA512:
+  metadata.gz: f5d8c80c23e3f0cd21a346136e8e2ce736ea9215525a1092341808502f6b004c18ec517d8bb213e52952858475a759f4d2db26134ed4a261decccd9104c2bfc4
+  data.tar.gz: 773919b0e9691996c339e11d1e3cf975db69c18807ae3c8d4017c256e1432a9218832bfe098daaff5420c98a704765532d6e617d844af38e60570ba9c422f645

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.txt

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2014/08/03)
+
+First version

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'fluentd'
+gem 'stackprof'
+gem 'pry'
+gem 'pry-nav'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naotoshi Seo
+
+MIT License
+
+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,77 @@
+# Fluent::Stackprof
+
+Using fluent-stackprof, you can start and stop [stackprof](https://github.com/tmm1/stackprof) dynamically from outside of fluentd without any configuration changes.
+
+## Installation
+
+```
+$ fluent-gem install fluent-stackprof
+```
+
+
+## Prerequisite
+
+Ruby 2.1 is required to use `stackprof`. 
+
+`in_debug_agent` plugin is required to be enabled.
+
+```
+<source>
+  type debug_agent
+</source>
+```
+
+And, `stackprof` gem is required. 
+
+```
+$ fluent-gem install stackprof
+```
+
+## Usage
+
+Start
+
+```
+$ fluent-stackprof start
+```
+
+Stop and write a profiling result.
+
+```
+$ fluent-stackprof stop -o /tmp/fluent-stackprof.dump
+```
+
+Then, use `stackprof` to analyze the resulting file:
+
+```
+$ stackprof /tmp/fluent-stackprof.dump --text --limit 1
+```
+
+See [stackprof#run](https://github.com/tmm1/stackprof#run) for more details. 
+The author's blog article is also helpful [Ruby 2.1: Profiling Ruby by @tmm1](http://tmm1.net/ruby21-profiling).
+
+## Options
+
+|parameter|description|default|
+|---|---|---|
+|-h, --host HOST|fluent host|127.0.0.1|
+|-p, --port PORT|debug_agent|24230|
+|-u, --unix PATH|use unix socket instead of tcp||
+|-o, --output PATH|output file|/tmp/fluent-stackprof.txt|
+|-m, --mode MODE|stackprof measure mode. See [stackprof#sampling](https://github.com/tmm1/stackprof#sampling)|cpu|
+
+## ChangeLog
+
+See [CHANGELOG.md](./CHANGELOG.md)
+
+## Contributing
+
+1. Fork it ( http://github.com/sonots/fluent-stackprof/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+See [LICENSE.txt](./LICENSE.txt)

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+    end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+      sh 'irb -rubygems -I lib'
+      end
+task :c => :console

data/bin/fluent-stackprof

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless defined?(gem)
+here = File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path(File.join(here, '..', 'lib'))
+require 'fluent/stackprof'
+Fluent::Stackprof.new.run

data/fluent-stackprof.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-stackprof"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+  spec.summary       = %q{Tools for start/stop stackprof dynamically from outside of fluentd}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/sonots/fluent-stackprof"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fluent/stackprof.rb

@@ -0,0 +1,101 @@
+require 'optparse'
+require 'drb/drb'
+
+module Fluent
+  class Stackprof
+    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-stackprof.dump',
+        mode: 'cpu',
+      }
+
+      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
+      }
+
+      op.on('-m', '--mode MODE', "stackprof measure mode (default: #{opts[:mode]})") {|v|
+        opts[:mode] = 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
+
+      modes = %w[wall cpu object custom]
+      unless modes.include?(opts[:mode])
+        raise OptionParser::InvalidOption.new("-m allows one of #{modes.join(', ')}")
+      end
+
+      opts
+    end
+
+    def run
+      begin
+        opts = parse_options
+      rescue 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 'stackprof'
+        StackProf.start(mode: :#{opts[:mode]})
+        CODE
+      when 'stop'
+        remote_code = <<-"CODE"
+        StackProf.stop
+        StackProf.results('#{opts[:output]}')
+        CODE
+      end
+
+      puts remote_code
+      $remote_engine.method_missing(:instance_eval, remote_code)
+
+      case opts[:command]
+      when 'start'
+        $stdout.puts 'fluent-stackprof: started'
+      when 'stop'
+        $stdout.puts "fluent-stackprof: outputs to #{opts[:output]}"
+      end
+    end
+  end
+end

data/spec/fluent-stackprof/fluent.conf

@@ -0,0 +1,8 @@
+<source>
+  type debug_agent
+</source>
+
+# just as a sample to profile
+<source>
+  type forward
+</source>

data/spec/fluent-stackprof/stackprof_spec.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'spec_helper'
+require 'fluent/stackprof'
+
+describe Fluent::Stackprof do
+  CONFIG_PATH = File.join(File.dirname(__FILE__), 'fluent.conf')
+  BIN_DIR = File.join(ROOT, 'bin')
+  OUTPUT_FILE = File.join(File.dirname(__FILE__), 'test.dump')
+
+  context '#parse_options' do
+    it 'incorrect subcommand' do
+      expect { Fluent::Stackprof.new.parse_options(['foo']) }.to raise_error(OptionParser::InvalidOption)
+    end
+
+    it 'correct measure_mode' do
+      expect { Fluent::Stackprof.new.parse_options(['start', '-m', 'cpu']) }.not_to raise_error
+    end
+
+    it 'incorrect measure_mode' do
+      expect { Fluent::Stackprof.new.parse_options(['start', '-m', 'foo']) }.to raise_error(OptionParser::InvalidOption)
+    end
+  end
+
+  context 'profiling' do
+    before :all do
+      @fluentd_pid = spawn('fluentd', '-c', CONFIG_PATH, out: '/dev/null')
+      sleep 2
+
+      system("#{File.join(BIN_DIR, 'fluent-stackprof')} start -m wall")
+      sleep 2
+
+      system("#{File.join(BIN_DIR, 'fluent-stackprof')} 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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+ROOT = File.expand_path('../../', __FILE__)
+$LOAD_PATH.unshift File.join(ROOT, 'lib')

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fluent-stackprof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tools for start/stop stackprof dynamically from outside of fluentd
+email:
+- sonots@gmail.com
+executables:
+- fluent-stackprof
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fluent-stackprof
+- fluent-stackprof.gemspec
+- lib/fluent/stackprof.rb
+- spec/fluent-stackprof/fluent.conf
+- spec/fluent-stackprof/stackprof_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-stackprof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Tools for start/stop stackprof dynamically from outside of fluentd
+test_files:
+- spec/fluent-stackprof/fluent.conf
+- spec/fluent-stackprof/stackprof_spec.rb
+- spec/spec_helper.rb