jvm_gc_graph 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jvm_gc_graph.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+## JVM GC Graph
+
+This gem creates a static HTML page that uses Google's 
+Interactive Charts to display JVM heap usage.  In order of this to
+work, you need to pass the following options to the JVM at startup:
+
+    -XX:-PrintGCTimeStamps -XX:-PrintGCDetails -Xloggc:<location of log file>
+
+Here is an example:
+
+    java -XX:-PrintGCTimeStamps -XX:-PrintGCDetails -Xloggc:/path/to/memory_gc.log MyApp
+
+## Installation
+
+    gem install jvm_gc_graph
+
+Does require the json_pure gem if on 1.8.7.
+
+## Usage
+
+    jvm_gc_graph -f /path/to/memory_gc.log -o /www/gc_log.html
+
+1. Looks at /path/to/memory_gc.log which contains the gc log
+2. Writes the result to the gc_log.html file.
+
+See `jvm_gc_graph -h` for more options.
+
+## Other
+
+For a much richer tool, try [GCViewer](http://www.tagtraum.com/gcviewer.html).
+
+## License
+
+Copyright (c) 2010 Richard Outten
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/jvm_gc_graph

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'jvm_gc_graph'
+require 'optparse'
+
+options = {}
+op = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options]"
+
+  # Mandatory argument.
+  opts.on("-f", "--file FILE", "FILE containing the output from -Xloggc:filename") do |f|
+    options[:file] = f
+  end
+  
+  opts.on("-o", "--output OUTPUT", "Generated HTML file.") do |o|
+    options[:output] = o
+  end
+
+  opts.on("-t", "--title TITLE", "The TITLE to add to the html page.") do |t|
+    options[:title] = t
+  end
+
+  opts.on('-h', "--help", "Display help message.") do |h|
+    options[:help] = true
+  end
+end
+op.parse!
+
+if options[:help]
+  puts op
+  exit(0)
+end
+
+if options[:file].nil?
+  puts op
+  exit(1)
+end
+
+options[:output] = STDOUT if options[:output].nil?
+options[:title] = "Memory Usage" if options[:title].nil?
+
+JvmGcGraph::Runner.run(options)

data/jvm_gc_graph.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jvm_gc_graph/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jvm_gc_graph"
+  s.version     = JvmGcGraph::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Richard Outten"]
+  s.email       = ["outtenr@gmail.com"]
+  s.homepage    = "https://github.com/outten45/jvm_gc_graph"
+  s.summary     = %q{Creates an HTML output for graphing Java GC.}
+  s.description = %q{Creates an HTML output that uses Google Interactive Charts
+to display the GC in graph format.}
+
+  s.rubyforge_project = "jvm_gc_graph"
+  s.add_dependency('json_pure',  '~> 1.4.6')  if RUBY_VERSION =~ /1.8/
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = %w(jvm_gc_graph)
+  #`git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/jvm_gc_graph.rb

@@ -0,0 +1,83 @@
+require 'json'
+require 'erb'
+
+module JvmGcGraph
+
+  class Runner
+
+    class << self
+      def run(opts)
+        pml = JvmGcGraph::ParseMemoryLog.new(opts)
+        pml.json
+        html = output(pml)
+        if opts[:output].is_a?(IO)
+          opts[:output].puts html
+        else
+          File.open(opts[:output],'w') {|f| f.write(html)}
+        end
+      end
+      
+      def output(parse_memory_log)
+        file = File.join(File.dirname(__FILE__),'templates','gc_chart.html.erb')
+        template = File.read(File.expand_path(file))
+        erb = ERB.new(template)
+        erb.result(parse_memory_log.get_binding)
+      end
+    end
+  end
+
+  class ParseMemoryLog
+
+    GC_REGEX       = /^(([0-9]|\.)*):\s\[(GC\s([0-9]*)K->([0-9]*)K\(([0-9]*)K\)),\s(([0-9]|\.)*).*\]/
+    FULL_GC_REGEX  = /^(([0-9]|\.)*):\s\[(Full GC\s([0-9]*)K->([0-9]*)K\(([0-9]*)K\)),\s(([0-9]|\.)*).*\]/
+    ANY_GC_REGEX   = /^(([0-9]|\.)*):\s\[((Full )?GC\s([0-9]*)K->([0-9]*)K\(([0-9]*)K\)),\s(([0-9]|\.)*).*\]/
+
+    attr_accessor :lines, :start_time, :data, :gc_data
+
+    def initialize(opts)
+      File.open(opts[:file], "r") do |f|
+        @lines = f.readlines
+      end
+      if m = @lines.last.match(ANY_GC_REGEX)
+        @start_time = Time.now.to_i - m[0].to_f
+      end
+      @data = []
+      @gc_data = []
+      self.class.send(:define_method, :title) {opts[:title]}
+    end
+
+    def parse_lines
+      lines.each do |line|
+        if m = line.match(GC_REGEX)
+          add_gc_arrays(m)
+        elsif m = line.match(FULL_GC_REGEX)
+          # might want to do something different with Full GC
+          add_gc_arrays(m)
+        end
+      end
+    end
+
+    def add_gc_arrays(matches)
+      add_to_array(@data, matches[0].to_i,
+                   [matches[4].to_f, nil,nil,
+                    matches[5].to_f, nil,nil,
+                    matches[6].to_f, nil,nil])
+      add_to_array(@gc_data, matches[0].to_i, [(matches[7].to_f*1000), nil,nil])
+    end
+
+    def add_to_array(data_values, time, values)
+      d = [((@start_time + time)*1000)]
+      data_values << (d + values)
+    end
+
+    def json
+      parse_lines
+      @data
+    end
+
+    def get_binding
+      binding
+    end
+  end
+
+end

