perfmonger 0.6.1 → 0.7.0

data/lib/perfmonger/command/summary.rb

@@ -61,340 +61,25 @@ EOS
 
     summary_title ||= @logfile
 
-    show_summary(@logfile, summary_title)
-  end
-
-
-  def read_logfile(logfile)
-    File.read(logfile).lines.map do |line|
-      begin
-        JSON.parse(line)
-      rescue JSON::ParserError => err
-        nil
-      end
-    end.compact
-  end
-
-  def make_accumulation(records)
-    unless records.all?{|record| record.has_key?("ioinfo")}
-      return nil
-    end
-    unless records.size > 1
-      return nil
-    end
-
-    accum = Hash.new
-
-    devices = records.first["ioinfo"]["devices"]
-    accum["ioinfo"] = Hash.new
-
-    devices.each do |device|
-      read_requests = 0
-      read_bytes = 0
-      write_requests = 0
-      write_bytes = 0
-
-      (1..(records.size - 1)).each do |idx|
-        last_record = records[idx - 1]
-        record = records[idx]
-        dt = record["time"] - last_record["time"]
-
-        read_requests += record["ioinfo"][device]["riops"] * dt
-        write_requests += record["ioinfo"][device]["wiops"] * dt
-        read_bytes += record["ioinfo"][device]["rsecps"] * 512 * dt
-        write_bytes += record["ioinfo"][device]["wsecps"] * 512 * dt
-      end
-
-      accum["ioinfo"][device] = Hash.new
-      accum["ioinfo"][device]["read_requests"] = read_requests
-      accum["ioinfo"][device]["read_bytes"] = read_bytes
-      accum["ioinfo"][device]["write_requests"] = write_requests
-      accum["ioinfo"][device]["write_bytes"] = write_bytes
-    end
-
-    accum
-  end
-
-  def make_summary(records)
-    if records.empty?
-      return nil
-    elsif records.size == 1
-      return records.first
-    end
-
-    # setup getters and setters all attributes for avg. calculation
-    # getter.call(record) returns value
-    # setter.call(record, value) set value
-    # getters and setters include attribute info as a closure
-    getters = []
-    setters = []
-
-    if records.first.include?("ioinfo")
-      records.first["ioinfo"]["devices"].each do |device|
-        records.first["ioinfo"][device].keys.each do |attr|
-          getters << lambda do |record|
-            record["ioinfo"][device][attr]
-          end
-          setters << lambda do |record, value|
-            record["ioinfo"][device][attr] = value
-          end
-        end
-      end
-
-      records.first["ioinfo"]["total"].keys.each do |attr|
-        getters << lambda do |record|
-          record["ioinfo"]["total"][attr]
-        end
-        setters << lambda do |record, value|
-          record["ioinfo"]["total"][attr] = value
-        end
-      end
-    end
-
-    if records.first.include?("cpuinfo")
-      records.first["cpuinfo"]["all"].keys.each do |attr|
-        getters << lambda do |record|
-          record["cpuinfo"]["all"][attr]
-        end
-        setters << lambda do |record, value|
-          record["cpuinfo"]["all"][attr] = value
-        end
-      end
-
-      records.first["cpuinfo"]["nr_cpu"].times do |cpu_idx|
-        records.first["cpuinfo"]["cpus"][cpu_idx].keys.each do |attr|
-          getters << lambda do |record|
-            record["cpuinfo"]["cpus"][cpu_idx][attr]
-          end
-          setters << lambda do |record, value|
-            record["cpuinfo"]["cpus"][cpu_idx][attr] = value
-          end
-        end
-      end
-    end
-
-    avg_record = Marshal.load(Marshal.dump(records.first)); # deep copy
-
-    setters.each do |setter|
-      setter.call(avg_record, 0.0)
-    end
-
-    (1..(records.size - 1)).each do |idx|
-      record = records[idx]
-
-      last_t = records[idx - 1]["time"]
-      t      = record["time"]
-
-      getters.size.times do |_etters_idx|
-        getter = getters[_etters_idx]
-        setter = setters[_etters_idx]
-
-        setter.call(avg_record,
-                    getter.call(avg_record) + getter.call(record) * (t - last_t))
-      end
-    end
-
-    getters.size.times do |_etters_idx|
-      getter = getters[_etters_idx]
-      setter = setters[_etters_idx]
-
-      setter.call(avg_record,
-                  getter.call(avg_record) / (records[-1]["time"] - records[0]["time"]))
-    end
-
+    @summarizer_bin = ::PerfMonger::Command::CoreFinder.summarizer()
 
