rails_performance 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb7e94d5d6bb24923c0b13fce9d05c1bec53f2cb07305405852ca3803cee9f25
-  data.tar.gz: 162d27d3c200f077fa378bc6a83a11e13a4e3891b1b9104fde5a62f123cc7fff
+  metadata.gz: eb51d8480c3184c5dba0f1eb8ac6de2947d22dd9afa5aa2434a9ccf26704e71b
+  data.tar.gz: ea76f7ca185e5e531aaa5b936cc22fb60fb9319601b62773c3f6e9b6915287b9
 SHA512:
-  metadata.gz: 1b87d9850d195628f6765cf7ac18223a5ded9705f7d1d0df66ea70cd83f0669f8c24759e3ca499aad1c9d99786095492731cd86f575bbe1571bf99edeaa41a0b
-  data.tar.gz: c601d675b34ae16baa725630e22c7c9473d17851a694ea3ecffdea6ee59bd41eed2a816fcda051cd5baf5d40ced7054591260f0b0bfb6eb340de79fcf2a65895
+  metadata.gz: cf34b64cb3c9d55faeff3820f09f6f91a1a8d59138e4a4c4ad0f172c0c7489f1dd5307ad90a447013b8a317616c0d647c618831ca63ddea7cfbe0758c2002510
+  data.tar.gz: 6aaf94e150feb3aa16e7c18f7c2195c85af4aee035bffef2e9d48f5dd164e1ff45d3c2d5ea32b5395c1a8f23efef524ff4ecb6bc069922d7631e65fb785f93df

data/README.md

