vernier 0.6.0 → 0.8.0

data/lib/vernier/autorun.rb

@@ -18,10 +18,11 @@ module Vernier
     def self.start
       interval = options.fetch(:interval, 500).to_i
       allocation_sample_rate = options.fetch(:allocation_sample_rate, 0).to_i
+      hooks = options.fetch(:hooks, "").split(",")
 
       STDERR.puts("starting profiler with interval #{interval}")
 
-      @collector = Vernier::Collector.new(:wall, interval:, allocation_sample_rate:)
+      @collector = Vernier::Collector.new(:wall, interval:, allocation_sample_rate:, hooks:)
       @collector.start
     end
 

data/lib/vernier/collector.rb

@@ -5,8 +5,14 @@ require_relative "thread_names"
 
 module Vernier
   class Collector
-    def initialize(mode, options={})
+    def initialize(mode, options = {})
+      if options.fetch(:gc, true) && (mode == :retained)
+        GC.start
+      end
+
       @mode = mode
+      @out = options[:out]
+
       @markers = []
       @hooks = []
 
@@ -23,11 +29,11 @@ module Vernier
     end
 
     private def add_hook(hook)
-      case hook
+      case hook.to_sym
       when :rails, :activesupport
         @hooks << Vernier::Hooks::ActiveSupport.new(self)
       else
-        warn "Unknown hook: #{hook}"
+        warn "Unknown hook: #{hook.inspect}"
       end
     end
 
@@ -69,6 +75,7 @@ module Vernier
     def stop
       result = finish
 
+      result.instance_variable_set("@stack_table", stack_table.to_h)
       @thread_names.finish
 
       @hooks.each do |hook|
@@ -99,6 +106,10 @@ module Vernier
 
       result.instance_variable_set(:@markers, markers)
 
+      if @out
+        result.write(out: @out)
+      end
+
       result
     end
   end

data/lib/vernier/hooks/active_support.rb

@@ -7,9 +7,12 @@ module Vernier
         {
           name: "sql.active_record",
           display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: "{marker.data.name}",
+          chartLabel: "{marker.data.name}",
+          tableLabel: "{marker.data.sql}",
           data: [
-            { key: "sql", format: "string" },
-            { key: "name", format: "string" },
+            { key: "sql", format: "string", searchable: true },
+            { key: "name", format: "string", searchable: true },
             { key: "type_casted_binds", label: "binds", format: "string"
             }
           ]
@@ -17,25 +20,50 @@ module Vernier
         {
           name: "instantiation.active_record",
           display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: "{marker.data.record_count} × {marker.data.class_name}",
+          chartLabel: "{marker.data.record_count} × {marker.data.class_name}",
+          tableLabel: "Instantiate {marker.data.record_count} × {marker.data.class_name}",
           data: [
             { key: "record_count", format: "integer" },
             { key: "class_name", format: "string" }
           ]
         },
+        {
+          name: "start_processing.action_controller",
+          display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.method} {marker.data.controller}#{marker.data.action}',
+          chartLabel:   '{marker.data.method} {marker.data.controller}#{marker.data.action}',
+          tableLabel:   '{marker.data.method} {marker.data.controller}#{marker.data.action}',
+          data: [
+            { key: "controller", format: "string" },
+            { key: "action", format: "string" },
+            { key: "status", format: "integer" },
+            { key: "path", format: "string" },
+            { key: "method", format: "string" },
+            { key: "format", format: "string" }
+          ]
+        },
         {
           name: "process_action.action_controller",
           display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.method} {marker.data.controller}#{marker.data.action}',
+          chartLabel:   '{marker.data.method} {marker.data.controller}#{marker.data.action}',
+          tableLabel:   '{marker.data.method} {marker.data.controller}#{marker.data.action}',
           data: [
             { key: "controller", format: "string" },
             { key: "action", format: "string" },
             { key: "status", format: "integer" },
             { key: "path", format: "string" },
-            { key: "method", format: "string" }
+            { key: "method", format: "string" },
+            { key: "format", format: "string" }
           ]
         },
         {
           name: "cache_read.active_support",
           display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.super_operation} {marker.data.key}',
