rails_performance 1.2.3 → 1.3.1

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

@@ -1,42 +1,56 @@
-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']
-
-  # 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 = ['/admin']
-
-  # store custom data for the request
-  # config.custom_data_proc = proc do |env|
-  #   request = Rack::Request.new(env)
-  #   {
-  #     email: request.env['warden'].user&.email, # if you are using Devise for example
-  #     user_agent: request.env['HTTP_USER_AGENT']
-  #   }
-  # end
-
-  # config home button link
-  config.home_link = '/'
-  config.skipable_rake_tasks = ['webpacker:compile']
-  config.include_rake_tasks = false
-  config.include_custom_events = true
-end if defined?(RailsPerformance)
+if defined?(RailsPerformance)
+  RailsPerformance.setup do |config|
+    # Redis configuration
+    config.redis = Redis::Namespace.new("#{Rails.env}-rails-performance", redis: Redis.new(url: ENV["REDIS_URL"].presence || "redis://127.0.0.1:6379/0"))
+
+    # All data we collect
+    config.duration = 4.hours
+
+    # Recent Requests configuration
+    config.recent_requests_time_window = 60.minutes
+    # confog.recent_requests_limit = nil # numnber of recent requests
+
+    # Slow Requests configuration
+    config.slow_requests_time_window = 4.hours
+    # config.slow_requests_limit = 500 # numnber of slow requests
+    config.slow_requests_threshold = 500 # ms
+
+    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']
+
+    # 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']
+
+    # store custom data for the request
+    # config.custom_data_proc = proc do |env|
+    #   request = Rack::Request.new(env)
+    #   {
+    #     email: request.env['warden'].user&.email, # if you are using Devise for example
+    #     user_agent: request.env['HTTP_USER_AGENT']
+    #   }
+    # end
+
+    # config home button link
+    config.home_link = "/"
+    config.skipable_rake_tasks = ["webpacker:compile"]
+    config.include_rake_tasks = false
+    config.include_custom_events = true
+  end
+end

data/lib/rails_performance/data_source.rb

