vernier 1.7.1 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356fbbcbb8c60616fe3a92c4eed26d7cac97f3a1e230e4904571f9666f4b64aa
-  data.tar.gz: cb7f9542080591e8fe680ab7f1b5688f0c5265e8d32d8ce2d8d56efab639ded0
+  metadata.gz: 4be5edc549ea93934096d98e46c4ffcabc140d06e27303f6ec6b01de8201983c
+  data.tar.gz: a6322324723a2f31f15a0b7e98a6de72bf5c555e29e21951b7f466466ecedd6f
 SHA512:
-  metadata.gz: 2bf9a5882a9494b23c6a695836ee253a04054c501bab46b20b12b73516d7b21c103d1bb306ccb2a6ac3b5dce61d882620e6abbc53e056d0fd3e9260e68e97c44
-  data.tar.gz: e82f4becfb5a9e30cafebbe5271bd6b2e9883c3422eb5e61ee2ffae8589a0861f55a19b190c9d5a829894755a227438c7f4d2aa2225d55697f0f954738a49f10
+  metadata.gz: 92377006ae54cc5cc89934cc3c393fdfe02746035235b507196ef9d360b6d843c50db4382e0b53ec253f1d08f10f78e28d7daf10979f26187bb7c925933dec56
+  data.tar.gz: 0e963a838d3c319d93d73ae224c9e11caa51562583ef37f2d5fff40781281d30ee714273a9ce021c9e8285942825a3356388d2f68b51315fb5275c5bb96b49a6

data/.ruby-version

@@ -0,0 +1 @@
+3.4.6

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/test_*.rb"]
+  t.deps << :compile
 end
 
 task :console => :compile do

data/exe/vernier

@@ -9,10 +9,9 @@ module Vernier
   module CLI
     class Metadata < Array
       require 'json'
-      require 'base64'
 
       def to_s
-        Base64.encode64(to_json)
+        [to_json].pack("m")
       end
     end
 
@@ -52,6 +51,9 @@ FLAGS:
           options[:metadata] ||= Metadata.new
           options[:metadata] << [key, value]
         end
+        o.on('--format [FORMAT]', String, "output format: firefox (default) or cpuprofile") do |output_format|
+          options[:format] = output_format
+        end
       end
     end
 
@@ -77,7 +79,7 @@ FLAGS:
 
       parsed_profile = Vernier::ParsedProfile.read_file(file)
 
-      puts Vernier::Output::Top.new(parsed_profile).output
+      puts Vernier::Output::Top.new(parsed_profile, top).output
       puts Vernier::Output::FileListing.new(parsed_profile).output
     end
   end
@@ -88,6 +90,8 @@ run = Vernier::CLI.run(options)
 view = Vernier::CLI.view(options)
 
 case ARGV.shift
+when "-v", "--version"
+  puts Vernier::VERSION
 when "run"
   run.parse!
   run.abort(run.help) if ARGV.empty?

data/lib/vernier/autorun.rb

@@ -1,6 +1,5 @@
 require "tempfile"
 require "vernier"
-require "base64"
 require "json"
 
 module Vernier
@@ -22,7 +21,7 @@ module Vernier
       allocation_interval = options.fetch(:allocation_interval, 0).to_i
       hooks = options.fetch(:hooks, "").split(",")
       metadata = if options[:metadata]
-        JSON.parse(Base64.decode64(@options[:metadata])).to_h { |k, v| [k.to_sym, v] }
+        JSON.parse(@options[:metadata].unpack1("m")).to_h { |k, v| [k.to_sym, v] }
       else
         {}
       end
@@ -49,12 +48,16 @@ module Vernier
         end
         prefix = "profile-"
         timestamp = Time.now.strftime("%Y%m%d-%H%M%S")
-        suffix = ".vernier.json.gz"
+        suffix = if options[:format] == "cpuprofile"
+          ".vernier.cpuprofile"
+        else
+          ".vernier.json.gz"
+        end
 
         output_path = File.expand_path("#{output_dir}/#{prefix}#{timestamp}-#{$$}#{suffix}")
       end
 
-      result.write(out: output_path)
+      result.write(out: output_path, format: options[:format] || "firefox")
 
       STDERR.puts(result.inspect)
       STDERR.puts("written to #{output_path}")

data/lib/vernier/collector.rb

@@ -11,6 +11,7 @@ module Vernier
 
       @mode = mode
       @out = options[:out]
