flamegraph_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0943ce9713996a8c3117f708bc598680e7a2b07b14dfa8ce35da38d5d06ea779'
+  data.tar.gz: bceb15a1ca53250b0e20fe672cb3fc5523c475c68f47ede4188d4fbf729f8e94
+SHA512:
+  metadata.gz: 2222222a3118826de2c7adb7806caba7ab85c2abd25023dc4270c8546066bde9be49c94eff593987f8b9254a5922a5deecc32e3a875757697641d7fed655768b
+  data.tar.gz: e3f4f702e17248854823d65c64bb138c0b72abe338c5bded98d0e851ed205f78603200463613ea11babff902a4c645edf93cb070146043be91ac4e4a47f49800

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in flamegraph_generator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    flamegraph_generator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    minitest (5.20.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.31.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.4)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  flamegraph_generator!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Owais
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# FlamegraphGenerator
+
+A super simple gem that allows you to create flamegraphs that can be opened via [speedscope.app](https://speedscope.app/).
+
+This differs from tools like stackprof/singed/rack-mini-profiler in that this allow *you* to specify the events used to create a flamegraph.
+Whereas those tools automatically create flamegraph based on the call stack.
+
+You might want to use this gem if you've got a need to create flamegraphs from a custom event source.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add flamegraph_generator
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install flamegraph_generator
+
+## Usage
+
+```ruby
+# Initialize generator
+#
+# Parameters
+#  - name: String
+#     Optional. Defaults to 'flamegraph'
+#  - units: 'none' | 'nanoseconds' | 'microseconds' | 'milliseconds' | 'seconds' | 'bytes'
+#     Optional. Defaults to 'seconds'
+generator = FlamegraphGenerator.new(name: 'myflamegraph', units: 'seconds')
+
+# Add your events here
+generator.add_event(name: 'UsersComponent', start: 0, finish: 100)
+generator.add_event(name: 'X', start: 50, finish: 70, file: 'xxx.rb', line: 200, col: 10)
+generator.add_event(name: 'Y', start: 112, finish: 130, file: 'yyy.rb', line: 200, col: 10)
+
+# Will save the flamegraph to /tmp/flamegraph.json + open the flamegraph in your browser
+generator.save(path: '/tmp/flamegraph.json', open: true)
+
+# You can also get the raw speedscope-compatible flamegraph hash by:
+generator.generate_flamegraph
+```
+
+## Contrived example
+
+The below example hooks into the notifications dispatched by the [view_component](https://viewcomponent.org/guide/instrumentation.html) library and generates a flamegraph during each request for view components.
+```ruby
+class ApplicationController
+    around_action :vc_bm
+
+    def vc_bm
+        return yield unless Rails.env.development?
+
+        generator = FlamegraphGenerator.new
+        callback = lambda do |name, start, finish, id, payload|
+            generator.add_event(name: payload[:name], start:, finish:)
+        end
+
+        ActiveSupport::Notifications.subscribed(callback, 'render.view_component', monotonic: true) do
+            yield
+        end
+
+        generator.save(path: Rails.root.join('tmp', 'vc_bm.json'), open: true)
+    end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/owaiswiz/flamegraph_generator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/flamegraph_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class FlamegraphGenerator
+  VERSION = "0.1.0"
+end

data/lib/flamegraph_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative "flamegraph_generator/version"
+
+class FlamegraphGenerator
+  Event = Struct.new(:name, :start, :finish, :file, :line, :col, keyword_init: true)
+
+  def initialize(name: 'flamegraph', unit: 'seconds')
+    @name = name
+    @unit = unit
+    @events = []
+  end
+
+  def add_event(name:, start:, finish:, file: nil, line: nil, col: nil)
+    raise ArgumentError, "name is required" unless name
+    raise ArgumentError, "start must be of type Numeric" unless start.is_a?(Numeric)
+    raise ArgumentError, "finish must be of type Numeric" unless finish.is_a?(Numeric)
+
+    @events << Event.new(name: name, start: start, finish: finish, file: file, line: line, col: col)
+  end
+
+  def save(path:, open: true)
+    File.write(path, generate_flamegraph.to_json)
+    open_with_speedscope(path) if open
+  end
+
+  def generate_flamegraph
+    sorted_events = @events.sort_by { |event| [event.start, event.finish] }
+
+    frames_by_name = {}
+    frames = sorted_events.uniq(&:name).map.with_index do |event, index|
+      frame = { name: event.name, file: event.file, line: event.line, col: event.col, index: index }.compact
+      frames_by_name[event.name] = frame
+      frame
+    end
+
+    start= sorted_events.first&.start
+    finish = sorted_events.max_by { |event| event.finish }&.finish
+
+    speedscope_events = sorted_events.map do |event|
+      frame_index = frames_by_name[event.name][:index]
+      [
+        { "type": 'O', "frame": frame_index, at: event.start - start },
+        { "type": 'C', "frame": frame_index, at: event.finish - start }
+      ]
+    end.flatten.sort_by { |speedscope_event| speedscope_event[:at] }
+
+    {
+      "$schema":  'https://www.speedscope.app/file-format-schema.json',
+      version:  '0.0.1',
+      shared:   { frames: frames },
+      profiles: [({
+        type:       'evented',
+        name:       @name,
+        unit:       @unit,
+        startValue: 0,
+        endValue:   finish - start,
+        events:     speedscope_events,
+      } if speedscope_events.present?)].compact
+    }
+  end
+
+  private
+    def open_with_speedscope(path)
+      system("npx speedscope #{path}")
+    end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: flamegraph_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owais
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/flamegraph_generator.rb
+- lib/flamegraph_generator/version.rb
+homepage: https://github.com/owaiswiz/flamegraph_generator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/owaiswiz/flamegraph_generator
+  source_code_uri: https://github.com/owaiswiz/flamegraph_generator
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: A simple way to generate arbitrary flamegraph that can be viewed by speedscope
+test_files: []