vernier 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfae18cfffd67e1e8a52c0c9de2654e7523b674d492964dfa3447c967d981e3
-  data.tar.gz: 4ff2a81a37d19f974914a0ff3fa28937302a636721b8732f7e7b282f895db9f3
+  metadata.gz: 6050bca74116d0e90f98025fe23d7fbd40c6107c085e3f768d606d4f418ebc60
+  data.tar.gz: e302542d8b06852d28d0ec1e2528f23bba46d5ef9ea9a828c9dbcdb985a292a3
 SHA512:
-  metadata.gz: bd4e4f001047bb3f20c9c0670339747b9e29abf6e44bcd77dbb38fcf7c16f42d33eef893045ab7a899b155d9b98765950e91af79864234a2d66243490d367d49
-  data.tar.gz: 14cecc8aa1058b4e38f130bed6ec1d43e8a59a636c125862ef6c61df13f885e1d76b1a142d0fa8fab16ea6bfee2642b7cd606bb562020f800ce3518b2c7fac2c
+  metadata.gz: 9d20e5f9d9c894a253bc4aeb6b9da6cb35d916e881abedf996ce19757a9cd92efe43bcc76fda0aa4ce5e334be36582adf7c716a998c4c5e1f403dc57364fb5ab
+  data.tar.gz: 7cf03df7bcb4f961b5b456eb781fd5818de7e18501baa01592ce17528f5eae7b272e90dcff200f861495ebb1a83c87f9146306db66ce20a9d56467ab87bce3c6

data/README.md

@@ -1,6 +1,22 @@
 # Vernier
 
