vernier 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d826cc1605b081bf6784ff46e1e49b09958f3c2626637d3d994b967bc52b391
-  data.tar.gz: 743a02e32629c961795ab0a4b62f839e5bf905e3a4f339f6534157cd257f2e7a
+  metadata.gz: dcfae18cfffd67e1e8a52c0c9de2654e7523b674d492964dfa3447c967d981e3
+  data.tar.gz: 4ff2a81a37d19f974914a0ff3fa28937302a636721b8732f7e7b282f895db9f3
 SHA512:
-  metadata.gz: ac4dc6ea1e3f9c32ba223e96aa7eae35c62f4a4e3d503efdee643b44984f5d03638b42a4d2e25fe991e8bc49240f75541da0c0791b525782f827969f1926d50c
-  data.tar.gz: 4321e93946c0c2155f79326f9bf29f00bf0fab24785c1c7238b8fdf46570706d8906bf70e80241a7dadd1d1531f8c44e12b4b47584b6024cf7d47fa9fa0a432d
+  metadata.gz: bd4e4f001047bb3f20c9c0670339747b9e29abf6e44bcd77dbb38fcf7c16f42d33eef893045ab7a899b155d9b98765950e91af79864234a2d66243490d367d49
+  data.tar.gz: 14cecc8aa1058b4e38f130bed6ec1d43e8a59a636c125862ef6c61df13f885e1d76b1a142d0fa8fab16ea6bfee2642b7cd606bb562020f800ce3518b2c7fac2c

data/README.md

@@ -1,6 +1,6 @@
 # Vernier
 
-Experimental Ruby profiling tool
+Experimental next-generation Ruby profiler.
 
 ## Installation
 
@@ -10,16 +10,23 @@ gem 'vernier'
 
 ## Usage
 
-Record a flamegraph of all **retained** allocations from requiring `irb`.
+### Retained memory
+
+Record a flamegraph of all **retained** allocations from loading `irb`.
 
 ```
-ruby -r vernier -e 'Vernier.trace_retained(out: "irb.stackcollapse") { require "irb" }'
+ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "irb" }'
 ```
 
-The output can then be viewed in speedscope or other flamegraph tools
+The output can then be viewed in the [Firefox Profiler (demo)](https://share.firefox.dev/3DhLsFa)
+
+![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)
 
-<img width="1082" alt="Screen Shot 2022-04-26 at 8 11 19 PM" src="https://user-images.githubusercontent.com/131752/165440422-3a11f5cc-3018-4455-8918-887c2afa6d6e.png">
+### Time
 
+```
+Vernier.trace(out: "time_profile.json") { some_slow_method }
+```
 
 ## Development
 
@@ -31,6 +38,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/vernier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jhawthorn/vernier/blob/main/CODE_OF_CONDUCT.md).
 
+### Resources
+
+* https://profiler.firefox.com/docs/#/
+* https://github.com/firefox-devtools/profiler/tree/main/docs-developer
+* https://github.com/tmm1/stackprof
+* https://github.com/ruby/ruby/pull/5500
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -9,6 +9,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+task :console => :compile do
+  sh "irb -r vernier"
+end
+
 require "rake/extensiontask"
 
 task build: :compile

data/examples/threaded_http_requests.rb

@@ -0,0 +1,38 @@
+require "vernier"
+
+Vernier.trace(out: "http_requests.json") do
+
+require "net/http"
+require "uri"
+require "openssl"
+
+urls = Queue.new
+received = Queue.new
+
+threads = 2.times.map do
+  Thread.new do
+    while url = urls.pop
+      uri = URI.parse(url)
+      response = Net::HTTP.get_response(uri)
+
+      received << [url, response.code]
+    end
+  end
+end
+
+Thread.new do
+  threads.each(&:join)
+  received.close
+end
+
+urls << "http://example.com"
+urls << "https://www.johnhawthorn.com"
+urls << "https://tenderlovemaking.com/"
+urls.close
+
+while x = received.pop
+  url, code = *x
+  puts "#{url} #{code}"
+end
+
+end

data/ext/vernier/ruby_type_names.h

@@ -0,0 +1,44 @@
+#pragma once
+
+inline const char *
+ruby_object_type_name(VALUE obj) {
+    enum ruby_value_type type = rb_type(obj);
+
+#define TYPE_CASE(x) case (x): return (#x)
+
+    // Many of these are impossible, but it's easier to just include them
+    switch (type) {
+        TYPE_CASE(T_OBJECT);
+        TYPE_CASE(T_CLASS);
+        TYPE_CASE(T_MODULE);
+        TYPE_CASE(T_FLOAT);
+        TYPE_CASE(T_STRING);
+        TYPE_CASE(T_REGEXP);
+        TYPE_CASE(T_ARRAY);
+        TYPE_CASE(T_HASH);
+        TYPE_CASE(T_STRUCT);
+        TYPE_CASE(T_BIGNUM);
+        TYPE_CASE(T_FILE);
+        TYPE_CASE(T_DATA);
+        TYPE_CASE(T_MATCH);
+        TYPE_CASE(T_COMPLEX);
+        TYPE_CASE(T_RATIONAL);
+
+        TYPE_CASE(T_NIL);
+        TYPE_CASE(T_TRUE);
+        TYPE_CASE(T_FALSE);
+        TYPE_CASE(T_SYMBOL);
+        TYPE_CASE(T_FIXNUM);
+        TYPE_CASE(T_UNDEF);
+
+        TYPE_CASE(T_IMEMO);
+        TYPE_CASE(T_NODE);
+        TYPE_CASE(T_ICLASS);
+        TYPE_CASE(T_ZOMBIE);
+        TYPE_CASE(T_MOVED);
+
+        default:
+        return "unknown type";
+    }
+#undef TYPE_CASE
+}