-    # r_await/w_await need special handling
-    if records.first.include?("ioinfo")
-      records.first["ioinfo"]["devices"].each do |device|
-        accum_r_io_time = 0.0
-        accum_w_io_time = 0.0
-        r_io_count = 0
-        w_io_count = 0
-
-        (records.size - 1).times do |idx|
-          rec0 = records[idx]
-          rec1 = records[idx + 1]
-          dev_ioinfo = rec1["ioinfo"][device]
-          dt = rec1["time"] - rec0["time"]
-
-          accum_r_io_time += dev_ioinfo["r_await"] * dev_ioinfo["riops"] * dt
-          accum_w_io_time += dev_ioinfo["w_await"] * dev_ioinfo["wiops"] * dt
-          r_io_count += dev_ioinfo["riops"] * dt
-          w_io_count += dev_ioinfo["wiops"] * dt
-        end
-
-        if r_io_count > 0
-          avg_record["ioinfo"][device]["r_await"] = accum_r_io_time / r_io_count
-        else
-          avg_record["ioinfo"][device]["r_await"] = 0.0
-        end
-
-        if w_io_count > 0
-          avg_record["ioinfo"][device]["w_await"] = accum_w_io_time / w_io_count
-        else
-          avg_record["ioinfo"][device]["w_await"] = 0.0
-        end
-      end
+    if ! @summarizer_bin
+      puts("[ERROR] no executable binary found.")
+      exit(false)
     end
 
-    avg_record
-  end
-
-  def show_summary(logfile, summary_title)
-    records = read_logfile(logfile)
-    summary = make_summary(records)
-    accum = make_accumulation(records)
-
-    duration = records.last["time"] - records.first["time"]
+    cmd = [@summarizer_bin]
 
     if @json
