vernier 0.5.1 → 0.7.0

data/lib/vernier.rb

@@ -2,7 +2,9 @@
 
 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"
 require_relative "vernier/output/firefox"
 require_relative "vernier/output/top"
@@ -10,8 +12,10 @@ require_relative "vernier/output/top"
 module Vernier
   class Error < StandardError; end
 
-  def self.trace(mode: :wall, out: nil, interval: nil)
-    collector = Vernier::Collector.new(mode, { interval: })
+  autoload :Middleware, "vernier/middleware"
+
+  def self.profile(mode: :wall, **collector_options)
+    collector = Vernier::Collector.new(mode, collector_options)
     collector.start
 
     result = nil
@@ -19,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

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["John Hawthorn"]
   spec.email = ["john@hawthorn.email"]
 
-  spec.summary = "An experimental profiler"
-  spec.description = spec.summary
+  spec.summary = "A next generation CRuby profiler"
+  spec.description = "Next-generation Ruby 3.2.1+ sampling profiler. Tracks multiple threads, GVL activity, GC pauses, idle time, and more."
   spec.homepage = "https://github.com/jhawthorn/vernier"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.2.1"
@@ -29,4 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/vernier/extconf.rb"]
+
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rack"
 end

metadata

@@ -1,16 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: vernier
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
-dependencies: []
-description: An experimental profiler
+date: 2024-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !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:
 - john@hawthorn.email
 executables:
@@ -27,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
@@ -39,10 +70,15 @@ files:
 - lib/vernier.rb
 - lib/vernier/autorun.rb
 - lib/vernier/collector.rb
+- 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
 homepage: https://github.com/jhawthorn/vernier
@@ -67,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: An experimental profiler
+summary: A next generation CRuby profiler
 test_files: []