vernier 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2419244a8929351d5c81f18b90766f20d7d9e29d4909c876deb06d2a9ad39f2d
-  data.tar.gz: 94ead7ad3797a5cca2311cebc0ba0a57de369b7a6d09a07cbe4b6fad1f8826ac
+  metadata.gz: fb2a2674d6f0654668b9fbfc03ec935fa21640585ae0b4dbd7567b472f975f26
+  data.tar.gz: 660264f955f4f2e9a9ae7e64acbb1b59d4d91f87d1a28d7a62aed0adabc9c51a
 SHA512:
-  metadata.gz: 25551c8b2d537ca00de410e0bbd2173a2cd0452462f8c8ed5c27fd9b6592fa60f7ff1eceb01b429eba69b1989287a7244acef7448b4335b3e2ef87e731af59df
-  data.tar.gz: e510284f293ae3efd17e82c8e643b800ccbce5d84ffca04ef35fb16b5edf796672080465384cb40ea59eeacc7cc3cea57cb25e73805183956359a4e58e464f8c
+  metadata.gz: aa249d63850b2ea08a3165e9b7045dcec5542173198aeef05c4c39047f604a5faa12b0d72c6f8fa7983e45a7011a3a5529dc4e4b7fbee426b2461f14b5d6b6c3
+  data.tar.gz: 93f82cd596d454db747afb11abe669b4ed53b6fd6691ebf9ab43ed53e5f2be9406ce93424e3b1179c9a7d13df28cdcbface7d2e80544aa1d2ba45d8a19385696

data/.ruby-version

@@ -0,0 +1 @@
+3.4.4

data/README.md

@@ -32,7 +32,7 @@ gem "vernier", "~> 1.0"
 
 ## Usage
 
-The output can be viewed in the web app at https://vernier.prof, locally using the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (both lightly customized versions of the firefox profiler frontend which profiles are compatible with), or by using the `vernier view` command in the CLI.
+The output can be viewed in the web app at https://vernier.prof, locally using the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (both lightly customized versions of the Firefox profiler frontend which profiles are compatible with), or by using the `vernier view` command in the CLI.
 
 - **Flame Graph**: Shows proportionally how much time is spent within particular stack frames. Frames are grouped together, which means that x-axis / left-to-right order is not meaningful.
 - **Stack Chart**: Shows the stack at each sample with the x-axis representing time and can be read left-to-right.
@@ -133,10 +133,26 @@ ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "i
 | `mode`                | N/A                           | Sampling mode: `:wall`, `:retained`, or `:custom`.            | `:wall` (`:wall`)            |
 | `out`                 | N/A                           | File to write the profile to.                                 | N/A (Auto-generated)         |
 | `interval`            | `vernier_interval`            | Sampling interval (µs). Only in `:wall` mode.                 | `500` (`200`)                |
-| `allocation_interval` | `vernier_allocation_interval` | Allocation sampling interval. Only in `:wall` mode.           | `0`/disabled (`200`)       |
+| `allocation_interval` | `vernier_allocation_interval` | Allocation sampling interval. Only in `:wall` mode.           | `0` i.e. disabled (`200`)    |
 | `gc`                  | N/A                           | Run full GC cycle before profiling. Only in `:retained` mode. | `true` (N/A)                 |
 | `metadata`            | N/A                           | Metadata key-value pairs to include in the profile.           | `{}` (N/A)                   |
 
+#### Hook options
+
+Vernier offers some optional hooks:
+
+- `:rails` / `:activesupport` - Adds selected Active Support event markers to the Firefox output
+
+- `:memory_usage` - Adds a memory usage counter to the Firefox output
+
+Usage example:
+
+```ruby
+Vernier.profile(out: "time_profile.json", hooks: [:rails, :memory_usage]) do
+  # ...
+end
+```
+
 ## 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/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
 
@@ -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/file_listing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "filename_filter"
-require "cgi/util"
+require "cgi/escape"
 
 module Vernier
   module Output

data/lib/vernier/output/firefox.rb

@@ -93,7 +93,7 @@ module Vernier
       end
 
       def output(gzip: false)
-        result = ::JSON.fast_generate(data)
+        result = ::JSON.generate(data)
         if gzip
           require "zlib"
           result = Zlib.gzip(result)

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.0"
+  VERSION = "1.8.0"
 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.0
+  version: 1.8.0
 platform: ruby
 authors:
 - John Hawthorn
 bindir: exe
 cert_chain: []
-date: 2025-04-03 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
@@ -125,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A next generation CRuby profiler
 test_files: []