+      @format = options[:format]
 
       @markers = []
       @hooks = []
@@ -142,7 +143,7 @@ module Vernier
       #result.instance_variable_set(:@markers, markers)
 
       if @out
-        result.write(out: @out)
+        result.write(out: @out, format: @format)
       end
 
       result

data/lib/vernier/middleware.rb

@@ -18,7 +18,7 @@ module Vernier
       result = Vernier.trace(interval:, allocation_interval:, hooks: [:rails]) do
         @app.call(env)
       end
-      body = result.to_gecko(gzip: true)
+      body = result.to_firefox(gzip: true)
       filename = "#{request.path.gsub("/", "_")}_#{DateTime.now.strftime("%Y-%m-%d-%H-%M-%S")}.vernier.json.gz"
       headers = {
         "Content-Type" => "application/octet-stream",

data/lib/vernier/output/cpuprofile.rb

@@ -0,0 +1,145 @@
+require "json"
+
+module Vernier
+  module Output
+    class Cpuprofile
+      def initialize(profile)
+        @profile = profile
+      end
+
+      def output
+        JSON.generate(data)
+      end
+
+      private
+
+      attr_reader :profile
+
+      def ns_to_us(timestamp)
+        (timestamp / 1_000.0).to_i
+      end
+
+      def data
+        # Get the main thread data (cpuprofile format is single-threaded)
+        main_thread = profile.main_thread
+        return empty_profile if main_thread.nil?
+
+        samples = main_thread[:samples]
+        timestamps = main_thread[:timestamps] || []
+
+        nodes = build_nodes
+        sample_node_ids = samples.map { |stack_idx| stack_to_node_id(stack_idx) }
+        time_deltas = calculate_time_deltas(timestamps)
+
+        {
+          nodes: nodes,
+          startTime: ns_to_us(profile.started_at),
+          endTime: ns_to_us(profile.end_time),
+          samples: sample_node_ids,
+          timeDeltas: time_deltas
+        }
+      end
+
+      def empty_profile
+        {
+          nodes: [root_node],
+          startTime: 0,
+          endTime: 0,
+          samples: [],
+          timeDeltas: []
+        }
+      end
+
+      def build_nodes
+        stack_table = profile.stack_table
+
+        nodes = []
+        @node_id_map = {}
+
+        root = root_node
+        nodes << root
+        @node_id_map[nil] = 0
+
+        stack_table.stack_count.times do |stack_idx|
+          create_node_for_stack(stack_idx, nodes, stack_table)
+        end
+
+        nodes
+      end
+
+      def root_node
+        {
+          id: 0,
+          callFrame: {
+            functionName: "(root)",
+            scriptId: "0",
+            url: "",
+            lineNumber: -1,
+            columnNumber: -1,
+          },
+          hitCount: 0,
+          children: []
+        }
+      end
+
+      def create_node_for_stack(stack_idx, nodes, stack_table)
+        return @node_id_map[stack_idx] if @node_id_map.key?(stack_idx)
+
+        frame_idx = stack_table.stack_frame_idx(stack_idx)
+        parent_stack_idx = stack_table.stack_parent_idx(stack_idx)
+
+        parent_node_id = if parent_stack_idx.nil?
+          0 # root node
+        else
+          create_node_for_stack(parent_stack_idx, nodes, stack_table)
+        end
+
+        func_idx = stack_table.frame_func_idx(frame_idx)
+        line = stack_table.frame_line_no(frame_idx) - 1
+
+        func_name = stack_table.func_name(func_idx)
+        filename = stack_table.func_filename(func_idx)
+
+        node_id = nodes.length
+        node = {
+          id: node_id,
+          callFrame: {
+            functionName: func_name || "(anonymous)",
+            scriptId: func_idx.to_s,
+            url: filename || "",
+            lineNumber: line || 0,
+            columnNumber: 0
+          },
+          hitCount: 0,
+          children: []
+        }
+
+        nodes << node
+        @node_id_map[stack_idx] = node_id
+
+        parent_node = nodes[parent_node_id]
+        parent_node[:children] << node_id unless parent_node[:children].include?(node_id)
+      end
+
+      def stack_to_node_id(stack_idx)
+        @node_id_map[stack_idx] || 0
+      end
+
+      def calculate_time_deltas(timestamps)
+        return [] if timestamps.empty?
+
+        deltas = []
+
+        timestamps.each_with_index do |timestamp, i|
+          if i == 0
+            deltas << 0
+          else
+            deltas << ns_to_us(timestamp - timestamps[i - 1])
+          end
+        end
+
+        deltas
+      end
+    end
+  end
+end

data/lib/vernier/output/firefox.rb

@@ -8,35 +8,59 @@ require_relative "filename_filter"
 module Vernier
   module Output
     # https://profiler.firefox.com/
-    # https://github.com/firefox-devtools/profiler/blob/main/src/types/profile.js
+    # https://github.com/firefox-devtools/profiler/blob/main/src/types/profile.ts
     class Firefox
       class Categorizer
+        RAILS_COMPONENTS = %w[ activesupport activemodel activerecord actionview
+                               actionpack activejob actionmailer actioncable
+                               activestorage actionmailbox actiontext railties ]
+
+        AVAILABLE_COLORS = %w[ transparent purple green orange yellow lightblue
+                               blue brown magenta red lightred darkgrey grey ]
+
+        ORDERED_CATEGORIES = %w[ Kernel Rails gem Ruby ] # This is in the order of preference
+
         attr_reader :categories
+
         def initialize
           @categories = []
           @categories_by_name = {}
 
-          add_category(name: "Ruby", color: "grey") do |c|
-            rails_components = %w[ activesupport activemodel activerecord
-              actionview actionpack activejob actionmailer actioncable
-              activestorage actionmailbox actiontext railties ]
+          add_category(name: "Kernel", color: "magenta") do |c|
             c.add_subcategory(
-              name: "Rails",
-              matcher: gem_path(*rails_components)
+              name: "Kernel",
+              matcher: starts_with("<internal")
             )
+          end
+
+          add_category(name: "gem", color: "lightblue") do |c|
             c.add_subcategory(
               name: "gem",
               matcher: starts_with(*Gem.path)
             )
+          end
+
+          add_category(name: "Rails", color: "red") do |c|
+            RAILS_COMPONENTS.each do |subcategory|
+              c.add_subcategory(
+                name: subcategory,
+                matcher: gem_path(subcategory)
+              )
+            end
+          end
+
+          add_category(name: "Ruby", color: "purple") do |c|
             c.add_subcategory(
               name: "stdlib",
               matcher: starts_with(RbConfig::CONFIG["rubylibdir"])
             )
           end
+
           add_category(name: "Idle", color: "transparent")
           add_category(name: "Stalled", color: "transparent")
 
           add_category(name: "GC", color: "red")
+
           add_category(name: "cfunc", color: "yellow", matcher: "<cfunc>")
 
           add_category(name: "Thread", color: "grey")
@@ -69,7 +93,10 @@ module Vernier
 
         class Category
           attr_reader :idx, :name, :color, :matcher, :subcategories
+
           def initialize(idx, name:, color:, matcher: nil)
+            raise ArgumentError, "invalid color: #{color}" if color && AVAILABLE_COLORS.none?(color)
+
             @idx = idx
             @name = name
             @color = color
@@ -315,19 +342,13 @@ module Vernier
             func_implementations[func_idx]
           end
 
-          cfunc_category = @categorizer.get_category("cfunc")
-          ruby_category = @categorizer.get_category("Ruby")
           func_categories, func_subcategories = [], []
           filenames.each do |filename|
-            if filename == "<cfunc>"
-              func_categories << cfunc_category
-              func_subcategories << 0
-            else
-              func_categories << ruby_category
-              subcategory = ruby_category.subcategories.detect {|c| c.matches?(filename) }&.idx || 0
-              func_subcategories << subcategory
-            end
+            category, subcategory = categorize_filename(filename)
+            func_categories << category
+            func_subcategories << subcategory
           end
+
           @frame_categories = @stack_table_hash[:frame_table].fetch(:func).map do |func_idx|
             func_categories[func_idx]
           end
@@ -336,6 +357,32 @@ module Vernier
           end
         end
 
+        def categorize_filename(filename)
+          return cfunc_category_and_subcategory if filename == "<cfunc>"
+
+          category, subcategory = find_category_and_subcategory(filename, Categorizer::ORDERED_CATEGORIES)
+          return category, subcategory if subcategory
+
+          ruby_category_and_subcategory
+        end
+
+        def cfunc_category_and_subcategory
+          [@categorizer.get_category("cfunc"), 0]
+        end
+
+        def ruby_category_and_subcategory
+          [@categorizer.get_category("Ruby"), 0]
+        end
+
+        def find_category_and_subcategory(filename, categories)
+          categories.each do |category_name|
+            category = @categorizer.get_category(category_name)
+            subcategory = category.subcategories.detect {|c| c.matches?(filename) }&.idx
+            return category, subcategory if subcategory
+          end
+          [nil, nil]
+        end
+
         def filter_filenames(filenames)
           filter = FilenameFilter.new
           filenames.map do |filename|

data/lib/vernier/output/top.rb

@@ -3,14 +3,16 @@
 module Vernier
   module Output
     class Top
-      def initialize(profile)
+      def initialize(profile, row_limit)
         @profile = profile
+        @row_limit = row_limit
       end
 
       class Table
-        def initialize(header)
+        def initialize(header, row_limit)
           @header = header
           @rows = []
+          @row_limit = row_limit
           yield self
         end
 
@@ -24,7 +26,7 @@ module Vernier
               row_separator,
               format_row(@header),
               row_separator
-            ] + @rows.map do |row|
+            ] + @rows.first(@row_limit).map do |row|
               format_row(row)
             end + [row_separator]
           ).join("\n")