data/lib/jvm_gc_graph/version.rb

@@ -0,0 +1,3 @@
+module JvmGcGraph
+  VERSION = "0.0.1"
+end

data/lib/templates/gc_chart.html.erb

@@ -0,0 +1,69 @@
+<html>
+  <head>
+    <title><%= title %></title>
+    <script type='text/javascript' src='https://www.google.com/jsapi'></script>
+    <script type='text/javascript'>
+      google.load('visualization', '1', {'packages':['annotatedtimeline']});
+      google.setOnLoadCallback(drawChart);
+      var lineData = <%= data.to_json %>;
+      var gcLineData = <%= gc_data.to_json %>;
+
+      var generator = {
+        createData: function(data) {
+          var d = [];
+          for(var i=0; i < data.length; i++) {
+            var tt = [];
+            var ll = data[i];
+            var dt = new Date(ll.shift());
+            tt.push(dt);
+            for(var j=0; j < ll.length; j++) {
+              tt.push(ll[j]);
+            }
+            d.push(tt);
+          }
+          return d;
+        }
+      };
+      function drawChart() {
+        var d = generator.createData(lineData);
+        var data = new google.visualization.DataTable();
+        data.addColumn('date', 'Date');
+        data.addColumn('number', 'Pre');
+        data.addColumn('string', 'title1');
+        data.addColumn('string', 'text1');
+        data.addColumn('number', 'After');
+        data.addColumn('string', 'title2');
+        data.addColumn('string', 'text2');
+        data.addColumn('number', 'Total');
+        data.addColumn('string', 'title3');
+        data.addColumn('string', 'text3');
+        data.addRows(d);
+
+        var chart = new google.visualization.AnnotatedTimeLine(document.getElementById('chart_div'));
+        chart.draw(data, {displayAnnotations: true, dateFormat: 'HH:mm MMMM dd, yyyy'});
+
+        var d2 = generator.createData(gcLineData);
+        var data2 = new google.visualization.DataTable();
+        data2.addColumn('date', 'Date');
+        data2.addColumn('number', 'Time (umsec)');
+        data2.addColumn('string', 'title4');
+        data2.addColumn('string', 'text4');
+        data2.addRows(d2);
+
+        var chart2 = new google.visualization.AnnotatedTimeLine(document.getElementById('chart_gc_time_div'));
+        chart2.draw(data2, {displayAnnotations: true, dateFormat: 'HH:mm MMMM dd, yyyy'});
+
+      }
+    </script>
+  </head>
+
+  <body>
+    <h2><%= title %></h2>
+    <div id='chart_div' style='width: 900px; height: 500px;'></div>
+
+    <h2>Collection Time</h2>
+    <div id='chart_gc_time_div' style='width: 900px; height: 500px;'></div>
+
+    <h5>Generated: <%= Time.now %></h5>
+  </body>
+</html>

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: jvm_gc_graph
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Richard Outten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Creates an HTML output that uses Google Interactive Charts
+  to display the GC in graph format.
+email: 
+- outtenr@gmail.com
+executables: 
+- jvm_gc_graph
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/jvm_gc_graph
+- jvm_gc_graph.gemspec
+- lib/jvm_gc_graph.rb
+- lib/jvm_gc_graph/version.rb
+- lib/templates/gc_chart.html.erb
+has_rdoc: true
+homepage: https://github.com/outten45/jvm_gc_graph
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: jvm_gc_graph
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Creates an HTML output for graphing Java GC.
+test_files: []
+