-      output = Hash.new
-
-      output["duration"] = duration
-      if summary
-        if summary["cpuinfo"]
-          output["cpuinfo"] = summary["cpuinfo"]
-        end
-
-        if summary['ioinfo']
-          output["ioinfo"] = summary["ioinfo"]
-        end
-      end
-
-      puts output.to_json
-    else
-      if $stdout.tty? && @pager
-        output_file = IO.popen(@pager, "w")
-      else
-        output_file = $stdout
-      end
-
-      output_file.puts("")
-      output_file.puts("== Performance summary of '#{summary_title}' ==")
-      output_file.puts("")
-      duration_str = sprintf("%.2f", duration)
-      output_file.puts("record duration: #{duration_str} sec")
-
-      if summary.nil?
-        output_file.puts("")
-        output_file.puts("No performance info was collected.")
-        output_file.puts("This is because command execution time was too short, or something went wrong.")
-      end
-
-      if summary && summary["cpuinfo"]
-        nr_cpu = records.first["cpuinfo"]["nr_cpu"]
-
-        usr, sys, iowait, irq, soft, idle =
-          [summary['cpuinfo']['all']['usr'] + summary['cpuinfo']['all']['nice'],
-           summary['cpuinfo']['all']['sys'],
-           summary['cpuinfo']['all']['iowait'],
-           summary['cpuinfo']['all']['irq'],
-           summary['cpuinfo']['all']['soft'],
-           summary['cpuinfo']['all']['idle']].map do |val|
-          val * nr_cpu
-        end
-
-        other = [100.0 - (usr + sys + iowait + irq + soft + idle), 0.0].max * nr_cpu
-
-        usr_str, sys_str, iowait_str, irq_str, soft_str, other_str, idle_str =
-          [usr, sys, iowait, irq, soft, other, idle].map do |value|
-          sprintf("%.2f", value)
-        end
-
-        total_non_idle_str = sprintf("%.2f", usr + sys + irq + soft + other)
-        total_idle_str = sprintf("%.2f", iowait + idle)
-
-        output_file.puts("")
-        output_file.puts <<EOS
-* Average CPU usage (MAX: #{100 * nr_cpu} %)
-  * Non idle portion: #{total_non_idle_str}
-       %usr: #{usr_str}
-       %sys: #{sys_str}
-       %irq: #{irq_str}
-      %soft: #{soft_str}
-     %other: #{other_str}
-  * Idle portion: #{total_idle_str}
-    %iowait: #{iowait_str}
-      %idle: #{idle_str}
-EOS
-      end
-
-      if summary && summary['ioinfo']
-        total_r_iops, total_w_iops, total_r_sec, total_w_sec = [0.0] * 4
-
-        summary['ioinfo']['devices'].each do |device|
-          r_iops, w_iops, r_sec, w_sec, r_await, w_await =
-            [summary['ioinfo'][device]['riops'],
-             summary['ioinfo'][device]['wiops'],
-             summary['ioinfo'][device]['rsecps'] * 512 / 1024.0 / 1024.0,
-             summary['ioinfo'][device]['wsecps'] * 512 / 1024.0 / 1024.0,
-             summary['ioinfo'][device]['r_await'],
-             summary['ioinfo'][device]['w_await']]
-
-          total_r_iops += r_iops
-          total_w_iops += w_iops
-          total_r_sec  += r_sec
-          total_w_sec  += w_sec
-
-          r_iops_str, w_iops_str, r_sec_str, w_sec_str = [r_iops, w_iops, r_sec, w_sec].map do |value|
-            sprintf("%.2f", value)
-          end
-
-          r_await_str, w_await_str = [r_await, w_await].map do |await|
-            if await < 1.0
-              sprintf("%.1f usec", await * 1000)
-            else
-              sprintf("%.2f msec", await)
-            end
-          end
-
-          total_r_bytes_str, total_w_bytes_str = ["read_bytes", "write_bytes"].map do |key|
-            bytes = accum["ioinfo"][device][key]
-            if bytes > 2**30
-              sprintf("%.2f GB", bytes / 2**30)
-            elsif bytes > 2**20
-              sprintf("%.2f MB", bytes / 2**20)
-            elsif bytes > 2**10
-              sprintf("%.2f KB", bytes / 2**10)
-            else
-              sprintf("%.2f bytes", bytes)
-            end
-          end
-
-
-          output_file.puts("")
-          output_file.puts("* Average DEVICE usage: #{device}")
-          output_file.puts("        read IOPS: #{r_iops_str}")
-          output_file.puts("       write IOPS: #{w_iops_str}")
-          output_file.puts("  read throughput: #{r_sec_str} MB/s")
-          output_file.puts(" write throughput: #{w_sec_str} MB/s")
-          output_file.puts("     read latency: #{r_await_str}")
-          output_file.puts("    write latency: #{w_await_str}")
-          output_file.puts("      read amount: #{total_r_bytes_str}")
-          output_file.puts("     write amount: #{total_w_bytes_str}")
-        end
-
-        if summary['ioinfo']['devices'].size > 1
-          total_r_iops_str, total_w_iops_str, total_r_sec_str, total_w_sec_str =
-            [total_r_iops, total_w_iops, total_r_sec, total_w_sec].map do |value|
-            sprintf("%.2f", value)
-          end
+      cmd << "-json"
+    end
 
-          output_file.puts("")
-          output_file.puts("* TOTAL DEVICE usage: #{summary['ioinfo']['devices'].join(', ')}")
-          output_file.puts("        read IOPS: #{total_r_iops_str}")
-          output_file.puts("       write IOPS: #{total_w_iops_str}")
-          output_file.puts("  read throughput: #{total_r_sec_str} MB/s")
-          output_file.puts(" write throughput: #{total_w_sec_str} MB/s")
-        end
+    cmd << "-title"
+    cmd << summary_title
 
-        output_file.puts("")
-      end
+    cmd << @logfile
 
-      if output_file != $stdout
-        output_file.close
-      end
-    end
+    Process.exec(*cmd)
   end
 end
 

data/lib/perfmonger/version.rb

@@ -1,5 +1,3 @@
-# This file is automatically generated by Autoconf: 2014-06-23 19:42:25
-
 module PerfMonger
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/perfmonger.rb

@@ -1,12 +1,15 @@
 require 'perfmonger/version.rb'
 require 'perfmonger/config.rb'
 require 'perfmonger/cli.rb'
+require 'perfmonger/command/core.rb'
 require 'perfmonger/command/base_command.rb'
 require 'perfmonger/command/record.rb'
 require 'perfmonger/command/record_option.rb'
+require 'perfmonger/command/live.rb'
 require 'perfmonger/command/stat.rb'
 require 'perfmonger/command/stat_option.rb'
 require 'perfmonger/command/summary.rb'
+require 'perfmonger/command/play.rb'
 require 'perfmonger/command/plot.rb'
 require 'perfmonger/command/server.rb'
 require 'perfmonger/command/fingerprint.rb'

data/misc/_perfmonger

@@ -0,0 +1,128 @@
+#compdef perfmonger
+
+_perfmonger-record() {
+    local curcontext=$curcontext state line ret=1
+    declare -A opt_args
+
+    # TODO: match -d,--device multiple times
+    _arguments -w -C -S \
+        '(-D --all-devices)'{-d,--device}'[device name to be monitored]: :__perfmonger_devices' \
+        '(-d --device)'{-D,--all-devices}'[monitor all devices]' \
+        '(-i --interval)'{-i,--interval}'[measurement interval]: interval in sec' \
+        {-l,--logfile}'[log file name]:_files' \
+        {-B,--no-interval-backoff}'[prevent interval backoff]' \
+        {-s,--start-delay}'[wait specified time before starting measurement]: wait time in sec' \
+        {-t,--timeout}'[length of measurement time]: timeout in sec' \
+        {-C,--cpu}'[report CPU usage]' \
+        {-S,--context-switch}'[report context switches per sec]' \
+        {-v,--verbose}'[verbose]' \
+        {-h,--help}'[show help]' \
+        && return
+}
+
+_perfmonger-stat() {
+    local ret
+    _call_function ret _perfmonger-record
+    return ret
+}
+
+_perfmonger-summary() {
+    local curcontext=$curcontext state line ret=1
+    declare -A opt_args
+
+    # TODO: accept only 1 file
+    _arguments -w -C -S \
+        '--json[output summary in JSON format]' \
+        {-p,--pager}'[use pager to see summary output]: pager program' \
+        {-h,--help}'[show help]' \
+        {-h,--help}'[show help]' \
+        '*:: :_files' \
+        && return
+}
+
+_perfmonger-plot() {
+    local curcontext=$curcontext state line ret=1
+    declare -A opt_args
+
+    # TODO: accept only 1 file
+    _arguments -w -C -S \
+        '--offset-time: offset time in sec' \
+        {-o,--output-dir}'[output directory]:_directories' \
+        {-T,--output-type}'[output image type]:output type:(pdf png)' \
+        {-p,--prefix}'[output file name prefix]:prefix' \
+        {-s,--save}'[save gnuplot script and data files]' \
+        {-h,--help}'[show help]' \
+        '*:: :_files' \
+        && return
+}
+
+_perfmonger-fingerprint() {
+    local curcontext=$curcontext state line ret=1
+    declare -A opt_args
+
+    _arguments -w -C -S \
+        '*::output tarball:_files -g "*.((tar|TAR)(.gz|.GZ|.Z|.bz2|.lzma|.xz|)|(tbz|tgz|txz))(-.)"' \
+        {-h,--help}'[show help]' \
+        && return
+}
+
+_perfmonger-server() {
+    local curcontext=$curcontext state line ret=1
+    declare -A opt_args
+
+    # TODO: complete record options after '--'
+    _arguments -w -C \
+        {-H,--hostname}'[host name to display]:host name' \
+        '--http-host[host name for HTTP URL]:host name' \
+        '--port[port number]:port number' \
+        {-h,--help}'[show help]' \
+        && return
+
+    return $ret
+}
+
+__perfmonger_devices() {
+    _values 'device' $(tail -n +3 /proc/partitions | awk '{print $4}')
+}
+
+# main completion function
+# (( $+functions[_perfmonger] )) ||
+_perfmonger() {
+    local curcontext context state line
+    declare -A opt_args
+
+    integer ret=1
+
+    _arguments -C -S \
+        '(- :)'{-h,--help}'[show help]' \
+        '(- :)'{-v,--version}'[show version]' \
+        '(-): :->commands' \
+        '(-)*:: :->option-or-argument' && return
+
+    case $state in
+        (commands)
+            _perfmonger_commands && ret=0
+            ;;
+        (option-or-argument)
+            if (( $+functions[_perfmonger-$words[1]] )); then
+                _call_function ret _perfmonger-$words[1]
+            else
+                _message 'unknown sub-command'
+            fi
+            ;;
+    esac
+
+    return $ret
+}
+
+_perfmonger_commands() {
+    _values 'command' \
+        'record[record system performance]' \
+        'stat[run a command and record system performance during execution]' \
+        'plot[plot system performance graphs from a perfmonger log file]' \
+        'fingerprint[gather all possible system config information]' \
+        'server[launch self-contained HTML5 realtime graph server]' \
+        'summary[show summary of a perfmonger log file]'
+}
+
+compdef _perfmonger perfmonger

data/misc/perfmonger-completion.bash

@@ -0,0 +1,49 @@
+# bash completion support for PerfMonger
+
+_perfmonger() {
+    local cmd cur prev subcmd
+    cmd=$1
+    cur=$2
+    prev=$3
+
+    subcmds="record stat plot fingerprint server summary"
+
+    # contextual completion
+    case $prev in
+        perfmonger)
+            COMPREPLY=( $(compgen -W "$subcmds" $cur) )
+            return 0
+            ;;
+        -d|--device)
+            COMPREPLY=( $(tail -n +3 /proc/partitions | awk '{print $4}') )
+            return 0
+            ;;
+        -l|--logfile)
+            COMPREPLY=( $(compgen -o default) )
+            return 0
+            ;;
+        -i|--interval|-s|--start-delay|-t|--timeout)
+            COMPREPLY=()
+            return 0
+            ;;
+    esac
+
+    # complete options
+    subcmd=${COMP_WORDS[1]}
+
+    case "$cur" in
+        # complete options
+        -*)
+            COMPREPLY=( $(compgen -W "$(perfmonger $subcmd -h | egrep -o ' ([-][[:alnum:]]|-{2}[[:alnum:]-]+)\b')" -- "$cur") )
+            return 0
+            ;;
+        *)
+            COMPREPLY=( $(compgen -o default "$cur") )
+            return 0
+            ;;
+    esac
+
+    return 0
+}
+
+complete -F _perfmonger perfmonger