@@ -1,121 +1,120 @@
-module RailsPerformance
-  class DataSource
-    KLASSES = {
-      requests: RailsPerformance::Models::RequestRecord,
-      sidekiq: RailsPerformance::Models::SidekiqRecord,
-      delayed_job: RailsPerformance::Models::DelayedJobRecord,
-      grape: RailsPerformance::Models::GrapeRecord,
-      rake: RailsPerformance::Models::RakeRecord,
-      custom: RailsPerformance::Models::CustomRecord,
-    }
-
-    attr_reader :q, :klass, :type
-
-    def initialize(q: {}, type:)
-      @type    = type
-      @klass   = KLASSES[type]
-      q[:on] ||= Date.today
-      @q       = q
-    end
-
-    def db
-      result = RailsPerformance::Models::Collection.new
-      (0..(RailsPerformance::Utils.days + 1)).to_a.reverse.each do |e|
-        RailsPerformance::DataSource.new(q: self.q.merge({ on: (Time.current - e.days).to_date }), type: type).add_to(result)
-      end
-      result
-    end
-
-    def default?
-      @q.keys == [:on]
-    end
-
-    def add_to(storage = RailsPerformance::Models::Collection.new)
-      store do |record|
-        storage.add(record)
-      end
-      storage
-    end
-
-    def store
-      keys, values = Utils.fetch_from_redis(query)
-
-      return [] if keys.blank?
-
-      keys.each_with_index do |key, index|
-        yield klass.from_db(key, values[index])
-      end
-    end
-
-    private
-
-    def query
-      case type
-      when :requests
-        "performance|*#{compile_requests_query}*|END|#{RailsPerformance::SCHEMA}"
-      when :sidekiq
-        "sidekiq|*#{compile_sidekiq_query}*|END|#{RailsPerformance::SCHEMA}"
-      when :delayed_job
-        "delayed_job|*#{compile_delayed_job_query}*|END|#{RailsPerformance::SCHEMA}"
-      when :grape
-        "grape|*#{compile_grape_query}*|END|#{RailsPerformance::SCHEMA}"
-      when :rake
-        "rake|*#{compile_rake_query}*|END|#{RailsPerformance::SCHEMA}"
-      when :custom
-        "custom|*#{compile_custom_query}*|END|#{RailsPerformance::SCHEMA}"
-      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 compile_sidekiq_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
-
-    def compile_delayed_job_query
-      str = []
-      str << "datetime|#{q[:on].strftime('%Y%m%d')}*|" if q[:on].present?
-      str << "status|#{q[:status]}|" if q[:status].present?
-      str.join("*")
-    end
-
-    def compile_rake_query
-      str = []
-      str << "datetime|#{q[:on].strftime('%Y%m%d')}*|" if q[:on].present?
-      str << "status|#{q[:status]}|" if q[:status].present?
-      str.join("*")
-    end
-
-    def compile_custom_query
-      str = []
-      str << "datetime|#{q[:on].strftime('%Y%m%d')}*|" if q[:on].present?
-      str << "status|#{q[:status]}|" if q[:status].present?
-      str.join("*")
-    end
-
-    def compile_grape_query
-      str = []
-      str << "datetime|#{q[:on].strftime('%Y%m%d')}*|" if q[:on].present?
-      str << "status|#{q[:status]}|" if q[:status].present?
-      str.join("*")
-    end
-
-  end
-end
+module RailsPerformance
+  class DataSource
+    KLASSES = {
+      requests: RailsPerformance::Models::RequestRecord,
+      sidekiq: RailsPerformance::Models::SidekiqRecord,
+      delayed_job: RailsPerformance::Models::DelayedJobRecord,
+      grape: RailsPerformance::Models::GrapeRecord,
+      rake: RailsPerformance::Models::RakeRecord,
+      custom: RailsPerformance::Models::CustomRecord
+    }
+
+    attr_reader :q, :klass, :type
+
+    def initialize(type:, q: {})
+      @type = type
+      @klass = KLASSES[type]
+      q[:on] ||= Date.today
+      @q = q
+    end
+
+    def db
+      result = RailsPerformance::Models::Collection.new
+      (0..(RailsPerformance::Utils.days + 1)).to_a.reverse_each do |e|
+        RailsPerformance::DataSource.new(q: q.merge({on: (Time.current - e.days).to_date}), type: type).add_to(result)
+      end
+      result
+    end
+
+    def default?
+      @q.keys == [:on]
+    end
+
+    def add_to(storage = RailsPerformance::Models::Collection.new)
+      store do |record|
+        storage.add(record)
+      end
+      storage
+    end
+
+    def store
+      keys, values = Utils.fetch_from_redis(query)
+
+      return [] if keys.blank?
+
+      keys.each_with_index do |key, index|
+        yield klass.from_db(key, values[index])
+      end
+    end
+
+    private
+
+    def query
+      case type
+      when :requests
+        "performance|*#{compile_requests_query}*|END|#{RailsPerformance::SCHEMA}"
+      when :sidekiq
+        "sidekiq|*#{compile_sidekiq_query}*|END|#{RailsPerformance::SCHEMA}"
+      when :delayed_job
+        "delayed_job|*#{compile_delayed_job_query}*|END|#{RailsPerformance::SCHEMA}"
+      when :grape
+        "grape|*#{compile_grape_query}*|END|#{RailsPerformance::SCHEMA}"
+      when :rake
+        "rake|*#{compile_rake_query}*|END|#{RailsPerformance::SCHEMA}"
+      when :custom
+        "custom|*#{compile_custom_query}*|END|#{RailsPerformance::SCHEMA}"
+      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 compile_sidekiq_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
+
+    def compile_delayed_job_query
+      str = []
+      str << "datetime|#{q[:on].strftime("%Y%m%d")}*|" if q[:on].present?
+      str << "status|#{q[:status]}|" if q[:status].present?
+      str.join("*")
+    end
+
+    def compile_rake_query
+      str = []
+      str << "datetime|#{q[:on].strftime("%Y%m%d")}*|" if q[:on].present?
+      str << "status|#{q[:status]}|" if q[:status].present?
+      str.join("*")
+    end
+
+    def compile_custom_query
+      str = []
+      str << "datetime|#{q[:on].strftime("%Y%m%d")}*|" if q[:on].present?
+      str << "status|#{q[:status]}|" if q[:status].present?
+      str.join("*")
+    end
+
+    def compile_grape_query
+      str = []
+      str << "datetime|#{q[:on].strftime("%Y%m%d")}*|" if q[:on].present?
+      str << "status|#{q[:status]}|" if q[:status].present?
+      str.join("*")
+    end
+  end
+end

