sperf 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d6adf217328a161001097ef85fd62f9716a70089c254f6a831f2d8135d7a52
-  data.tar.gz: 92b0aefb1cd263fb86c84553b76cbf1f3124eff5c24e2ceb7d8e15e36f7d5012
+  metadata.gz: 125090cb17cacbc9157402fcb9db54117011ccde812da775ea00b6c1f6bee535
+  data.tar.gz: 1430d997988a6538059a0c63be28d4f05f43681d1f2efbd84020490308a5c279
 SHA512:
-  metadata.gz: ee0ba192454f4794b1f9c064ea743978dde3f8eb5588c2ed590b0cb90604e26aa373223e4d7eaf3b8f3ed56b7a8564a79aef7cc40b9fd806b528ac8482a22dc2
-  data.tar.gz: e3519944bab031f83418893bdbf122ab0e308f1d72246dfca5315128365749c085fa3e1aa99f1fb75edd6d2fd2e7c3014fc86c996348420f69b32c80fb1a4b22
+  metadata.gz: 17a52cfc856ae47f254bf0df3450ff76cd471703c97e029907abbf639aa9dd8d6971ef8b18acf6a9784b87b295981533776c147b0fc31993e33dcf528cf15a3d
+  data.tar.gz: 6bbad7152c998859f4ec1f07d42eeca8824918ad635b0454fbe13635d9b913ad309b09f8e7c760f5cdd4cc1d32d1316ba50a5fb7c1863e7718cb1df01a2761ad

data/README.md

@@ -9,6 +9,7 @@ A safepoint-based sampling performance profiler for Ruby. Uses actual time delta
 - Requires Ruby >= 3.4.0
 - Output: pprof protobuf, collapsed stacks, or text report
 - Modes: CPU time (per-thread) and wall time (with GVL/GC tracking)