@@ -70,7 +72,7 @@ module Vernier
           top_by_self[name] += weight
         end
 
-        Table.new %w[Samples % name] do |t|
+        Table.new %w[Samples % name], @row_limit do |t|
           top_by_self.sort_by(&:last).reverse.each do |frame, samples|
             pct = 100.0 * samples / total
             t << [samples.to_s, pct.round(1).to_s, frame]

data/lib/vernier/result.rb

@@ -29,13 +29,25 @@ module Vernier
       (current_time_real_ns - current_time_mono_ns + started_at_mono_ns)
     end
 
-    def to_gecko(gzip: false)
+    def to_firefox(gzip: false)
       Output::Firefox.new(self).output(gzip:)
     end
+    alias_method :to_gecko, :to_firefox
 
-    def write(out:)
-      gzip = out.end_with?(".gz")
-      File.binwrite(out, to_gecko(gzip:))
+    def to_cpuprofile
+      Output::Cpuprofile.new(self).output
+    end
+
+    def write(out:, format: "firefox")
+      case format
+      when "cpuprofile"
+        File.binwrite(out, to_cpuprofile)
+      when nil, "firefox"
+        gzip = out.end_with?(".gz")
+        File.binwrite(out, to_firefox(gzip:))
+      else
+        raise ArgumentError, "unknown format: #{format}"
+      end
     end
 
     def elapsed_seconds