data/lib/rails_performance/engine.rb

@@ -1,7 +1,7 @@
-require 'action_view/log_subscriber'
-require_relative './rails/middleware.rb'
-require_relative './models/collection.rb'
-require_relative './instrument/metrics_collector.rb'
+require "action_view/log_subscriber"
+require_relative "rails/middleware"
+require_relative "models/collection"
+require_relative "instrument/metrics_collector"
 
 module RailsPerformance
   class Engine < ::Rails::Engine
@@ -23,7 +23,7 @@ module RailsPerformance
       app.middleware.insert_before RailsPerformance::Rails::Middleware, RailsPerformance::Rails::MiddlewareTraceStorerAndCleanup
 
       if defined?(::Sidekiq)
-        require_relative './gems/sidekiq_ext.rb'
+        require_relative "gems/sidekiq_ext"
         Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
             chain.add RailsPerformance::Gems::SidekiqExt
@@ -32,12 +32,12 @@ module RailsPerformance
       end
 
       if defined?(::Grape)
-        require_relative './gems/grape_ext.rb'
+        require_relative "gems/grape_ext"
         RailsPerformance::Gems::GrapeExt.init
       end
 
       if defined?(::Delayed::Job)
-        require_relative './gems/delayed_job_ext.rb'
+        require_relative "gems/delayed_job_ext"
         RailsPerformance::Gems::DelayedJobExt.init
       end
     end
@@ -58,7 +58,7 @@ module RailsPerformance
       ActiveRecord::LogSubscriber.send :prepend, RailsPerformance::Extensions::Db if defined?(ActiveRecord)
 
       if defined?(::Rake::Task) && RailsPerformance.include_rake_tasks
-        require_relative './gems/rake_ext.rb'
+        require_relative "gems/rake_ext"
         RailsPerformance::Gems::RakeExt.init
       end
     end

data/lib/rails_performance/extensions/trace.rb

@@ -1,33 +1,32 @@
-module RailsPerformance
-  module Extensions
-    module View
-
-      def info(&block)
-        CurrentRequest.current.trace({
-          group: :view,
-          message: block.call
-        })
-        super(&block)
-      end
-
-    end
-  end
-end
-
-module RailsPerformance
-  module Extensions
-    module Db
-
-      def sql(event)
-        CurrentRequest.current.trace({
-          group: :db,
-          duration: event.duration.round(2),
-          sql: event.payload[:sql]
-        })
-        super(event)
-      end
-
-    end
-  end
-end
-
+module RailsPerformance
+  module Extensions
+    module View
+      # in env
+      # this works if config.log_level = :info
+      def info(&block)
+        CurrentRequest.current.trace({
+          group: :view,
+          message: block.call
+        })
+        super
+      end
+    end
+  end
+end
+
+module RailsPerformance
+  module Extensions
+    module Db
+      # in env
+      # this works if config.log_level = :debug
+      def sql(event)
+        CurrentRequest.current.trace({
+          group: :db,
+          duration: event.duration.round(2),
+          sql: event.payload[:sql]
+        })
+        super
+      end
+    end
+  end
+end

data/lib/rails_performance/gems/custom_ext.rb

@@ -1,34 +1,31 @@
-module RailsPerformance
-  module Gems
-    module CustomExtension
-      extend self
-
-      def measure(tag_name, namespace_name = nil)
-        return yield unless RailsPerformance.enabled
-        return yield unless RailsPerformance.include_custom_events
-
-        begin
-          now    = Time.current
-          status = 'success'
-          result = yield
-          result
-        rescue Exception => ex
-          status = 'error'
-          raise(ex)
-        ensure
-          RailsPerformance::Models::CustomRecord.new(
-            tag_name: tag_name,
-            namespace_name: namespace_name,
-            status: status,
-            duration: (Time.current - now) * 1000,
-            datetime: now.strftime(RailsPerformance::FORMAT),
-            datetimei: now.to_i,
-          ).save
-
-          result
-        end
-      end
-
-    end
-  end
-end
+module RailsPerformance
+  module Gems
+    module CustomExtension
+      extend self
+
+      def measure(tag_name, namespace_name = nil)
+        return yield unless RailsPerformance.enabled
+        return yield unless RailsPerformance.include_custom_events
+
+        begin
+          now = Time.current
+          status = "success"
+          result = yield
+          result
+        rescue Exception => ex # rubocop:disable Lint/RescueException
+          status = "error"
+          raise(ex)
+        ensure
+          RailsPerformance::Models::CustomRecord.new(
+            tag_name: tag_name,
+            namespace_name: namespace_name,
+            status: status,
+            duration: (Time.current - now) * 1000,
+            datetime: now.strftime(RailsPerformance::FORMAT),
+            datetimei: now.to_i
+          ).save
+        end
+      end
+    end
+  end
+end

