rails_performance 0.9.0.1 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f448780915ccb27d02015c9b9b4d011ae318175c5564ae33643fcf0c0a3ecd2f
-  data.tar.gz: cd3f09c47e39ab49a35df35ff83f0f604e76758ebea92a424e5a817e6eef7294
+  metadata.gz: 91dc41ef53b796c8c0755afd109fc7b7684ea9a5567828ab0e7f9e6c80cf9e79
+  data.tar.gz: 434e5e19a7abb0fc86b094d591623d626ab4b8a8e2ad28b70d2dfe70583e510b
 SHA512:
-  metadata.gz: '0891876b6e5aa7826da42d1a58800b574c5d0d987c286ae836c31a493adea505cd5d407f833b681f72e66526dbbfa6da05a16b7562002f328c150c1070beee4a'
-  data.tar.gz: eab4c06078ef53261b90f7063c54859d39157e1999f27674db5f7f7dab3c30fe2fb87fa1013502f0910a0ea36e24e46ec2d22251e3c4707220d58fb5c61370c4
+  metadata.gz: dffbb9eab0930f214009a8717c97a9fe82b7ea5fea22cd7a18d9a34426811d8467a19600e38e5fbdc1eb4c1aee1308b7819a8b79ff77d721907a644b9f2facea
+  data.tar.gz: 69e08649d416bf680f203ee801534c1c5dbedd5ee956e85cca5439db3eaa8062ca830800454eb37335059732239946f6a39ad0a1d756b7efa40864fc5ebb9dc9

data/README.md

@@ -1,29 +1,45 @@
 # Rails Performance
 