data/perfmonger.gemspec

@@ -1,12 +1,11 @@
 # -*- mode: ruby -*-
 
 $:.push File.expand_path("../lib", __FILE__)
-require 'perfmonger'
+require 'perfmonger/version'
 
 Gem::Specification.new do |s|
   s.name        = 'perfmonger'
   s.version     = PerfMonger::VERSION
-  s.date        = '2015-01-19'
   s.summary     = "yet anothor performance measurement/monitoring tool"
   s.description = "yet anothor performance measurement/monitoring tool"
   s.authors     = ["Yuto HAYAMIZU"]
@@ -14,18 +13,20 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://github.com/hayamiz/perfmonger/'
   s.license     = 'GPL-2'
 
-  s.required_ruby_version = '>= 1.9.0'
+  s.required_ruby_version = '>= 1.9.3'
 
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake-compiler"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "aruba"
 
   s.files       = `git ls-files`.split("\n")
+  s.files      += Dir.glob("lib/exec/*")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
 
-  s.extensions << 'ext/perfmonger/extconf.rb'
-
   s.post_install_message = <<EOS
 
 ============================================================

data/spec/fingerprint_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'tmpdir'
+
+describe '[fingerprint] subcommand' do
+  before(:each) do
+    @old_pwd = Dir.pwd
+    @tmpdir = Dir.mktmpdir
+    Dir.chdir(@tmpdir)
+  end
+
+  after(:each) do
+    Dir.chdir(@old_pwd)
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  it 'should create output tgz successfully' do
+    run("#{perfmonger_bin} fingerprint output.tgz", 20)
+    assert_success(true)
+    check_file_presence("output.tgz")
+  end
+
+  it 'should create output tgz successfully with alias invocation' do
+    run("#{perfmonger_bin} fp output.tgz", 20)
+    assert_success(true)
+    check_file_presence("output.tgz")
+  end
+
+  it "should create output tgz successfully with content" do
+    run("#{perfmonger_bin} fingerprint output.tgz", 20)
+    assert_success(true)
+    run("tar xf output.tgz")
+    assert_success(true)
+    check_directory_presence(["output"], true)
+  end
+end

