estackprof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fb2e9ab5ae1157f4f88c4ddf9091aba225e97036725c1641598df88a9959c91
+  data.tar.gz: b9b994ef293a0f97df4a1a2c72395fd2d2765e7023ce4cf4e86e19898137bf12
+SHA512:
+  metadata.gz: 8e98f8ebe4b4051c418e6f75d7f93aab8a40b0d6a1cf9f02d24d00b0ae5909371a020c1c59d76a3de243cbe0f0b16c98d18627ac40d4977c6870cbeccc7fff63
+  data.tar.gz: 0e5de4a47cd8217c29b4fd8956796a14674bfab44992b7e58e9152e619d870bd20ef343cec94dc6e4865dbc1e2c534f11031b008791f416a49db712748d88b2d

data/.circleci/config.yml

@@ -0,0 +1,28 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:3.0.1
+    steps:
+      - checkout
+      - restore_cache:
+          name: Restore bundle cache
+          keys:
+            - bundle-{{ arch }}-{{ checksum "Gemfile" }}-{{ checksum "estackprof.gemspec" }}
+            - bundle-{{ arch }}-{{ checksum "Gemfile" }}
+            - bundle-{{ arch }}
+            - bundle
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - save_cache:
+          name: Store bundle cache
+          key: bundle-{{ arch }}-{{ checksum "Gemfile" }}-{{ checksum "estackprof.gemspec" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+      - run:
+          name: RSpec
+          command: bundle exec rspec

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/vendor/bundle/
+Gemfile.lock
+
+/example/vendor/bundle/
+/example/bundle/
+
+# rspec failure tracking
+.rspec_status
+
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+Security/MarshalLoad:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in estackprof.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+group :development do
+  gem 'guard-rubocop'
+  gem 'pry'
+  gem 'rubocop'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+  gem 'sinatra'
+  gem 'webrick'
+end
+
+group :test do
+  gem 'aruba', '~> 2.0.0'
+  gem 'guard-rspec'
+  gem 'rspec', '~> 3.0'
+end

data/Guardfile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+  dsl.watch_spec_files_for(%r{^(exe/.+)\.rb$})
+end
+
+guard :rubocop, cli: %w[-a] do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -0,0 +1,150 @@
+# Estackprof
+
+Estackprof is a wrapper to make it easier to use [Stackprof](https://github.com/tmm1/stackprof) in your rack application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'estackprof'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install estackprof
+
+## Usage
+
+### Profiling
+
+Add the following code to your rack application to enable the rack middleware.
+`Estackprof::Middleware` supports the same options as `StackProf::Middleware`.
+
+```ruby
+require 'estackprof'
+
+use Estackprof::Middleware
+
+# ...your rack application
+```
+
+### Reporting
+
+Use the CLI to report.
+
+```sh
+# Report the top 3 frames
+$ estackprof top -l 3
+==================================
+  Mode: cpu(1000)
+  Samples: 516 (0.00% miss rate)
+  GC: 77 (14.92%)
+==================================
+     TOTAL    (pct)     SAMPLES    (pct)     FRAME
+       434  (84.1%)         434  (84.1%)     Object#bubble_sort(example/app.rb:9)
+        45   (8.7%)          45   (8.7%)     (sweeping)
+        31   (6.0%)          31   (6.0%)     (marking)
+
+# Report the top 3 cumlative frames
+$ estackprof top -l 3 -c
+==================================
+  Mode: cpu(1000)
+  Samples: 516 (0.00% miss rate)
+  GC: 77 (14.92%)
+==================================
+     TOTAL    (pct)     SAMPLES    (pct)     FRAME
+       439  (85.1%)           0   (0.0%)     Rack::MethodOverride#call(vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/method_override.rb:15)
+       439  (85.1%)           0   (0.0%)     Sinatra::ExtendedRack#call(vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb:215)
+       439  (85.1%)           0   (0.0%)     Sinatra::Wrapper#call(vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb:1990)
+
+# Report the top frames filtered by patten(file name).
+$ estackprof top -p app.rb
+==================================
+  Mode: cpu(1000)
+  Samples: 516 (0.00% miss rate)
+  GC: 77 (14.92%)
+==================================
+     TOTAL    (pct)     SAMPLES    (pct)     FRAME
+       434  (84.1%)         434  (84.1%)     Object#bubble_sort(example/app.rb:9)
+       438  (84.9%)           0   (0.0%)     block in <main>(example/app.rb:23)
+
+# Report the top frames filtered by patten(method name).
+$ estackprof top -p bubble
+==================================
+  Mode: cpu(1000)
+  Samples: 516 (0.00% miss rate)
+  GC: 77 (14.92%)
+==================================
+     TOTAL    (pct)     SAMPLES    (pct)     FRAME
+       434  (84.1%)         434  (84.1%)     Object#bubble_sort(example/app.rb:9)
+
+# Report the list in the specified file.
+$ estackprof list -f app.rb
+                                  |     1  | # frozen_string_literal: true
+                                  |     2  | 
+                                  |     3  | require 'sinatra'
+                                  |     4  | require 'json'
+                                  |     5  | require 'estackprof'
+                                  |     6  | 
+                                  |     7  | use Estackprof::Middleware
+                                  |     8  | 
+                                  |     9  | def bubble_sort(array)
+                                  |    10  |   ary = array.dup
+                                  |    11  |   pos_max = ary.size - 1
+                                  |    12  | 
+  434   (84.1%)                   |    13  |   (0...pos_max).each do |n|
+  433   (83.9%)                   |    14  |     (0...(pos_max - n)).each do |ix|
+                                  |    15  |       iy = ix + 1
+  139   (26.9%) /   139  (26.9%)  |    16  |       ary[ix], ary[iy] = ary[iy], ary[ix] if ary[ix] > ary[iy]
+  294   (57.0%) /   294  (57.0%)  |    17  |     end
+    1    (0.2%) /     1   (0.2%)  |    18  |   end
+                                  |    19  | 
+                                  |    20  |   ary
+                                  |    21  | end
+                                  |    22  | 
+                                  |    23  | get '/' do
+                                  |    24  |   array = Array.new(1000) { rand(10_000) }
+  438   (84.9%)                   |    25  |   bubble_sort(array).to_s
+                                  |    26  | end
+
+# Report the list in the specified method.
+$ estackprof list -m bubble
+Object#bubble_sort (/estackprof/example/app.rb:9)
+  samples:   434 self (84.1%)  /    434 total (84.1%)
+  callers:
+     867  (  199.8%)  Range#each
+     434  (  100.0%)  block in <main>
+  callees (0 total):
+     867  (    Inf%)  Range#each
+  code:
+                                  |     9  | def bubble_sort(array)
+                                  |    10  |   ary = array.dup
+                                  |    11  |   pos_max = ary.size - 1
+                                  |    12  | 
+  434   (84.1%)                   |    13  |   (0...pos_max).each do |n|
+  433   (83.9%)                   |    14  |     (0...(pos_max - n)).each do |ix|
+                                  |    15  |       iy = ix + 1
+  139   (26.9%) /   139  (26.9%)  |    16  |       ary[ix], ary[iy] = ary[iy], ary[ix] if ary[ix] > ary[iy]
+  294   (57.0%) /   294  (57.0%)  |    17  |     end
+    1    (0.2%) /     1   (0.2%)  |    18  |   end
+                                  |    19  |
+
+# Display the flamegraph
+$ estackprof flamegraph
+#=> Open flamegraph in your browser.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/estackprof.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'estackprof'
+
+# 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(__FILE__)

data/bin/setup

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

data/estackprof.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/estackprof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'estackprof'
+  spec.version       = Estackprof::VERSION
+  spec.authors       = ['Yuhei Okazaki']
+  spec.email         = ['okazaki@fusic.co.jp']
+
+  spec.summary       = 'We want to make stackprof easier to use.'
+  spec.description   = 'Estackprof is a wrapper to make it easier to use Stackprof in your rack application'
+  spec.homepage      = 'https://github.com/fusic/estackprof'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fusic/estackprof'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'launchy'
+  spec.add_dependency 'stackprof', '~> 0.2'
+  spec.add_dependency 'thor', '~> 1.1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/example/app.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sinatra'
+require 'json'
+require 'estackprof'
+
+use Estackprof::Middleware
+
+def bubble_sort(array)
+  ary = array.dup
+  pos_max = ary.size - 1
+
+  (0...pos_max).each do |n|
+    (0...(pos_max - n)).each do |ix|
+      iy = ix + 1
+      ary[ix], ary[iy] = ary[iy], ary[ix] if ary[ix] > ary[iy]
+    end
+  end
+
+  ary
+end
+
+get '/' do
+  array = Array.new(1000) { rand(10_000) }
+  bubble_sort(array).to_s
+end

data/exe/estackprof

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'estackprof'
+
+Estackprof::CLI.start(ARGV)

data/flamegraph.html

@@ -0,0 +1,153 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@2.0.3/dist/d3-flamegraph.css">
+
+    <style>
+
+    /* Space out content a bit */
+    body {
+      padding-top: 20px;
+      padding-bottom: 20px;
+    }
+
+    /* Custom page header */
+    .header {
+      padding-bottom: 20px;
+      padding-right: 15px;
+      padding-left: 15px;
+      border-bottom: 1px solid #e5e5e5;
+    }
+
+    /* Make the masthead heading the same height as the navigation */
+    .header h3 {
+      margin-top: 0;
+      margin-bottom: 0;
+      line-height: 40px;
+    }
+
+    /* Customize container */
+    .container {
+      max-width: 990px;
+    }
+
+    address {
+      text-align: right;
+    }
+    </style>
+
+    <title>stackprof (mode: cpu)</title>
+
+    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="container">
+      <div class="header clearfix">
+        <nav>
+          <div class="pull-right">
+            <form class="form-inline" id="form">
+              <a class="btn" href="javascript: resetZoom();">Reset zoom</a>
+              <a class="btn" href="javascript: clear();">Clear</a>
+              <div class="form-group">
+                <input type="text" class="form-control" id="term">
+              </div>
+              <a class="btn btn-primary" href="javascript: search();">Search</a>
+            </form>
+          </div>
+        </nav>
+        <h3 class="text-muted">stackprof (mode: cpu)</h3>
+      </div>
+      <div id="chart">
+      </div>
+      <address>
+        powered by <a href="https://github.com/spiermar/d3-flame-graph">d3-flame-graph</a>
+      </address>
+      <hr>
+      <div id="details">
+      </div>
+    </div>
+
+    <!-- D3.js -->
+    <script src="https://d3js.org/d3.v4.min.js" charset="utf-8"></script>
+
+    <!-- d3-tip -->
+    <script type="text/javascript" src=https://cdnjs.cloudflare.com/ajax/libs/d3-tip/0.9.1/d3-tip.min.js></script>
+
+    <!-- d3-flamegraph -->
+    <script type="text/javascript" src="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@2.0.3/dist/d3-flamegraph.min.js"></script>
+
+    <script type="text/javascript">
+    var flameGraph = d3.flamegraph()
+      .width(960)
+      .cellHeight(18)
+      .transitionDuration(750)
+      .minFrameSize(5)
+      .transitionEase(d3.easeCubic)
+      .sort(true)
+      //Example to sort in reverse order
+      //.sort(function(a,b){ return d3.descending(a.name, b.name);})
+      .title("")
+      .onClick(onClick)
+      .differential(false)
+      .selfValue(false);
+
+
+    // Example on how to use custom tooltips using d3-tip.
+    // var tip = d3.tip()
+    //   .direction("s")
+    //   .offset([8, 0])
+    //   .attr('class', 'd3-flame-graph-tip')
+    //   .html(function(d) { return "name: " + d.data.name + ", value: " + d.data.value; });
+
+    // flameGraph.tooltip(tip);
+
+    var details = document.getElementById("details");
+    flameGraph.setDetailsElement(details);
+
+    // Example on how to use custom labels
+    // var label = function(d) {
+    //  return "name: " + d.name + ", value: " + d.value;
+    // }
+    // flameGraph.label(label);
+
+    // Example of how to set fixed chart height
+    // flameGraph.height(540);
+
+    d3.select("#chart")
+        .datum({"name":"<root>","value":278,"children":[{"name":"(garbage collection) : ","value":36,"children":[{"name":"(marking) : ","value":12,"children":[]},{"name":"(sweeping) : ","value":24,"children":[]}]},{"name":"WEBrick::GenericServer#start_thread : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/server.rb","value":241,"children":[{"name":"WEBrick::HTTPServer#run : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/httpserver.rb","value":241,"children":[{"name":"WEBrick::HTTPServer#service : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/httpserver.rb","value":241,"children":[{"name":"Rack::Handler::WEBrick#service : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/handler/webrick.rb","value":241,"children":[{"name":"Sinatra::Base.call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Base.synchronize : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Base.call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Wrapper#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::ExtendedRack#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::ShowExceptions#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/show_exceptions.rb","value":241,"children":[{"name":"Rack::MethodOverride#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/method_override.rb","value":241,"children":[{"name":"Rack::Head#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/head.rb","value":241,"children":[{"name":"Sinatra::CommonLogger#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Rack::CommonLogger#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Rack::CommonLogger#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/common_logger.rb","value":241,"children":[{"name":"Rack::Logger#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/logger.rb","value":241,"children":[{"name":"Rack::Protection::FrameOptions#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-protection-2.1.0/lib/rack/protection/frame_options.rb","value":241,"children":[{"name":"Rack::Protection::Base#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-protection-2.1.0/lib/rack/protection/base.rb","value":241,"children":[{"name":"Rack::Protection::Base#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-protection-2.1.0/lib/rack/protection/base.rb","value":241,"children":[{"name":"Rack::Protection::JsonCsrf#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-protection-2.1.0/lib/rack/protection/json_csrf.rb","value":241,"children":[{"name":"Rack::Protection::PathTraversal#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-protection-2.1.0/lib/rack/protection/path_traversal.rb","value":241,"children":[{"name":"Rack::Protection::XSSHeader#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-protection-2.1.0/lib/rack/protection/xss_header.rb","value":241,"children":[{"name":"StackProf::Middleware#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/stackprof-0.2.17/lib/stackprof/middleware.rb","value":241,"children":[{"name":"Sinatra::Base#call : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Base#call! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Base#invoke : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Kernel#catch : <cfunc>","value":241,"children":[{"name":"Sinatra::Base#invoke : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Base#call! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Base#dispatch! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":241,"children":[{"name":"Sinatra::Request#params : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":1,"children":[{"name":"Rack::Request#params : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/request.rb","value":1,"children":[{"name":"Rack::Request::Helpers#params : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/request.rb","value":1,"children":[{"name":"Rack::Request::Helpers#POST : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/request.rb","value":1,"children":[{"name":"Rack::Request::Helpers#form_data? : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/request.rb","value":1,"children":[{"name":"Rack::Request::Helpers#media_type : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/request.rb","value":1,"children":[{"name":"Kernel#require : <cfunc>","value":1,"children":[{"name":"<top (required)> : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/media_type.rb","value":1,"children":[{"name":"<module:Rack> : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/media_type.rb","value":1,"children":[{"name":"Class#inherited : <cfunc>","value":1,"children":[]}]}]}]}]}]}]}]}]}]},{"name":"Sinatra::Base#invoke : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":240,"children":[{"name":"Kernel#catch : <cfunc>","value":238,"children":[{"name":"Sinatra::Base#invoke : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base#dispatch! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base#route! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Array#each : <cfunc>","value":238,"children":[{"name":"Sinatra::Base#route! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base#process_route : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Kernel#catch : <cfunc>","value":238,"children":[{"name":"Sinatra::Base#process_route : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base#route! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base#route_eval : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base#route! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Sinatra::Base.compile! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":238,"children":[{"name":"Method#call : <cfunc>","value":238,"children":[{"name":"block in <main> : /Users/yokazaki/src/github.com/fusic/estackprof/example/app.rb","value":238,"children":[{"name":"Object#bubble_sort : /Users/yokazaki/src/github.com/fusic/estackprof/example/app.rb","value":237,"children":[{"name":"Range#each : <cfunc>","value":237,"children":[{"name":"Object#bubble_sort : /Users/yokazaki/src/github.com/fusic/estackprof/example/app.rb","value":237,"children":[{"name":"Range#each : <cfunc>","value":237,"children":[{"name":"Object#bubble_sort : /Users/yokazaki/src/github.com/fusic/estackprof/example/app.rb","value":237,"children":[]}]}]}]}]},{"name":"Array#inspect : <cfunc>","value":1,"children":[{"name":"Integer#to_s : <cfunc>","value":1,"children":[]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]},{"name":"Sinatra::Helpers#body : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":2,"children":[{"name":"Kernel#require : <cfunc>","value":1,"children":[{"name":"<top (required)> : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/file.rb","value":1,"children":[{"name":"Kernel#require_relative : <cfunc>","value":1,"children":[]}]}]},{"name":"Kernel#block_given? : <cfunc>","value":1,"children":[]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]},{"name":"<main> : example/app.rb","value":1,"children":[{"name":"block in <module:Sinatra> : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/main.rb","value":1,"children":[{"name":"Sinatra::Base.run! : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":1,"children":[{"name":"Sinatra::Base.start_server : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/sinatra-2.1.0/lib/sinatra/base.rb","value":1,"children":[{"name":"Rack::Handler::WEBrick.run : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/rack-2.2.3/lib/rack/handler/webrick.rb","value":1,"children":[{"name":"WEBrick::GenericServer#start : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/server.rb","value":1,"children":[{"name":"WEBrick::SimpleServer.start : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/server.rb","value":1,"children":[{"name":"WEBrick::GenericServer#start : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/server.rb","value":1,"children":[{"name":"Array#each : <cfunc>","value":1,"children":[{"name":"WEBrick::GenericServer#start : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/server.rb","value":1,"children":[{"name":"WEBrick::GenericServer#start_thread : /Users/yokazaki/src/github.com/fusic/estackprof/vendor/bundle/ruby/3.0.0/gems/webrick-1.7.0/lib/webrick/server.rb","value":1,"children":[{"name":"Thread.start : <cfunc>","value":1,"children":[]}]}]}]}]}]}]}]}]}]}]}]}]})
+        .call(flameGraph);
+
+    document.getElementById("form").addEventListener("submit", function(event){
+      event.preventDefault();
+      search();
+    });
+
+    function search() {
+      var term = document.getElementById("term").value;
+      flameGraph.search(term);
+    }
+
+    function clear() {
+      document.getElementById('term').value = '';
+      flameGraph.clear();
+    }
+
+    function resetZoom() {
+      flameGraph.resetZoom();
+    }
+
+    function onClick(d) {
+      console.info("Clicked on " + d.data.name);
+    }
+    </script>
+  </body>
+</html>

data/lib/estackprof/cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'pry'
+require 'estackprof'
+
+module Estackprof
+  class CLI < Thor
+    class_option :debug, type: :boolean, aliases: '-d', desc: 'debug mode'
+
+    desc 'top [OPTIONS] [FILE...]', 'Report to top of methods'
+    option :limit, aliases: '-l', desc: 'Limit reports.', type: :numeric
+    option :pattern, aliases: '-p', desc: 'Filter reports by pattern match.'
+    option :cumlative, aliases: '-c', desc: 'Sort by cumulative count.', type: :boolean
+    def top(*files)
+      puts Estackprof.top(
+        files: files.empty? ? Dir.glob('./tmp/*.dump') : files,
+        options: options
+      )
+      exit
+    rescue StandardError => e
+      output_error_if_debug_mode(e)
+      exit(-1)
+    end
+
+    desc 'list [OPTIONS] [FILE...]', 'Display sample counts of each line'
+    option :file, aliases: '-f', desc: 'Filter by file name.'
+    option :method, aliases: '-m', desc: 'Filter by method name'
+    def list(*files)
+      puts Estackprof.list(
+        files: files.empty? ? Dir.glob('./tmp/*.dump') : files,
+        options: options
+      )
+      exit
+    rescue StandardError => e
+      output_error_if_debug_mode(e)
+      exit(-1)
+    end
+
+    desc 'flamegraph [OPTIONS] [FILE]', 'Generate and open flamegraph'
+    def flamegraph(*files)
+      puts Estackprof.flamegraph(
+        files: files.empty? ? Dir.glob('./tmp/*.dump') : files
+      )
+      exit
+    rescue StandardError => e
+      output_error_if_debug_mode(e)
+      exit(-1)
+    end
+
+    map %w[--version -v] => :version
+    desc 'version', 'version'
+    def version
+      puts Estackprof::VERSION
+    end
+
+    private
+
+    def output_error_if_debug_mode(exception)
+      return unless options[:debug]
+
+      warn(exception.message)
+      warn(exception.backtrace)
+    end
+
+    class << self
+      private
+
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/estackprof/flamegraph.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'stackprof'
+require 'launchy'
+
+module Estackprof
+  def flamegraph(files:)
+    mkdir(tmp_path = './tmp')
+    html_path = File.expand_path("#{tmp_path}/flamegraph.html")
+    File.open(html_path, 'w') { |f| Report.create([files[0]]).print_d3_flamegraph(f) }
+    Launchy.open(html_path)
+    html_path
+  rescue StandardError
+    puts 'Dump files are missing or incorrect.'
+  end
+
+  private
+
+  def mkdir(path)
+    FileUtils.mkdir_p(path) unless FileTest.exist?(path)
+  end
+
+  module_function :flamegraph, :mkdir
+end

data/lib/estackprof/list.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'stackprof'
+
+module Estackprof
+  def list(files:, options:)
+    io = StringIO.new
+
+    print_by_options(Report.create(files), options, io)
+
+    io.rewind
+    io.read.to_s
+  rescue StandardError
+    puts 'Dump files are missing or incorrect.'
+  end
+
+  private
+
+  def print_by_options(report, options, io)
+    if options[:method]
+      report.print_method(options[:method], io)
+    elsif options[:file]
+      report.print_file(options[:file], io)
+    else
+      report.print_files(false, nil, io)
+    end
+  end
+
+  module_function :list, :print_by_options
+end

data/lib/estackprof/middleware.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'stackprof'
+
+module Estackprof
+  class Middleware < StackProf::Middleware
+    def initialize(app, options = {})
+      options[:enabled] = true if options[:enabled].nil?
+      options[:raw] = true if options[:raw].nil?
+      options[:save_every] ||= 10
+
+      super(app, **options)
+    end
+
+    class << self
+      %i[enabled mode interval raw path metadata].each do |sym|
+        define_method(sym) do
+          StackProf::Middleware.send(sym)
+        end
+        define_method("#{sym}=") do |value|
+          StackProf::Middleware.send("#{sym}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/estackprof/report.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'stackprof'
+
+module Estackprof
+  class Report < StackProf::Report
+    def self.create(files)
+      reports = files.map do |file|
+        new(Marshal.load(IO.binread(file)))
+      end
+      reports.inject(:+)
+    end
+
+    def print_text(limit:, pattern:, sort_by_total: false, out: $stdout)
+      print_summary(out)
+      print_header(out)
+
+      list = frames(sort_by_total)
+      if pattern
+        list = list.filter do |_frame, info|
+          %i[file name].any? { |s| info[s].match?(pattern) }
+        end
+      end
+      list = list.first(limit) if limit
+      print_body(list, out)
+    end
+
+    private
+
+    def print_summary(out)
+      out.puts '=================================='
+      out.printf "  Mode: #{modeline}\n"
+      print_summary_samples(out)
+      print_summary_gc(out)
+      out.puts '=================================='
+    end
+
+    def print_summary_samples(out)
+      out.printf "  Samples: #{@data[:samples]} (%.2f%% miss rate)\n",
+                 100.0 * @data[:missed_samples] / (@data[:missed_samples] + @data[:samples])
+    end
+
+    def print_summary_gc(out)
+      out.printf "  GC: #{@data[:gc_samples]} (%.2f%%)\n", 100.0 * @data[:gc_samples] / @data[:samples]
+    end
+
+    def print_header(out)
+      out.printf format("%<total>10s    (pct)  %<samples>10s    (pct)     FRAME\n", total: 'TOTAL', samples: 'SAMPLES')
+    end
+
+    def print_body(list, out)
+      list.each do |_frame, info|
+        call, total = info.values_at(:samples, :total_samples)
+        out.printf(
+          "%<total>10d %<total_pct>8s  %<samples>10d %<samples_pct>8s     %<frame>s\n",
+          total: total, total_pct: format('(%2.1f%%)', (total * 100.0 / overall_samples)),
+          samples: call, samples_pct: format('(%2.1f%%)', (call * 100.0 / overall_samples)),
+          frame: frame(info[:name], info[:file], info[:line])
+        )
+      end
+    end
+
+    def frame(name, file, line)
+      file_path = name
+      begin
+        file_path += "(#{Pathname(file).relative_path_from(Dir.pwd)}:#{line})"
+      rescue StandardError
+        # NOP
+      end
+      file_path
+    end
+  end
+end

data/lib/estackprof/top.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'stackprof'
+
+module Estackprof
+  def top(files:, options:)
+    io = StringIO.new
+    Report.create(files).print_text(**parse_options(options), out: io)
+    io.rewind
+    io.read.to_s
+  rescue StandardError
+    puts 'Dump files are missing or incorrect.'
+  end
+
+  private
+
+  def parse_options(options)
+    limit = options[:limit] || 10
+    pattern = options[:pattern] && Regexp.new(options[:pattern])
+    sort_by_total = options[:cumlative]
+    { limit: limit, pattern: pattern, sort_by_total: sort_by_total }
+  end
+
+  module_function :top, :parse_options
+end

data/lib/estackprof/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Estackprof
+  VERSION = '0.1.0'
+end

data/lib/estackprof.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'estackprof/cli'
+require_relative 'estackprof/top'
+require_relative 'estackprof/list'
+require_relative 'estackprof/flamegraph'
+require_relative 'estackprof/version'
+require_relative 'estackprof/report'
+require_relative 'estackprof/middleware'
+
+module Estackprof
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: estackprof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuhei Okazaki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Estackprof is a wrapper to make it easier to use Stackprof in your rack
+  application
+email:
+- okazaki@fusic.co.jp
+executables:
+- estackprof
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- estackprof.gemspec
+- example/app.rb
+- exe/estackprof
+- flamegraph.html
+- lib/estackprof.rb
+- lib/estackprof/cli.rb
+- lib/estackprof/flamegraph.rb
+- lib/estackprof/list.rb
+- lib/estackprof/middleware.rb
+- lib/estackprof/report.rb
+- lib/estackprof/top.rb
+- lib/estackprof/version.rb
+homepage: https://github.com/fusic/estackprof
+licenses: []
+metadata:
+  homepage_uri: https://github.com/fusic/estackprof
+  source_code_uri: https://github.com/fusic/estackprof
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: We want to make stackprof easier to use.
+test_files: []