@@ -2,7 +2,6 @@
 
 [![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)
 [![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/r/igorkasyanchuk/rails_performance)
 
 A self-hosted tool to monitor the performance of your Ruby on Rails application.
@@ -52,7 +51,7 @@ Create `config/initializers/rails_performance.rb` in your app:
 
 ```ruby
 RailsPerformance.setup do |config|
-  config.redis    = Redis::Namespace.new("#{Rails.env}-rails-performance", redis: Redis.new)
+  config.redis    = Redis::Namespace.new("#{Rails.env}-rails-performance", redis: Redis.new(url: ENV["REDIS_URL"].presence || "redis://127.0.0.1:6379/0"))
   config.duration = 4.hours
 
   config.debug    = false # currently not used>
@@ -81,6 +80,13 @@ RailsPerformance.setup do |config|
   # 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']
+
+  # You can ignore request paths by specifying the beginning of the path.
+  # For example, all routes starting with '/admin' can be ignored:
+  config.ignored_paths = ['/rails/performance', '/admin']
+
   # store custom data for the request
   # config.custom_data_proc = proc do |env|
   #   request = Rack::Request.new(env)
@@ -238,17 +244,9 @@ If "schema" how records are stored i Redis is changed, and this is a breaking ch
 
 ## 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
-- https://github.com/D1ceWard
-- https://github.com/carl-printreleaf
-- https://github.com/langalex
-- https://github.com/olleolleolle
-- https://github.com/desheikh
+https://github.com/igorkasyanchuk/rails_performance/graphs/contributors
+
+## Other
 
 [<img src="https://opensource-heroes.com/svg/embed/igorkasyanchuk/rails_performance"
 />](https://opensource-heroes.com/r/igorkasyanchuk/rails_performance)

data/Rakefile

@@ -1,31 +1,31 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'RailsPerformance'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "RailsPerformance"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/assets/images/download.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6">
+  <path stroke-linecap="round" stroke-linejoin="round" d="M3 16.5v2.25A2.25 2.25 0 0 0 5.25 21h13.5A2.25 2.25 0 0 0 21 18.75V16.5M16.5 12 12 16.5m0 0L7.5 12m4.5 4.5V3" />
+</svg>

data/app/controllers/rails_performance/base_controller.rb

@@ -1,21 +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
+module RailsPerformance
+  class BaseController < ActionController::Base
+    include RailsPerformance::Concerns::CsvExportable
+    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/concerns/csv_exportable.rb

@@ -0,0 +1,29 @@
+require "csv"
+module RailsPerformance
+  module Concerns
+    module CsvExportable
+      extend ActiveSupport::Concern
+
+      def export_to_csv(filename, data)
+        return if data.blank?
+
+        send_data generate_csv(data),
+          filename: "#{filename}_#{Time.zone.today}.csv",
+          type: "text/csv",
+          disposition: "attachment"
+      end
+
+      private
+
+      def generate_csv(data)
+        CSV.generate(headers: true) do |csv|
+          headers = data.first.keys
+          csv << headers.map(&:to_s)
+          data.each do |entry|
+            csv << headers.map { |header| entry[header].to_s }
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/rails_performance/rails_performance_controller.rb

@@ -1,58 +1,84 @@
-require_relative './base_controller.rb'
+require_relative "base_controller"
 
 module RailsPerformance
   class RailsPerformanceController < RailsPerformance::BaseController
-
     protect_from_forgery except: :recent
 
     if RailsPerformance.enabled
       def index
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
-        db                         = @datasource.db
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :requests
+        )
+        db = @datasource.db
 
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
       end
 
       def summary
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
-        db                         = @datasource.db
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :requests
+        )
+        db = @datasource.db
 
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
-        @data                      = RailsPerformance::Reports::BreakdownReport.new(db, title: "Requests").data
-
+        @data = RailsPerformance::Reports::BreakdownReport.new(
+          db, title: "Requests"
+        ).data
         respond_to do |format|
           format.js {}
-          format.any { render plain: "Doesn't open in new window. Wait until full page load." }
+          format.any do
+            render plain: "Doesn't open in new window. Wait until full page load."
+          end
         end
       end
 
       def trace
         @record = RailsPerformance::Models::RequestRecord.find_by(request_id: params[:id])
-        @data   = RailsPerformance::Reports::TraceReport.new(request_id: params[:id]).data
+        @data = RailsPerformance::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." }
+          format.any do
+            render plain: "Doesn't open in new window. Wait until full page load."
+          end
         end
       end
 
       def crashes
-        @datasource   = RailsPerformance::DataSource.new(**prepare_query({status_eq: 500}), type: :requests)
-        db            = @datasource.db
-        @data         = RailsPerformance::Reports::CrashReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query({status_eq: 500}), type: :requests
+        )
+        db = @datasource.db
+        @data = RailsPerformance::Reports::CrashReport.new(db).data
+
+        respond_to do |format|
+          format.html
+          format.csv do
+            export_to_csv "error_report", @data
+          end
+        end
       end
 
       def requests
-        @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
-        db          = @datasource.db
-        @data       = RailsPerformance::Reports::RequestsReport.new(db, group: :controller_action_format, sort: :count).data
+        @datasource = RailsPerformance::DataSource.new(**prepare_query,
+type: :requests)
+        db = @datasource.db
+        @data = RailsPerformance::Reports::RequestsReport.new(db,
+          group: :controller_action_format, sort: :count).data
+        respond_to do |format|
+          format.html
+          format.csv do
+            export_to_csv "requests_report", @data
+          end
+        end
       end
 
       def recent
-        @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
-        db          = @datasource.db
-        @data       = RailsPerformance::Reports::RecentRequestsReport.new(db).data(params[:from_timei])
+        @datasource = RailsPerformance::DataSource.new(**prepare_query,
+type: :requests)
+        db = @datasource.db
+        @data = RailsPerformance::Reports::RecentRequestsReport.new(db).data(params[:from_timei])
 
         # example
         # :controller=>"HomeController",
@@ -73,54 +99,75 @@ module RailsPerformance
         # "email"=>nil,
         # "user_agent"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36"}]
 
-        respond_to do |page|
-          page.html
-          page.js
+        respond_to do |format|
+          format.html
+          format.js
+          format.csv do
+            export_to_csv "recent_requests_report", @data
+          end
         end
       end
 
       def slow
-        @datasource = RailsPerformance::DataSource.new(**prepare_query, type: :requests)
-        db          = @datasource.db
-        @data       = RailsPerformance::Reports::SlowRequestsReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(**prepare_query,
+type: :requests)
+        db = @datasource.db
+        @data = RailsPerformance::Reports::SlowRequestsReport.new(db).data
+
+        respond_to do |format|
+          format.html
+          format.csv do
+            export_to_csv "slow_requests_report", @data
+          end
+        end
       end
 
       def sidekiq
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :sidekiq)
-        db                         = @datasource.db
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :sidekiq
+        )
+        db = @datasource.db
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
-        @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
+        @recent_report_data = RailsPerformance::Reports::RecentRequestsReport.new(db).data
       end
 
       def delayed_job
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :delayed_job)
-        db                         = @datasource.db
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :delayed_job
+        )
+        db = @datasource.db
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
-        @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
+        @recent_report_data = RailsPerformance::Reports::RecentRequestsReport.new(db).data
       end
 
       def custom
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :custom)
-        db                         = @datasource.db
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :custom
+        )
+        db = @datasource.db
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
         @response_time_report_data = RailsPerformance::Reports::ResponseTimeReport.new(db).data
-        @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
+        @recent_report_data = RailsPerformance::Reports::RecentRequestsReport.new(db).data
       end
 
       def grape
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :grape)
-        db                         = @datasource.db
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
-        @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :grape
+        )
+        db = @datasource.db
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @recent_report_data = RailsPerformance::Reports::RecentRequestsReport.new(db).data
       end
 
       def rake
-        @datasource                = RailsPerformance::DataSource.new(**prepare_query, type: :rake)
-        db                         = @datasource.db
-        @throughput_report_data    = RailsPerformance::Reports::ThroughputReport.new(db).data
-        @recent_report_data        = RailsPerformance::Reports::RecentRequestsReport.new(db).data
+        @datasource = RailsPerformance::DataSource.new(
+          **prepare_query, type: :rake
+        )
+        db = @datasource.db
+        @throughput_report_data = RailsPerformance::Reports::ThroughputReport.new(db).data
+        @recent_report_data = RailsPerformance::Reports::RecentRequestsReport.new(db).data
       end
 
       private
@@ -129,6 +176,5 @@ module RailsPerformance
         RailsPerformance::Rails::QueryBuilder.compose_from(query)
       end
     end
-
   end
 end