perfmonger 0.10.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fec4f6034a16fc8915547917510cb8c69299b095
-  data.tar.gz: 6eb9b12b445f78adf0709d298ce71279abff2c8a
+SHA256:
+  metadata.gz: 9610baac2556f61a8deb2cab5c7d4c10dac9c7da69c0c07a2f7d2b5f2414199e
+  data.tar.gz: 1e94e2c14421eabddd25f60abb8ef6e749aa57a557c4d661830b52fc5f91d7ca
 SHA512:
-  metadata.gz: 101f22ee04ff2cdee38ddcae194970ce5af08c70a4850c295e38ecece1c14648bc1953b35558a9735f642423f03cac583b868010a9f35d8fd9a629d0ea9b1f5a
-  data.tar.gz: 31321ba34ecc71ce31668f13e32d58f2d82fd2808dfbabb3c3d869ae78e70fba46020e3dbfe2779e8a2cd202e2c43e392ee1266a4a94db748b726949d7d8a34d
+  metadata.gz: 7a5f69061b79e2dcafe707bdb24b5a7be0443df2130bd928f33a7aba7a56623a946979ac22e0a82ce367f6d8d17d66facaf7286c6fe1c09016f8cedfc43dc5f6
+  data.tar.gz: 9754fb8acc4b1a521c2daf2a67017d95ec018b414f7f808989589efa498f3f66003f93d1d8d6aa7455a008259486f7ea71dae8c8d2934c52ed0b55e9dd0b0a1f

data/.gitignore

@@ -11,3 +11,6 @@
 /cpu.dat
 /disk.dat
 /perfmonger.pgr
+/.wercker/
+/spec/examples.txt
+/perfmonger.pgr.gz

data/.travis.yml

@@ -1,24 +1,25 @@
-
 language: ruby
 install:
   - sudo apt-get update
   - sudo apt-get install gnuplot
   - gnuplot -e "set terminal" < /dev/null 2>&1
   - bundle install
-  - go_version="1.4.2"
+  - go_version="1.14.1"
   - wget http://golang.org/dl/go${go_version}.linux-amd64.tar.gz
   - sudo tar -C /usr/local -xzf go${go_version}.linux-amd64.tar.gz
   - export PATH=$PATH:/usr/local/go/bin
   - export GOPATH="$HOME/go"
   - export PATH="$PATH:$GOPATH/bin"
   - mkdir -p "$HOME/go/{src,pkg,bin}"
-  - go get -u golang.org/x/crypto/ssh/terminal
-  - go get -u github.com/hayamiz/perfmonger/core/subsystem
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 script:
+  - rake go_get
   - rake spec
   - rake test_core
+notifications:
+  slack:
+    secure: fH8tRyxWHL60OV6QuJlzig9lCLbjfpHx8E6D2EzgQz7+/wqAxtoTUyiN7mbpEJa4hyQeZfpmMpDTnl2tHD6eI8yqjAsY4Q+jt21tCKyrKMegq9Pypd4eMP4o+DupT2mXm0K3cZ2Kgb+yP8AuJPoTy20j3kpmnDFWdqRnhgpBLC8=

data/HOWTO.md

@@ -3,7 +3,6 @@
 ## TODO in release
 
 1. Make a commit for changing version number
-  * Update version number in configure.ac
   * Add a new version number and release date to NEWS
 2. Tag the commit with name `v<VERSION>` ex) `v0.3.0`
 3. Push tags to the github repository

data/NEWS

@@ -1,10 +1,54 @@
-## 2017-09-14: PerfMonger 0.10.2
+## 20XX-XX-XX: PerfMonger 0.13.0
+
+## 2021-07-08: PerfMonger 0.12.1
+  * Bug fixes
+    * [record] subcommand:
+      * --kill waits until a recorder process surely exits
+
+## 2021-05-10: PerfMonger 0.12.0
+  * New features
+    * [record] subcommand:
+      * Add memory usage collection
+
+## 2021-02-10: PerfMonger 0.11.3
+  * Bug fixes
+    * [plot] subcommand:
+      * Fall back to available gnuplot terminal
+  * Changes
+    * [plot] subcommand:
+      * Added --with-gnuplot option for specifying gnuplot binary
+
+## 2020-03-31: PerfMonger 0.11.2
   * Bug fixes
     * [plot] subcommand:
-      * Delete temporary files after plot
+      * Remove temporary directory correctly
+  * Changes
+    * CI environment
+      * Changed golang version to 1.14
+      * Dropped support of ruby older than 2.4
+      * Added ruby 2.6 and 2.7
+
+## 2018-05-15: PerfMonger 0.11.1
+  * Bug fixes
+    * [record] subcommand:
+      * Fixed session detection mechanism (did not worked for execution under sudo)
 
