https://github.com/julianrubisch/stimulus_reflex_profiler

A Rails engine with profiling options for StimulusReflex
https://github.com/julianrubisch/stimulus_reflex_profiler

Last synced: 15 days ago
JSON representation

A Rails engine with profiling options for StimulusReflex

• Host: GitHub
• URL: https://github.com/julianrubisch/stimulus_reflex_profiler
• Owner: julianrubisch
• License: mit
• Created: 2020-10-27T16:02:02.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-27T10:45:40.000Z (over 3 years ago)
• Last Synced: 2024-11-29T13:14:26.044Z (28 days ago)
• Language: Ruby
• Size: 34.2 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# StimulusReflexProfiler



Provides profiling functionality for [StimulusReflex](https://github.com/hopsoft/stimulus_reflex). Heavily inspired by [Rack Mini Profiler](https://github.com/MiniProfiler/rack-mini-profiler).

Currently implemented:

- Call Stack Profiling (Flamegraph)

## Usage

Mount `StimulusReflexProfiler` as an engine in your `routes.rb`.

```ruby

if Rails.env.development?

  mount StimulusReflexProfiler::Engine, at: '/stimulus_reflex_profiler'

end

```

`http://localhost:3000/stimulus_reflex_profiler/flamegraph` will now display the flamegraph of the last triggered Reflex (see above).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'stimulus_reflex_profiler'

```

For call-stack profiling/flamegraphs add the following gems, too:

```ruby

gem 'flamegraph'

gem 'stackprof'

```

And then execute:

```bash

$ bundle

```

## Contributing

Contribution directions go here.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).