+- [Online manual](https://ko1.github.io/sperf/docs/manual/) | [GitHub](https://github.com/ko1/sperf)
 
 ## Quick Start
 
@@ -56,7 +57,7 @@ Profile without code changes (e.g., Rails):
 SPERF_ENABLED=1 SPERF_MODE=wall SPERF_OUTPUT=profile.pb.gz ruby app.rb
 ```
 
-Run `sperf help` for full documentation (all options, output interpretation, diagnostics guide).
+Run `sperf help` for full documentation, or see the [online manual](https://ko1.github.io/sperf/).
 
 ## Subcommands
 

data/exe/sperf

@@ -1,5 +1,13 @@
 #!/usr/bin/env ruby
 require "optparse"
+require "socket"
+
+def find_available_port
+  server = TCPServer.new("localhost", 0)
+  port = server.addr[1]
+  server.close
+  port
+end
 
 HELP_TEXT = <<'HELP'
 sperf - safepoint-based sampling performance profiler for Ruby
@@ -22,12 +30,16 @@ CLI USAGE
     -f, --frequency HZ      Sampling frequency in Hz (default: 1000)
     -m, --mode MODE         cpu or wall (default: cpu)
     --format FORMAT         pprof, collapsed, or text (default: auto from extension)
+    --signal VALUE          Timer signal (Linux only): signal number, or 'false'
+                            for nanosleep thread (default: auto)
     -v, --verbose           Print sampling statistics to stderr
 
   stat: Run command and print performance summary to stderr.
     Always uses wall mode. No file output by default.
     -o, --output PATH       Also save profile to file (default: none)
     -f, --frequency HZ      Sampling frequency in Hz (default: 1000)
+    --signal VALUE          Timer signal (Linux only): signal number, or 'false'
+                            for nanosleep thread (default: auto)
     -v, --verbose           Print additional sampling statistics
 
     Shows: user/sys/real time, time breakdown (CPU execution, GVL blocked,
@@ -230,6 +242,7 @@ ENVIRONMENT VARIABLES
     SPERF_MODE=cpu|wall   Profiling mode
     SPERF_FORMAT=fmt      pprof, collapsed, or text
     SPERF_VERBOSE=1       Print statistics
+    SPERF_SIGNAL=N|false  Timer signal number or 'false' for nanosleep (Linux only)
 
 TIPS
 
@@ -316,7 +329,7 @@ when "report"
   when :text
     exec("go", "tool", "pprof", "-text", report_file)
   else
-    exec("go", "tool", "pprof", "-http=:0", report_file)
+    exec("go", "tool", "pprof", "-http=localhost:#{find_available_port}", report_file)
   end
 when "diff"
   # sperf diff: compare two pprof profiles via go tool pprof -diff_base
@@ -374,7 +387,7 @@ when "diff"
   when :text
     exec("go", "tool", "pprof", "-text", "-diff_base=#{base_file}", target_file)
   else
-    exec("go", "tool", "pprof", "-http=:0", "-diff_base=#{base_file}", target_file)
+    exec("go", "tool", "pprof", "-http=localhost:#{find_available_port}", "-diff_base=#{base_file}", target_file)
   end
 when "record", "stat"
   # continue below
@@ -388,6 +401,7 @@ output = (subcommand == "stat") ? nil : "sperf.data"
 frequency = 1000
 mode = (subcommand == "stat") ? "wall" : "cpu"
 format = nil
+signal = nil
 verbose = false
 
 parser = OptionParser.new do |opts|
@@ -412,6 +426,10 @@ parser = OptionParser.new do |opts|
     end
   end
 
+  opts.on("--signal VALUE", "Timer signal (Linux only): signal number, or 'false' for nanosleep thread") do |v|
+    signal = (v == "false") ? "false" : v
+  end
+
   opts.on("-v", "--verbose", "Print sampling statistics to stderr") do
     verbose = true
   end
@@ -448,6 +466,7 @@ ENV["SPERF_FREQUENCY"] = frequency.to_s
 ENV["SPERF_MODE"] = mode
 ENV["SPERF_FORMAT"] = format if format
 ENV["SPERF_VERBOSE"] = "1" if verbose
+ENV["SPERF_SIGNAL"] = signal if signal
 
 if subcommand == "stat"
   ENV["SPERF_STAT"] = "1"

data/lib/sperf/version.rb

@@ -1,3 +1,3 @@
 module Sperf
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/sperf.rb

@@ -359,11 +359,18 @@ module Sperf
     _sperf_mode = _sperf_mode_str == "wall" ? :wall : :cpu
     _sperf_format = ENV["SPERF_FORMAT"] ? ENV["SPERF_FORMAT"].to_sym : nil
     _sperf_stat = ENV["SPERF_STAT"] == "1"
-    start(frequency: (ENV["SPERF_FREQUENCY"] || 1000).to_i, mode: _sperf_mode,
-          output: _sperf_stat ? ENV["SPERF_OUTPUT"] : (ENV["SPERF_OUTPUT"] || "sperf.data"),
-          verbose: ENV["SPERF_VERBOSE"] == "1",
-          format: _sperf_format,
-          stat: _sperf_stat)
+    _sperf_signal = case ENV["SPERF_SIGNAL"]
+                    when nil then nil
+                    when "false" then false
+                    else ENV["SPERF_SIGNAL"].to_i
+                    end
+    _sperf_start_opts = { frequency: (ENV["SPERF_FREQUENCY"] || 1000).to_i, mode: _sperf_mode,
+                          output: _sperf_stat ? ENV["SPERF_OUTPUT"] : (ENV["SPERF_OUTPUT"] || "sperf.data"),
+                          verbose: ENV["SPERF_VERBOSE"] == "1",
+                          format: _sperf_format,
+                          stat: _sperf_stat }
+    _sperf_start_opts[:signal] = _sperf_signal unless _sperf_signal.nil?
+    start(**_sperf_start_opts)
     at_exit { stop }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sperf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
   - Koichi Sasada