vernier 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ba6d060b4eb230a865df67f378f81b08721d36a9f8cf394f9a8d5d0455b844
-  data.tar.gz: d01c209f5fab9bc99940fb5b967a722f69c75376dd6aba0c3e7759a9c52bc698
+  metadata.gz: 4988794520691870cb34178385be791e28fa4806eb1f6934b0d0abf52c8a070c
+  data.tar.gz: b1e63c6f5398f61fb68d634f17f33dc6aa7461344cb8acf446dd75ca52395818
 SHA512:
-  metadata.gz: 65e359b25b1cc5a5e3dc2724ec7c98eb4f20203a98e0fd8f402b5875fe329afb6a20f6fc722f8da2febdd4cd30e8e2d56a00e42a4e5262baffb7a250fba79f3d
-  data.tar.gz: bf9ca5416e6b7b17d316eb9c762273ab711518c7ba50c862f803eed9e2d17fcbdeee378f9d6702d4029715926d105398105c5eb0f6aec046fa540611993ec89a
+  metadata.gz: '082561b2a381f88c540e607d1dd9c0d42d841a0de82fc61471fb2d67754ee14a4fd1e87fa71896b586077664e61fd1db623fd250cd13064d198c9dc91d3f13ed'
+  data.tar.gz: a28c197d405e4f52d999db3ae73187047886e1fcfb7d353d13f26ad5ba4b61f0675daf617119b37d72ad3760bd0dffcae234f2dcb0a0e960a60046dfb87dd784

data/Gemfile

@@ -8,5 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rake-compiler"
+gem "benchmark-ips"
 
 gem "minitest", "~> 5.0"

data/README.md

@@ -30,17 +30,33 @@ gem 'vernier'
 
 ## Usage
 
+The output can be viewed in the web app at https://vernier.prof or locally using the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (both are lightly customized versions of the firefox profiler frontend, which profiles are also compatible with).
+
+- **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.
+
 
 ### Time
 
+
+#### Command line
+
+The easiest way to record a program or script is via the CLI
+
 ```
-Vernier.trace(out: "time_profile.json") { some_slow_method }
+$ vernier run -- ruby -e 'sleep 1'
+starting profiler with interval 500
+#<Vernier::Result 1.001589 seconds, 1 threads, 2002 samples, 1 unique>
+written to /tmp/profile20240328-82441-gkzffc.vernier.json
 ```
 
-The output can be viewed in the web app at https://vernier.prof or locally using the [`profile-viewer` gem](https://github.com/tenderlove/profiler/tree/ruby) (both are lightly customized versions of the firefox profiler frontend, which profiles are also compatible with).
+### Block of code
 
-- **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.
+``` ruby
+Vernier.run(out: "time_profile.json") do
+  some_slow_method
+end
+```
 
 ### Retained memory
 

data/examples/gvl_sleep.rb

@@ -0,0 +1,62 @@
+# Different (bad) ways to sleep
+
+File.write("#{__dir__}/my_sleep.c", <<~EOF)
+#include <time.h>
+#include <sys/errno.h>
+
+void my_sleep() {
+  struct timespec ts;
+  ts.tv_sec = 1;
+  ts.tv_nsec = 0;
+
+  int rc;
+  do {
+    rc = nanosleep(&ts, &ts);
+  } while (rc < 0 && errno == EINTR);
+}
+EOF
+
+soext = RbConfig::CONFIG["SOEXT"]
+system("gcc", "-shared", "-fPIC", "#{__dir__}/my_sleep.c", "-o", "#{__dir__}/my_sleep.#{soext}")
+
+require "fiddle"
+
+SLEEP_LIB = Fiddle.dlopen("./my_sleep.#{soext}")
+
+def cfunc_sleep_gvl
+  Fiddle::Function.new(SLEEP_LIB['my_sleep'], [], Fiddle::TYPE_VOID, need_gvl: true).call
+end
+
+def cfunc_sleep_idle
+  Fiddle::Function.new(SLEEP_LIB['my_sleep'], [], Fiddle::TYPE_VOID, need_gvl: true).call
+end
+
+def ruby_sleep_gvl
+  target = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond) + 1000
+  while Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond) < target
+    i = 0
+    while i < 1000
+      i += 1
+    end
+  end
+end
+
+def sleep_idle
+  sleep 1
+end
+
+def run(name)
+  STDOUT.print "#{name}..."
+  STDOUT.flush
+
+  before = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  send(name)
+  after = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+  STDOUT.puts " %.2fs" % (after - before)
+end
+
+run(:cfunc_sleep_gvl)
+run(:cfunc_sleep_idle)
+run(:ruby_sleep_gvl)
+run(:sleep_idle)

data/examples/measure_overhead.rb

@@ -0,0 +1,39 @@
+require "benchmark/ips"
+require "vernier"
+
+def compare(**options, &block)
+  block.call
+
+  Benchmark.ips do |x|
+    x.report "no profiler" do |n|
+      n.times do
+        block.call
+      end
+    end
+
+    x.report "vernier" do |n|
+      Vernier.profile(**options) do
+        n.times do
+          block.call
+        end
+      end
+    end
+
+    x.compare!
+  end
+end
+
+compare do
+  i = 0
+  while i < 10_000
+    i += 1
+  end
+end
+
+compare(allocation_sample_rate: 1000) do
+  Object.new
+end
+
+compare(allocation_sample_rate: 1) do
+  Object.new
+end