+          chartLabel:   '{marker.data.super_operation} {marker.data.key}',
+          tableLabel:   '{marker.data.super_operation} {marker.data.key}',
           data: [
             { key: "key", format: "string" },
             { key: "store", format: "string" },
@@ -55,11 +83,65 @@ module Vernier
         },
         {
           name: "cache_fetch_hit.active_support",
+          tooltipLabel: 'HIT {marker.data.key}',
+          chartLabel:   'HIT {marker.data.key}',
+          tableLabel:   'HIT {marker.data.key}',
           display: [ "marker-chart", "marker-table" ],
           data: [
             { key: "key", format: "string" },
             { key: "store", format: "string" }
           ]
+        },
+        {
+          name: "render_template.action_view",
+          display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.identifier}',
+          chartLabel:   '{marker.data.identifier}',
+          tableLabel:   '{marker.data.identifier}',
+          data: [
+            { key: "identifier", format: "string" }
+          ]
+        },
+        {
+          name: "render_layout.action_view",
+          display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.identifier}',
+          chartLabel:   '{marker.data.identifier}',
+          tableLabel:   '{marker.data.identifier}',
+          data: [
+            { key: "identifier", format: "string" }
+          ]
+        },
+        {
+          name: "render_partial.action_view",
+          display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.identifier}',
+          chartLabel:   '{marker.data.identifier}',
+          tableLabel:   '{marker.data.identifier}',
+          data: [
+            { key: "identifier", format: "string" }
+          ]
+        },
+        {
+          name: "render_collection.action_view",
+          display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.identifier}',
+          chartLabel:   '{marker.data.identifier}',
+          tableLabel:   '{marker.data.identifier}',
+          data: [
+            { key: "identifier", format: "string" },
+            { key: "count", format: "integer" }
+          ]
+        },
+        {
+          name: "load_config_initializer.railties",
+          display: [ "marker-chart", "marker-table" ],
+          tooltipLabel: '{marker.data.initializer}',
+          chartLabel:   '{marker.data.initializer}',
+          tableLabel:   '{marker.data.initializer}',
+          data: [
+            { key: "initializer", format: "string" }
+          ]
         }
       ])
 

data/lib/vernier/middleware.rb

@@ -0,0 +1,32 @@
+module Vernier
+  class Middleware
+    def initialize(app, permit: ->(_) { true })
+      @app = app
+      @permit = permit
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      return @app.call(env) unless request.GET.has_key?("vernier")
+
+      permitted = @permit.call(request)
+      return @app.call(env) unless permitted
+
+      interval = request.GET.fetch(:vernier_interval, 200).to_i
+      allocation_sample_rate = request.GET.fetch(:vernier_allocation_sample_rate, 200).to_i
+
+      result = Vernier.trace(interval:, allocation_sample_rate:, hooks: [:rails]) do
+        @app.call(env)
+      end
+      body = result.to_gecko
+      filename = "#{request.path.gsub("/", "_")}_#{DateTime.now.strftime("%Y-%m-%d-%H-%M-%S")}.vernier.json"
+      headers = {
+        "Content-Type" => "application/json; charset=utf-8",
+        "Content-Disposition" => "attachment; filename=\"#{filename}\"",
+        "Content-Length" => body.bytesize.to_s
+      }
+
+      Rack::Response.new(body, 200, headers).finish
+    end
+  end
+end

data/lib/vernier/output/firefox.rb

@@ -90,7 +90,7 @@ module Vernier
       end
 
       def output
-        ::JSON.generate(data)
+        ::JSON.fast_generate(data)
       end
 
       private
