rails_performance 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da39e641dcac93526efb39f08e39cff972b5c09c04956b48bf1a30a6988fc24f
-  data.tar.gz: b7b0615aab822ec3742cc43ee74f45b63f1141cb79c246e4bc58c1d1b30b01f0
+  metadata.gz: 437c85fdb48db55caa5da3b41a7b0344d05e27094637cca6f3e8f28f8a15d284
+  data.tar.gz: c4bf8df35605e2cef8de589be79cde872d1a5d5210883140855eb0cf877562d7
 SHA512:
-  metadata.gz: 9ed2ae6cbd21422811df03088d04c036129ccf1bd527cf18964d6c1ff7c3781f7d5ab251041900a264ee89d7f0598b154f8426921f4cd3a5628a18b477580e6c
-  data.tar.gz: 55c864e62678514bf2b9c03cd648dfb8faa454d42061e8f454572c2d0083f367105540e0533c5b9efcd587e08dadabedc583fce842269aaa6b3659f26eb72d56
+  metadata.gz: e54cd14676bde4b86de76a1cc73b482f51dfa9cd7529a658b70bec638e7f0d7eae1af22d60d00e959fbfbd4f3912cce2f6a5c545e8358c949bd0ba0c844e633e
+  data.tar.gz: 7c459ccf377434021fc0d2a4348e95e49ea9ef4e741cc7d768e8f9185121bf7fe36c0cd0b6475aa03fd208cb518f764467880542eb38d994baa8484810e5074f

data/README.md

@@ -3,6 +3,7 @@
 [![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.
 
@@ -70,6 +71,15 @@ RailsPerformance.setup do |config|
   # for example when you have `current_user`
   # config.verify_access_proc = proc { |controller| controller.current_user && controller.current_user.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 = '/'
 

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

@@ -20,4 +20,4 @@
       </tr>
     <% end %>
   </tbody>
-</table>
+</table>

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

@@ -35,7 +35,7 @@
       <div class="navbar-item">
         <div class="buttons">
           <%#= link_to 'Export to CSV', '#', target: '_blank', class: "button is-primary" %>
-          <%= link_to RailsPerformance.home_link, target: '_blank', class: "button is-light home_icon" do %>
+          <%= link_to RailsPerformance.home_link, class: "button is-light home_icon" do %>
             <%= icon('home') %>
           <% end %>
         </div>

data/config/routes.rb

@@ -1,4 +1,6 @@
 RailsPerformance::Engine.routes.draw do
+  devise_for :users
+
   get '/'          => 'rails_performance#index', as: :rails_performance
 
   get '/requests'  => 'rails_performance#requests', as: :rails_performance_requests
@@ -22,4 +24,4 @@ Rails.application.routes.draw do
       # already added
       # this code exist here because engine not includes routing automatically
   end
-end
+end

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

@@ -21,6 +21,15 @@ RailsPerformance.setup do |config|
   # You can ignore endpoints with Rails standard notation controller#action
   # config.ignored_endpoints = ['HomeController#contact']
 
+  # 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 = '/'
 end if defined?(RailsPerformance)

data/lib/rails_performance/models/request_record.rb

@@ -2,7 +2,7 @@ module RailsPerformance
   module Models
     class RequestRecord < BaseRecord
       attr_accessor :controller, :action, :format, :status, :datetime, :datetimei, :method, :path, :request_id, :json
-      attr_accessor :view_runtime, :db_runtime, :duration, :http_referer
+      attr_accessor :view_runtime, :db_runtime, :duration, :http_referer, :custom_data
       attr_accessor :exception, :exception_object
 
       def RequestRecord.find_by(request_id:)
@@ -25,7 +25,7 @@ module RailsPerformance
       # path|/|
       # request_id|454545454545454545|
       # END|1.0.0
-      # = {"view_runtime":null,"db_runtime":0,"duration":27.329741000000002,"http_referer":null,"exception":"ZeroDivisionError divided by 0","backtrace":["/root/projects/rails_performance/test/dummy/app/controllers/account/site_controller.rb:17:in `/'","/root/projects/rails_performance/test/dummy/app/controllers/account/site_controller.rb:17:in `crash'","/usr/local/rvm/gems/ruby-2.6.3/gems/actionpack-6.1.3.1/lib/action_controller/metal/basic_implicit_render.rb:6:in `send_action'"]}
+      # = {"view_runtime":null,"db_runtime":0,"duration":27.329741000000002,"http_referer":null,"custom_data":null,"exception":"ZeroDivisionError divided by 0","backtrace":["/root/projects/rails_performance/test/dummy/app/controllers/account/site_controller.rb:17:in `/'","/root/projects/rails_performance/test/dummy/app/controllers/account/site_controller.rb:17:in `crash'","/usr/local/rvm/gems/ruby-2.6.3/gems/actionpack-6.1.3.1/lib/action_controller/metal/basic_implicit_render.rb:6:in `send_action'"]}
       # value = JSON
       def RequestRecord.from_db(key, value)
         items = key.split("|")
@@ -44,26 +44,27 @@ module RailsPerformance
         )
       end
 
-      def initialize(controller:, action:, format:, status:, datetime:, datetimei:, method:, path:, request_id:, view_runtime: nil, db_runtime: nil, duration: nil, http_referer: nil, exception: nil, exception_object: nil, json: '{}')
-        @controller = controller
-        @action     = action
-        @format     = format
-        @status     = status
-        @datetime   = datetime
-        @datetimei  = datetimei.to_i
-        @method     = method
-        @path       = path
-        @request_id = request_id
+      def initialize(controller:, action:, format:, status:, datetime:, datetimei:, method:, path:, request_id:, view_runtime: nil, db_runtime: nil, duration: nil, http_referer: nil, custom_data: nil, exception: nil, exception_object: nil, json: '{}')
+        @controller   = controller
+        @action       = action
+        @format       = format
+        @status       = status
+        @datetime     = datetime
+        @datetimei    = datetimei.to_i
+        @method       = method
+        @path         = path
+        @request_id   = request_id
 
         @view_runtime = view_runtime
         @db_runtime   = db_runtime
         @duration     = duration
         @http_referer = http_referer
+        @custom_data  = custom_data
 
         @exception        = Array.wrap(exception).compact.join(" ")
         @exception_object = exception_object
 
-        @json       = json
+        @json         = json
       end
 
       def controller_action
@@ -74,6 +75,7 @@ module RailsPerformance
         "#{controller}##{action}|#{format}"
       end
 
+      # show on UI in the right panel
       def record_hash
         {
           controller: self.controller,
@@ -89,8 +91,14 @@ module RailsPerformance
           db_runtime: self.value['db_runtime'],
           view_runtime: self.value['view_runtime'],
           exception: self.value['exception'],
-          backtrace: self.value['backtrace']
-        }
+          backtrace: self.value['backtrace'],
+          http_referer: self.value['http_referer']
+        }.tap do |h|
+          custom_data = JSON.parse(self.value['custom_data']) rescue nil
+          if custom_data.is_a?(Hash)
+            h.merge!(custom_data)
+          end
+        end
       end
 
       def save