data/spec/live_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe '[live] subcommand' do
+  before(:each) do
+    skip_if_proc_is_not_available
+  end
+
+  it 'should print JSON records for 3 seconds and exit successfully.' do
+    cmd = "#{perfmonger_bin} live --timeout 3"
+    run(cmd, 5)
+    assert_success(true)
+    expect(stdout_from(cmd).lines.to_a.size).to eq 3
+
+    stdout_from(cmd).each_line do |line|
+      expect do
+        JSON.parse(line)
+      end.not_to raise_error
+
+      json = JSON.parse(line)
+      expect(json.keys.sort).to eq %w{time cpu disk net}.sort
+    end
+
+    check_file_presence("perfmonger.pgr")
+  end
+end

data/spec/perfmonger_spec.rb

@@ -0,0 +1,37 @@
+
+require 'spec_helper'
+
+describe "perfmonger command" do
+  it "should be an executable" do
+    expect(File.executable?(perfmonger_bin)).to be true
+  end
+
+  it 'should print help and exit with failure when no arguments given' do
+    cmd = "#{perfmonger_bin}"
+    run(cmd)
+    assert_success(false)
+    expect(stdout_from(cmd)).to match(/^Usage: perfmonger/)
+  end
+
+  it 'should print help and exit with success when --help is given' do
+    ["-h", "--help"].each do |arg|
+      cmd = "#{perfmonger_bin} #{arg}"
+      run(cmd)
+      assert_success(true)
+      expect(stdout_from(cmd)).to match(/^Usage: perfmonger/)
+    end
+  end
+
+  it 'should print version number if --version given' do
+    cmd = "#{perfmonger_bin} --version"
+    run(cmd)
+    assert_success(true)
+    expect(stdout_from(cmd)).to include(PerfMonger::VERSION)
+  end
+
+  it 'fails if unknown subcommand given' do
+    cmd = "#{perfmonger_bin} piyo"
+    run(cmd)
+    assert_success(false)
+  end
+end