-Experimental next-generation Ruby profiler.
+Next-generation Ruby sampling profiler. Tracks multiple threads, GVL activity, GC pauses, idle time, and more.
+
+## Examples
+
+[Livestreamed demo: Pairin' with Aaron (YouTube)](https://www.youtube.com/watch?v=9nvX3OHykGQ#t=27m43)
+
+Sidekiq jobs from Mastodon (time, threded)
+: https://share.firefox.dev/44jZRf3
+
+Puma web requests from Mastodon (time, threded)
+: https://share.firefox.dev/48FOTnF
+
+Rails benchmark - lobste.rs (time)
+: https://share.firefox.dev/3Ld89id
+
+`require "irb"` (retained memory)
+: https://share.firefox.dev/3DhLsFa
 
 ## Installation
 
@@ -10,24 +26,24 @@ gem 'vernier'
 
 ## Usage
 
-### Retained memory
 
-Record a flamegraph of all **retained** allocations from loading `irb`.
+### Time
 
 ```
-ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "irb" }'
+Vernier.trace(out: "time_profile.json") { some_slow_method }
 ```
 
-The output can then be viewed in the [Firefox Profiler (demo)](https://share.firefox.dev/3DhLsFa)
+The output can then be viewed in the Firefox Profiler (demo) or the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (a Ruby-customized version of the firefox profiler.
 
-![Screenshot 2023-07-16 at 21-06-19 Ruby_Vernier – 1970-01-01 12 00 00 a m  UTC – Firefox Profiler](https://github.com/jhawthorn/vernier/assets/131752/9ca0b593-70fb-4c8b-aed9-cb33e0e0bc06)
+### Retained memory
 
-### Time
+Record a flamegraph of all **retained** allocations from loading `irb`.
 
 ```
-Vernier.trace(out: "time_profile.json") { some_slow_method }
+ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "irb" }'
 ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/vernier

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+load "#{__dir__}/../exe/vernier"

data/examples/minitest.rb

@@ -0,0 +1,20 @@
+ENV["MT_CPU"] = "3"
+
+require "minitest/autorun"
+
+class TestMeme < Minitest::Test
+  parallelize_me!
+
+  def test_sleeping
+    sleep 1
+  end
+
+  def test_also_sleeping
+    sleep 1
+  end
+
+  def test_prime
+    require "prime"
+    assert_equal 1299709, Prime.first(100000).last
+  end
+end

data/examples/ractor.rb

@@ -0,0 +1,11 @@
+def tarai(x, y, z) =
+  x <= y ? y : tarai(tarai(x-1, y, z),
+                     tarai(y-1, z, x),
+                     tarai(z-1, x, y))
+
+require 'vernier'
+Vernier.trace(out: "ractor.json") do
+  4.times.map do
+    Ractor.new { tarai(14, 7, 0) }
+  end.each(&:take)
+end

data/examples/rails.rb

@@ -0,0 +1,125 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  rails_version = ENV["RAILS"]
+  case rails_version
+  when nil
+    gem "rails"
+  when "edge", "main"
+    gem "rails", github: "rails/rails"
+  when /\//
+    gem "rails", path: rails_version
+  else
+    gem "rails", rails_version
+  end
+  gem "sqlite3"
+  gem "vernier", path: "#{__dir__}/.."
+end
+
+require "action_controller"
+require "action_view"
+require "active_record"
+require "rails"
+
+ENV["RAILS_ENV"] = "production"
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+class MyApp < Rails::Application
+  config.load_defaults 7.0
+
+  config.eager_load = true
+  config.cache_classes = true
+  config.hosts << ->(_){ true }
+  config.secret_key_base = SecureRandom.hex
+  config.consider_all_requests_local = true
+  config.public_file_server.enabled = false
+  config.cache_store = :null_store
+  config.log_level = :warn
+  config.enable_site_error_reporting = false
+
+  logger           = ActiveSupport::Logger.new(STDOUT)
+  logger.formatter = config.log_formatter
+  config.logger    = ActiveSupport::TaggedLogging.new(logger)
+
+  routes.append do
+    root to: "home#show"
+  end
+
+  MyApp.initialize!
+end
+
+def silence(stream=STDOUT)
+  old = stream.dup
+  stream.reopen IO::NULL
+  yield
+  stream.reopen(old)
+  old.dup
+end
+
+silence do
+  ActiveRecord::Schema.define do
+    create_table :posts, force: true do |t|
+      t.string :title
+      t.text :body
+      t.integer :likes
+    end
+    create_table :comments, force: true do |t|
+      t.belongs_to :post
+      t.string :title
+      t.text :body
+      t.datetime :posted_at
+    end
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+0.upto(100) do |i|
+  post = Post.create!(title: "Post number #{i}", body: "blog " * 50, likes: ((i * 1337) % 30))
+  5.times do
+    post.comments.create!(post: post, title: "nice post!", body: "keep it up!", posted_at: Time.now)
+  end
+end
+
+class HomeController < ActionController::Base
+  def show
+    posts = Post.order(likes: :desc).includes(:comments).first(10)
+    render json: posts
+  end
+end
+
+app = Rails.application
+env = Rack::MockRequest.env_for("http://example.org/")
+make_request = -> () do
+  status, headers, body = app.call(env)
+  body.close if body.respond_to?(:close)
+  if status
+  end
+  body = body.each.to_a.join("")
+  raise body if status != 200
+  [status, headers, body]
+end
+
+# warm up
+make_request.call
+
+Vernier.trace(out: "rails.json") do |collector|
+  ActiveSupport::Notifications.monotonic_subscribe do |name, start, finish, id, payload|
+    collector.add_marker(
+      name:,
+      start: (start * 1_000_000_000).to_i,
+      finish: (finish * 1_000_000_000).to_i,
+    )
+  end
+
+  1000.times do
+    make_request.call
+  end
+end

data/exe/vernier

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+
+banner = <<-END
+Usage: vernier run [FLAGS] -- COMMAND
+
+FLAGS:
+END
+
+options = {}
+parser = OptionParser.new(banner) do |o|
+  o.on('--output [FILENAME]', String, "output filename") do |s|
+    options[:output] = s
+  end
+  o.on('--interval [MICROSECONDS]', Integer, "sampling interval (default 500)") do |i|
+    options[:interval] = i
+  end
+  o.on('--signal [NAME]', String, "specify a signal to start and stop the profiler") do |s|
+    options[:signal] = s
+  end
+  o.on('--start-paused', "don't automatically start the profiler") do
+    options[:start_paused] = true
+  end
+end
+
+parser.parse!
+parser.abort(parser.help) if ARGV.shift != "run"
+parser.abort(parser.help) if ARGV.empty?
+
+env = {}
+options.each do |k, v|
+  env["VERNIER_#{k.to_s.upcase}"] = v.to_s
+end
+vernier_path = File.expand_path('../lib', __dir__)
+env['RUBYOPT'] = "-I #{vernier_path} -r vernier/autorun #{ENV['RUBYOPT']}"
+
+Kernel.exec(env, *ARGV)