vernier 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f250b62a547d9c79e6d7beb4382c4d8bdde8e2245e868c3ac5b8d5354e2929b
-  data.tar.gz: e900e786f82b759edc4dc83d5c9bfe37048ca3eca62a1352cef54e1ad2822069
+  metadata.gz: 56faced9b5a5fe99a124ab7743609eb23a981ca27888a5a8957e509d28f508ef
+  data.tar.gz: 0b258dc2f1f4c143568527213a3f39055a44aed3c983c84a14f71d6af68c900a
 SHA512:
-  metadata.gz: 49bf98de660939233cfdd7c256d4976dea3438ebaaf1bfd3b31dfa273d5b4d9da07e86cef98336fdc2178cfa56c368f5d68593c0449e424c8f9982dcb8d4155f
-  data.tar.gz: 5a78302e03fb52cb2e8ad69019ed3ed3be4cdc13f9ab86a86231013d8ca574595da34c00bc65ee6336a624cebad7d0ccd1b761eaffa3f6e3bc711fdcdb5cbbfc
+  metadata.gz: '096133a98cfc38236c89025c51f70a0c4def9c6208031775d11640291d08b17d53fb2817d6f9b7fea1e7d0551ac0e58471d757fd5568c732969d73134ca20fc3'
+  data.tar.gz: 063ce46032770d8d2cd161071587dea386af0497a9437d8bc19148c54263e32c2d4d00b164c926ff19f1236f704f1c76aabff8be63bb2b66cd7409f69742004b

data/exe/vernier

@@ -1,44 +1,136 @@
 #!/usr/bin/env ruby
 
 require "optparse"
+require "vernier/version"
 
-banner = <<-END
+module Vernier
+  module CLI
+    def self.run(options)
+      banner = <<-END
 Usage: vernier run [FLAGS] -- COMMAND
 
 FLAGS:
-END
+      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('--allocation_sample_rate [ALLOCATIONS]', Integer, "allocation sampling interval (default 0 disabled)") do |i|
-    options[:allocation_sample_rate] = 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
-  o.on('--hooks [HOOKS]', String, "Enable instrumentation hooks. Currently supported: rails") do |s|
-    options[:hooks] = s
+      OptionParser.new(banner) do |o|
+        o.version = Vernier::VERSION
+
+        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('--allocation_sample_rate [ALLOCATIONS]', Integer, "allocation sampling interval (default 0 disabled)") do |i|
+          options[:allocation_sample_rate] = 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
+        o.on('--hooks [HOOKS]', String, "Enable instrumentation hooks. Currently supported: rails") do |s|
+          options[:hooks] = s
+        end
+      end
+    end
+
+    def self.view(options)
+      banner = <<-END
+Usage: vernier view [FLAGS] FILENAME
+
+FLAGS:
+      END
+
+      OptionParser.new(banner) do |o|
+        o.on('--top [COUNT]', Integer, "number of frames to show (default 20)") do |i|
+          options[:top] = i
+        end
+      end
+    end
+
+    def self.inverted_tree(top, file)
+      # Print the inverted tree from a Vernier profile
+      require "json"
+
+      is_gzip = File.binread(file, 2) == "\x1F\x8B".b # check for gzip header
+
+      json = if is_gzip
+        require "zlib"
+        Zlib::GzipReader.open(file) { |gz| gz.read }
+      else
+        File.read file
+      end
+
+      info = JSON.load json
+
+      main = info["threads"].find { |thread| thread["isMainThread"] }
+
+      weight_by_frame = Hash.new(0)
+
+      stack_frames = main["stackTable"]["frame"]
+      frame_table = main["frameTable"]["func"]
+      func_table = main["funcTable"]["name"]
+      string_array = main["stringArray"]
+
+      main["samples"]["stack"].zip(main["samples"]["weight"]).each do |stack, weight|
+        top_frame_index = stack_frames[stack]
+        func_index = frame_table[top_frame_index]
+        string_index = func_table[func_index]
+        str = string_array[string_index]
+        weight_by_frame[str] += weight
+      end
+
+      total = weight_by_frame.values.inject :+
+
+      header = ["Samples", "%", ""]
+      widths = header.map(&:bytesize)
+
+      columns = weight_by_frame.sort_by { |k,v| v }.reverse.first(top).map { |k,v|
+        entry = [v.to_s, ((v / total.to_f) * 100).round(1).to_s, k]
+        entry.each_with_index { |str, i| widths[i] = str.bytesize if widths[i] < str.bytesize }
+        entry
+      }
+
+      print_separator widths
+      print_row header, widths
+      print_separator widths
+      columns.each { print_row(_1, widths) }
+      print_separator widths
+    end
+
+    def self.print_row(list, widths)
+      puts("|" + list.map.with_index { |str, i| " " + str.ljust(widths[i] + 1) }.join("|") + "|")
+    end
+
+    def self.print_separator(widths)
+      puts("+" + widths.map { |i| "-" * (i + 2) }.join("+") + "+")
+    end
   end
 end
 
-parser.parse!
-parser.abort(parser.help) if ARGV.shift != "run"
-parser.abort(parser.help) if ARGV.empty?
+options = {}
+run = Vernier::CLI.run(options)
+view = Vernier::CLI.view(options)
 
-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']}"
+case ARGV.shift
+when "run"
+  run.parse!
+  run.abort(run.help) if ARGV.empty?
 
-Kernel.exec(env, *ARGV)
+  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)
+when "view"
+  view.parse!
+  view.abort(view.help) if ARGV.empty?
+  Vernier::CLI.inverted_tree(options[:top] || 20, ARGV.shift)
+else
+  run.abort(run.help + "\n" + view.help)
+end

data/ext/vernier/vernier.cc

@@ -672,10 +672,6 @@ StackTable::stack_table_convert(VALUE self, VALUE original_tableval, VALUE origi
     StackTable *original_table = get_stack_table(original_tableval);
     int original_idx = NUM2INT(original_idxval);
 
-    if (original_idx == -1) {
-        return original_idxval;
-    }
-
     int original_size;
     {
         const std::lock_guard<std::mutex> lock(original_table->stack_mutex);
@@ -1027,13 +1023,15 @@ class SampleList {
         }
 
         void record_sample(int stack_index, TimeStamp time, Category category) {
-            if (
-                    !empty() &&
-                    stacks.back() == stack_index &&
-                    categories.back() == category)
-            {
-                // We don't compare timestamps for de-duplication
-                weights.back() += 1;
+          // FIXME: probably better to avoid generating -1 higher up.
+          // Currently this happens when we measure an empty stack. Ideally we would have a better representation
+          if (stack_index < 0)
+            return;
+
+          if (!empty() && stacks.back() == stack_index &&
+              categories.back() == category) {
+            // We don't compare timestamps for de-duplication
+            weights.back() += 1;
             } else {
                 stacks.push_back(stack_index);
                 timestamps.push_back(time);

data/lib/vernier/result.rb

@@ -102,7 +102,7 @@ module Vernier
       end
 
       def line
-        result.frame_line_idx(idx)
+        result._stack_table.frame_line_no(idx)
       end
 
       def to_s

data/lib/vernier/version.rb

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

data/vernier.gemspec

@@ -12,7 +12,10 @@ Gem::Specification.new do |spec|
   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"
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vernier
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - John Hawthorn
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-07 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,7 +102,7 @@ metadata:
   homepage_uri: https://github.com/jhawthorn/vernier
   source_code_uri: https://github.com/jhawthorn/vernier
   changelog_uri: https://github.com/jhawthorn/vernier
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: A next generation CRuby profiler
 test_files: []