stackprof 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81201dbe84f93b79242ce9987c763b7edaa54b4f66a7005ff83d22a9b4e25cb4
-  data.tar.gz: c80ad82b003cb989c83bc5882f4bcdeb6f6db697729315faf6d4507b7f3888fb
+  metadata.gz: 50313d95bc2bb3257ea5d4bc6b4c1889f7d6c4c2612b35b7a289de1d8abddaf8
+  data.tar.gz: ac748642b2298f1d23a0c950eed379dd6670eaef7ad300bc5ab5341886d22b39
 SHA512:
-  metadata.gz: f4fec270902e0b6f21e9d37b8317a2c3614cf4647ad29956b52561bc6c86d7625c4ee3362388c1323c1b74fd2fbb6c99242e75cf0314e20f5be97491e9888122
-  data.tar.gz: 01a18137afc847cba43882fbc7e22483e350490e655e9536f0dc1cb5275a49c222c4613b9a4f39cb0d3265a6e834560fc87cac4fae77324634bc2f68cde0c03a
+  metadata.gz: d790c7c34cc8f12e5e3d12cfc2476e94801e62f79a8ccb747b3d0743b9b8d0bb8ec8fd92757c5696814c028ddeaa4044bbaa0d242fe5796079f741d2fdbef2d6
+  data.tar.gz: b3e5d358816564a6a3a72bfd68c2d94f184a27430b9b75765cf733c4c5104e7c4020ce72bfdf6d3698bbf0456ca487314fb094a0faf6eed7040bce10726df017

data/.travis.yml

@@ -7,7 +7,6 @@ language: general
 
 env:
   matrix:
-    - RVM_RUBY_VERSION=2.1
     - RVM_RUBY_VERSION=2.2
     - RVM_RUBY_VERSION=2.3
     - RVM_RUBY_VERSION=2.4

data/CHANGELOG.md

@@ -1,15 +1,7 @@
-# 0.2.13
+# 0.2.14
 
-* Remove /ext from .gitignore
-* update gemfile
-* Add ruby 2.5 to CI targets
-* comment some of the inner workings
-* feature: add --json format
-* Add test coverage around the string branch in result writing
-* Flip conditional to use duck typing
-* Allow Pathname objects for Stackprof :out
-* Fix a compilation error and a compilation warning
-* Add `--alphabetical-flamegraph` for population-based instead of timeline
-* Add `--d3-flamegraph` to output html using d3-flame-graph
-* Avoid JSON::NestingError when processing deep stacks
-* Use docker for CI
+* Relax threshold of missed_samples to <= 25 in GC test
+* Support custom metadata option in stackprof
+* Drop support for Ruby 2.1
+* More generic handling of "fake" frame names
+* Record marking and sweeping as fake gc calls

data/README.md