-## 2017-09-08: PerfMonger 0.10.1
-  * Yanked wrongly shipped v0.10.0 and pushed up-to-date code
+## 2018-05-15: PerfMonger 0.11.0
+  * New features
+    * [play] subcommand:
+      * Add --color, --pretty option for pretty JSON output
+    * [live] subcommand:
+      * Add --color, --pretty option for pretty JSON output
+    * [fingerprint] subcommand:
+      * Collect additional info: numactl, ec2-metadata
+  * Bug fixes
+    * [plot] subcommand:
+      * Correctly filter out disk usages by --disk-only option
+  * Changes
+    * Dropped support of i386
+    * Use go-projson for JSON output
+    * [plot] subcommand:
+      * Stacked graphs layout in allcpu.pdf
 
 ## 2017-06-19: PerfMonger 0.10.0
   * New features
@@ -204,4 +248,4 @@ PerfMonger is available on yum repository from this release.
 ## 2011-12-09: PerfMonger 0.1.0 released
 
   * New features
-    * I/O performance monitoring
+    * I/O performance monitoring

data/README.md

@@ -5,31 +5,97 @@
 
 [![wercker status](https://app.wercker.com/status/44c3ade6a2406d337df6d93097a52fdf/m "wercker status")](https://app.wercker.com/project/bykey/44c3ade6a2406d337df6d93097a52fdf)
 
-PerfMonger is an yet anothor performance measurement/monitoring tool
-speaking JSON.
+PerfMonger is a system performance monitor which enables high-resolution and holistic performance measurement with the programmer friendly interface.
+
+* High-resolution: sub-second level monitoring is possible!
+* Holistic performance measurement: monitoring CPU, Disk I/O, Network all at once.
+* Programmer friendly: PerfMonger speaks monitoring results in JSON format, which makes later performance analysis much easier (ex. [jq](https://github.com/stedolan/jq)).
 
 **CAUTION: PerfMonger is still in early stage, so there may be a drastic change in the future. Do not use it for critical jobs**
 
 ## Target platform
 
   * GNU/Linux
+  * Mac OS X (experimental support)
 
-## Prerequisites
-
-  * Ruby 1.9.3 or later
-  * gnuplot 4.6.0 or later (optional)
-
-Note: You need Cutter unit testing framework for building/running tests.
-
-## How to install
+## How to installation
 
     gem install perfmonger
 
+You need gnuplot 4.6.0 or later build with cairo terminals for plotting measurement data with `perfmonger plot` command.
+
 ### Build from source
 
+You need Ruby 2.2 or later, and Go 1.8 or later to build perfmonger.
+
+    bundle
     rake build
 
-## How to use: case study
+## Getting started
+
+Basic usage of PerfMonger is:
+
+* Run `perfmonger record` to record performance information logs
+* Run `perfmonger play` to show performance information logs in JSON format
+
+`perfmonger play` repatedly prints records of system performance including CPU
+usages, disk usages, and network usages. One line includes only one record, so
+you can easily process output records with `jq`, or any scripting languages like
+Ruby, Python, and etc.
+
+Pretty-printed structure of a record is as follows:
+
+```
+{"time": 1500043743.504, # timestamp in unix epoch time
+  "cpu": {               # CPU usages
+    "num_core": 2,         # the number of cores
+    "all": {               # aggregated CPU usage (max = num_core * 100%)
+      "usr": 50.0,
+      "sys": 50.0,
+      "idle": 100.0,
+      ...
+    },
+    "cores": [             # Usage of each CPU core
+      {
+        "usr": 25.0,
+        "sys": 25.0,
+        "idle": 50.0,
+        ...
+      },
+      {
+        "usr": 25.0,
+        "sys": 25.0,
+        "idle": 50.0,
+        ...
+      }
+    ]
+  },
+  "disk": {             # Disk usages
+    "devices": ["sda"],   # List of disk devices
+    "sda": {              # Usage of device 'sda'
+      "riops": 10.0,        # The number of read I/O per second
+      "wiops": 20.0,        # The number of write I/O per second
+      "rkbyteps": 80.0,     # Read transfer rate in KB/s
+      "wkbyteps": 160.0,    # Write transfer rate in KB/s
+      ...
+    }
+    "total": {           # Aggregated usage of all devices
+      "riops": 10.0,
+      "wiops": 20.0,
+      "rkbyteps": 80.0,
+      "wkbyteps": 160.0,
+      ...
+    }
+  }
+}
+```
+
+
+## Typical use cases
+
+### `perfmonger live`: live performance monitoring
+
+    $ perfmonger live
 
 ### Monitor IO performance of /dev/sda for each 0.1 second
 
@@ -42,19 +108,3 @@ Note: You need Cutter unit testing framework for building/running tests.
 ### Monitor CPU usage and IO performance of /dev/sda, sdb for each 0.1 second
 
     $ perfmonger record -i 0.1 -d sda -d sdb
-
-### Plot CPU and IOPS
-
-    $ perfmonger record -i 0.1 -C -d sda > /tmp/perfmonger.log & sleep 10; pkill perfmonger
-    $ perfmonger plot -o /path/to/output_dir/ -Tpng /tmp/perfmonger.log
-    $ display /path/to/output_dir/read-iops.png
-    $ display /path/to/output_dir/cpu.png
-
-![Sample image of IOPS graph](https://raw.github.com/hayamiz/perfmonger/master/misc/sample-read-iops.png)
-![Sample image of CPU usage graph](https://raw.github.com/hayamiz/perfmonger/master/misc/sample-cpu.png)
-
-## Special Thanks
-
-Large portion of PerfMonger comes from
-[SYSSTAT](http://sebastien.godard.pagesperso-orange.fr/) codebase. Thanks for
-their great work.

data/Rakefile

@@ -2,12 +2,12 @@ require 'rubygems'
 require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
 
-task :default => [:spec, :test_core]
+task :default => [:spec, :test_core, :analyze_core]
 
 desc "Run all specs in spec directory"
 RSpec::Core::RakeTask.new(:spec)
 
-task :spec => [:self_build_core]
+task :spec => [:cross_build_core]
 
 desc "Cross build core recorder/player"
 task :cross_build_core do
@@ -18,22 +18,44 @@ task :cross_build_core do
   end
 end
 
-desc "Self build core recorder/player"
-task :self_build_core do
-  Dir.chdir("./core") do
-    sh "./build.sh -"
-  end
-end
-
 task :build => :cross_build_core
 
-desc "Run tests of core recorder/player"
-task :test_core do
+desc "Install Golang libraries"
+task :go_get do
+  sh "go get -u github.com/hayamiz/go-projson"
+  sh "go get -u github.com/hayamiz/perfmonger/core/subsystem"
+  sh "go get -u golang.org/x/crypto/ssh/terminal"
+  sh "go get -u github.com/mattn/go-isatty"
+  sh "go get -u github.com/nsf/termbox-go"
+  sh "go get -u github.com/jroimartin/gocui"
+end
+
+desc "Run tests of golang core library"
+task :test_core => [:cross_build_core] do
   Dir.chdir("./core/subsystem") do
+    # check coverage
     sh "go test -v -cover"
   end
 end
 
+desc "Run static-analysis of golang core library"
+task :analyze_core => [:cross_build_core] do
+  # running static analysis
+  Dir.chdir("./core/subsystem") do
+    ["linux", "darwin"].each do |platform|
+      puts "* ./core/subsystem"
+      sh "go vet perfmonger_#{platform}.go $(ls *.go | grep -v perfmonger_)"
+    end
+  end
+
+  Dir["./core", "./core/cmd/*"].each do |dir|
+    Dir.chdir(dir) do
+      puts "* #{dir}"
+      sh "go vet *.go"
+    end
+  end
+end
+
 desc "Removed generated files"
 task :clean do
   sh "make -C core clean"

data/core/Makefile

@@ -2,63 +2,54 @@
 # generated by build.sh
 
 GO_DEPS := subsystem/perfmonger_darwin.go subsystem/perfmonger.go subsystem/perfmonger_linux.go subsystem/perfmonger_linux_test.go subsystem/stat.go subsystem/stat_test.go subsystem/usage.go subsystem/usage_test.go utils.go
-GO_SRC := utils.go
 
 .PHONY: all build clean
 
 all: build
 
 
-../lib/exec/perfmonger-recorder_linux_386: perfmonger-recorder.go $(GO_DEPS)
-	go build -o $@ perfmonger-recorder.go $(GO_SRC)
+../lib/exec/perfmonger-recorder_linux_amd64: cmd/perfmonger-recorder/perfmonger-recorder.go $(GO_DEPS)
+	cd cmd/perfmonger-recorder && go build -o ../../$@ perfmonger-recorder.go
 
 
-../lib/exec/perfmonger-player_linux_386: perfmonger-player.go $(GO_DEPS)
-	go build -o $@ perfmonger-player.go $(GO_SRC)
+../lib/exec/perfmonger-player_linux_amd64: cmd/perfmonger-player/perfmonger-player.go $(GO_DEPS)
+	cd cmd/perfmonger-player && go build -o ../../$@ perfmonger-player.go
 
 
-../lib/exec/perfmonger-summarizer_linux_386: perfmonger-summarizer.go $(GO_DEPS)
-	go build -o $@ perfmonger-summarizer.go $(GO_SRC)
+../lib/exec/perfmonger-viewer_linux_amd64: cmd/perfmonger-viewer/perfmonger-viewer.go $(GO_DEPS)
+	cd cmd/perfmonger-viewer && go build -o ../../$@ perfmonger-viewer.go
 
 
-../lib/exec/perfmonger-plot-formatter_linux_386: perfmonger-plot-formatter.go $(GO_DEPS)
-	go build -o $@ perfmonger-plot-formatter.go $(GO_SRC)
+../lib/exec/perfmonger-summarizer_linux_amd64: cmd/perfmonger-summarizer/perfmonger-summarizer.go $(GO_DEPS)
+	cd cmd/perfmonger-summarizer && go build -o ../../$@ perfmonger-summarizer.go
 
 
-../lib/exec/perfmonger-recorder_linux_amd64: perfmonger-recorder.go $(GO_DEPS)
-	go build -o $@ perfmonger-recorder.go $(GO_SRC)
+../lib/exec/perfmonger-plot-formatter_linux_amd64: cmd/perfmonger-plot-formatter/perfmonger-plot-formatter.go $(GO_DEPS)
+	cd cmd/perfmonger-plot-formatter && go build -o ../../$@ perfmonger-plot-formatter.go
 
 
-../lib/exec/perfmonger-player_linux_amd64: perfmonger-player.go $(GO_DEPS)
-	go build -o $@ perfmonger-player.go $(GO_SRC)
+../lib/exec/perfmonger-recorder_darwin_amd64: cmd/perfmonger-recorder/perfmonger-recorder.go $(GO_DEPS)
+	cd cmd/perfmonger-recorder && go build -o ../../$@ perfmonger-recorder.go
 
 
-../lib/exec/perfmonger-summarizer_linux_amd64: perfmonger-summarizer.go $(GO_DEPS)
-	go build -o $@ perfmonger-summarizer.go $(GO_SRC)
+../lib/exec/perfmonger-player_darwin_amd64: cmd/perfmonger-player/perfmonger-player.go $(GO_DEPS)
+	cd cmd/perfmonger-player && go build -o ../../$@ perfmonger-player.go
 
 
-../lib/exec/perfmonger-plot-formatter_linux_amd64: perfmonger-plot-formatter.go $(GO_DEPS)
-	go build -o $@ perfmonger-plot-formatter.go $(GO_SRC)
+../lib/exec/perfmonger-viewer_darwin_amd64: cmd/perfmonger-viewer/perfmonger-viewer.go $(GO_DEPS)
+	cd cmd/perfmonger-viewer && go build -o ../../$@ perfmonger-viewer.go
 
 
-../lib/exec/perfmonger-recorder_darwin_amd64: perfmonger-recorder.go $(GO_DEPS)
-	go build -o $@ perfmonger-recorder.go $(GO_SRC)
+../lib/exec/perfmonger-summarizer_darwin_amd64: cmd/perfmonger-summarizer/perfmonger-summarizer.go $(GO_DEPS)
+	cd cmd/perfmonger-summarizer && go build -o ../../$@ perfmonger-summarizer.go
 
 
-../lib/exec/perfmonger-player_darwin_amd64: perfmonger-player.go $(GO_DEPS)
-	go build -o $@ perfmonger-player.go $(GO_SRC)
+../lib/exec/perfmonger-plot-formatter_darwin_amd64: cmd/perfmonger-plot-formatter/perfmonger-plot-formatter.go $(GO_DEPS)
+	cd cmd/perfmonger-plot-formatter && go build -o ../../$@ perfmonger-plot-formatter.go
 
 
-../lib/exec/perfmonger-summarizer_darwin_amd64: perfmonger-summarizer.go $(GO_DEPS)
-	go build -o $@ perfmonger-summarizer.go $(GO_SRC)
-
-
-../lib/exec/perfmonger-plot-formatter_darwin_amd64: perfmonger-plot-formatter.go $(GO_DEPS)
-	go build -o $@ perfmonger-plot-formatter.go $(GO_SRC)
-
-
-build: ../lib/exec/perfmonger-recorder_linux_386 ../lib/exec/perfmonger-player_linux_386 ../lib/exec/perfmonger-summarizer_linux_386 ../lib/exec/perfmonger-plot-formatter_linux_386 ../lib/exec/perfmonger-recorder_linux_amd64 ../lib/exec/perfmonger-player_linux_amd64 ../lib/exec/perfmonger-summarizer_linux_amd64 ../lib/exec/perfmonger-plot-formatter_linux_amd64 ../lib/exec/perfmonger-recorder_darwin_amd64 ../lib/exec/perfmonger-player_darwin_amd64 ../lib/exec/perfmonger-summarizer_darwin_amd64 ../lib/exec/perfmonger-plot-formatter_darwin_amd64
+build: ../lib/exec/perfmonger-recorder_linux_amd64 ../lib/exec/perfmonger-player_linux_amd64 ../lib/exec/perfmonger-viewer_linux_amd64 ../lib/exec/perfmonger-summarizer_linux_amd64 ../lib/exec/perfmonger-plot-formatter_linux_amd64 ../lib/exec/perfmonger-recorder_darwin_amd64 ../lib/exec/perfmonger-player_darwin_amd64 ../lib/exec/perfmonger-viewer_darwin_amd64 ../lib/exec/perfmonger-summarizer_darwin_amd64 ../lib/exec/perfmonger-plot-formatter_darwin_amd64
 
 clean:
-	rm -f ../lib/exec/perfmonger-recorder_linux_386 ../lib/exec/perfmonger-player_linux_386 ../lib/exec/perfmonger-summarizer_linux_386 ../lib/exec/perfmonger-plot-formatter_linux_386 ../lib/exec/perfmonger-recorder_linux_amd64 ../lib/exec/perfmonger-player_linux_amd64 ../lib/exec/perfmonger-summarizer_linux_amd64 ../lib/exec/perfmonger-plot-formatter_linux_amd64 ../lib/exec/perfmonger-recorder_darwin_amd64 ../lib/exec/perfmonger-player_darwin_amd64 ../lib/exec/perfmonger-summarizer_darwin_amd64 ../lib/exec/perfmonger-plot-formatter_darwin_amd64
+	rm -f ../lib/exec/perfmonger-recorder_linux_amd64 ../lib/exec/perfmonger-player_linux_amd64 ../lib/exec/perfmonger-viewer_linux_amd64 ../lib/exec/perfmonger-summarizer_linux_amd64 ../lib/exec/perfmonger-plot-formatter_linux_amd64 ../lib/exec/perfmonger-recorder_darwin_amd64 ../lib/exec/perfmonger-player_darwin_amd64 ../lib/exec/perfmonger-viewer_darwin_amd64 ../lib/exec/perfmonger-summarizer_darwin_amd64 ../lib/exec/perfmonger-plot-formatter_darwin_amd64
 

data/core/build.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 
-READLINK=$(type -p greadlink readlink | head -1)
-cd $(dirname $($READLINK -f $0))
+cd $(cd $(dirname $0); pwd)
 
 if [[ $1 = "-" ]]; then
     # do self build
@@ -28,12 +27,12 @@ if [[ $1 = "-" ]]; then
     TARGET=("${os} ${arch}")
 else
     # cross build
-    TARGET=("linux 386" "linux amd64"  "darwin amd64")
+    TARGET=("linux amd64"  "darwin amd64")
 fi
 
 set -e
 
-GO_DEPS=$(ls subsystem/*.go; ls utils.go)
+GO_DEPS=$(ls subsystem/*.go utils.go)
 
 makefile=`mktemp`
 
@@ -42,7 +41,6 @@ cat <<EOF > $makefile
 # generated by build.sh
 
 GO_DEPS := $(echo ${GO_DEPS})
-GO_SRC := utils.go
 
 .PHONY: all build clean
 
@@ -57,13 +55,13 @@ for idx in $(seq 0 $((${#TARGET[@]}-1))); do
     export var_GOOS=$1
     export var_GOARCH=$2
 
-    for subcmd in recorder player summarizer plot-formatter; do
+    for subcmd in recorder player viewer summarizer plot-formatter; do
         TARGETS+=(../lib/exec/perfmonger-${subcmd}_${var_GOOS}_${var_GOARCH})
 
         cat <<EOF >> $makefile
 
-../lib/exec/perfmonger-${subcmd}_${var_GOOS}_${var_GOARCH}: perfmonger-${subcmd}.go \$(GO_DEPS)
-	go build -o \$@ perfmonger-$subcmd.go \$(GO_SRC)
+../lib/exec/perfmonger-${subcmd}_${var_GOOS}_${var_GOARCH}: cmd/perfmonger-${subcmd}/perfmonger-${subcmd}.go \$(GO_DEPS)
+	cd cmd/perfmonger-${subcmd} && go build -o ../../\$@ perfmonger-$subcmd.go
 
 EOF
     done