@@ -152,7 +152,7 @@ module Vernier
         [
           {
             name: "THREAD_RUNNING",
-            display: [ "marker-chart", "marker-table" ],
+            display: [ "marker-chart" ],
             data: [
               {
                 label: "Description",
@@ -162,7 +162,7 @@ module Vernier
           },
           {
             name: "THREAD_STALLED",
-            display: [ "marker-chart", "marker-table" ],
+            display: [ "marker-chart" ],
             data: [
               {
                 label: "Description",
@@ -172,7 +172,7 @@ module Vernier
           },
           {
             name: "THREAD_SUSPENDED",
-            display: [ "marker-chart", "marker-table" ],
+            display: [ "marker-chart" ],
             data: [
               {
                 label: "Description",
@@ -237,25 +237,26 @@ module Vernier
 
           lines = profile.frame_table.fetch(:line)
 
-          @frame_implementations = filenames.zip(lines).map do |filename, line|
+          func_implementations = filenames.map do |filename|
             # Must match strings in `src/profile-logic/profile-data.js`
             # inside the firefox profiler. See `getFriendlyStackTypeName`
             if filename == "<cfunc>"
               @strings["native"]
             else
-              # FIXME: We need to get upstream support for JIT frames
-              if line == -1
-                @strings["yjit"]
-              else
-                # nil means interpreter
-                nil
-              end
+              # nil means interpreter
+              nil
             end
           end
+          @frame_implementations = profile.frame_table.fetch(:func).map do |func_idx|
+            func_implementations[func_idx]
+          end
 
-          @frame_categories = filenames.map do |filename|
+          func_categories = filenames.map do |filename|
             @categorizer.categorize(filename)
           end
+          @frame_categories = profile.frame_table.fetch(:func).map do |func_idx|
+            func_categories[func_idx]
+          end
         end
 
         def filter_filenames(filenames)
@@ -280,13 +281,16 @@ module Vernier
         end
 
         def data
+          started_at = (@started_at - 0) / 1_000_000.0
+          stopped_at = (@stopped_at - 0) / 1_000_000.0 if @stopped_at
+
           {
             name: @name,
             isMainThread: @is_main,
-            processStartupTime: 0, # FIXME
-            processShutdownTime: nil, # FIXME
-            registerTime: (@started_at - 0) / 1_000_000.0,
-            unregisterTime: ((@stopped_at - 0) / 1_000_000.0 if @stopped_at),
+            processStartupTime: started_at,
+            processShutdownTime: stopped_at,
+            registerTime: started_at,
+            unregisterTime: stopped_at,
             pausedRanges: [],
             pid: profile.pid || Process.pid,
             tid: @tid,
@@ -324,12 +328,14 @@ module Vernier
             end_times << (finish&./(1_000_000.0))
             phases << phase
 
-            category = case name
-            when /\AGC/ then gc_category.idx
-            when /\AThread/ then thread_category.idx
-            else
-              0
-            end
+            category =
+              if name.start_with?("GC")
+                gc_category.idx
+              elsif name.start_with?("Thread")
+                thread_category.idx
+              else
+                0
+              end
 
             categories << category
             data << datum

data/lib/vernier/result.rb

@@ -1,6 +1,17 @@
 module Vernier
   class Result
-    attr_reader :stack_table, :frame_table, :func_table
+    def stack_table
+      @stack_table[:stack_table]
+    end
+
+    def frame_table
+      @stack_table[:frame_table]
+    end
+
+    def func_table
+      @stack_table[:func_table]
+    end
+
     attr_reader :markers
 
     attr_accessor :hooks

data/lib/vernier/stack_table.rb

@@ -0,0 +1,42 @@
+module Vernier
+  class StackTable
+    def to_h
+      {
+        stack_table: {
+          parent: stack_count.times.map { stack_parent_idx(_1) },
+          frame:  stack_count.times.map { stack_frame_idx(_1) }
+        },
+        frame_table: {
+          func: frame_count.times.map { frame_func_idx(_1) },
+          line:  frame_count.times.map { frame_line_no(_1) }
+        },
+        func_table: {
+          name: func_count.times.map { func_name(_1) },
+          filename: func_count.times.map { func_filename(_1) },
+          first_line: func_count.times.map { func_first_lineno(_1) }
+        }
+      }
+    end
+
+    def backtrace(stack_idx)
+      full_stack(stack_idx).map do |stack_idx|
+        frame_idx = stack_frame_idx(stack_idx)
+        func_idx = frame_func_idx(frame_idx)
+        line = frame_line_no(frame_idx)
+        name = func_name(func_idx);
+        filename = func_filename(func_idx);
+
+        "#{filename}:#{line}:in '#{name}'"
+      end
+    end
+
+    def full_stack(stack_idx)
+      full_stack = []
+      while stack_idx
+        full_stack << stack_idx
+        stack_idx = stack_parent_idx(stack_idx)
+      end
+      full_stack
+    end
+  end
+end

data/lib/vernier/thread_names.rb

@@ -35,7 +35,7 @@ module Vernier
       return name if name && !name.empty?
 
       if thread == Thread.main
-        return "main"
+        return $0
       end
 
       name = Thread.instance_method(:inspect).bind_call(thread)

data/lib/vernier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vernier
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/vernier.rb

@@ -2,6 +2,7 @@
 
 require_relative "vernier/version"
 require_relative "vernier/collector"
+require_relative "vernier/stack_table"
 require_relative "vernier/result"
 require_relative "vernier/hooks"
 require_relative "vernier/vernier"
@@ -11,7 +12,9 @@ require_relative "vernier/output/top"
 module Vernier
   class Error < StandardError; end
 
-  def self.trace(mode: :wall, out: nil, **collector_options)
+  autoload :Middleware, "vernier/middleware"
+
+  def self.profile(mode: :wall, **collector_options)
     collector = Vernier::Collector.new(mode, collector_options)
     collector.start
 
@@ -20,33 +23,43 @@ module Vernier
       yield collector
     ensure
       result = collector.stop
-      if out
-        File.write(out, Output::Firefox.new(result).output)
-      end
     end
 
     result
   end
 
-  def self.trace_retained(out: nil, gc: true)
-    3.times { GC.start } if gc
+  class << self
+    alias_method :trace, :profile
+    alias_method :run, :profile
+  end
 
-    collector = Vernier::Collector.new(:retained)
-    collector.start
+  @collector = nil
 
-    result = nil
-    begin
-      yield collector
-    ensure
-      result = collector.stop
-    end
+  def self.start_profile(mode: :wall, **collector_options)
+    if @collector
+      @collector.stop
+      @collector = nil
 
-    if out
-      result.write(out:)
+      raise "Profile already started, stopping..."
     end
+
+    @collector = Vernier::Collector.new(mode, collector_options)
+    @collector.start
+  end
+
+  def self.stop_profile
+    raise "No profile started" unless @collector
+
+    result = @collector.stop
+    @collector = nil
+
     result
   end
 
+  def self.trace_retained(out: nil, gc: true, &block)
+    profile(mode: :retained, out:, gc:, &block)
+  end
+
   class Collector
     def self.new(mode, options = {})
       _new(mode, options)

data/vernier.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.extensions = ["ext/vernier/extconf.rb"]
 
   spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rack"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vernier
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Next-generation Ruby 3.2.1+ sampling profiler. Tracks multiple threads,
   GVL activity, GC pauses, idle time, and more.
 email:
@@ -42,6 +56,8 @@ files:
 - bin/console
 - bin/setup
 - bin/vernier
+- examples/gvl_sleep.rb
+- examples/measure_overhead.rb
 - examples/minitest.rb
 - examples/ractor.rb
 - examples/rails.rb
@@ -57,9 +73,11 @@ files:
 - lib/vernier/hooks.rb
 - lib/vernier/hooks/active_support.rb
 - lib/vernier/marker.rb
+- lib/vernier/middleware.rb
 - lib/vernier/output/firefox.rb
 - lib/vernier/output/top.rb
 - lib/vernier/result.rb
+- lib/vernier/stack_table.rb
 - lib/vernier/thread_names.rb
 - lib/vernier/version.rb
 - vernier.gemspec
@@ -85,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A next generation CRuby profiler