vernier 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52f738e495accaaab1af3f33a806a7b20467aa8f2a93f4b7bf8d7300fdaf88ad
-  data.tar.gz: e6877e7315fb990e8db9482b940a96068770987989fec85a804c75ce79b62022
+  metadata.gz: 6050bca74116d0e90f98025fe23d7fbd40c6107c085e3f768d606d4f418ebc60
+  data.tar.gz: e302542d8b06852d28d0ec1e2528f23bba46d5ef9ea9a828c9dbcdb985a292a3
 SHA512:
-  metadata.gz: 4dcf1c2ebcbfcfd1b5a456fbc9ffbfd82da1f96622b8dc889d9ece105a9f461768dd688b6e0ee73102db104bff527a9c940f6d74689d520005ea216823444cbe
-  data.tar.gz: 97e0116ec7de5ee084512520debd37d0262555ca6a09d427b9147c3e08303492c925e8b1f81c9299915aff6322122a82e8737d1ef22823da8689aab2ce63aa6f
+  metadata.gz: 9d20e5f9d9c894a253bc4aeb6b9da6cb35d916e881abedf996ce19757a9cd92efe43bcc76fda0aa4ce5e334be36582adf7c716a998c4c5e1f403dc57364fb5ab
+  data.tar.gz: 7cf03df7bcb4f961b5b456eb781fd5818de7e18501baa01592ce17528f5eae7b272e90dcff200f861495ebb1a83c87f9146306db66ce20a9d56467ab87bce3c6

data/README.md

@@ -1,6 +1,22 @@
 # Vernier
 