-Self-hosted tool to monitor the performance of your Ruby on Rails application.
+[![Build Status](https://travis-ci.org/igorkasyanchuk/rails_performance.svg?branch=master)](https://travis-ci.org/igorkasyanchuk/rails_performance)
+
+A self-hosted tool to monitor the performance of your Ruby on Rails application.
 
 This is **simple and free alternative** to the New Relic APM, Datadog or other similar services.
 
+![Demo](docs/rails_performance.gif)
+
 It allows you to track:
 
 - throughput report (see amount of RPM (requests per minute))
 - an average response time
 - the slowest controllers & actions
 - total duration of time spent per request, views rendering, DB
-- SQL queries, rendering log in recent requests
+- SQL queries, rendering logs in "Recent Requests" section
 - simple 500-crashes reports
+- track Sidekiq jobs performance
+- works with Rails 4.2+ (and probably 4.1, 4.0 too)
 
 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 perfect.
+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.
 
 ## Usage
 
+```
+1. Add gem to the Gemfile (in appropriate group if needed)
+2. Start rails server
+3. Make a few requests to your app
+4. open localhost:3000/rails/performance
+5. Tune the configuration and deploy to production
+```
+
 Default configulation is listed below. But you can overide it.
 
-Create `config/initializers/rails_performance.rb`
+Create `config/initializers/rails_performance.rb` in your app:
 
 ```ruby
 RailsPerformance.setup do |config|
@@ -50,6 +66,12 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'rails_performance'
+
+# or 
+
+group :development, :production do
+  gem 'rails_performance'
+end
 ```
 
 And then execute:
@@ -61,6 +83,10 @@ You must also have installed Redis server, because this gem is storing data into
 
 After installation and configuration, start your Rails application, make a few requests, and open `https://localhost:3000/rails/performance` URL.
 
+## How it works
+
+![Schema](docs/rails_performance.png)
+
 ## Limitations
 
 - it doesn't track params of POST/PUT requests
@@ -70,6 +96,8 @@ After installation and configuration, start your Rails application, make a few r
 
 ## Redis
 
+Gem is using Redis. This is the only one dependency.
+
 All information is stored into Redis. The default expiration time is set to `config.duration` from the configuration.
 
 ## Development & Testing
@@ -79,7 +107,7 @@ Just clone the repo, setup dummy app (`rails db:migrate`).
 After this:
 
 - rails s
-- rake tests
+- rake test
 
 Like a regular web development.
 
@@ -111,11 +139,17 @@ The idea of this gem grew from curriosity how many RPM my app receiving per day.
 - collect deprecation.rails
 - fix misspellings?
 - 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
 
 ## Contributing
 
 You are welcome to contribute. I've a big list of TODO.
 
+## Big thanks to contributors
+
+- https://github.com/synth
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/rails_performance/base_controller.rb

@@ -0,0 +1,21 @@
+module RailsPerformance
+  class BaseController < ActionController::Base
+    layout 'rails_performance/layouts/rails_performance'
+
+    before_action :verify_access
+
+    if RailsPerformance.http_basic_authentication_enabled
+      http_basic_authenticate_with \
+        name: RailsPerformance.http_basic_authentication_user_name,
+        password: RailsPerformance.http_basic_authentication_password
+    end
+
+    private
+
+    def verify_access
+      result = RailsPerformance.verify_access_proc.call(self)
+      redirect_to('/', error: 'Access Denied', status: 401) unless result
+    end
+
+  end
+end

data/app/controllers/rails_performance/rails_performance_controller.rb

@@ -0,0 +1,91 @@
+require_relative './base_controller.rb'
+
+module RailsPerformance
+  class RailsPerformanceController < RailsPerformance::BaseController
+    include RailsPerformance::ApplicationHelper
+
+    if RailsPerformance.enabled
+      def index
+        @datasource                = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        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
+      end
+
+      def summary
+        @datasource                = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        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
+
+        respond_to do |format|
+          format.js {}
+          format.any { render plain: "Doesn't open in new window. Wait until full page load." }
+        end
+      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
+        respond_to do |format|
+          format.js {}
+          format.any { render plain: "Doesn't open in new window. Wait until full page load." }
+        end
+      end
+
+      def crashes
+        @datasource   = RP::DataSource.new(**prepare_query({status_eq: 500}), type: :requests, klass: RP::Models::Record)
+        db            = @datasource.db
+        @report       = RP::Reports::CrashReport.new(db)
+        @data         = @report.data
+      end
+
+      def requests
+        @datasource = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        db          = @datasource.db
+        @report     = RP::Reports::RequestsReport.new(db, group: :controller_action_format, sort: :count)
+        @data       = @report.data
+      end
+
+      def recent
+        @datasource = RP::DataSource.new(**prepare_query, type: :requests, klass: RP::Models::Record)
+        db          = @datasource.db
+        @report     = RP::Reports::RecentRequestsReport.new(db)
+        @data       = @report.data
+      end
+
+      def jobs
+        @datasource                = RP::DataSource.new(**prepare_query, type: :jobs, klass: RP::Models::JobRecord)
+        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
+
+        @recent_report             = RP::Reports::RecentRequestsReport.new(db)
+        @recent_report_data        = @recent_report.data(:jobs)
+      end
+
+      private
+
+      def prepare_query(query = params)
+        RP::Rails::QueryBuilder.compose_from(query)
+      end
+    end
+
+  end
+end

data/app/helpers/rails_performance/application_helper.rb

@@ -0,0 +1,116 @@
+module RailsPerformance
+  module ApplicationHelper
+    def round_it(value)
+      return nil unless value
+      return value if value.is_a?(Integer)
+
+      value.nan? ? nil : value.round(1)
+    end
+
+    def duraction_alert_class(duration_str)
+      if duration_str.to_s =~ /(\d+.?\d+?)/
+        duration = $1.to_f
+        if duration >= 500
+          'has-background-danger has-text-white-bis'
+        elsif duration >= 200
+          'has-background-warning has-text-black-ter'
+        else
+          'has-background-success has-text-white-bis'
+        end
+      else
+        'has-background-light'
+      end
+    end
+
+    def extract_duration(str)
+      if (str =~ /Duration: (\d+.?\d+?ms)/i)
+        $1
+      else
+        '-'
+      end
+    end
+
+    def ms(value)
+      result = round_it(value)
+      result && result != 0 ? "#{result} ms" : '-'
+    end
+
+    def short_path(path, length: 60)
+      content_tag :span, title: path do
+        truncate(path, length: length)
+      end
+    end
+
+    def link_to_path(e)
+      if e[:method] == 'GET'
+        link_to(short_path(e[:path]), e[:path], target: '_blank')
+      else
+        short_path(e[:path])
+      end
+    end
+
+    def report_name(h)
+      h.except(:on).collect do |k, v|
+        next if v.blank?
+
+        %Q{
+        <div class="control">
+          <span class="tags has-addons">
+            <span class="tag">#{k}</span>
+            <span class="tag is-info is-light">#{v}</span>
+          </span>
+        </div>}
+      end.compact.join.html_safe
+    end
+
+    def status_tag(status)
+      klass = case status.to_s
+      when /^5/
+        "tag is-danger"
+      when /^4/
+        "tag is-warning"
+      when /^3/
+        "tag is-info"
+      when /^2/
+        "tag is-success"
+      else
+        nil
+      end
+      content_tag(:span, class: klass) do
+        status
+      end
+    end
+
+    def icon(name)
+      # https://www.iconfinder.com/iconsets/vivid
+      raw File.read(File.expand_path(File.dirname(__FILE__) +  "/../../assets/images/#{name}.svg"))
+    end
+
+    def insert_css_file(file)
+      raw "<style>#{raw File.read File.expand_path(File.dirname(__FILE__) + "/../../views/rails_performance/stylesheets/#{file}")}</style>"
+    end
+
+    def insert_js_file(file)
+      raw "<script>#{raw File.read File.expand_path(File.dirname(__FILE__) + "/../../views/rails_performance/javascripts/#{file}")}</script>"
+    end
+
+    def format_datetime(e)
+      e.strftime("%Y-%m-%d %H:%M:%S")
+    end
+
+    def active?(section)
+      case section
+      when :dashboard
+        "is-active" if controller_name == "rails_performance" && action_name == "index"
+      when :crashes
+        "is-active" if controller_name == "rails_performance" && action_name == "crashes"
+      when :requests
+        "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"
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-function showTIRChart(div, data) {
+function showTIRChart(div, data, addon, name) {
   Highcharts.chart(div, {
       time: {
         timezone: 'Europe/Kiev'
@@ -24,7 +24,7 @@ function showTIRChart(div, data) {
               if (this.y == 0) {
                 return '';
               }
-              return this.y + ' rpm';
+            return this.y + addon;
           }
       },
       xAxis: {
@@ -69,7 +69,7 @@ function showTIRChart(div, data) {
       },
       series: [{
           type: 'area',
-          name: 'RPM',
+          name: name,
           data: data,
           fillOpacity: 0.3,
           lineWidth: 1,

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

@@ -5,7 +5,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>Rails Performance</title>
     <%= csrf_meta_tags %>
-    <%= csp_meta_tag %>
+    <%= csp_meta_tag if ::Rails::VERSION::MAJOR.to_i >= 5 %>
     <%= render '/rails_performance/stylesheets/stylesheets' %>
     <link rel="shortcut icon" href="/favicon.ico">
   </head>

data/app/views/rails_performance/{index.html.erb → rails_performance/index.html.erb}

@@ -25,7 +25,7 @@
 <% content_for :on_load do %>
   <script>
     var data1 = <%= raw @throughput_report_data.to_json %>;
-    showTIRChart('throughput_report_chart', data1);
+    showTIRChart('throughput_report_chart', data1, ' rpm', 'RPM');
 
     var data2 = <%= raw @response_time_report_data.to_json %>;
     showRTChart('response_time_report_chart', data2);

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

@@ -0,0 +1,73 @@
+<title>Number of Requests to the Application</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">Sidekiq Workers Throughput Report</h2>
+    <div id="throughput_report_chart" class="chart"></div>
+    <p class="content is-small">All workers 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 workers in the application</p>
+  </div>
+</div>
+
+<div class="card">
+  <div class="card-content">
+    <h2 class="subtitle">Recent Jobs (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">Queue</th>
+          <th data-sort="string">Worker</th>
+          <th data-sort="string">Job ID</th>
+          <th data-sort="string">Status</th>
+          <th data-sort="float">Duration</th>
+          <th>Message</th>
+          <th></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% if @recent_report_data.empty? %>
+          <tr>
+            <td colspan="10">Nothing to show here. Try to make a few requests in main app.</td>
+          </tr>
+        <% end %>
+        <% @recent_report_data.each do |e| %>
+          <tr>
+            <td><%= format_datetime e[:datetime] %></td>
+            <td><%= e[:queue] %></td>
+            <td><%= e[:worker] %></td>
+            <td><%= e[:jid] %></td>
+            <td><%= status_tag e[:status] %></td>
+            <td class="nowrap"><%= ms e[:duration] %></td>
+            <td><%= e[:message] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+
+<% content_for :on_load do %>
+  <script>
+    var data1 = <%= raw @throughput_report_data.to_json %>;
+    showTIRChart('throughput_report_chart', data1, ' jobs / minute', 'Jobs');
+
+    var data2 = <%= raw @response_time_report_data.to_json %>;
+    showRTChart('response_time_report_chart', data2);
+  </script>
+<% end %>

data/app/views/rails_performance/{recent.html.erb → rails_performance/recent.html.erb}

@@ -1,11 +1,11 @@
 <div class="card">
   <div class="card-content">
-
     <h2 class="subtitle">Recent Requests (last <%= RailsPerformance::Reports::RecentRequestsReport::TIME_WINDOW / 60 %> minutes)<h2>
 
     <table class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>
+          <th data-sort="string"></th>
           <th data-sort="string">Datetime</th>
           <th data-sort="string">Controller#action</th>
           <th data-sort="string">Method</th>
@@ -26,6 +26,13 @@
         <% end %>
         <% @data.each do |e| %>
           <tr>
+            <td>
+              <% if e[:request_id].present? %>
+                <%= link_to rails_performance.rails_performance_trace_path(id: e[:request_id]), remote: true do %>
+                  <span class="stats_icon_max"><%= icon 'activity' %></span>
+                <% end %>
+              <% end %>
+            </td>
             <td><%= format_datetime e[:datetime] %></td>
             <td><%= link_to e[:controller] + '#' + e[:action], rails_performance.rails_performance_summary_path({controller_eq: e[:controller], action_eq: e[:action]}), remote: true %></td>
             <td><%= e[:method] %></td>

data/app/views/rails_performance/{summary.js.erb → rails_performance/summary.js.erb}

@@ -1,8 +1,8 @@
 window.panel.header.html(window.panel.close + '<%= j report_name(@datasource.q) %>');
-window.panel.content.html("<%= j render '/rails_performance/summary' %>");
+window.panel.content.html("<%= j render '/rails_performance/rails_performance/summary' %>");
 
 var data1 = <%= raw @throughput_report_data.to_json %>;
-showTIRChart('throughput_report_chart_mini', data1);
+showTIRChart('throughput_report_chart_mini', data1, ' rpm', 'RPM');
 
 var data2 = <%= raw @response_time_report_data.to_json %>;
 showRTChart('response_time_report_chart_mini', data2);

data/app/views/rails_performance/{trace.js.erb → rails_performance/trace.js.erb}

@@ -4,6 +4,6 @@
   window.panel.header.html(window.panel.close);
 <% end %>
 
-window.panel.content.html("<%= j render '/rails_performance/trace' %>");
+window.panel.content.html("<%= j render '/rails_performance/rails_performance/trace' %>");
 
 showPanel();

data/app/views/rails_performance/shared/_header.html.erb

@@ -18,6 +18,9 @@
       <%= link_to 'Requests Analysis', rails_performance.rails_performance_requests_url, class: "navbar-item #{active?(:requests)}" %>
       <%= link_to '500 Errors', rails_performance.rails_performance_crashes_url, class: "navbar-item #{active?(:crashes)}" %>
       <%= link_to 'Recent Requests', rails_performance.rails_performance_recent_url, class: "navbar-item #{active?(:recent)}" %>
+      <% if defined?(Sidekiq) %>
+        <%= link_to 'Sidekiq', rails_performance.rails_performance_jobs_url, class: "navbar-item #{active?(:jobs)}" %>
+      <% end %>
     </div>
 
     <div class="navbar-end">

data/config/routes.rb

@@ -7,6 +7,8 @@ RailsPerformance::Engine.routes.draw do
 
   get '/trace/:id'  => 'rails_performance#trace', as: :rails_performance_trace
   get '/summary'    => 'rails_performance#summary', as: :rails_performance_summary
+
+  get '/jobs'       => 'rails_performance#jobs', as: :rails_performance_jobs
 end
 
 Rails.application.routes.draw do

data/lib/rails_performance.rb

@@ -4,7 +4,9 @@ require_relative "./rails_performance/version.rb"
 require_relative "rails_performance/rails/query_builder.rb"
 require_relative "rails_performance/rails/middleware.rb"
 require_relative "rails_performance/data_source.rb"
+require_relative "rails_performance/models/base_record.rb"
 require_relative "rails_performance/models/record.rb"
+require_relative "rails_performance/models/job_record.rb"
 require_relative "rails_performance/utils.rb"
 require_relative "rails_performance/reports/base_report.rb"
 require_relative "rails_performance/reports/requests_report.rb"

data/lib/rails_performance/data_source.rb

@@ -1,8 +1,10 @@
 module RailsPerformance
   class DataSource
-    attr_reader :q
+    attr_reader :q, :klass, :type
 
-    def initialize(q: {})
+    def initialize(q: {}, type:, klass:)
+      @klass   = klass
+      @type    = type
       q[:on] ||= Date.today
       @q       = q
 
@@ -12,7 +14,7 @@ module RailsPerformance
     def db
       result = RP::Models::Collection.new
       (RP::Utils.days + 1).times do |e|
-        RP::DataSource.new(q: self.q.merge({ on: e.days.ago.to_date })).add_to(result)
+        RP::DataSource.new(q: self.q.merge({ on: e.days.ago.to_date }), klass: klass, type: type).add_to(result)
       end
       result
     end
@@ -34,41 +36,46 @@ module RailsPerformance
       return [] if keys.blank?
 
       keys.each_with_index do |key, index|
-        yield RP::Models::Record.new(key, values[index])
+        yield klass.new(key, values[index])
       end
     end
 
     private
 
-    # key = performance|
-    # controller|HomeController|
-    # action|index|
-    # format|html|
-    # status|200|
-    # datetime|20200124T0523|
-    # datetimei|1579861423|
-    # method|GET|
-    # path|/|
-    # END
-
-    def compile_query
+    def query
+      case type
+      when :requests
+        "performance|*#{compile_requests_query}*|END"
+      when :jobs
+        "jobs|*#{compile_jobs_query}*|END"
+      else
+        raise "wrong type for datasource query builder"
+      end
+    end
+
+    def compile_requests_query
       str = []
 
       str << "controller|#{q[:controller]}|" if q[:controller].present?
       str << "action|#{q[:action]}|" if q[:action].present?
       str << "format|#{q[:format]}|" if q[:format].present?
       str << "status|#{q[:status]}|" if q[:status].present?
-
       str << "datetime|#{q[:on].strftime('%Y%m%d')}*|" if q[:on].present?
-
       str << "method|#{q[:method]}|" if q[:method].present?
       str << "path|#{q[:path]}|" if q[:path].present?
 
       str.join("*")
     end
 
-    def query
-      "performance|*#{compile_query}*|END"
+    def compile_jobs_query
+      str = []
+
+      str << "queue|#{q[:queue]}|" if q[:queue].present?
+      str << "worker|#{q[:worker]}|" if q[:worker].present?
+      str << "datetime|#{q[:on].strftime('%Y%m%d')}*|" if q[:on].present?
+      str << "status|#{q[:status]}|" if q[:status].present?
+
+      str.join("*")
     end
 
   end

data/lib/rails_performance/engine.rb

@@ -4,10 +4,15 @@ require_relative './instrument/metrics_collector.rb'
 
 module RailsPerformance
   class Engine < ::Rails::Engine
+    isolate_namespace RailsPerformance
 
     if RailsPerformance.try(:enabled) # for rails c
 
-      config.app_middleware.insert_after ActionDispatch::Executor, RailsPerformance::Rails::Middleware
+      if ::Rails::VERSION::MAJOR.to_i >= 5
+        config.app_middleware.insert_after ActionDispatch::Executor, RailsPerformance::Rails::Middleware
+      else
+        config.app_middleware.insert_after ActionDispatch::Static, RailsPerformance::Rails::Middleware
+      end
 
       initializer :configure_metrics, after: :initialize_logger do
         ActiveSupport::Notifications.subscribe(
@@ -19,7 +24,15 @@ module RailsPerformance
           ActionView::LogSubscriber.send :prepend, RailsPerformance::Extensions::View
           ActiveRecord::LogSubscriber.send :prepend, RailsPerformance::Extensions::Db
         end
+      end
 
+      if const_defined?("Sidekiq")
+        require_relative './gems/sidekiq.rb'
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add RailsPerformance::Gems::Sidekiq
+          end
+        end
       end
 
     end

data/lib/rails_performance/gems/sidekiq.rb

@@ -0,0 +1,35 @@
+module RailsPerformance
+  module Gems
+    class Sidekiq
+
+      def initialize(options=nil)
+      end
+
+      def call(worker, msg, queue)
+        now  = Time.now
+        data = {
+          enqueued_ati: msg['enqueued_at'].to_i,
+          created_ati: msg['created_at'].to_i,
+          jid: msg['jid'],
+          queue: queue,
+          start_timei: now.to_i,
+          datetime: now.strftime(RailsPerformance::FORMAT),
+          worker: msg['wrapped'.freeze] || worker.class.to_s
+        }
+        begin
+          yield
+          data[:status]   = "success"
+        rescue Exception => ex
+          data[:status]   = "exception"
+          data[:message]  = ex.message
+        ensure
+          # store in ms instead of seconds
+          data[:duration] = (Time.now - now) * 1000
+          #puts data
+          RailsPerformance::Utils.log_job_in_redis(data)
+        end
+      end
+
+    end
+  end
+end

data/lib/rails_performance/models/base_record.rb

@@ -0,0 +1,24 @@
+module RailsPerformance
+  module Models
+    class BaseRecord
+      def value
+        @value ||= JSON.parse(@json || "{}")
+      end
+
+      def duration
+        value['duration']
+      end
+
+      private
+
+      def ms(e)
+        if e
+          e.to_f.round(1).to_s + " ms"
+        else
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/rails_performance/models/job_record.rb

@@ -0,0 +1,48 @@
+module RailsPerformance
+  module Models
+    class JobRecord < BaseRecord
+      attr_reader :queue, :worker, :jid, :created_ati, :enqueued_ati, :datetime, :start_timei, :status
+
+      # key = job-performance
+      # |queue|default
+      # |worker|SimpleWorker
+      # |jid|7d48fbf20976c224510dbc60
+      # |datetime|20200124T0523
+      # |created_ati|1583146613
+      # |enqueued_ati|1583146613
+      # |start_timei|1583146614
+      # |status|success|END
+      # value = JSON
+      def initialize(key, value)
+        @json = value
+
+        items = key.split("|")
+
+        @queue        = items[2]
+        @worker       = items[4]
+        @jid          = items[6]
+        @datetime     = items[8]
+        @created_ati  = items[10]
+        @enqueued_ati = items[12]
+        @start_timei  = items[14]
+        @status       = items[16]
+      end
+
+      def to_h
+        {
+          queue: queue,
+          worker: worker,
+          jid: jid,
+          datetime: datetime,
+          created_ati: created_ati,
+          enqueued_ati: enqueued_ati,
+          start_timei: start_timei,
+          duration: duration,
+          status: status,
+          message: value['message']
+        }
+      end
+
+    end
+  end
+end

data/lib/rails_performance/models/record.rb

@@ -1,9 +1,8 @@
 module RailsPerformance
   module Models
-    class Record
+    class Record < BaseRecord
       attr_reader :controller, :action, :format, :status, :datetime, :datetimei, :method, :path, :request_id
 
-
       def Record.find_by(request_id:)
         keys, values = RP::Utils.fetch_from_redis("performance|*|request_id|#{request_id}|*")
 
@@ -42,10 +41,6 @@ module RailsPerformance
         @request_id = items[18]
       end
 
-      def value
-        @value ||= JSON.parse(@json || "{}")
-      end
-
       def controller_action
         "#{controller}##{action}"
       end
@@ -61,23 +56,13 @@ module RailsPerformance
           format: format,
           method: method,
           path: path,
-          duration: ms(value['duration']),
+          duration: ms(duration),
           view_runtime: ms(value['view_runtime']),
           db_runtime: ms(value['db_runtime']),
           HTTP_REFERER: value['HTTP_REFERER']
         }
       end
 
-      private
-
-      def ms(e)
-        if e
-          e.to_f.round(1).to_s + " ms"
-        else
-          nil
-        end
-      end
-
     end
   end
 end

data/lib/rails_performance/rails/middleware.rb

@@ -6,6 +6,10 @@ module RailsPerformance
       end
 
       def call(env)
+        dup.call!(env)
+      end
+
+      def call!(env)
         @status, @headers, @response = @app.call(env)
 
         #t = Time.now

data/lib/rails_performance/reports/recent_requests_report.rb

@@ -7,25 +7,48 @@ module RailsPerformance
         @sort ||= :datetime
       end
 
-      def data
+      def data(type = :requests) # most popular type
         db.data.collect do |record|
-          {
-            controller: record.controller,
-            action: record.action,
-            format: record.format,
-            status: record.status,
-            method: record.method,
-            path: record.path,
-            request_id: record.request_id,
-            datetime: Time.at(record.datetimei.to_i),
-            duration: record.value['duration'],
-            db_runtime: record.value['db_runtime'],
-            view_runtime: record.value['view_runtime'],
-          }
+          case type
+          when :requests
+            record_hash(record)
+          when :jobs
+            job_hash(record)
+          end
         end
         .select{|e| e if e[:datetime] >= TIME_WINDOW.ago}
         .sort{|a, b| b[sort] <=> a[sort]}
       end
+
+      private
+
+      def record_hash(record)
+        {
+          controller: record.controller,
+          action: record.action,
+          format: record.format,
+          status: record.status,
+          method: record.method,
+          path: record.path,
+          request_id: record.request_id,
+          datetime: Time.at(record.datetimei.to_i),
+          duration: record.value['duration'],
+          db_runtime: record.value['db_runtime'],
+          view_runtime: record.value['view_runtime'],
+        }
+      end
+
+      def job_hash(record)
+        {
+          worker: record.worker,
+          queue: record.queue,
+          
+          jid: record.jid,
+          status: record.status,
+          datetime: Time.at(record.start_timei.to_i),
+          duration: record.value['duration'],
+        }
+      end
     end
 
 

data/lib/rails_performance/utils.rb

@@ -12,28 +12,21 @@ module RailsPerformance
       now.strftime("%H:%M")
     end
 
+    def Utils.log_job_in_redis(e)
+      key   = "jobs|queue|#{e[:queue]}|worker|#{e[:worker]}|jid|#{e[:jid]}|datetime|#{e[:datetime]}|created_ati|#{e[:created_ati]}|enqueued_ati|#{e[:enqueued_ati]}|start_timei|#{e[:start_timei]}|status|#{e[:status]}|END"
+      value = { message: e[:message], duration: e[:duration] }
+      Utils.save_to_redis(key, value)
+    end
+
     def Utils.log_request_in_redis(e)
       value = e.slice(:view_runtime, :db_runtime, :duration, :HTTP_REFERER)
       key   = "performance|controller|#{e[:controller]}|action|#{e[:action]}|format|#{e[:format]}|status|#{e[:status]}|datetime|#{e[:datetime]}|datetimei|#{e[:datetimei]}|method|#{e[:method]}|path|#{e[:path]}|request_id|#{e[:request_id]}|END"
-
-      # puts "  [SAVE]    key  --->  #{key}\n"
-      # puts "          value  --->  #{value.to_json}\n\n"
-
-      RP.redis.set(key, value.to_json)
-      RP.redis.expire(key, RP.duration.to_i)
-
-      true
+      Utils.save_to_redis(key, value)
     end
 
     def Utils.log_trace_in_redis(request_id, value)
       key = "trace|#{request_id}"
-
-      # puts "  [SAVE]    key  --->  #{key}\n"
-      # puts "          value  --->  #{value.to_json}\n\n"
-      # pp value
-
-      RP.redis.set(key, value.to_json)
-      RP.redis.expire(key, RailsPerformance::Reports::RecentRequestsReport::TIME_WINDOW.to_i)
+      Utils.save_to_redis(key, value, RailsPerformance::Reports::RecentRequestsReport::TIME_WINDOW.to_i)
     end
 
     def Utils.fetch_from_redis(query)
@@ -47,7 +40,7 @@ module RailsPerformance
     end
 
     def Utils.days
-      (RP.duration % 24.days).parts[:days] + 1
+      (RP.duration / 1.day) + 1
     end
 
     def Utils.median(array)
@@ -64,5 +57,12 @@ module RailsPerformance
       end
     end
 
+    def Utils.save_to_redis(key, value, expire = RP.duration.to_i)
+      # puts "  [SAVE]    key  --->  #{key}\n"
+      # puts "          value  --->  #{value.to_json}\n\n"
+      RP.redis.set(key, value.to_json)
+      RP.redis.expire(key, expire.to_i)
+    end
+
   end
-end
+end

data/lib/rails_performance/version.rb

@@ -1,3 +1,3 @@
 module RailsPerformance
-  VERSION = '0.9.0.1'
+  VERSION = '0.9.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_performance
 version: !ruby/object:Gem::Version
-  version: 0.9.0.1
+  version: 0.9.5
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: 3rd party dependency-free solution how to monitor performance of your
   Rails applications.
 email:
@@ -101,14 +115,10 @@ files:
 - app/assets/images/import.svg
 - app/assets/images/menu.svg
 - app/assets/images/stat.svg
-- app/controllers/base_controller.rb
-- app/controllers/rails_performance_controller.rb
-- app/helpers/rails_performance_helper.rb
+- app/controllers/rails_performance/base_controller.rb
+- app/controllers/rails_performance/rails_performance_controller.rb
+- app/helpers/rails_performance/application_helper.rb
 - app/views/rails_performance/_panel.html.erb
-- app/views/rails_performance/_summary.html.erb
-- app/views/rails_performance/_trace.html.erb
-- app/views/rails_performance/crashes.html.erb
-- app/views/rails_performance/index.html.erb
 - app/views/rails_performance/javascripts/_javascripts.html.erb
 - app/views/rails_performance/javascripts/app.js
 - app/views/rails_performance/javascripts/jquery-3.4.1.min.js
@@ -117,23 +127,31 @@ files:
 - app/views/rails_performance/javascripts/stupidtable.min.js
 - app/views/rails_performance/javascripts/table.js
 - app/views/rails_performance/layouts/rails_performance.html.erb
-- app/views/rails_performance/recent.html.erb
-- app/views/rails_performance/requests.html.erb
+- app/views/rails_performance/rails_performance/_summary.html.erb
+- app/views/rails_performance/rails_performance/_trace.html.erb
+- app/views/rails_performance/rails_performance/crashes.html.erb
+- app/views/rails_performance/rails_performance/index.html.erb
+- app/views/rails_performance/rails_performance/jobs.html.erb
+- app/views/rails_performance/rails_performance/recent.html.erb
+- app/views/rails_performance/rails_performance/requests.html.erb
+- app/views/rails_performance/rails_performance/summary.js.erb
+- app/views/rails_performance/rails_performance/trace.js.erb
 - app/views/rails_performance/shared/_header.html.erb
 - app/views/rails_performance/stylesheets/_stylesheets.html.erb
 - app/views/rails_performance/stylesheets/bulma.min.css
 - app/views/rails_performance/stylesheets/panel.css
 - app/views/rails_performance/stylesheets/style.css
-- app/views/rails_performance/summary.js.erb
-- app/views/rails_performance/trace.js.erb
 - config/routes.rb
 - lib/rails_performance.rb
 - lib/rails_performance/data_source.rb
 - lib/rails_performance/engine.rb
 - lib/rails_performance/extensions/capture_everything.rb
+- lib/rails_performance/gems/sidekiq.rb
 - lib/rails_performance/instrument/metrics_collector.rb
+- lib/rails_performance/models/base_record.rb
 - lib/rails_performance/models/collection.rb
 - lib/rails_performance/models/current_request.rb
+- lib/rails_performance/models/job_record.rb
 - lib/rails_performance/models/record.rb
 - lib/rails_performance/rails/middleware.rb
 - lib/rails_performance/rails/query_builder.rb
@@ -166,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple Rails Performance tracker. Alternative to the NewRelic, Datadog or

data/app/controllers/base_controller.rb

@@ -1,19 +0,0 @@
-class BaseController < ActionController::Base
-  layout 'rails_performance/layouts/rails_performance'
-
-  before_action :verify_access
-
-  if RailsPerformance.http_basic_authentication_enabled
-    http_basic_authenticate_with \
-      name: RailsPerformance.http_basic_authentication_user_name,
-      password: RailsPerformance.http_basic_authentication_password
-  end
-
-  private
-
-  def verify_access
-    result = RailsPerformance.verify_access_proc.call(self)
-    redirect_to('/', error: 'Access Denied', status: 401) unless result
-  end
-
-end

data/app/controllers/rails_performance_controller.rb

@@ -1,74 +0,0 @@
-require_relative './base_controller.rb'
-
-class RailsPerformanceController < BaseController
-
-  if RailsPerformance.enabled
-    def index
-      @datasource                = RP::DataSource.new(prepare_query)
-      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
-    end
-
-    def summary
-      @datasource                = RP::DataSource.new(prepare_query)
-      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
-
-      respond_to do |format|
-        format.js {}
-        format.any { render plain: "Doesn't open in new window. Wait until full page load." }
-      end
-    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
-      respond_to do |format|
-        format.js {}
-        format.any { render plain: "Doesn't open in new window. Wait until full page load." }
-      end
-    end
-
-    def crashes
-      @datasource   = RP::DataSource.new(prepare_query({status_eq: 500}))
-      db            = @datasource.db
-      @report       = RP::Reports::CrashReport.new(db)
-      @data         = @report.data
-    end
-
-    def requests
-      @datasource = RP::DataSource.new(prepare_query)
-      db          = @datasource.db
-      @report     = RP::Reports::RequestsReport.new(db, group: :controller_action_format, sort: :count)
-      @data       = @report.data
-    end
-
-    def recent
-      @datasource = RP::DataSource.new(prepare_query)
-      db          = @datasource.db
-      @report     = RP::Reports::RecentRequestsReport.new(db)
-      @data       = @report.data
-    end
-
-    private
-
-    def prepare_query(query = params)
-      RP::Rails::QueryBuilder.compose_from(query)
-    end
-  end
-
-end

data/app/helpers/rails_performance_helper.rb

@@ -1,112 +0,0 @@
-module RailsPerformanceHelper
-  def round_it(value)
-    return nil unless value
-    return value if value.is_a?(Integer)
-
-    value.nan? ? nil : value.round(1)
-  end
-
-  def duraction_alert_class(duration_str)
-    if duration_str.to_s =~ /(\d+.?\d+?)/
-      duration = $1.to_f
-      if duration >= 500
-        'has-background-danger has-text-white-bis'
-      elsif duration >= 200
-        'has-background-warning has-text-black-ter'
-      else
-        'has-background-success has-text-white-bis'
-      end
-    else
-      'has-background-light'
-    end
-  end
-
-  def extract_duration(str)
-    if (str =~ /Duration: (\d+.?\d+?ms)/i)
-      $1
-    else
-      '-'
-    end
-  end
-
-  def ms(value)
-    result = round_it(value)
-    result && result != 0 ? "#{result} ms" : '-'
-  end
-
-  def short_path(path, length: 60)
-    content_tag :span, title: path do
-      truncate(path, length: length)
-    end
-  end
-
-  def link_to_path(e)
-    if e[:method] == 'GET'
-      link_to(short_path(e[:path]), e[:path], target: '_blank')
-    else
-      short_path(e[:path])
-    end
-  end
-
-  def report_name(h)
-    h.except(:on).collect do |k, v|
-      next if v.blank?
-
-      %Q{
-      <div class="control">
-        <span class="tags has-addons">
-          <span class="tag">#{k}</span>
-          <span class="tag is-info is-light">#{v}</span>
-        </span>
-      </div>}
-    end.compact.join.html_safe
-  end
-
-  def status_tag(status)
-    klass = case status.to_s
-    when /^5/
-      "tag is-danger"
-    when /^4/
-      "tag is-warning"
-    when /^3/
-      "tag is-info"
-    when /^2/
-      "tag is-success"
-    else
-      nil
-    end
-    content_tag(:span, class: klass) do
-      status
-    end
-  end
-
-  def icon(name)
-    # https://www.iconfinder.com/iconsets/vivid
-    raw File.read(File.expand_path(File.dirname(__FILE__) +  "/../assets/images/#{name}.svg"))
-  end
-
-  def insert_css_file(file)
-    raw "<style>#{raw File.read File.expand_path(File.dirname(__FILE__) + "/../views/rails_performance/stylesheets/#{file}")}</style>"
-  end
-
-  def insert_js_file(file)
-    raw "<script>#{raw File.read File.expand_path(File.dirname(__FILE__) + "/../views/rails_performance/javascripts/#{file}")}</script>"
-  end
-
-  def format_datetime(e)
-    e.strftime("%Y-%m-%d %H:%M:%S")
-  end
-
-  def active?(section)
-    case section
-    when :dashboard
-      "is-active" if controller_name == "rails_performance" && action_name == "index"
-    when :crashes
-      "is-active" if controller_name == "rails_performance" && action_name == "crashes"
-    when :requests
-      "is-active" if controller_name == "rails_performance" && action_name == "requests"
-    when :recent
-      "is-active" if controller_name == "rails_performance" && action_name == "recent"
-    end
-  end
-end