ruby-prof 1.7.2 → 2.0.1

data/docs/profiling-rails.md

@@ -0,0 +1,64 @@
+# Profiling Rails
+
+To profile a Rails application it is vital to run it using production-like settings (cache classes, cache view lookups, etc.). Otherwise, Rails dependency loading code will overwhelm any time spent in the application itself (our tests show that Rails dependency loading causes a roughly 6x slowdown). The best way to do this is to create a new Rails environment, `profile`.
+
+To profile Rails:
+
+1. Add ruby-prof to your Gemfile:
+
+   ```ruby
+   group :profile do
+     gem 'ruby-prof'
+   end
+   ```
+
+   Then install it:
+
+   ```bash
+   bundle install
+   ```
+
+2. Create `config/environments/profile.rb` with production-like settings and the ruby-prof middleware:
+
+   ```ruby
+   # config/environments/profile.rb
+   require_relative "production"
+
+   Rails.application.configure do
+     # Optional: reduce noise while profiling.
+     config.log_level = :warn
+
+     # Optional: disable controller/view caching if you want raw app execution timing.
+     config.action_controller.perform_caching = false
+
+     config.middleware.use Rack::RubyProf, path: Rails.root.join("tmp/profile")
+   end
+   ```
+
+   By default the rack adapter generates flat text, graph text, graph HTML, and call stack HTML reports.
+
+3. Start Rails in the profile environment:
+
+   ```bash
+   bin/rails server -e profile
+   ```
+
+   You can run a console in the same environment with:
+
+   ```bash
+   bin/rails console -e profile
+   ```
+
+4. Make a request to generate profile output:
+
+   ```bash
+   curl http://127.0.0.1:3000/
+   ```
+
+5. Inspect reports in `tmp/profile`:
+
+   ```bash
+   ls -1 tmp/profile
+   ```
+
+   Reports are generated per request path. Repeating the same request path overwrites the previous report files for that path.

data/docs/public/examples/example.rb

@@ -0,0 +1,33 @@
+# A small synthetic workload for demonstrating ruby-prof reports.
+# word_freq.rb
+
+def normalize(text)
+  text.downcase.gsub(/[^a-z\s]/, "")
+end
+
+def tokenize(text)
+  text.split(/\s+/)
+end
+
+def count_words(words)
+  counts = Hash.new(0)
+  words.each { |w| counts[w] += 1 }
+  counts
+end
+
+def top_words(counts, n = 10)
+  counts.sort_by { |_, v| -v }.take(n)
+end
+
+def run_example
+  text = <<~EOS * 200
+  Ruby is a dynamic, open source programming language with a focus on
+  simplicity and productivity. It has an elegant syntax that is natural
+  to read and easy to write.
+EOS
+
+  normalized = normalize(text)
+  tokens     = tokenize(normalized)
+  counts     = count_words(tokens)
+  top        = top_words(counts)
+end

