rails_performance 0.9.4 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6532a46e577225137d7fbd9baae88b245157d75c4091690f73209886b6c6c15
-  data.tar.gz: 7946da511a5e589a854af1bef20c642de207004c4f860353657c92c895e2c485
+  metadata.gz: a6efdeeeb71789d08c284f21165138c13bdcb094cd0d48fcbaad521a946fec6f
+  data.tar.gz: 81b265d6bf3555fb2868504983ec3b01cf1efe9d99b4b4e74b08533d08ff2023
 SHA512:
-  metadata.gz: 7c5a8d54bb4670dfe84cd720410dc30cab1facadcbac0f6457a41c2954d8ab66726728ebff333f1778ebdbcb3525806b01594619a0bf054a9e9c8eb3dfd9ab72
-  data.tar.gz: b7c6cda16e208941173e3aeaa7d3f5cc282a79d9b4077645364e341b0b30ad169133db769744abb24eefb34b7357145492047cf4a7041b505544df758783836e
+  metadata.gz: 1f59e689a2b57a486b857cc910fccdf84fdc2a7afeee08f691a912aa3affcea5138f1be4f693699c06d9ac0c126c07f4b479e1434242d427581a413818d13fc7
+  data.tar.gz: 591b8b1334668e285fb8a23fdf01498e90b0f5d172378cce8abfd67af2d81f31046ee7520b1d1aad6c125cc61f13ef83f86dd6f2591eeb0fb1a2f89697518349

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.
 
@@ -17,13 +19,13 @@ It allows you to track:
 - 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)
+- 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,6 +51,9 @@ RailsPerformance.setup do |config|
   config.debug    = false # currently not used>
   config.enabled  = true
 
+  # default path where to mount gem
+  config.mount_at = '/rails/performance'
+
   # protect your Performance Dashboard with HTTP BASIC password
   config.http_basic_authentication_enabled   = false
   config.http_basic_authentication_user_name = 'rails_performance'