data/lib/rails_performance/gems/delayed_job_ext.rb

@@ -1,54 +1,50 @@
-module RailsPerformance
-  module Gems
-    class DelayedJobExt
-
-      class Plugin < ::Delayed::Plugin
-        callbacks do |lifecycle|
-          lifecycle.around(:invoke_job) do |job, *args, &block|
-            begin
-              now = Time.current
-              block.call(job, *args)
-              status = 'success'
-            rescue Exception => error
-              status = 'error'
-              raise error
-            ensure
-              meta_data = RailsPerformance::Gems::DelayedJobExt::Plugin.meta(job.payload_object)
-              record    = RailsPerformance::Models::DelayedJobRecord.new(
-                jid: job.id,
-                duration: (Time.current - now) * 1000,
-                datetime: now.strftime(RailsPerformance::FORMAT),
-                datetimei: now.to_i,
-                source_type: meta_data[0],
-                class_name: meta_data[1],
-                method_name: meta_data[2],
-                status: status
-              )
-              record.save
-            end
-          end
-        end
-
-        # [source_type, class_name, method_name, duration]
-        def self.meta(payload_object)
-          if payload_object.is_a?(::Delayed::PerformableMethod)
-            if payload_object.object.is_a?(Module)
-              [:class_method, payload_object.object.name, payload_object.method_name.to_s]
-            else
-              [:instance_method, payload_object.object.class.name, payload_object.method_name.to_s]
-            end
-          else
-            [:instance_method, payload_object.class.name, "perform"]
-          end
-        rescue
-          [:unknown, :unknown, :unknown]
-        end
-      end
-
-      def self.init
-        ::Delayed::Worker.plugins += [::RailsPerformance::Gems::DelayedJobExt::Plugin]
-      end
-
-    end
-  end
-end
+module RailsPerformance
+  module Gems
+    class DelayedJobExt
+      class Plugin < ::Delayed::Plugin
+        callbacks do |lifecycle|
+          lifecycle.around(:invoke_job) do |job, *args, &block|
+            now = Time.current
+            block.call(job, *args)
+            status = "success"
+          rescue Exception => error # rubocop:disable Lint/RescueException
+            status = "error"
+            raise error
+          ensure
+            meta_data = RailsPerformance::Gems::DelayedJobExt::Plugin.meta(job.payload_object)
+            record = RailsPerformance::Models::DelayedJobRecord.new(
+              jid: job.id,
+              duration: (Time.current - now) * 1000,
+              datetime: now.strftime(RailsPerformance::FORMAT),
+              datetimei: now.to_i,
+              source_type: meta_data[0],
+              class_name: meta_data[1],
+              method_name: meta_data[2],
+              status: status
+            )
+            record.save
+          end
+        end
+
+        # [source_type, class_name, method_name, duration]
+        def self.meta(payload_object)
+          if payload_object.is_a?(::Delayed::PerformableMethod)
+            if payload_object.object.is_a?(Module)
+              [:class_method, payload_object.object.name, payload_object.method_name.to_s]
+            else
+              [:instance_method, payload_object.object.class.name, payload_object.method_name.to_s]
+            end
+          else
+            [:instance_method, payload_object.class.name, "perform"]
+          end
+        rescue
+          [:unknown, :unknown, :unknown]
+        end
+      end
+
+      def self.init
+        ::Delayed::Worker.plugins += [::RailsPerformance::Gems::DelayedJobExt::Plugin]
+      end
+    end
+  end
+end