data/docs/public/examples/generate_reports.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Generates example reports for all ruby-prof printers.
+# Usage: ruby docs/public/examples/generate_reports.rb
+
+# To make testing/debugging easier test within this source tree versus an installed gem
+require 'bundler/setup'
+
+# Add ext directory to load path to make it easier to test locally built extensions
+ext_path = File.expand_path(File.join(__dir__, '..', '..', '..', 'ext', 'ruby_prof'))
+$LOAD_PATH.unshift(ext_path)
+
+require 'fileutils'
+require 'stringio'
+require 'uri'
+require 'ruby-prof'
+require_relative 'example'
+
+output_dir = File.join(File.dirname(__FILE__), "reports")
+FileUtils.mkdir_p(output_dir)
+
+def sanitize_local_file_links(path)
+  content = File.read(path)
+  content.gsub!(%r{href="file://[^"]*/docs/public/examples/([^"#]+)#\d+"}, 'href="../\1"')
+  content.gsub!(%r{title=".*?/docs/public/examples/([^":]+):\d+"}, 'title="\1"')
+  content.gsub!(%r{href="file://[^"]+"}, 'href="#"')
+  content.gsub!(%r{title="[^"]*(?:<internal:|&lt;internal:)[^"]+"}, 'title="internal"')
+  File.write(path, content)
+end
+
+result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+  run_example
+end
+
+# Flame Graph
+File.open(File.join(output_dir, "flame_graph.html"), "wb") do |f|
+  RubyProf::FlameGraphPrinter.new(result).print(f)
+end
+
+# Call Stack
+File.open(File.join(output_dir, "call_stack.html"), "wb") do |f|
+  RubyProf::CallStackPrinter.new(result).print(f)
+end
+sanitize_local_file_links(File.join(output_dir, "call_stack.html"))
+
+# Graph HTML
+File.open(File.join(output_dir, "graph.html"), "wb") do |f|
+  RubyProf::GraphHtmlPrinter.new(result).print(f)
+end
+sanitize_local_file_links(File.join(output_dir, "graph.html"))
+
+# Graph (text)
+File.open(File.join(output_dir, "graph.txt"), "wb") do |f|
+  RubyProf::GraphPrinter.new(result).print(f)
+end
+
+# Flat
+File.open(File.join(output_dir, "flat.txt"), "wb") do |f|
+  RubyProf::FlatPrinter.new(result).print(f)
+end
+
+# Call Info
+File.open(File.join(output_dir, "call_info.txt"), "wb") do |f|
+  RubyProf::CallInfoPrinter.new(result).print(f)
+end
+
+# Dot
+dot_io = StringIO.new
+RubyProf::DotPrinter.new(result).print(dot_io)
+dot_content = dot_io.string
+File.open(File.join(output_dir, "graph.dot"), "wb") do |f|
+  f << dot_content
+end
+
+# Graphviz Online viewer with dot content embedded in URL
+viewer_url = "https://dreampuf.github.io/GraphvizOnline/?engine=dot#" + URI.encode_uri_component(dot_content)
+File.open(File.join(output_dir, "graphviz_viewer.html"), "wb") do |f|
+  f << %(<html><head><meta http-equiv="refresh" content="0;url=#{viewer_url}"></head></html>)
+end
+
+# Call Tree (calltree format)
+RubyProf::CallTreePrinter.new(result).print(path: output_dir, profile: "profile")
+# Rename PID-based filename to a stable name
+Dir.glob(File.join(output_dir, "callgrind.out.*")).each do |f|
+  FileUtils.mv(f, File.join(output_dir, "callgrind.out"))
+end
+
+puts "Reports written to #{output_dir}/"
+Dir.glob(File.join(output_dir, "*")).sort.each do |f|
+  puts "  #{File.basename(f)}"
+end

data/docs/public/examples/reports/call_info.txt

@@ -0,0 +1,27 @@
+----------------------------------------------------
+Thread ID: 464
+Fiber ID: 456
+Total Time: 0.007774999990942888
+Sort by: 
+
+[global]# (tt:0.01, st:0.00, wt:0.00, ct:0.01, call:1, )
+  Object#run_example (tt:0.01, st:0.00, wt:0.00, ct:0.01, call:1, )
+    String#* (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+    Object#normalize (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+      String#downcase (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+      String#gsub (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+    Object#tokenize (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+      String#split (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+    Object#count_words (tt:0.01, st:0.00, wt:0.00, ct:0.01, call:1, )
+      Hash#initialize (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+      Array#each (tt:0.01, st:0.00, wt:0.00, ct:0.00, call:1, )
+        Hash#[] (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:5800, )
+        Integer#+ (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:5800, )
+        Hash#[]= (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:5800, )
+    Object#top_words (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+      Enumerable#sort_by (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+        Hash#each (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+          Integer#-@ (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:25, )
+      Array#take (tt:0.00, st:0.00, wt:0.00, ct:0.00, call:1, )
+
+