@@ -62,12 +67,13 @@ end if defined?(RailsPerformance)
 ```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'rails_performance'
 
-# or 
+# or
 
 group :development, :production do
   gem 'rails_performance'
@@ -75,10 +81,19 @@ 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.
@@ -121,10 +136,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
@@ -149,7 +162,15 @@ You are welcome to contribute. I've a big list of TODO.
 ## 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/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/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 if ::Rails::VERSION::MAJOR.to_i >= 5 %>
+    <%= csp_meta_tag if ::Rails::VERSION::STRING.to_f >= 5.2 %>
     <%= render '/rails_performance/stylesheets/stylesheets' %>
     <link rel="shortcut icon" href="/favicon.ico">
   </head>
@@ -29,4 +29,4 @@
     <%= yield :on_load %>
 
   </body>
-</html>
+</html>

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

@@ -26,7 +26,7 @@
           <% c, a = groups[0].split("#") %>
           <tr>
             <td><%= link_to groups[0],  rails_performance.rails_performance_summary_path({controller_eq: c, action_eq: a}), remote: true %></td>
-            <td><%= link_to groups[1]&.upcase,  rails_performance.rails_performance_summary_path({controller_eq: c, action_eq: a, format_eq: groups[1]}), remote: true %></td>
+            <td><%= link_to groups[1].try(:upcase),  rails_performance.rails_performance_summary_path({controller_eq: c, action_eq: a, format_eq: groups[1]}), remote: true %></td>
             <td><%= e[:count] %></td>
             <td class="nowrap"><%= ms e[:duration_average] %></td>
             <td class="nowrap"><%= ms e[:view_runtime_average] %></td>

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

@@ -1,5 +1,5 @@
 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, ' rpm', 'RPM');

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/config/routes.rb

@@ -13,9 +13,9 @@ end
 
 Rails.application.routes.draw do
   begin
-    mount RailsPerformance::Engine => '/rails/performance', as: 'rails_performance'
+    mount RailsPerformance::Engine => RailsPerformance.mount_at, as: 'rails_performance'
   rescue ArgumentError
       # already added
-      # this cod exist here because engine not includes routing automatically
+      # this code exist here because engine not includes routing automatically
   end
 end

data/lib/generators/rails_performance/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates initial config for rails_performance gem
+
+Example:
+    bin/rails generate rails_performance:install
+
+    This will create:
+        config/initializers/rails_performance.rb

data/lib/generators/rails_performance/install/install_generator.rb

@@ -0,0 +1,8 @@
+class RailsPerformance::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc "Generates initial config for rails_performance gem"
+
+  def copy_initializer_file
+    copy_file "initializer.rb", "config/initializers/rails_performance.rb"
+  end
+end

data/lib/generators/rails_performance/install/templates/initializer.rb

@@ -0,0 +1,23 @@
+RailsPerformance.setup do |config|
+  config.redis = Redis::Namespace.new("#{Rails.env}-rails-performance", redis: Redis.new)
+  config.duration = 4.hours
+
+  config.debug = false # currently not used>
+  config.enabled = true
+
+  # default path where to mount gem
+  config.mount_at = '/rails/performance'
+
+  # protect your Performance Dashboard with HTTP BASIC password
+  config.http_basic_authentication_enabled = false
+  config.http_basic_authentication_user_name = 'rails_performance'
+  config.http_basic_authentication_password = 'password12'
+
+  # if you need an additional rules to check user permissions
+  config.verify_access_proc = proc { |controller| true }
+  # for example when you have `current_user`
+  # config.verify_access_proc = proc { |controller| controller.current_user && controller.current_user.admin? }
+  
+  # You can ignore endpoints with Rails standard notation controller#action
+  # config.ignored_endpoints = ['HomeController#contact']
+end if defined?(RailsPerformance)

data/lib/rails_performance.rb

@@ -34,6 +34,10 @@ module RailsPerformance
   mattr_accessor :enabled
   @@enabled = true
 
+  # default path where to mount gem
+  mattr_accessor :mount_at
+  @@mount_at = "/rails/performance"
+
   # Enable http basic authentication
   mattr_accessor :http_basic_authentication_enabled
   @@http_basic_authentication_enabled = false
@@ -50,6 +54,12 @@ module RailsPerformance
   mattr_accessor :verify_access_proc
   @@verify_access_proc = proc { |controller| true }
 
+  mattr_reader :ignored_endpoints
+  def RailsPerformance.ignored_endpoints=(endpoints)
+    @@ignored_endpoints = Set.new(endpoints)
+  end
+  @@ignored_endpoints = []
+
   def self.setup
     yield(self)
   end
@@ -58,4 +68,4 @@ end
 
 RP = RailsPerformance
 
-require "rails_performance/engine"
+require "rails_performance/engine"

data/lib/rails_performance/engine.rb

@@ -1,31 +1,22 @@
+require 'action_view/log_subscriber'
 require_relative './rails/middleware.rb'
 require_relative './models/collection.rb'
 require_relative './instrument/metrics_collector.rb'
 
 module RailsPerformance
   class Engine < ::Rails::Engine
+    isolate_namespace RailsPerformance
 
-    if RailsPerformance.try(:enabled) # for rails c
+    initializer "rails_performance.middleware" do |app|
+      next unless RailsPerformance.enabled
 
       if ::Rails::VERSION::MAJOR.to_i >= 5
-        config.app_middleware.insert_after ActionDispatch::Executor, RailsPerformance::Rails::Middleware
+        app.middleware.insert_after ActionDispatch::Executor, RailsPerformance::Rails::Middleware
       else
-        config.app_middleware.insert_after ActionDispatch::Static, RailsPerformance::Rails::Middleware
+        app.middleware.insert_after ActionDispatch::Static, RailsPerformance::Rails::Middleware
       end
 
-      initializer :configure_metrics, after: :initialize_logger do
-        ActiveSupport::Notifications.subscribe(
-          "process_action.action_controller",
-          RailsPerformance::Instrument::MetricsCollector.new
-        )
-
-        config.after_initialize do |app|
-          ActionView::LogSubscriber.send :prepend, RailsPerformance::Extensions::View
-          ActiveRecord::LogSubscriber.send :prepend, RailsPerformance::Extensions::Db
-        end
-      end
-
-      if const_defined?("Sidekiq")
+      if defined?(Sidekiq)
         require_relative './gems/sidekiq.rb'
         Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
@@ -33,8 +24,22 @@ module RailsPerformance
           end
         end
       end
+    end
+
+    initializer :configure_metrics, after: :initialize_logger do
+      next unless RailsPerformance.enabled
 
+      ActiveSupport::Notifications.subscribe(
+        "process_action.action_controller",
+        RailsPerformance::Instrument::MetricsCollector.new
+      )
     end
 
+    config.after_initialize do
+      next unless RailsPerformance.enabled
+
+      ActionView::LogSubscriber.send :prepend, RailsPerformance::Extensions::View
+      ActiveRecord::LogSubscriber.send :prepend, RailsPerformance::Extensions::Db
+    end
   end
 end

data/lib/rails_performance/gems/sidekiq.rb

@@ -22,6 +22,7 @@ module RailsPerformance
         rescue Exception => ex
           data[:status]   = "exception"
           data[:message]  = ex.message
+          raise ex
         ensure
           # store in ms instead of seconds
           data[:duration] = (Time.now - now) * 1000

data/lib/rails_performance/instrument/metrics_collector.rb

@@ -18,7 +18,8 @@ module RailsPerformance
       def call(event_name, started, finished, event_id, payload)
         event = ActiveSupport::Notifications::Event.new(event_name, started, finished, event_id, payload)
 
-        return if event.payload[:path] =~ /^\/rails\/performance/
+        return if %r{#{RailsPerformance.mount_at}}.match? event.payload[:path]
+        return if RailsPerformance.ignored_endpoints.include? "#{event.payload[:controller]}##{event.payload[:action]}"
 
         record = {
           controller: event.payload[:controller],
@@ -38,4 +39,4 @@ module RailsPerformance
       end
     end
   end
-end
+end

data/lib/rails_performance/utils.rb

@@ -60,8 +60,7 @@ module RailsPerformance
     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)
+      RP.redis.set(key, value.to_json, ex: expire.to_i)
     end
 
   end

data/lib/rails_performance/version.rb

@@ -1,3 +1,3 @@
 module RailsPerformance
-  VERSION = '0.9.4'
+  VERSION = '0.9.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_performance
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.9
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  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:
@@ -115,14 +129,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
@@ -130,18 +140,25 @@ files:
 - app/views/rails_performance/javascripts/rails.js
 - app/views/rails_performance/javascripts/stupidtable.min.js
 - app/views/rails_performance/javascripts/table.js
-- app/views/rails_performance/jobs.html.erb
 - 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/generators/rails_performance/install/USAGE
+- lib/generators/rails_performance/install/install_generator.rb
+- lib/generators/rails_performance/install/templates/initializer.rb
 - lib/rails_performance.rb
 - lib/rails_performance/data_source.rb
 - lib/rails_performance/engine.rb

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,88 +0,0 @@
-require_relative './base_controller.rb'
-
-class RailsPerformanceController < BaseController
-
-  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

data/app/helpers/rails_performance_helper.rb

@@ -1,114 +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"
-    when :jobs
-      "is-active" if controller_name == "rails_performance" && action_name == "jobs"
-    end
-  end
-end