@@ -6,7 +6,7 @@ Inspired heavily by [gperftools](https://code.google.com/p/gperftools/), and wri
 
 ## Requirements
 
-* Ruby 2.1+
+* Ruby 2.2+
 * Linux-based OS
 
 ## Getting Started
@@ -330,6 +330,7 @@ Option      | Meaning
 `interval`  | mode-relative sample rate [c.f.](#sampling)
 `aggregate` | defaults: `true` - if `false` disables [aggregation](#aggregation)
 `raw`       | defaults `false` - if `true` collects the extra data required by the `--flamegraph` and `--stackcollapse` report types
+`metadata`  | defaults to `{}`. Must be a `Hash`. metadata associated with this profile
 `save_every`| (rack middleware only) write the target file after this many requests
 
 ## Todo

data/ext/stackprof/stackprof.c

@@ -17,6 +17,18 @@
 
 #define BUF_SIZE 2048
 
+#define FAKE_FRAME_GC    INT2FIX(0)
+#define FAKE_FRAME_MARK  INT2FIX(1)
+#define FAKE_FRAME_SWEEP INT2FIX(2)
+
+static const char *fake_frame_cstrs[] = {
+	"(garbage collection)",
+	"(marking)",
+	"(sweeping)",
+};
+
+#define TOTAL_FAKE_FRAMES (sizeof(fake_frame_cstrs) / sizeof(char *))
+
 typedef struct {
     size_t total_samples;
     size_t caller_samples;
@@ -33,6 +45,7 @@ static struct {
     VALUE mode;
     VALUE interval;
     VALUE out;
+    VALUE metadata;
 
     VALUE *raw_samples;
     size_t raw_samples_len;
@@ -48,10 +61,11 @@ static struct {
     size_t overall_samples;
     size_t during_gc;
     size_t unrecorded_gc_samples;
+    size_t unrecorded_gc_marking_samples;
+    size_t unrecorded_gc_sweeping_samples;
     st_table *frames;
 
-    VALUE fake_gc_frame;
-    VALUE fake_gc_frame_name;
+    VALUE fake_frame_names[TOTAL_FAKE_FRAMES];
     VALUE empty_string;
     VALUE frames_buffer[BUF_SIZE];
     int lines_buffer[BUF_SIZE];
@@ -59,7 +73,8 @@ static struct {
 
 static VALUE sym_object, sym_wall, sym_cpu, sym_custom, sym_name, sym_file, sym_line;
 static VALUE sym_samples, sym_total_samples, sym_missed_samples, sym_edges, sym_lines;
-static VALUE sym_version, sym_mode, sym_interval, sym_raw, sym_frames, sym_out, sym_aggregate, sym_raw_timestamp_deltas;
+static VALUE sym_version, sym_mode, sym_interval, sym_raw, sym_metadata, sym_frames, sym_out, sym_aggregate, sym_raw_timestamp_deltas;
+static VALUE sym_state, sym_marking, sym_sweeping;
 static VALUE sym_gc_samples, objtracer;
 static VALUE gc_hook;
 static VALUE rb_mStackProf;
@@ -72,7 +87,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
 {
     struct sigaction sa;
     struct itimerval timer;
-    VALUE opts = Qnil, mode = Qnil, interval = Qnil, out = Qfalse;
+    VALUE opts = Qnil, mode = Qnil, interval = Qnil, metadata = rb_hash_new(), out = Qfalse;
     int raw = 0, aggregate = 1;
 
     if (_stackprof.running)
@@ -85,6 +100,14 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
 	interval = rb_hash_aref(opts, sym_interval);
 	out = rb_hash_aref(opts, sym_out);
 
+	VALUE metadata_val = rb_hash_aref(opts, sym_metadata);
+	if (RTEST(metadata_val)) {
+	    if (!RB_TYPE_P(metadata_val, T_HASH))
+		rb_raise(rb_eArgError, "metadata should be a hash");
+
+	    metadata = metadata_val;
+	}
+
 	if (RTEST(rb_hash_aref(opts, sym_raw)))
 	    raw = 1;
 	if (rb_hash_lookup2(opts, sym_aggregate, Qundef) == Qfalse)
@@ -128,6 +151,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
     _stackprof.aggregate = aggregate;
     _stackprof.mode = mode;
     _stackprof.interval = interval;
+    _stackprof.metadata = metadata;
     _stackprof.out = out;
 
     if (raw) {
@@ -201,8 +225,8 @@ frame_i(st_data_t key, st_data_t val, st_data_t arg)
 
     rb_hash_aset(results, rb_obj_id(frame), details);
 
-    if (frame == _stackprof.fake_gc_frame) {
-	name = _stackprof.fake_gc_frame_name;
+    if (FIXNUM_P(frame)) {
+	name = _stackprof.fake_frame_names[FIX2INT(frame)];
 	file = _stackprof.empty_string;
 	line = INT2FIX(0);
     } else {
@@ -258,6 +282,7 @@ stackprof_results(int argc, VALUE *argv, VALUE self)
     rb_hash_aset(results, sym_samples, SIZET2NUM(_stackprof.overall_samples));
     rb_hash_aset(results, sym_gc_samples, SIZET2NUM(_stackprof.during_gc));
     rb_hash_aset(results, sym_missed_samples, SIZET2NUM(_stackprof.overall_signals - _stackprof.overall_samples));
+    rb_hash_aset(results, sym_metadata, _stackprof.metadata);
 
     frames = rb_hash_new();
     rb_hash_aset(results, sym_frames, frames);
@@ -522,15 +547,37 @@ stackprof_record_gc_samples()
 	}
     }
 
-    _stackprof.frames_buffer[0] = _stackprof.fake_gc_frame;
-    _stackprof.lines_buffer[0] = 0;
 
     for (i = 0; i < _stackprof.unrecorded_gc_samples; i++) {
 	int timestamp_delta = i == 0 ? delta_to_first_unrecorded_gc_sample : NUM2LONG(_stackprof.interval);
-	stackprof_record_sample_for_stack(1, timestamp_delta);
+
+      if (_stackprof.unrecorded_gc_marking_samples) {
+        _stackprof.frames_buffer[0] = FAKE_FRAME_MARK;
+        _stackprof.lines_buffer[0] = 0;
+        _stackprof.frames_buffer[1] = FAKE_FRAME_GC;
+        _stackprof.lines_buffer[1] = 0;
+        _stackprof.unrecorded_gc_marking_samples--;
+
+        stackprof_record_sample_for_stack(2, timestamp_delta);
+      } else if (_stackprof.unrecorded_gc_sweeping_samples) {
+        _stackprof.frames_buffer[0] = FAKE_FRAME_SWEEP;
+        _stackprof.lines_buffer[0] = 0;
+        _stackprof.frames_buffer[1] = FAKE_FRAME_GC;
+        _stackprof.lines_buffer[1] = 0;
+
+        _stackprof.unrecorded_gc_sweeping_samples--;
+
+        stackprof_record_sample_for_stack(2, timestamp_delta);
+      } else {
+        _stackprof.frames_buffer[0] = FAKE_FRAME_GC;
+        _stackprof.lines_buffer[0] = 0;
+        stackprof_record_sample_for_stack(1, timestamp_delta);
+      }
     }
     _stackprof.during_gc += _stackprof.unrecorded_gc_samples;
     _stackprof.unrecorded_gc_samples = 0;
+    _stackprof.unrecorded_gc_marking_samples = 0;
+    _stackprof.unrecorded_gc_sweeping_samples = 0;
 }
 
 static void
@@ -562,6 +609,12 @@ stackprof_signal_handler(int sig, siginfo_t *sinfo, void *ucontext)
 {
     _stackprof.overall_signals++;
     if (rb_during_gc()) {
+	VALUE mode = rb_gc_latest_gc_info(sym_state);
+	if (mode == sym_marking) {
+	    _stackprof.unrecorded_gc_marking_samples++;
+	} else if (mode == sym_sweeping) {
+	    _stackprof.unrecorded_gc_sweeping_samples++;
+	}
 	_stackprof.unrecorded_gc_samples++;
 	rb_postponed_job_register_one(0, stackprof_gc_job_handler, (void*)0);
     } else {
@@ -642,6 +695,7 @@ stackprof_atfork_child(void)
 void
 Init_stackprof(void)
 {
+    size_t i;
 #define S(name) sym_##name = ID2SYM(rb_intern(#name));
     S(object);
     S(custom);
@@ -662,10 +716,17 @@ Init_stackprof(void)
     S(raw);
     S(raw_timestamp_deltas);
     S(out);
+    S(metadata);
     S(frames);
     S(aggregate);
+    S(state);
+    S(marking);
+    S(sweeping);
 #undef S
 
+    /* Need to run this to warm the symbol table before we call this during GC */
+    rb_gc_latest_gc_info(sym_state);
+
     gc_hook = Data_Wrap_Struct(rb_cObject, stackprof_gc_mark, NULL, &_stackprof);
     rb_global_variable(&gc_hook);
 
@@ -678,12 +739,14 @@ Init_stackprof(void)
     _stackprof.raw_timestamp_deltas_len = 0;
     _stackprof.raw_timestamp_deltas_capa = 0;
 
-    _stackprof.fake_gc_frame = INT2FIX(0x9C);
     _stackprof.empty_string = rb_str_new_cstr("");
-    _stackprof.fake_gc_frame_name = rb_str_new_cstr("(garbage collection)");
-    rb_global_variable(&_stackprof.fake_gc_frame_name);
     rb_global_variable(&_stackprof.empty_string);
 
+    for (i = 0; i < TOTAL_FAKE_FRAMES; i++) {
+	    _stackprof.fake_frame_names[i] = rb_str_new_cstr(fake_frame_cstrs[i]);
+	    rb_global_variable(&_stackprof.fake_frame_names[i]);
+    }
+
     rb_mStackProf = rb_define_module("StackProf");
     rb_define_singleton_method(rb_mStackProf, "running?", stackprof_running_p, 0);
     rb_define_singleton_method(rb_mStackProf, "run", stackprof_run, -1);

data/lib/stackprof.rb

@@ -1,7 +1,7 @@
 require "stackprof/stackprof"
 
 module StackProf
-  VERSION = '0.2.13'
+  VERSION = '0.2.14'
 end
 
 StackProf.autoload :Report, "stackprof/report.rb"

data/lib/stackprof/middleware.rb

@@ -13,12 +13,18 @@ module StackProf
       Middleware.enabled  = options[:enabled]
       options[:path]      = 'tmp/' if options[:path].to_s.empty?
       Middleware.path     = options[:path]
+      Middleware.metadata = options[:metadata] || {}
       at_exit{ Middleware.save } if options[:save_at_exit]
     end
 
     def call(env)
       enabled = Middleware.enabled?(env)
-      StackProf.start(mode: Middleware.mode, interval: Middleware.interval, raw: Middleware.raw) if enabled
+      StackProf.start(
+        mode:     Middleware.mode,
+        interval: Middleware.interval,
+        raw:      Middleware.raw,
+        metadata: Middleware.metadata,
+      ) if enabled
       @app.call(env)
     ensure
       if enabled
@@ -31,7 +37,7 @@ module StackProf
     end
 
     class << self
-      attr_accessor :enabled, :mode, :interval, :raw, :path
+      attr_accessor :enabled, :mode, :interval, :raw, :path, :metadata
 
       def enabled?(env)
         if enabled.respond_to?(:call)

data/stackprof.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.13'
+  s.version = '0.2.14'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'
@@ -14,9 +14,11 @@ Gem::Specification.new do |s|
   s.executables << 'stackprof-flamegraph.pl'
   s.executables << 'stackprof-gprof2dot.py'
 
-  s.summary = 'sampling callstack-profiler for ruby 2.1+'
+  s.summary = 'sampling callstack-profiler for ruby 2.2+'
   s.description = 'stackprof is a fast sampling profiler for ruby code, with cpu, wallclock and object allocation samplers.'
 
+  s.required_ruby_version = '>= 2.2'
+
   s.license = 'MIT'
 
   s.add_development_dependency 'rake-compiler', '~> 0.9'

data/test/test_middleware.rb

@@ -64,4 +64,10 @@ class StackProf::MiddlewareTest < MiniTest::Test
     StackProf::Middleware.new(Object.new, raw: true)
     assert StackProf::Middleware.raw
   end
+
+  def test_metadata
+    metadata = { key: 'value' }
+    StackProf::Middleware.new(Object.new, metadata: metadata)
+    assert_equal metadata, StackProf::Middleware.metadata
+  end
 end

data/test/test_stackprof.rb

@@ -109,6 +109,36 @@ class StackProfTest < MiniTest::Test
     assert_equal 10, profile[:raw_timestamp_deltas].size
   end
 
+  def test_metadata
+    metadata = {
+      path: '/foo/bar',
+      revision: '5c0b01f1522ae8c194510977ae29377296dd236b',
+    }
+    profile = StackProf.run(mode: :cpu, metadata: metadata) do
+      math
+    end
+
+    assert_equal metadata, profile[:metadata]
+  end
+
+  def test_empty_metadata
+    profile = StackProf.run(mode: :cpu) do
+      math
+    end
+
+    assert_equal({}, profile[:metadata])
+  end
+
+  def test_raises_if_metadata_is_not_a_hash
+    exception = assert_raises ArgumentError do
+      StackProf.run(mode: :cpu, metadata: 'foobar') do
+        math
+      end
+    end
+
+    assert_equal 'metadata should be a hash', exception.message
+  end
+
   def test_fork
     StackProf.run do
       pid = fork do
@@ -150,10 +180,18 @@ class StackProfTest < MiniTest::Test
 
     raw = profile[:raw]
     gc_frame = profile[:frames].values.find{ |f| f[:name] == "(garbage collection)" }
+    marking_frame = profile[:frames].values.find{ |f| f[:name] == "(marking)" }
+    sweeping_frame = profile[:frames].values.find{ |f| f[:name] == "(sweeping)" }
+
     assert gc_frame
-    assert_equal gc_frame[:samples], profile[:gc_samples]
+    assert marking_frame
+    assert sweeping_frame
+
+    assert_equal gc_frame[:total_samples], profile[:gc_samples]
+    assert_equal profile[:gc_samples], [gc_frame, marking_frame, sweeping_frame].map{|x| x[:samples] }.inject(:+)
+
     assert_operator profile[:gc_samples], :>, 0
-    assert_operator profile[:missed_samples], :<=, 10
+    assert_operator profile[:missed_samples], :<=, 25
   end
 
   def test_out

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -103,15 +103,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.0.pre1
+rubygems_version: 3.1.0.pre3
 signing_key: 
 specification_version: 4
-summary: sampling callstack-profiler for ruby 2.1+
+summary: sampling callstack-profiler for ruby 2.2+
 test_files: []