rails_mini_profiler 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b1f043e04e0f4aaf67b7cfe22be413aa689e51553c3e30e535b2a828d5abde2
-  data.tar.gz: '028d6a1d92f6d66552ccf5f7ea9d1c622d15551ba16977c53b773041fd48464c'
+  metadata.gz: 68745f57dfbd4c05a60722a699c377ec8b5eb6f101edc3259bec8134f3b8078e
+  data.tar.gz: c28c669797fb80f92590a9b7574878c59bc0050c415b939d14936c2caf7127d1
 SHA512:
-  metadata.gz: 4722b94b458742b5f0c3f3ebe12c119054f053f9a4c783748e5e72686f5676de3fdc7ea5ff9c7aa1bc3872e4ed1d139934aeeb7f653ab40a4818d11b268b85ef
-  data.tar.gz: '0958d98854d3df4c1129a2aef7a85dbf0053770f6c761b7901bf3e121acbb2d1116308d419364ce5528b1b8458d68368bb6f32938966b5a35215c45fe8cd2872'
+  metadata.gz: 8c2a6559821ce43c54dd30f1f8c396734b2f8d2559b81802553a31197f7a1cdafbd7ee25756f59ea51e3b6aa4685a6184a9b8972bdc3b761e7ac4b6261724ee2
+  data.tar.gz: 34af332d02f3e9a7de68e74a3f900b8c58c57bed9f7fcb37b4c7125e9086c57d446885d8778755d92bddcbb10cd8b5e3393c066877ca9844cffec9e712a82506

data/README.md

@@ -6,33 +6,42 @@
 
 ### Performance profiling for Rails, made simple.
 