@@ -100,6 +108,7 @@ module RailsPerformance
           db_runtime: db_runtime,
           duration: duration,
           http_referer: http_referer,
+          custom_data: custom_data.to_json
         }
         value[:exception] = exception if exception.present?
         value[:backtrace] = exception_object.backtrace.take(3) if exception_object
@@ -108,4 +117,4 @@ module RailsPerformance
 
     end
   end
-end
+end

data/lib/rails_performance/rails/middleware.rb

@@ -53,6 +53,13 @@ module RailsPerformance
               # capture referer from where this page was opened
               record.http_referer = env["HTTP_REFERER"] if record.status == 404
 
+              # we can add custom data, for example Http User-Agent
+              # or even devise current_user
+              if RailsPerformance.custom_data_proc
+                # just to be sure it won't break format how we store in redis
+                record.custom_data = RailsPerformance.custom_data_proc.call(env)
+              end
+
               # store for section "recent requests"
               # store request information (regular rails request)
               record.save
@@ -66,4 +73,4 @@ module RailsPerformance
 
     end
   end
-end
+end

data/lib/rails_performance/version.rb

@@ -1,4 +1,4 @@
 module RailsPerformance
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
   SCHEMA  = '1.0.1'
 end

data/lib/rails_performance.rb

@@ -77,12 +77,16 @@ module RailsPerformance
   mattr_accessor :skipable_rake_tasks
   @@skipable_rake_tasks = []
 
+  # add custom payload to the request
+  mattr_accessor :custom_data_proc
+  @@custom_data_proc = []
+
   def RailsPerformance.setup
     yield(self)
   end
 
   def RailsPerformance.log(message)
-    return
+    return unless RailsPerformance.debug
 
     if ::Rails.logger
       # puts(message)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_performance
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2023-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  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:
@@ -301,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Simple Rails Performance tracker. Alternative to the NewRelic, Datadog or