rackprof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07ce5c7dfbfdce738b4236a0ebdd6677dda426be
+  data.tar.gz: 13c8d4ce865bba4409474811d7ac2d288ab04e12
+SHA512:
+  metadata.gz: 14eccfc8b25ebca81314da07c6d63111834163d69c9b085e1a472b665a6eb9d6a897839701eac28a88087ad72ed6a9ed5be7a2f42e2f1b6620bcd524c9b57bb3
+  data.tar.gz: efd2681021433e03b521ada0128b241b46530070378ebf84482641b243c1dbdcf525b87f99827fb7d2d86794ec649cfdd7abb25833c14d1c30ba4b41bf89d2ec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Norimasa Ando
+
+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,53 @@
+# Rackprof
+
+Middleware which displays GC, sampling call-stack on dashboard using GC.stat, [stackprof](https://github.com/tmm1/stackprof).
+
+Only supports for ruby 2.1+ and [thin](https://github.com/macournoyer/thin) web server at the moment.
+
+![image](https://raw.githubusercontent.com/wiki/hbd225/rackprof/images/sample.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rackprof'
+```
+
+### Rails
+
+Nothing to do!
+
+### Sinatra
+
+```ruby
+require 'rackprof'
+class MyApp < Sinatra::Base
+  use Rackprof::Middleware
+end
+```
+
+### Rack
+
+In your `config.ru` add `use RackProf` line:
+
+```ruby
+require 'rackprof'
+use Rackprof::Middleware
+```
+
+## Usage
+
+Access to dashboard page which is automatically mounted at `/rackprof`:
+
+```
+http://localhost:3000/rackprof
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rackprof/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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rackprof"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rackprof.rb

@@ -0,0 +1,14 @@
+require 'rackprof/version'
+require 'observer'
+
+module Rackprof
+  autoload :Web,             'rackprof/web'
+  autoload :Middleware,      'rackprof/middleware'
+  autoload :Observer,        'rackprof/observer'
+  autoload :GCNotify,        'rackprof/gc_notify'
+  autoload :GCObserver,      'rackprof/gc_observer'
+  autoload :RequestNotify,   'rackprof/request_notify'
+  autoload :RequestObserver, 'rackprof/request_observer'
+end
+
+require 'rackprof/rails' if defined? Rails::Railtie

data/lib/rackprof/engine.rb

@@ -0,0 +1,5 @@
+module Rackprof
+  class Engine < ::Rails::Engine
+    isolate_namespace Rackprof
+  end
+end

data/lib/rackprof/gc_notify.rb

@@ -0,0 +1,21 @@
+require 'observer'
+
+module Rackprof
+  class GCNotify
+    include Singleton
+    include Observable
+
+    def start
+      EM.run do
+        EM.add_periodic_timer(3) do
+          notify if count_observers > 0
+        end
+      end
+    end
+
+    def notify
+      changed
+      notify_observers
+    end
+  end
+end

data/lib/rackprof/gc_observer.rb

@@ -0,0 +1,7 @@
+module Rackprof
+  class GCObserver < Observer
+    def update
+      connection << "data: #{GC.stat.to_json}\n\n"
+    end
+  end
+end

data/lib/rackprof/middleware.rb

@@ -0,0 +1,17 @@
+module Rackprof
+  class Middleware
+    IGNORE_REQUESTS = /(assets|rackprof)/
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env['PATH_INFO'] !~ IGNORE_REQUESTS
+        RequestNotify.instance.notify { @app.call(env) }
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rackprof/observer.rb

@@ -0,0 +1,9 @@
+module Rackprof
+  class Observer
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+  end
+end

data/lib/rackprof/rails.rb

@@ -0,0 +1,8 @@
+module Rackprof
+  class Railtie < Rails::Railtie
+    initializer 'rackprof.initialization' do |app|
+      app.middleware.use Rackprof::Middleware
+      app.routes.append { mount Rackprof::Web => '/rackprof' }
+    end
+  end
+end

data/lib/rackprof/request_notify.rb

@@ -0,0 +1,27 @@
+require 'stackprof'
+
+module Rackprof
+  class RequestNotify
+    include Singleton
+    include Observable
+
+    def notify(&block)
+      ret = []
+
+      profile = StackProf.run(mode: :cpu) do
+        ret = block.call
+      end
+
+      if count_observers > 0
+        io = StringIO.new
+        #StackProf::Report.new(profile).print_graphviz(nil, io)
+        StackProf::Report.new(profile).print_text(false, 20, io)
+
+        changed
+        notify_observers(io.string)
+      end
+
+      ret
+    end
+  end
+end

data/lib/rackprof/request_observer.rb

@@ -0,0 +1,12 @@
+module Rackprof
+  class RequestObserver < Observer
+    def update(profile)
+      profile.split("\n").each_with_index do |line, index|
+        str = index == 0 ? "data: #{line}" : line
+        connection << "#{str}<br />"
+      end
+
+      connection << "\n\n"
+    end
+  end
+end

data/lib/rackprof/templates/assets/dashboard.css

@@ -0,0 +1,105 @@
+/*
+ * Base structure
+ */
+
+/* Move down content because we have a fixed navbar that is 50px tall */
+body {
+  padding-top: 50px;
+}
+
+
+/*
+ * Global add-ons
+ */
+
+.sub-header {
+  padding-bottom: 10px;
+  border-bottom: 1px solid #eee;
+}
+
+/*
+ * Top navigation
+ * Hide default border to remove 1px line.
+ */
+.navbar-fixed-top {
+  border: 0;
+}
+
+/*
+ * Sidebar
+ */
+
+/* Hide for mobile, show later */
+.sidebar {
+  display: none;
+}
+@media (min-width: 768px) {
+  .sidebar {
+    position: fixed;
+    top: 51px;
+    bottom: 0;
+    left: 0;
+    z-index: 1000;
+    display: block;
+    padding: 20px;
+    overflow-x: hidden;
+    overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */
+    background-color: #f5f5f5;
+    border-right: 1px solid #eee;
+  }
+}
+
+/* Sidebar navigation */
+.nav-sidebar {
+  margin-right: -21px; /* 20px padding + 1px border */
+  margin-bottom: 20px;
+  margin-left: -20px;
+}
+.nav-sidebar > li > a {
+  padding-right: 20px;
+  padding-left: 20px;
+}
+.nav-sidebar > .active > a,
+.nav-sidebar > .active > a:hover,
+.nav-sidebar > .active > a:focus {
+  color: #fff;
+  background-color: #428bca;
+}
+
+
+/*
+ * Main content
+ */
+
+.main {
+  padding: 20px;
+}
+@media (min-width: 768px) {
+  .main {
+    padding-right: 40px;
+    padding-left: 40px;
+  }
+}
+.main .page-header {
+  margin-top: 0;
+}
+
+
+/*
+ * Placeholder dashboard ideas
+ */
+
+.placeholders {
+  margin-bottom: 30px;
+  text-align: center;
+}
+.placeholders h4 {
+  margin-bottom: 0;
+}
+.placeholder {
+  margin-bottom: 20px;
+}
+.placeholder img {
+  display: inline-block;
+  border-radius: 50%;
+}

data/lib/rackprof/templates/assets/index.js

@@ -0,0 +1,152 @@
+// Chart option
+
+var options = {
+  legendTemplate : "<% for (var i=0; i<datasets.length; i++){%><li><span style=\"color:<%=datasets[i].strokeColor%>\">■</span><%if(datasets[i].label){%><%=datasets[i].label%><%}%></li><%}%>"
+};
+
+// GC count
+var gc_chart_ctx = document.getElementById('gc_chart').getContext('2d');
+var gc_chart = new Chart(gc_chart_ctx).Line({
+  labels: [],
+  datasets: [
+    {
+      label: 'minor GC count',
+      fillColor: 'rgba(220,220,220,0.2)',
+      strokeColor: 'rgba(220,220,220,1)',
+      pointColor: 'rgba(220,220,220,1)',
+      pointStrokeColor: '#fff',
+      pointHighlightFill: '#fff',
+      pointHighlightStroke: 'rgba(220,220,220,1)',
+      data: []
+    },
+    {
+      label: 'major GC Count',
+      fillColor: 'rgba(151,187,205,0.2)',
+      strokeColor: 'rgba(151,187,205,1)',
+      pointColor: 'rgba(151,187,205,1)',
+      pointStrokeColor: '#fff',
+      pointHighlightFill: '#fff',
+      pointHighlightStroke: 'rgba(151,187,205,1)',
+      data: []
+    }
+  ]
+}, options);
+
+document.getElementById('gc_legend').innerHTML = gc_chart.generateLegend();
+
+// total object
+var total_object_ctx = document.getElementById('total_object').getContext('2d');
+var total_object_chart = new Chart(total_object_ctx).Line({
+  labels: [],
+  datasets: [
+    {
+      label: 'total allocated object',
+      fillColor: 'rgba(220,220,220,0.2)',
+      strokeColor: 'rgba(220,220,220,1)',
+      pointColor: 'rgba(220,220,220,1)',
+      pointStrokeColor: '#fff',
+      pointHighlightFill: '#fff',
+      pointHighlightStroke: 'rgba(220,220,220,1)',
+      data: []
+    },
+    {
+      label: 'total freed object',
+      fillColor: 'rgba(151,187,205,0.2)',
+      strokeColor: 'rgba(151,187,205,1)',
+      pointColor: 'rgba(151,187,205,1)',
+      pointStrokeColor: '#fff',
+      pointHighlightFill: '#fff',
+      pointHighlightStroke: 'rgba(151,187,205,1)',
+      data: []
+    }
+  ]
+}, options);
+
+document.getElementById('total_object_legend').innerHTML = total_object_chart.generateLegend();
+
+
+// malloc increase
+var malloc_increase_ctx = document.getElementById('malloc_increase').getContext('2d');
+var malloc_increase_chart = new Chart(malloc_increase_ctx).Line({
+  labels: [],
+  datasets: [
+    {
+      label: 'malloc increase bytes limit',
+      fillColor: 'rgba(220,220,220,0.2)',
+      strokeColor: 'rgba(220,220,220,1)',
+      pointColor: 'rgba(220,220,220,1)',
+      pointStrokeColor: '#fff',
+      data: []
+    },
+    {
+      label: 'malloc increase bytes',
+      fillColor: 'rgba(151,187,205,0.2)',
+      strokeColor: 'rgba(151,187,205,1)',
+      pointColor: 'rgba(151,187,205,1)',
+      pointStrokeColor: '#fff',
+      data: []
+    }
+  ]
+}, options);
+
+document.getElementById('malloc_increase_legend').innerHTML = malloc_increase_chart.generateLegend();
+
+
+// old objects
+var old_objects_ctx = document.getElementById('old_objects').getContext('2d');
+var old_objects_chart = new Chart(old_objects_ctx).Line({
+  labels: [],
+  datasets: [
+    {
+      label: 'old objects limit',
+      fillColor: 'rgba(220,220,220,0.2)',
+      strokeColor: 'rgba(220,220,220,1)',
+      pointColor: 'rgba(220,220,220,1)',
+      pointStrokeColor: '#fff',
+      data: []
+    },
+    {
+      label: 'old objects',
+      fillColor: 'rgba(151,187,205,0.2)',
+      strokeColor: 'rgba(151,187,205,1)',
+      pointColor: 'rgba(151,187,205,1)',
+      pointStrokeColor: '#fff',
+      data: []
+    }
+  ]
+}, options);
+
+document.getElementById('old_objects_legend').innerHTML = old_objects_chart.generateLegend();
+
+
+// SSE
+var source = new EventSource('/rackprof/gc_stream');
+
+source.onmessage = function(event) {
+  data = JSON.parse(event.data);
+
+  var gc_data              = [data.minor_gc_count, data.major_gc_count];
+  var total_object_data    = [data.total_allocated_objects, data.total_freed_objects];
+  var malloc_increase_data = [data.malloc_increase_bytes_limit, data.malloc_increase_bytes];
+  var old_objects_data     = [data.old_objects_limit, data.old_objects];
+
+  gc_chart.addData(gc_data, new Date().getSeconds());
+  if (gc_chart.datasets[0].points.length > 10) {
+    gc_chart.removeData();
+  }
+
+  total_object_chart.addData(total_object_data, new Date().getSeconds());
+  if (total_object_chart.datasets[0].points.length > 10) {
+    total_object_chart.removeData();
+  }
+
+  malloc_increase_chart.addData(malloc_increase_data, new Date().getSeconds());
+  if (malloc_increase_chart.datasets[0].points.length > 10) {
+    malloc_increase_chart.removeData();
+  }
+
+  old_objects_chart.addData(old_objects_data, new Date().getSeconds());
+  if (old_objects_chart.datasets[0].points.length > 10) {
+    old_objects_chart.removeData();
+  }
+};