-[![Gem Version](https://badge.fury.io/rb/graphql-groups.svg)](https://badge.fury.io/rb/graphql-groups)
+[![Gem Version](https://badge.fury.io/rb/rails_mini_profiler.svg)](https://badge.fury.io/rb/rails_mini_profiler)
 [![Main](https://github.com/hschne/rails-mini-profiler/actions/workflows/main.yml/badge.svg)](https://github.com/hschne/rails-mini-profiler/actions/workflows/main.yml)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/692d4125ac8548fb145e/test_coverage)](https://codeclimate.com/github/hschne/graphql-groups/test_coverage)
+[![Main](https://img.shields.io/github/license/hschne/rails-mini-profiler)](https://img.shields.io/github/license/hschne/rails-mini-profiler)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/1fcc2f4d01ab5bf7a260/maintainability)](https://codeclimate.com/github/hschne/rails-mini-profiler/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1fcc2f4d01ab5bf7a260/test_coverage)](https://codeclimate.com/github/hschne/rails-mini-profiler/test_coverage)
 
 </div>
 
 ## What's this?
 
-Rails Mini Profiler is an easy-to-use performance profiler for your Rails applications. It is heavily inspired by [Rack Mini Profiler](https://github.com/MiniProfiler/rack-mini-profiler) and other APM tools. It looks something like this: 
+Rails Mini Profiler is an easy-to-use performance profiler for your Rails applications. It is heavily inspired by [Rack Mini Profiler](https://github.com/MiniProfiler/rack-mini-profiler) and other APM tools. To find out how it stacks up against those check out [Why Rails Mini Profiler](#why-rails-mini-profiler)? 
+
+To see it in action view the preview below:
+
+<div align="center">
 
+[![Rails Mini Profiler Preview](http://img.youtube.com/vi/fSR8fCcsO8Q/0.jpg)](https://www.youtube.com/watch?v=fSR8fCcsO8Q)
 
+</div>
 
-**Note**: This gem is in early development and I'm looking for contributors. Try it out and leave some feedback, it really goes a long way in helping me out with development. Any  [feature request](https://github.com/hschne/rails-mini-profiler/issues/new?assignees=&labels=type%3ABug&template=FEATURE_REQUEST.md&title=) or [bug report](https://github.com/hschne/rails-mini-profiler/issues/new?assignees=&labels=type%3AEnhancement&template=BUG_REPORT.md&title=) is welcome. If you like this project, leave a star to show your support! ⭐
+**Note**: This gem is in early development and I'm looking for contributors. Try it out and leave some feedback, it really goes a long way in helping me out with development. Any [feature request](https://github.com/hschne/rails-mini-profiler/issues/new?assignees=&labels=type%3ABug&template=FEATURE_REQUEST.md&title=) or [bug report](https://github.com/hschne/rails-mini-profiler/issues/new?assignees=&labels=type%3AEnhancement&template=BUG_REPORT.md&title=) is welcome. If you like this project, leave a star to show your support! ⭐
 
 ## Getting Started
 
 Add Rails Mini Profiler to your Gemfile:
 
 ```ruby
-gem 'rails-mini-profiler'
+gem 'rails_mini_profiler'
 ```
 
 Install the gem and run the installer:
 
 ```bash
 bundle install
-rails rail_mini_profiler:install
+rails rails_mini_profiler:install
 ```
 
 Inspect the generated migration in `db/migrate` and run it:
@@ -42,7 +51,7 @@ rails db:migrate
 ```
 
 Start your Rails application and perform some requests. You can either click the little hedgehog 🦔 on the top
-right or navigate to `/rails_mini_profiler` to view collected performance metrics.
+left or navigate to `/rails_mini_profiler` to view collected performance metrics.
 
 ## Usage
 
@@ -55,7 +64,7 @@ route:
 # routes.rb
 Rails.application.routes.draw do
   ...
-  
+
   mount RailsMiniProfiler::Engine => '/rails_mini_profiler'
 end
 ```
@@ -95,7 +104,7 @@ you may have to amend your content security policy. See [Troubleshooting](#Troub
 You can set the following configuration options in Rails Mini Profiler:
 
 | Option                   | Default                      | Description                                                                                     |
-|--------------------------|------------------------------|-------------------------------------------------------------------------------------------------|
+| ------------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------- |
 | `enabled`                | `true` (dev)/ `false` (prod) | Whether or not RMP is enabled                                                                   |
 | `badge_enabled`          | `true`                       | Should the hedgehog 🦔 badge be injected into pages?                                            |
 | `badge_position`         | `'top-left'`                 | Where to display the badge. Options are `'top-left', 'top-right', 'bottom-left, 'bottom-right'` |
@@ -110,7 +119,7 @@ You can set the following configuration options in Rails Mini Profiler:
 You may override the configuration by sending request parameters. The following parameters are available:
 
 | Option           | Description                                                                                 |
-|------------------|---------------------------------------------------------------------------------------------|
+| ---------------- | ------------------------------------------------------------------------------------------- |
 | `rmp_flamegraph` | Overrides `flamegraph_enabled` If set to `true` will redirect to the flamegraph immediatly. |
 
 ### Storage
@@ -119,7 +128,7 @@ Rails Mini Profiler stores profiling information in your database per default. Y
 traces and requests are stored.
 
 | Configuration             | Default                 | Description                                                                                               |
-|---------------------------|-------------------------|-----------------------------------------------------------------------------------------------------------|
+| ------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------- |
 | `database`                | `nil`                   | Set a custom database to be used for storing profiler information. Uses `connect_to` for profiler records |
 | `profiled_requests_table` | `rmp_profiled_requests` | The table to be used to store profiled requests.                                                          |
 | `flamegraphs_table`       | `rmp_flamegraphs`       | The table to be used to store flamegraphs.                                                                |
@@ -137,7 +146,7 @@ end
 class ProfiledRequestCleanupJob < ApplicationJob
   queue_as :default
 
-  def perform(*guests)
+  def perform
     RailsMiniProfiler::ProfiledRequest.where('created_at < ?', 1.month.ago).destroy_all
   end
 end
@@ -158,8 +167,8 @@ You may also explicitly set the user from the application itself:
 ```ruby
 class ApplicationController < ActionController::Base
   ...
-  
-  before_action do 
+
+  before_action do
     RailsMiniProfiler::User.authorize(current_user.id)
   end
 end
@@ -183,8 +192,35 @@ end
 
 Only requests by explicitly set users will be stored. To configure how individual users are identified see [Users](#Users)
 
+## Why Rails Mini Profiler?
+
+Improving the performance of any application is a 3-step process. You have to answer these questions:
+
+1. What is slow?
+2. Why is it slow?
+3. Did my solution fix the slowness?
+
+I'm a huge fan of [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler), and AMP tools such as [Skylight](https://www.skylight.io/) or [Scout APM](https://scoutapm.com), and each of these tools has its place.
+
+APM tools are excellent for profiling your app in production - aka. they show you what is slow - and offer _some_ hints as to what causes the slowdown. `rack-mini-profiler` can do some sampling in production, but excels at providing detailed insight into _why_ something is slow, using Flamegraphs and detailed query information.
+
+Rails Mini Profiler improves upon `rack-mini-profiler` in the latter regard. It is a developer tool, rather than a monitoring tool, and sets a big focus on developer experience. Simply put, it aims to be the best tool available to help you figure out _why_ specific requests are slow.
+
+As such, compared to `rack-mini-profiler`, it does not support non-Rails apps (e.g. Sinatra) or production sampling, but provides a much better user experience and better supports API-only applications.
+
 ## Troubleshooting
 
+### Upgrading
+
+Rails Mini Profiler is in early development. As such, breaking changes may still be introduced on a regular basis. While Rails Mini Profiler is in pre-release we do not offer upgrade migrations.
+
+If an upgrade to Rails Mini Profiler breaks your application, we recommend that you drop the offending tables and re-run migrations for the latest version: 
+
+```
+rails rails_mini_profiler:install:migrations
+rails db:migrate
+```
+
 ### Flamegraphs are not rendering?
 
 Flamegraphs are loaded into [Speedscope](https://github.com/jlfwong/speedscope) using an Iframe and URI Encoded blobs (see [source](https://github.com/hschne/rails-mini-profiler/blob/main/app/views/rails_mini_profiler/flamegraphs/show.html.erb))
@@ -202,14 +238,14 @@ end
 [StackProf](https://github.com/tmm1/stackprof), which is used for recording Flamegraphs, does not work on concurrent requests.
 Because of this, concurrent requests may skip recording a Flamegraph.
 
-It is recommended that you resend _only_ the request you wish to get a Flamegraph for.
+It is recommended that you resend _only_ the request you wish to build a Flamegraph for.
 
 ## Credit
 
 This project was heavily inspired by projects such as [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler) and
 [rack-profiler](https://github.com/dawanda/rack-profiler). [Skylight](https://www.skylight.io/) was also a huge influence.
 
-[Lena Schnedlitz](https://github.com/LenaSchnedlitz) designed the Logo and provided great support. Without her supreme CSS skills this project would not have been possible :hands_raised:
+[Lena Schnedlitz](https://github.com/LenaSchnedlitz) designed the Logo and provided great support. Without her supreme CSS skills this project would not have been possible 🙌
 
 ## Contributing
 

data/app/models/rails_mini_profiler/controller_trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class ControllerTrace < Trace
     store :payload, accessors: %i[view_runtime db_runtime]

data/app/models/rails_mini_profiler/flamegraph.rb

@@ -10,6 +10,10 @@
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_flamegraphs_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class Flamegraph < RailsMiniProfiler::ApplicationRecord
     self.table_name = RailsMiniProfiler.storage_configuration.flamegraphs_table

data/app/models/rails_mini_profiler/instantiation_trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class InstantiationTrace < Trace
     store :payload, accessors: %i[record_count class_name]

data/app/models/rails_mini_profiler/profiled_request.rb

@@ -4,21 +4,27 @@
 #
 # Table name: rmp_profiled_requests
 #
-#  id               :integer          not null, primary key
-#  user_id          :string
-#  start            :integer
-#  finish           :integer
-#  duration         :integer
-#  allocations      :integer
-#  request_path     :string
-#  request_method   :string
-#  request_headers  :json
-#  request_body     :json
-#  response_status  :integer
-#  response_body    :json
-#  response_headers :json
-#  created_at       :datetime         not null
-#  updated_at       :datetime         not null
+#  id                   :integer          not null, primary key
+#  user_id              :string
+#  start                :bigint
+#  finish               :bigint
+#  duration             :integer
+#  allocations          :bigint
+#  request_path         :string
+#  request_query_string :string
+#  request_method       :string
+#  request_headers      :json
+#  request_body         :text
+#  response_status      :integer
+#  response_body        :text
+#  response_headers     :json
+#  response_media_type  :string
+#  created_at           :datetime         not null
+#  updated_at           :datetime         not null
+#
+# Indexes
+#
+#  index_rmp_profiled_requests_on_created_at  (created_at)
 #
 module RailsMiniProfiler
   class ProfiledRequest < RailsMiniProfiler::ApplicationRecord

data/app/models/rails_mini_profiler/render_partial_trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class RenderPartialTrace < Trace
     store :payload, accessors: %i[identifier]

data/app/models/rails_mini_profiler/render_template_trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class RenderTemplateTrace < Trace
     store :payload, accessors: %i[identifier]

data/app/models/rails_mini_profiler/rmp_trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class RmpTrace < Trace
     class << self

data/app/models/rails_mini_profiler/sequel_trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class SequelTrace < Trace
     store :payload, accessors: %i[name sql binds]

data/app/models/rails_mini_profiler/trace.rb

@@ -7,15 +7,19 @@
 #  id                      :integer          not null, primary key
 #  rmp_profiled_request_id :bigint           not null
 #  name                    :string
-#  start                   :integer
-#  finish                  :integer
+#  start                   :bigint
+#  finish                  :bigint
 #  duration                :integer
-#  allocations             :integer
+#  allocations             :bigint
 #  payload                 :json
 #  backtrace               :json
 #  created_at              :datetime         not null
 #  updated_at              :datetime         not null
 #
+# Indexes
+#
+#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
+#
 module RailsMiniProfiler
   class Trace < RailsMiniProfiler::ApplicationRecord
     self.table_name = RailsMiniProfiler.storage_configuration.traces_table

data/db/migrate/20210621185018_create_rmp.rb

@@ -4,10 +4,10 @@ class CreateRmp < ActiveRecord::Migration[6.0]
   def change
     create_table :rmp_profiled_requests do |t|
       t.string :user_id
-      t.integer :start
-      t.integer :finish
+      t.bigint :start
+      t.bigint :finish
       t.integer :duration
-      t.integer :allocations
+      t.bigint :allocations
       t.string :request_path
       t.string :request_query_string
       t.string :request_method
@@ -19,15 +19,17 @@ class CreateRmp < ActiveRecord::Migration[6.0]
       t.string :response_media_type
 
       t.timestamps
+
+      t.index :created_at
     end
 
     create_table :rmp_traces do |t|
       t.belongs_to :rmp_profiled_request, null: false, foreign_key: true
       t.string :name
-      t.integer :start
-      t.integer :finish
+      t.bigint :start
+      t.bigint :finish
       t.integer :duration
-      t.integer :allocations
+      t.bigint :allocations
       t.json :payload
       t.json :backtrace
 

data/lib/generators/rails_mini_profiler/templates/rails_mini_profiler.rb.erb

@@ -6,7 +6,7 @@ RailsMiniProfiler.configure do |config|
   # config.flamegraph_enabled = false
 
   # Use RailsMiniProfiler::Storage::ActiveRecord to store profiles in your Database
-  config.storage = RailsMiniProfiler::Storage::Memory
+  config.storage = RailsMiniProfiler::Storage
 
   # Uncomment to customize how users are detected
   # config.user_provider = proc { |env| Rack::Request.new(env).ip }

data/lib/rails_mini_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mini_profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hschne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inline_svg