data/lib/vernier/version.rb

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

data/lib/vernier.rb

@@ -8,6 +8,7 @@ require_relative "vernier/result"
 require_relative "vernier/hooks"
 require_relative "vernier/vernier"
 require_relative "vernier/output/firefox"
+require_relative "vernier/output/cpuprofile"
 require_relative "vernier/output/top"
 require_relative "vernier/output/file_listing"
 require_relative "vernier/output/filename_filter"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vernier
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.1
 platform: ruby
 authors:
 - John Hawthorn
 bindir: exe
 cert_chain: []
-date: 2025-05-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,6 +61,7 @@ extensions:
 - ext/vernier/extconf.rb
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -93,6 +94,7 @@ files:
 - lib/vernier/hooks/memory_usage.rb
 - lib/vernier/marker.rb
 - lib/vernier/middleware.rb
+- lib/vernier/output/cpuprofile.rb
 - lib/vernier/output/file_listing.rb
 - lib/vernier/output/filename_filter.rb
 - lib/vernier/output/firefox.rb
@@ -103,7 +105,6 @@ files:
 - lib/vernier/stack_table_helpers.rb
 - lib/vernier/thread_names.rb
 - lib/vernier/version.rb
-- vernier.gemspec
 homepage: https://github.com/jhawthorn/vernier
 licenses:
 - MIT
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A next generation CRuby profiler
 test_files: []

data/vernier.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/vernier/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "vernier"
-  spec.version = Vernier::VERSION
-  spec.authors = ["John Hawthorn"]
-  spec.email = ["john@hawthorn.email"]
-
-  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"
-
-  unless ENV["IGNORE_REQUIRED_RUBY_VERSION"]
-    spec.required_ruby_version = ">= 3.2.1"
-  end
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
-
-  # 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 do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  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 "gvltest"
-  spec.add_development_dependency "rack"
-end