singed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5276eb42b69baf43de15c7ad5a3549f048d00865f225998eb4479b6e7723f2b8
-  data.tar.gz: 0f46bfb076f12a4766e060a017f2cb0e9ad6af98a96b8f96ebf05b58205aac21
+  metadata.gz: b94bd39d1904f3d339e34974c5ad88bec590c2373ffedc6ffba15a4bce0fbb06
+  data.tar.gz: dcf1af83d2b05c7cc2d20566045a99781385408c6316ef183fa3cba77ec8538f
 SHA512:
-  metadata.gz: 81b34cf130fbe187680d65ba593ee68ce606e72cbb5db99284aba82beb6bf9ac17cef5104850a49ebba7bce87cc8a11b39f4b0897accb9bc6e0cb268ee35168e
-  data.tar.gz: 23e265212f1f70ebe105c218dde2025728782ae1574ef2abcf4705b04e13eeab7bd9b6197442b950517492c5a540a2ebaa99478d7841b4170a8611ff668094a9
+  metadata.gz: c3155afc39b9bc923718a488ebc170f3c0b03ecdf8eb945af93a85ad489a3825dd464a10dc8289795b30b91e6ff0ce43a488f348a5e2cacd1308417626228edd
+  data.tar.gz: f0f054893e83aceb2f3342317f30e732e75c79af1fa61164e7b637fea5ae18b03b8aee5eac68b4d05facc4a37e62a5e1ef833d1aa86df55046de7e8686fc2aac

data/README.md

@@ -1,10 +1,20 @@
 # Singed
 
-Singed makes it easy to get a flamegraph anywhere in your code base:
+Singed makes it easy to get a flamegraph anywhere in your code base. It wraps profiling your code with [stackprof](https://github.com/tmm1/stackprof) or [rbspy](https://github.com/rbspy/rbspy), and then launching [speedscope](https://github.com/jlfwong/speedscope) to view it.
+
+## Installation
+
+Add to `Gemfile`:
+
+```ruby
+gem "singed"
+```
+
+Then run `bundle install`
 
 ## Usage
 
-To profile your code, and launch [speedscope](https://github.com/jlfwong/speedscope) for viewing it:
+Simplest is calling with a block:
 
 ```ruby
 flamegraph {
@@ -22,7 +32,7 @@ Singed.output_directory = "tmp/slowness-exploration"
 If you are calling it in a loop, or with different variations, you can include a label on the filename:
 
 ```ruby
-flamegraph(label: "rspec") {
+flamegraph("rspec") {
   # your code here
 }
 ```
@@ -64,7 +74,7 @@ class EmployeesController < ApplicationController
 end
 ```
 
-This won't catch the entire request though, just once it's been routed to controller and a response has been served.
+This won't catch the entire request though, just once it's been routed to controller and a response has been served (ie no middleware).
 
 ### Rack/Rails requests
 
@@ -84,7 +94,7 @@ There is a `singed` command line you can use that will record a flamegraph from
 
 ```shell
 $ bundle binstub singed # if you want to be able to call it like bin/singed
-$ bundle exec singed -- bin/rails 
+$ bundle exec singed -- bin/rails runner 'Model.all.to_a'
 ```
 
 The flamegraph is opened afterwards.
@@ -98,5 +108,5 @@ The `open` is expected to be available.
 
 ## Alternatives
 
-- using [rbspy](https://rbspy.github.io/) directory
+- using [rbspy](https://rbspy.github.io/) directly
 - using [stackprof](https://github.com/tmm1/stackprof) (a dependency of singed) directly

data/lib/singed/cli.rb

@@ -1,6 +1,7 @@
 require 'shellwords'
 require 'tmpdir'
 require 'optionparser'
+require 'pathname'
 
 # NOTE: we defer requiring singed until we run. that lets Rails load it if its in the gemfile, so the railtie has had a chance to run
 
@@ -64,6 +65,7 @@ module Singed
 
       Singed.output_directory = @output_directory if @output_directory
       Singed.output_directory ||= Dir.tmpdir
+      FileUtils.mkdir_p Singed.output_directory
       @filename = Singed::Flamegraph.generate_filename(label: 'cli')
 
       options = {
@@ -86,11 +88,19 @@ module Singed
         prompt_password
       end
 
-      Bundler.with_unbundled_env do
+      rbspy = lambda do
         # don't run things with spring, because it forks and rbspy won't see it
         sudo ['rbspy', *rbspy_args], reason: 'Singed needs to run as root, but will drop permissions back to your user.', env: { 'DISABLE_SPRING' => '1' }
       end
 
+      if defined?(Bundler)
+        Bundler.with_unbundled_env do
+          rbspy.call
+        end
+      else
+        rbspy.call
+      end
+
       unless filename.exist?
         puts "#{filename} doesn't exist. Maybe rbspy had a failure capturing it? Check the scrollback."
         exit 1
@@ -102,9 +112,9 @@ module Singed
       end
 
       # clean the report, similar to how Singed::Report does
-      json = JSON.parse(filename.read).with_indifferent_access
+      json = JSON.parse(filename.read)
       json['shared']['frames'].each do |frame|
-        frame[:file] = Singed.filter_line(frame[:file])
+        frame['file'] = Singed.filter_line(frame['file'])
       end
       filename.write(JSON.dump(json))
 

data/lib/singed/flamegraph.rb

@@ -53,7 +53,7 @@ module Singed
     end
 
     def self.generate_filename(label: nil, time: Time.now) # rubocop:disable Rails/TimeZone
-      formatted_time = time.to_formatted_s(:number)
+      formatted_time = time.strftime('%Y%m%d%H%M%S')
       basename_parts = ['speedscope', label, formatted_time].compact
 
       file = Singed.output_directory.join("#{basename_parts.join('-')}.json")

data/lib/singed/kernel_ext.rb

@@ -1,15 +1,15 @@
 module Kernel
-  def flamegraph(label = nil, open: true, ignore_gc: false, interval: 1000, &block)
+  def flamegraph(label = nil, open: true, ignore_gc: false, interval: 1000, io: $stdout, &block)
     fg = Singed::Flamegraph.new(label: label, ignore_gc: ignore_gc, interval: interval)
     result = fg.record(&block)
     fg.save
 
     if open
       # use npx, so we don't have to add it as a dependency
-      puts "🔥📈 #{'Captured flamegraph, opening with'.colorize(:bold).colorize(:red)}: #{fg.open_command}"
+      io.puts "🔥📈 #{'Captured flamegraph, opening with'.colorize(:bold).colorize(:red)}: #{fg.open_command}"
       fg.open
     else
-      puts "🔥📈 #{'Captured flamegraph to file'.colorize(:bold).colorize(:red)}: #{fg.filename}"
+      io.puts "🔥📈 #{'Captured flamegraph to file'.colorize(:bold).colorize(:red)}: #{fg.filename}"
     end
 
     result

data/lib/singed.rb

@@ -13,7 +13,7 @@ module Singed
   end
 
   def self.output_directory
-    @output_directory || raise("output directory hasn't been set!")
+    @output_directory
   end
 
   def enabled=(enabled)

data/singed.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |spec|
   spec.name          = 'singed'
 
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Josh Nichols']
   spec.email         = ['josh.nichols@gusto.com']
 
@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'stackprof'
 
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Nichols
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - josh.nichols@gusto.com