rails_performance 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecd06e180b5b5619c81180f22a852a74fe0a69fab43bb04b3d3d29b18b2c72fd
-  data.tar.gz: 48c8335202f70441f1f252df55e8a8c5bebd750c491539d3a0f295c19a042e77
+  metadata.gz: 2fd36bc442cc4c70eb58e007e07df73a44bf7ce745de9d4e50b94d8f41bfa050
+  data.tar.gz: 590694fef0143bf1080ef4eb224f6c6beb657728c53d0a13c825b8012fa7ca04
 SHA512:
-  metadata.gz: 256ca7fcb9d7dca9b33f4ee29b71644b112bdb29329b863a0aa04697ec528e96196660ded8eea3efafd8c473a23668140bb682368c0add0ec3ed428b09b4139f
-  data.tar.gz: fb861466ac7f8b0a19eff40b9432856470537abd5c9f005585357f423ede2d6214beef2815ef9876bd881db0baa666eb790c559a3c558292432636381ef86a1a
+  metadata.gz: b49fda7d3eb4081a963c87417b1033a4a204f52b10bdb544a8984ab7367d77ebe38421e2447c68e45a4110d653ee27dd772a8ec5e6ac5ea80e7954e3210295d6
+  data.tar.gz: a649c5987684c72c3b6ded1847478a3bf4ace015054a4e2cbee293f33aaee3f3a442acefbcc59eeb9e9ae68cfd0ca95032c7d353ec38978bee664c4795c2baae

data/README.md

@@ -1,6 +1,6 @@
 # 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)
 
 A self-hosted tool to monitor the performance of your Ruby on Rails application.
@@ -24,7 +24,7 @@ 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.
 
@@ -66,6 +66,7 @@ end if defined?(RailsPerformance)
 ```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -79,10 +80,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.
@@ -127,7 +137,6 @@ The idea of this gem grew from curriosity how many RPM my app receiving per day.
 
 - 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?
@@ -156,6 +165,8 @@ You are welcome to contribute. I've a big list of TODO.
 - https://github.com/alagos
 - https://github.com/klondaiker
 - https://github.com/jules2689
+- https://github.com/PedroAugustoRamalhoDuarte
+- https://github.com/haffla
 
 ## License
 

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

@@ -54,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
@@ -62,4 +68,4 @@ end
 
 RP = RailsPerformance
 
-require "rails_performance/engine"
+require "rails_performance/engine"

data/lib/rails_performance/engine.rb

@@ -1,3 +1,4 @@
+require 'action_view/log_subscriber'
 require_relative './rails/middleware.rb'
 require_relative './models/collection.rb'
 require_relative './instrument/metrics_collector.rb'

data/lib/rails_performance/instrument/metrics_collector.rb

@@ -18,8 +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)
 
-        mount_url = RailsPerformance.mount_at || "/rails/performance/"
-        return if event.payload[:path] =~ /^#{Regexp.escape(mount_url)}/ 
+        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],

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.7'
+  VERSION = '0.9.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_performance
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -142,6 +142,9 @@ files:
 - app/views/rails_performance/stylesheets/panel.css
 - app/views/rails_performance/stylesheets/style.css
 - 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
@@ -184,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple Rails Performance tracker. Alternative to the NewRelic, Datadog or