vernier 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3847eff8849b364e1cd777058a720d4960e7058c4895c86ded9c5f98d053e76
-  data.tar.gz: 306275958737222981ec6fd45846b210b757bc858feee84533dbc45b3997d471
+  metadata.gz: 2419244a8929351d5c81f18b90766f20d7d9e29d4909c876deb06d2a9ad39f2d
+  data.tar.gz: 94ead7ad3797a5cca2311cebc0ba0a57de369b7a6d09a07cbe4b6fad1f8826ac
 SHA512:
-  metadata.gz: 803e19370d96f59ddf2668fadd2c4f0318c98d60576ad9f34a7a229495c6c9185d5fa5bc461b998722ca83979fb05a9007120efeaa206a734eff05bb0e3b864e
-  data.tar.gz: 3bab21c2bcb0cdaf82287cd7fbe9a619bba3bdf0658d6ec3cdd7d9b7cdae6feec5f43f1cc2056dd86af31fdf19794173e12d651fd26620f5e05304f7aa1ecf5b
+  metadata.gz: 25551c8b2d537ca00de410e0bbd2173a2cd0452462f8c8ed5c27fd9b6592fa60f7ff1eceb01b429eba69b1989287a7244acef7448b4335b3e2ef87e731af59df
+  data.tar.gz: e510284f293ae3efd17e82c8e643b800ccbce5d84ffca04ef35fb16b5edf796672080465384cb40ea59eeacc7cc3cea57cb25e73805183956359a4e58e464f8c

data/README.md

@@ -4,9 +4,11 @@ Next-generation Ruby 3.2.1+ sampling profiler. Tracks multiple threads, GVL acti
 
 <img width="500" alt="Screenshot 2024-02-29 at 22 47 43" src="https://github.com/jhawthorn/vernier/assets/131752/aa995a41-d74f-405f-8ada-2522dd72c2c8">
 
-## Examples
+## Demos and Examples
 
-[Livestreamed demo: Pairin' with Aaron (YouTube)](https://www.youtube.com/watch?v=9nvX3OHykGQ#t=27m43)
+[Livestreamed demo: Pairin' with Aaron (YouTube)](https://www.youtube.com/watch?v=9nvX3OHykGQ#t=27m40)
+
+[Overview at RubyKaigi 2024 (YouTube)](https://youtu.be/QSjN-H4hGsM)
 
 Sidekiq jobs from Mastodon (time, threaded)
 : https://share.firefox.dev/44jZRf3
@@ -131,8 +133,9 @@ 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`/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)                   |
 
 ## Development
 

data/exe/vernier

@@ -7,6 +7,15 @@ require "vernier/version"
 
 module Vernier
   module CLI
+    class Metadata < Array
+      require 'json'
+      require 'base64'
+
+      def to_s
+        Base64.encode64(to_json)
+      end
+    end
+
     def self.run(options)
       banner = <<-END
 Usage: vernier run [FLAGS] -- COMMAND
@@ -38,6 +47,11 @@ FLAGS:
         o.on('--hooks [HOOKS]', String, "enable instrumentation hooks, currently supported: rails") do |s|
           options[:hooks] = s
         end
+        o.on("--metadata KEY=VALUE", String, "Set metadata key-value pairs (can be specified multiple times)") do |kv|
+          key, value = kv.split('=')
+          options[:metadata] ||= Metadata.new
+          options[:metadata] << [key, value]
+        end
       end
     end
 

data/ext/vernier/vernier.cc

@@ -74,8 +74,7 @@ static const char *gvl_event_name(rb_event_flag_t event) {
     return "no-event";
 }
 
-// TODO: Rename FuncInfo
-struct FrameInfo {
+struct FuncInfo {
     static const char *label_cstr(VALUE frame) {
         VALUE label = rb_profile_frame_full_label(frame);
         // Currently (2025-03-22, Ruby 3.4.2) this occurs when an iseq method
@@ -100,7 +99,7 @@ struct FrameInfo {
         return NIL_P(first_lineno) ? 0 : FIX2INT(first_lineno);
     }
 
-    FrameInfo(VALUE frame) :
+    FuncInfo(VALUE frame) :
         label(label_cstr(frame)),
         file(file_cstr(frame)),
         first_lineno(first_lineno_int(frame)) { }
@@ -110,7 +109,7 @@ struct FrameInfo {
     int first_lineno;
 };
 
-bool operator==(const FrameInfo& lhs, const FrameInfo& rhs) noexcept {
+bool operator==(const FuncInfo& lhs, const FuncInfo& rhs) noexcept {
     return
         lhs.label == rhs.label &&
         lhs.file == rhs.file &&
@@ -266,13 +265,13 @@ struct StackTable {
 
     struct FrameWithInfo {
         Frame frame;
-        FrameInfo info;
+        FuncInfo info;
     };
 
     IndexMap<Frame> frame_map;
 
     IndexMap<VALUE> func_map;
-    std::vector<FrameInfo> func_info_list;
+    std::vector<FuncInfo> func_info_list;
 
     struct StackNode {
         std::unordered_map<Frame, int> children;
@@ -363,7 +362,7 @@ struct StackTable {
         for (int i = func_info_list.size(); i < func_map.size(); i++) {
             const auto &func = func_map[i];
             // must not hold a mutex here
-            func_info_list.push_back(FrameInfo(func));
+            func_info_list.push_back(FuncInfo(func));
         }
     }
 

data/lib/vernier/autorun.rb

@@ -1,5 +1,7 @@
 require "tempfile"
 require "vernier"
+require "base64"
+require "json"
 
 module Vernier
   module Autorun
@@ -19,10 +21,15 @@ module Vernier
       interval = options.fetch(:interval, 500).to_i
       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] }
+      else
+        {}
+      end
 
       STDERR.puts("starting profiler with interval #{interval} and allocation interval #{allocation_interval}")
 
-      @collector = Vernier::Collector.new(:wall, interval:, allocation_interval:, hooks:)
+      @collector = Vernier::Collector.new(:wall, interval:, allocation_interval:, hooks:, metadata:)
       @collector.start
     end
 

data/lib/vernier/collector.rb

@@ -25,6 +25,8 @@ module Vernier
       @hooks.each do |hook|
         hook.enable
       end
+
+      @user_metadata = options[:metadata] || {}
     end
 
     private def add_hook(hook)
@@ -79,6 +81,7 @@ module Vernier
       result.meta[:mode] = @mode
       result.meta[:out] = @out
       result.meta[:gc] = @gc
+      result.meta[:user_metadata] = @user_metadata
 
       result.stack_table = stack_table
       @thread_names.finish

data/lib/vernier/output/firefox.rb

@@ -145,7 +145,18 @@ module Vernier
             end,
             sourceCodeIsNotOnSearchfox: true,
             initialVisibleThreads: threads.each_index.to_a,
-            initialSelectedThreads: Array(threads.find_index(&:is_start))
+            initialSelectedThreads: Array(threads.find_index(&:is_start)),
+            vernierUserMetadata: profile.meta[:user_metadata],
+            extra: [
+              label: "User-Supplied Metadata",
+              entries: profile.meta[:user_metadata].map do |k, v|
+                {
+                  label: k,
+                  format: "string",
+                  value: v
+                }
+              end
+            ]
           },
           counters: counter_data,
           libs: [],

data/lib/vernier/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vernier
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - John Hawthorn
 bindir: exe
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport