rails_performance 0.9.6 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7057afb1ba78e88e9c7cd43609f5b42592be9a63aea28038389634afe8c6563
-  data.tar.gz: 469e0a13402fbaff70387902b28d4d0a7441d42403df6f3bd4f89aa8a3124bf3
+  metadata.gz: 136a862da6c0d5b7d7d458e6c5389314cfe776d0437272d319d89a95eeaa8a11
+  data.tar.gz: 913394396bb6d45c8a9d12d8b2f115bc135cf9fe61eee19c79a3a88165c50551
 SHA512:
-  metadata.gz: b1f93f46640ef509be5ea38f624f916689fe5f61bb3413428673c1ca14d41f30bdfc22111e97f0e5b0629e4421e68400cb75437d65dc3616c9fef55af7f521fb
-  data.tar.gz: 539bb052282c277077f68b37230ae121b84d4eb7a5a87cb679a38ce03d7bc4df7fc8b38cd1f72f8f235819c53edacb24b256ca18be2e2e51bd9b282e5895faaf
+  metadata.gz: 4e07938ad437c12dfc911ca66d06717eded983694436b9936bc038876c685bcd9bc432c42ddc35279eb96e5511220781d790f3322f1f1acd6cfce4cce1fc27c2
+  data.tar.gz: 6fd601401eba7c250a31481df0f4bf1bf92c5d856ea9f5c454f3eefd45fbccc669fb1f088538a2a56a0a0decf5627eb87b2e1e93557b0515fd34ee0b575608df

data/README.md

@@ -1,6 +1,8 @@
 # Rails Performance
 
-[![Build Status](https://travis-ci.org/igorkasyanchuk/rails_performance.svg?branch=master)](https://travis-ci.org/igorkasyanchuk/rails_performance)
+[![Tests](https://github.com/igorkasyanchuk/rails_performance/actions/workflows/ruby.yml/badge.svg)](https://github.com/igorkasyanchuk/rails_performance/actions/workflows/ruby.yml)
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+[![https://www.patreon.com/igorkasyanchuk](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/patron.svg?raw=true)](https://www.patreon.com/igorkasyanchuk)
 
 A self-hosted tool to monitor the performance of your Ruby on Rails application.
 
@@ -16,14 +18,18 @@ It allows you to track:
 - total duration of time spent per request, views rendering, DB
 - SQL queries, rendering logs in "Recent Requests" section
 - simple 500-crashes reports
-- track Sidekiq jobs performance
+- Sidekiq jobs
+- Delayed Job jobs
+- Grape API inside Rails app
+- Rake tasks performance
+- Custom events wrapped with `RailsPerformance.measure do .. end` block
 - works with Rails 4.2+ (and probably 4.1, 4.0 too) and Ruby 2.2+
 
 All data are stored in `local` Redis and not sent to any 3rd party servers.
 
 ## Production
 
-Gem is production-ready. At least on my 2 applications with ~800 unique users per day it works perfectly. 
+Gem is production-ready. At least on my 2 applications with ~800 unique users per day it works perfectly.
 
 Just don't forget to protect performance dashboard with http basic auth or check of current_user.
 
@@ -49,7 +55,8 @@ RailsPerformance.setup do |config|
   config.debug    = false # currently not used>
   config.enabled  = true
 
-  # default path where to mount gem
+  # default path where to mount gem,
+  # alternatively you can mount the RailsPerformance::Engine in your routes.rb
   config.mount_at = '/rails/performance'
 
   # protect your Performance Dashboard with HTTP BASIC password
@@ -65,6 +72,7 @@ end if defined?(RailsPerformance)
 ```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -78,18 +86,47 @@ end
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
+Create default configuration file:
+
+```bash
+$ rails generate rails_performance:install
+```
+
+Have a look at `config/initializers/rails_performance.rb` and adjust the configuration to your needs.
+
 You must also have installed Redis server, because this gem is storing data into it.
 
 After installation and configuration, start your Rails application, make a few requests, and open `https://localhost:3000/rails/performance` URL.
 
+### Alternative: Mounting the engine yourself
+
+If you, for whatever reason (company policy, devise, ...) need to mount RailsPerformance yourself, feel free to do so by using the following snippet as inspiration.
+You can skip the `mount_at` and `http_basic_authentication_*` configurations then, if you like.
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  ...
+  # example for usage with Devise
+  authenticate :user, -> (user) { user.admin? } do
+    mount RailsPerformance::Engine, at: 'rails/performance'
+  end
+end
+```
+
+
+
 ## How it works
 
 ![Schema](docs/rails_performance.png)
 
+In addition it's wrapping gems internal methods and collecting performance information. See `./lib/rails_performance/gems/*` for more information.
+
 ## Limitations
 
 - it doesn't track params of POST/PUT requests
@@ -124,10 +161,8 @@ The idea of this gem grew from curriosity how many RPM my app receiving per day.
 
 ## TODO
 
-- documentation in Readme
+- documentation in Readme?
 - capture stacktrace of 500 errors and show in side panel
-- generator for initial config
-- CI for tests
 - time/zone config?
 - connected charts on dashboard, when zoom, when hover?
 - ability to zoom to see requests withing specific datetime range
@@ -136,7 +171,7 @@ The idea of this gem grew from curriosity how many RPM my app receiving per day.
 - better stats tooltip, do not show if nothing to show
 - dark mode toggle? save to the cookies?
 - integration with elastic search? or other?
-- monitor active job (sidekiq)?
+- monitor active job?
 - better logo?
 - number of requests last 24 hours, hour, etc.
 - collect deprecation.rails
@@ -144,17 +179,29 @@ The idea of this gem grew from curriosity how many RPM my app receiving per day.
 - show "loading banner" until jquery is loaded?
 - better UI on smaller screens? Recent requests when URL's are long? Truncate with CSS?
 - rules for highlighting durations? how many ms to show warning, alert
+- elastic search
+- searchkiq
+- sinatra?
+- tests to check what is actually stored in redis db after request
 
 ## Contributing
 
 You are welcome to contribute. I've a big list of TODO.
 
+If "schema" how records are stored i Redis is changed, and this is a breacking change, update: `RailsPerformance::SCHEMA` to a newer value.
+
 ## Big thanks to contributors
 
 - https://github.com/synth
 - https://github.com/alagos
 - https://github.com/klondaiker
+- https://github.com/jules2689
+- https://github.com/PedroAugustoRamalhoDuarte
+- https://github.com/haffla
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/)

data/app/controllers/rails_performance/rails_performance_controller.rb

@@ -6,28 +6,20 @@ module RailsPerformance
 
     if RailsPerformance.enabled
       def index
-        @datasource                = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        @datasource                = RP::DataSource.new(**prepare_query, type: :requests)
         db                         = @datasource.db
 
-        @throughput_report         = RP::Reports::ThroughputReport.new(db)
-        @throughput_report_data    = @throughput_report.data
-
-        @response_time_report      = RP::Reports::ResponseTimeReport.new(db)
-        @response_time_report_data = @response_time_report.data
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @response_time_report_data = RP::Reports::ResponseTimeReport.new(db).data
       end
 
       def summary
-        @datasource                = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        @datasource                = RP::DataSource.new(**prepare_query, type: :requests)
         db                         = @datasource.db
 
-        @throughput_report         = RP::Reports::ThroughputReport.new(db)
-        @throughput_report_data    = @throughput_report.data
-
-        @response_time_report      = RP::Reports::ResponseTimeReport.new(db)
-        @response_time_report_data = @response_time_report.data
-
-        @report                    = RP::Reports::BreakdownReport.new(db, title: "Requests")
-        @data                      = @report.data
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @response_time_report_data = RP::Reports::ResponseTimeReport.new(db).data
+        @data                      = RP::Reports::BreakdownReport.new(db, title: "Requests").data
 
         respond_to do |format|
           format.js {}
@@ -36,9 +28,8 @@ module RailsPerformance
       end
 
       def trace
-        @record = RP::Models::Record.find_by(request_id: params[:id])
-        @report = RP::Reports::TraceReport.new(request_id: params[:id])
-        @data   = @report.data
+        @record = RP::Models::RequestRecord.find_by(request_id: params[:id])
+        @data   = RP::Reports::TraceReport.new(request_id: params[:id]).data
         respond_to do |format|
           format.js {}
           format.any { render plain: "Doesn't open in new window. Wait until full page load." }
@@ -46,38 +37,59 @@ module RailsPerformance
       end
 
       def crashes
-        @datasource   = RP::DataSource.new(**prepare_query({status_eq: 500}), type: :requests, klass: RP::Models::Record)
+        @datasource   = RP::DataSource.new(**prepare_query({status_eq: 500}), type: :requests)
         db            = @datasource.db
-        @report       = RP::Reports::CrashReport.new(db)
-        @data         = @report.data
+        @data         = RP::Reports::CrashReport.new(db).data
       end
 
       def requests
-        @datasource = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        @datasource = RP::DataSource.new(**prepare_query, type: :requests)
         db          = @datasource.db
-        @report     = RP::Reports::RequestsReport.new(db, group: :controller_action_format, sort: :count)
-        @data       = @report.data
+        @data       = RP::Reports::RequestsReport.new(db, group: :controller_action_format, sort: :count).data
       end
 
       def recent
-        @datasource = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        @datasource = RP::DataSource.new(**prepare_query, type: :requests)
         db          = @datasource.db
-        @report     = RP::Reports::RecentRequestsReport.new(db)
-        @data       = @report.data
+        @data       = RP::Reports::RecentRequestsReport.new(db).data
+      end
+
+      def sidekiq
+        @datasource                = RP::DataSource.new(**prepare_query, type: :sidekiq)
+        db                         = @datasource.db
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @response_time_report_data = RP::Reports::ResponseTimeReport.new(db).data
+        @recent_report_data        = RP::Reports::RecentRequestsReport.new(db).data
       end
 
-      def jobs
-        @datasource                = RP::DataSource.new(**prepare_query, type: :jobs, klass: RP::Models::JobRecord)
+      def delayed_job
+        @datasource                = RP::DataSource.new(**prepare_query, type: :delayed_job)
         db                         = @datasource.db
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @response_time_report_data = RP::Reports::ResponseTimeReport.new(db).data
+        @recent_report_data        = RP::Reports::RecentRequestsReport.new(db).data
+      end
 
-        @throughput_report         = RP::Reports::ThroughputReport.new(db)
-        @throughput_report_data    = @throughput_report.data
+      def custom
+        @datasource                = RP::DataSource.new(**prepare_query, type: :custom)
+        db                         = @datasource.db
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @response_time_report_data = RP::Reports::ResponseTimeReport.new(db).data
+        @recent_report_data        = RP::Reports::RecentRequestsReport.new(db).data
+      end
 
-        @response_time_report      = RP::Reports::ResponseTimeReport.new(db)
-        @response_time_report_data = @response_time_report.data
+      def grape
+        @datasource                = RP::DataSource.new(**prepare_query, type: :grape)
+        db                         = @datasource.db
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @recent_report_data        = RP::Reports::RecentRequestsReport.new(db).data
+      end
 
-        @recent_report             = RP::Reports::RecentRequestsReport.new(db)
-        @recent_report_data        = @recent_report.data(:jobs)
+      def rake
+        @datasource                = RP::DataSource.new(**prepare_query, type: :rake)
+        db                         = @datasource.db
+        @throughput_report_data    = RP::Reports::ThroughputReport.new(db).data
+        @recent_report_data        = RP::Reports::RecentRequestsReport.new(db).data
       end
 
       private

data/app/helpers/rails_performance/application_helper.rb

@@ -1,10 +1,10 @@
 module RailsPerformance
   module ApplicationHelper
-    def round_it(value)
+    def round_it(value, limit = 1)
       return nil unless value
       return value if value.is_a?(Integer)
 
-      value.nan? ? nil : value.round(1)
+      value.nan? ? nil : value.round(limit)
     end
 
     def duraction_alert_class(duration_str)
@@ -30,9 +30,15 @@ module RailsPerformance
       end
     end
 
-    def ms(value)
-      result = round_it(value)
-      result && result != 0 ? "#{result} ms" : '-'
+    def mss(value, limit = 1)
+      ms(value.to_f * 1000, limit)
+    end
+
+    def ms(value, limit = 1)
+      result = round_it(value, limit)
+      return '-' if result.nil?
+
+      result && result != 0 ? "#{result} ms" : '< 0 ms'
     end
 
     def short_path(path, length: 60)
@@ -65,6 +71,8 @@ module RailsPerformance
 
     def status_tag(status)
       klass = case status.to_s
+      when /error/
+        "tag is-danger"
       when /^5/
         "tag is-danger"
       when /^4/
@@ -73,6 +81,8 @@ module RailsPerformance
         "tag is-info"
       when /^2/
         "tag is-success"
+      when /success/
+        "tag is-success"
       else
         nil
       end
@@ -108,8 +118,16 @@ module RailsPerformance
         "is-active" if controller_name == "rails_performance" && action_name == "requests"
       when :recent
         "is-active" if controller_name == "rails_performance" && action_name == "recent"
-      when :jobs
-        "is-active" if controller_name == "rails_performance" && action_name == "jobs"
+      when :sidekiq
+        "is-active" if controller_name == "rails_performance" && action_name == "sidekiq"
+      when :delayed_job
+        "is-active" if controller_name == "rails_performance" && action_name == "delayed_job"
+      when :grape
+        "is-active" if controller_name == "rails_performance" && action_name == "grape"
+      when :rake
+        "is-active" if controller_name == "rails_performance" && action_name == "rake"
+      when :custom
+        "is-active" if controller_name == "rails_performance" && action_name == "custom"
       end
     end
   end

data/app/views/rails_performance/javascripts/app.js

@@ -22,7 +22,7 @@ function showTIRChart(div, data, addon, name) {
           },
           formatter: function() {
               if (this.y == 0) {
-                return '';
+                return 'n/a';
               }
             return this.y + addon;
           }
@@ -107,7 +107,7 @@ function showRTChart(div, data) {
           },
           formatter: function() {
               if (this.y == 0) {
-                return "";
+                return 'n/a';
               }
               return this.y + ' ms';
           }

data/app/views/rails_performance/rails_performance/_summary.html.erb

@@ -4,7 +4,7 @@
 <h2 class="subtitle">Average Response Time</h2>
 <div id="response_time_report_chart_mini" class="chart_mini"></div>
 
-<h2 class="subtitle"><%= @report.title %></h2>
+<h2 class="subtitle"><%= title %></h2>
 <table class="table is-fullwidth is-hoverable is-narrow is-size-7">
   <thead>
     <tr>

data/app/views/rails_performance/rails_performance/custom.html.erb

@@ -0,0 +1,83 @@
+<title>Custom Events</title>
+
+<% unless @datasource.default? %>
+  <%#= link_to raw("&larr; Back"), rails_performance_path, class: "back_link" %>
+<% end %>
+
+<div class="card">
+  <div class="card-content">
+    <h2 class="subtitle">Recent Events (last <%= RailsPerformance::Reports::RecentRequestsReport::TIME_WINDOW / 60 %> minutes)<h2>
+
+    <table class="table is-fullwidth is-hoverable is-narrow">
+      <thead>
+        <tr>
+          <th data-sort="string">Datetime</th>
+          <th data-sort="string">Tag</th>
+          <th data-sort="string">Namespace</th>
+          <th data-sort="string">Status</th>
+          <th data-sort="float">Duration</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% if @recent_report_data.empty? %>
+          <tr>
+            <td colspan="5">
+              Nothing to show here. Try to make a few requests in the main app.
+
+              <pre>
+                <code>
+                  # in controller for example
+                  def index
+                    RailsPerformance.measure("stats calculation", "reports#index") do
+                      stats = User.calculate_stats
+                    end
+                  end
+                </code>
+              </pre>
+            </td>
+          </tr>
+        <% end %>
+        <% @recent_report_data.each do |e| %>
+          <tr>
+            <td><%= format_datetime e[:datetime] %></td>
+            <td><%= e[:tag_name] %></td>
+            <td><%= e[:namespace_name] %></td>
+            <td><%= status_tag e[:status] %></td>
+            <td class="nowrap"><%= ms e[:duration] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<br/>
+
+<div class="card">
+  <div class="card-content">
+    <h2 class="subtitle">Custom Events Throughput Report</h2>
+    <div id="throughput_report_chart" class="chart"></div>
+    <p class="content is-small">All custom events in the application</p>
+  </div>
+</div>
+
+<br/>
+
+<div class="card">
+  <div class="card-content">
+    <h2 class="subtitle">Average Execution Time</h2>
+    <div id="response_time_report_chart" class="chart"></div>
+    <p class="content is-small">All custom events in the application</p>
+  </div>
+</div>
+
+
+<% content_for :on_load do %>
+  <script>
+    var data1 = <%= raw @throughput_report_data.to_json %>;
+    showTIRChart('throughput_report_chart', data1, ' events / minute', 'Events');
+
+    var data2 = <%= raw @response_time_report_data.to_json %>;
+    showRTChart('response_time_report_chart', data2);
+  </script>
+<% end %>