rperf 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dd9ddc0ea22d51ff2ebcdae6ddfa2f5e531c4a7814552b16470668d04d1d617
-  data.tar.gz: fce76e35ea6ccbca8e8b429da4b55574349f98b8731a2db3826efd908082dda6
+  metadata.gz: 3240adc0c0b301a502b663cd9b044e02661c64e072e5a6582ac30d273b349d54
+  data.tar.gz: a49b1fab25b96e80f17f942acba4a07aef745a61e565587f791f99c878a0d84e
 SHA512:
-  metadata.gz: dceedb899f6b9249ae342e5701ef3280253c82d317ad73dea0bdd0c0c040a576740bb747c05c79b1f6118c82b05ad4756207ac046d9cc4805982a2f24ad09e1b
-  data.tar.gz: 4353afbe9ca80126c25884e837aacdd902a1e9d20756d543d235415492e17932490711b348ee49eb9e5144f977027a1284876cbd4dea4de31c342a16db16d931
+  metadata.gz: 1e5c770faca5dfe03cb87eb83d3021f12b0bbf23433eac923656910fe7275ebe20c08aec7046ab82975ccf2b7b1574bb062493712bee6e2adb5d772e9f60beb6
+  data.tar.gz: 776f023349f55073383d78c81736a578cb31f8d1973c49a57b3eef596a132edb1a03e89734fad69f53395c91578a431c27e4952fd6c272b3a069b04dc577c0e7

data/README.md

@@ -82,6 +82,12 @@ rperf report ./profiles/                             # sidebar: per-commit list,
 
 # Flat tables for AI analysis (no Go required)
 rperf diff --format table base.json.gz head.json.gz | claude -p "analyze the regression"