-Experimental next-generation Ruby sampling profiler. Tracks multiple threads, GVL activity, GC pauses, idle time, and more.
+Next-generation Ruby sampling profiler. Tracks multiple threads, GVL activity, GC pauses, idle time, and more.
+
+## Examples
+
+[Livestreamed demo: Pairin' with Aaron (YouTube)](https://www.youtube.com/watch?v=9nvX3OHykGQ#t=27m43)
+
+Sidekiq jobs from Mastodon (time, threded)
+: https://share.firefox.dev/44jZRf3
+
+Puma web requests from Mastodon (time, threded)
+: https://share.firefox.dev/48FOTnF
+
+Rails benchmark - lobste.rs (time)
+: https://share.firefox.dev/3Ld89id
+
+`require "irb"` (retained memory)
+: https://share.firefox.dev/3DhLsFa
 
 ## Installation
 
@@ -10,24 +26,24 @@ gem 'vernier'
 
 ## Usage
 
-### Retained memory
 
-Record a flamegraph of all **retained** allocations from loading `irb`.
+### Time
 
 ```
-ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "irb" }'
+Vernier.trace(out: "time_profile.json") { some_slow_method }
 ```
 
-The output can then be viewed in the [Firefox Profiler (demo)](https://share.firefox.dev/3DhLsFa) or the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (a Ruby-customized version of the firefox profiler.
+The output can then be viewed in the Firefox Profiler (demo) or the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (a Ruby-customized version of the firefox profiler.
 
-![Screenshot 2023-07-16 at 21-06-19 Ruby_Vernier – 1970-01-01 12 00 00 a m  UTC – Firefox Profiler](https://github.com/jhawthorn/vernier/assets/131752/9ca0b593-70fb-4c8b-aed9-cb33e0e0bc06)
+### Retained memory
 
-### Time
+Record a flamegraph of all **retained** allocations from loading `irb`.
 
 ```
-Vernier.trace(out: "time_profile.json") { some_slow_method }
+ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "irb" }'
 ```
 
+
 ## 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/ext/vernier/vernier.cc

@@ -72,13 +72,17 @@ class TimeStamp {
         return TimeStamp(0);
     }
 
-    static void Sleep(const TimeStamp &time) {
-        struct timespec ts = time.timespec();
+    // SleepUntil a specified timestamp
+    // Highly accurate manual sleep time
+    static void SleepUntil(const TimeStamp &target_time) {
+        if (target_time.zero()) return;
+        struct timespec ts = target_time.timespec();
 
         int res;
         do {
-            res = nanosleep(&ts, &ts);
-        } while (res && errno == EINTR);
+            // do nothing until it's time :)
+            sleep(0);
+        } while (target_time > TimeStamp::Now());
     }
 
     static TimeStamp from_microseconds(uint64_t us) {
@@ -1091,6 +1095,9 @@ class RetainedCollector : public BaseCollector {
         VALUE weights = rb_ary_new();
         rb_hash_aset(thread_hash, sym("weights"), weights);
 
+        rb_hash_aset(thread_hash, sym("name"), rb_str_new_cstr("retained memory"));
+        rb_hash_aset(thread_hash, sym("started_at"), ULL2NUM(collector->started_at.nanoseconds()));
+
         for (auto& obj: collector->object_list) {
             const auto search = collector->object_frames.find(obj);
             if (search != collector->object_frames.end()) {
@@ -1252,13 +1259,12 @@ class TimeCollector : public BaseCollector {
 
             next_sample_schedule += interval;
 
+            // If sampling falls behind, restart, and check in another interval
             if (next_sample_schedule < sample_complete) {
-                //fprintf(stderr, "fell behind by %ius\n", (sample_complete - next_sample_schedule).microseconds());
                 next_sample_schedule = sample_complete + interval;
             }
 
-            TimeStamp sleep_time = next_sample_schedule - sample_complete;
-            TimeStamp::Sleep(sleep_time);
+            TimeStamp::SleepUntil(next_sample_schedule);
         }
 
         thread_stopped.post();

data/lib/vernier/output/firefox.rb

@@ -157,14 +157,15 @@ module Vernier
       class Thread
         attr_reader :profile
 
-        def initialize(profile, categorizer, name:, tid:, samples:, weights:, timestamps:, sample_categories:, markers:, started_at:, stopped_at: nil)
+        def initialize(profile, categorizer, name:, tid:, samples:, weights:, timestamps: nil, sample_categories: nil, markers:, started_at:, stopped_at: nil)
           @profile = profile
           @categorizer = categorizer
           @tid = tid
           @name = name
 
+          timestamps ||= [0] * samples.size
           @samples, @weights, @timestamps = samples, weights, timestamps
-          @sample_categories = sample_categories
+          @sample_categories = sample_categories || ([0] * samples.size)
           @markers = markers
 
           @started_at, @stopped_at = started_at, stopped_at
@@ -211,7 +212,7 @@ module Vernier
         def data
           {
             name: @name,
-            isMainThread: @tid == ::Thread.main.native_thread_id,
+            isMainThread: (@tid == ::Thread.main.native_thread_id) || (profile.threads.size == 1),
             processStartupTime: 0, # FIXME
             processShutdownTime: nil, # FIXME
             registerTime: (@started_at - 0) / 1_000_000.0,
@@ -237,8 +238,6 @@ module Vernier
         end
 
         def markers_table
-          size = @markers.size
-
           string_indexes = []
           start_times = []
           end_times = []
@@ -292,7 +291,6 @@ module Vernier
             times = (0...size).to_a
           end
 
-          raise unless samples.size == size
           raise unless weights.size == size
           raise unless times.size == size
 

data/lib/vernier/version.rb

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

data/lib/vernier.rb

@@ -19,11 +19,11 @@ module Vernier
       yield collector
     ensure
       result = collector.stop
+      if out
+        File.write(out, Output::Firefox.new(result).output)
+      end
     end
 
-    if out
-      File.write(out, Output::Firefox.new(result).output)
-    end
     result
   end
 

data/vernier.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = spec.summary
   spec.homepage = "https://github.com/jhawthorn/vernier"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
+  spec.required_ruby_version = ">= 3.2.1"
 
   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: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - John Hawthorn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies: []
 description: An experimental profiler
 email:
@@ -60,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="