+
+# Drive rperf without wrapping the command (CI/tooling): source the env, then
+# run your command unchanged — `bundle exec …` stays bundler-managed, plain
+# `ruby …` stays plain. (Run `rperf help` for details.)
+eval "$(rperf record --snapshot-dir ./profiles --print-env)"
+export RPERF_ROOT_PROCESS=$$ && exec ruby app.rb
 ```
 
 On `rperf report`, you can see the profile result like this page: [rperf viewer](https://ko1.github.io/rperf/examples/cpu_intensive_profile.html)

data/docs/help.md

@@ -31,8 +31,28 @@ POSIX systems (Linux, macOS). Requires Ruby >= 3.4.0.
     --label KEY=VALUE       Add a label to profile metadata (repeatable)
     --no-inherit            Do not profile forked/spawned child processes
     --no-aggregate          Disable C-level sample aggregation (raw per-sample data)
+    --print-env             Print the env rperf would set (export KEY=VALUE lines)
+                            and exit WITHOUT running a command — see below
     -v, --verbose           Print sampling statistics to stderr
 
+#### --print-env: drive rperf without wrapping the command
+
+Instead of `rperf record [options] -- command`, `--print-env` prints the
+environment a profiled process auto-starts from and exits without running
+anything. A wrapper (e.g. a CI script) sources it, makes the process that runs
+the command the session root, and runs the command unchanged — so a
+`bundle exec …` command stays bundler-managed and a plain `ruby …` stays plain;
+rperf is never inserted into the command line.
+
+    eval "$(rperf record --snapshot-dir ./profiles --print-env)"
+    export RPERF_ROOT_PROCESS=$$    # the pid that will exec the command is the root
+    exec ruby app.rb               # runs verbatim; rperf auto-starts via RUBYOPT
+
+`RPERF_ROOT_PROCESS` is not emitted (the caller sets it to the pid that execs
+the command); `RPERF_META_LABELS` is not emitted (set it yourself if you want
+per-run labels). Everything else (`RUBYOPT=-rrperf`, output path, mode,
+frequency, fork session dir, …) is included.
+
 JSON output embeds `meta` (git commit, host, Ruby/rperf versions, labels)
 and `summary` (time, GC, allocation, top methods) — see "Profile metadata"
 under OUTPUT FORMATS.

data/exe/rperf

@@ -368,6 +368,7 @@ stat_report = (subcommand == "exec")
 inherit = true
 meta_labels = {}
 snapshot_dir = nil
+print_env = false
 
 parser = OptionParser.new do |opts|
   opts.banner = case subcommand
@@ -441,6 +442,13 @@ parser = OptionParser.new do |opts|
     inherit = false
   end
 
+  opts.on("--print-env",
+          "Print the environment rperf would set (one `export KEY=VALUE` per line), then exit " \
+          "WITHOUT running a command. The caller sources it, sets RPERF_ROOT_PROCESS to the pid " \
+          "that will exec the command, and runs the command itself — so rperf never wraps it.") do
+    print_env = true
+  end
+
   opts.on("-v", "--verbose", "Print sampling statistics to stderr") do
     verbose = true
   end
@@ -461,7 +469,7 @@ rescue OptionParser::ParseError => e
   exit 1
 end
 
-if ARGV.empty?
+if ARGV.empty? && !print_env
   $stderr.puts "No command specified."
   $stderr.puts parser
   exit 1
@@ -557,9 +565,27 @@ session_dir = nil
 if inherit
   session_dir = Rperf.send(:_create_session_dir, clean_stale: true)
   if session_dir
-    ENV["RPERF_ROOT_PROCESS"] = Process.pid.to_s
     ENV["RPERF_SESSION_DIR"] = session_dir
+    # In --print-env mode this short-lived process does not run the command, so
+    # it must not claim rootship: the caller sets RPERF_ROOT_PROCESS to the pid
+    # that will exec the command. Otherwise (normal exec) we are the root.
+    ENV["RPERF_ROOT_PROCESS"] = Process.pid.to_s unless print_env
+  end
+end
+
+# --print-env: emit the environment a profiled process inherits to auto-start
+# rperf, then exit without running anything. RPERF_ROOT_PROCESS and
+# RPERF_META_LABELS are deliberately omitted — the caller owns those (it sets
+# the root pid, and labels per measurement run).
+if print_env
+  require "shellwords"
+  %w[RUBYLIB RUBYOPT RPERF_ENABLED RPERF_OUTPUT RPERF_FREQUENCY RPERF_MODE
+     RPERF_FORMAT RPERF_VERBOSE RPERF_SIGNAL RPERF_AGGREGATE RPERF_META_GIT
+     RPERF_SESSION_DIR RPERF_STAT RPERF_STAT_COMMAND RPERF_STAT_REPORT].each do |k|
+    v = ENV[k]
+    puts "export #{k}=#{Shellwords.escape(v)}" unless v.nil?
   end
+  exit 0
 end
 
 begin

data/lib/rperf/meta.rb

@@ -6,7 +6,11 @@
 # first two top-level keys, so Meta.read can decompress only the head of the
 # file and stop as soon as both are extracted.
 
-require "json"
+# NOTE: json is NOT required here. rperf loads via `ruby -rrperf` at interpreter
+# boot, before the profiled app runs `bundler/setup`. Requiring json eagerly
+# would activate the default json gem and then clash with a bundle that pins a
+# different json (Gem::LoadError). json is used only at profile write/read time
+# (after the app has set up its bundle), so each user requires it lazily.
 require "time"
 require "zlib"
 
@@ -103,6 +107,7 @@ module Rperf
         v = ENV["RPERF_META_GIT"].to_s
         return nil if v.empty? || v == "null"
         begin
+          require "json"
           JSON.parse(v, symbolize_names: true)
         rescue JSON::ParserError
           nil
@@ -119,6 +124,7 @@ module Rperf
       v = ENV["RPERF_META_LABELS"]
       return nil unless v
       begin
+        require "json"
         labels = JSON.parse(v)
         labels.is_a?(Hash) ? labels : nil
       rescue JSON::ParserError
@@ -224,6 +230,7 @@ module Rperf
     # Returns { meta:, summary: }, nil (old format / malformed),
     # or :incomplete (need more input).
     def scan_prefix(buf)
+      require "json" # lazy: see the note at the top of this file
       n = buf.bytesize
       i = skip_ws(buf, 0, n)
       return :incomplete if i >= n

data/lib/rperf/table.rb

@@ -5,8 +5,11 @@
 # TSV: header row, data rows, then a trailing "# summary" line of
 # tab-separated key=value pairs.
 # JSON: an array of row objects; the last element is { "summary": { ... } }.
-
-require "json"
+#
+# json is required lazily in the format methods, not here: rperf loads at
+# interpreter boot via `-rrperf`, before the profiled app's bundler/setup, and
+# eagerly activating the default json gem would clash with a bundle that pins a
+# different json (see the note in meta.rb).
 
 module Rperf
   module Table
@@ -67,6 +70,7 @@ module Rperf
     end
 
     def report_json(data)
+      require "json"
       JSON.generate(report_rows(data) + [{ summary: report_summary(data) }])
     end
 
@@ -117,6 +121,7 @@ module Rperf
     end
 
     def diff_json(base, head)
+      require "json"
       JSON.generate(diff_rows(base, head) + [{ summary: diff_summary(base, head) }])
     end
 

data/lib/rperf/version.rb

@@ -1,3 +1,3 @@
 module Rperf
-  VERSION = "0.10.0"
+  VERSION = "0.11.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rperf
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Koichi Sasada
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Safepoint-based sampling performance profiler for Ruby
 test_files: []