rails_performance 1.2.2 → 1.3.0

data/app/helpers/rails_performance/rails_performance_helper.rb

@@ -1,156 +1,152 @@
-module RailsPerformance
-  module RailsPerformanceHelper
-
-    def round_it(value, limit = 1)
-      return nil unless value
-      return value if value.is_a?(Integer)
-
-      value.nan? ? nil : value.round(limit)
-    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 mss(value, limit = 1)
-      ms(value.to_f * 1000, limit)
-    end
-
-    def ms(value, limit = 1)
-      result = round_it(value, limit)
-      return '-' if result.nil?
-
-      result && result != 0 ? "#{result} ms" : '< 0 ms'
-    end
-
-    def short_path(path, length: 55)
-      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', title: short_path(e[:path]))
-      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 /error/
-        "tag is-danger"
-      when /^5/
-        "tag is-danger"
-      when /^4/
-        "tag is-warning"
-      when /^3/
-        "tag is-info"
-      when /^2/
-        "tag is-success"
-      when /success/
-        "tag is-success"
-      else
-        nil
-      end
-      content_tag(:span, class: klass) do
-        status
-      end
-    end
-
-    def bot_icon(user_agent)
-      return nil if user_agent.blank?
-
-      browser = Browser.new(user_agent)
-      if browser.bot?
-        content_tag(:span, class: "user-agent-icon", title: browser.bot&.name) do
-          icon("bot")
-        end
-      else
-        content_tag(:span, class: "user-agent-icon user-agent-icon-user", title: "Real User") do
-          icon("user")
-        end
-      end
-    end
-
-    def icon(name)
-      @icons ||= {}
-      @icons[name] ||= begin
-        # https://www.iconfinder.com/iconsets/vivid
-        raw File.read(File.expand_path(File.dirname(__FILE__) +  "/../../assets/images/#{name}.svg"))
-      end
-    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)
-      dt = RailsPerformance::Reports::BaseReport::time_in_app_time_zone(e)
-      I18n.l(dt, format: "%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 :slow
-        "is-active" if controller_name == "rails_performance" && action_name == "slow"
-      when :sidekiq
-        "is-active" if controller_name == "rails_performance" && action_name == "sidekiq"
-      when :delayed_job
-        "is-active" if controller_name == "rails_performance" && action_name == "delayed_job"
-      when :grape
-        "is-active" if controller_name == "rails_performance" && action_name == "grape"
-      when :rake
-        "is-active" if controller_name == "rails_performance" && action_name == "rake"
-      when :custom
-        "is-active" if controller_name == "rails_performance" && action_name == "custom"
-      end
-    end
-  end
-end
+module RailsPerformance
+  module RailsPerformanceHelper
+    def round_it(value, limit = 1)
+      return nil unless value
+      return value if value.is_a?(Integer)
+
+      value.nan? ? nil : value.round(limit)
+    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 mss(value, limit = 1)
+      ms(value.to_f * 1000, limit)
+    end
+
+    def ms(value, limit = 1)
+      result = round_it(value, limit)
+      return "-" if result.nil?
+
+      (result && result != 0) ? "#{result} ms" : "< 0 ms"
+    end
+
+    def short_path(path, length: 55)
+      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", title: short_path(e[:path]))
+      else
+        short_path(e[:path])
+      end
+    end
+
+    def report_name(h)
+      h.except(:on).collect do |k, v|
+        next if v.blank?
+
+        %(
+        <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 /error/
+        "tag is-danger"
+      when /^5/
+        "tag is-danger"
+      when /^4/
+        "tag is-warning"
+      when /^3/
+        "tag is-info"
+      when /^2/
+        "tag is-success"
+      when /success/
+        "tag is-success"
+      end
+      content_tag(:span, class: klass) do
+        status
+      end
+    end
+
+    def bot_icon(user_agent)
+      return nil if user_agent.blank?
+
+      browser = Browser.new(user_agent)
+      if browser.bot?
+        content_tag(:span, class: "user-agent-icon", title: browser.bot&.name) do
+          icon("bot")
+        end
+      else
+        content_tag(:span, class: "user-agent-icon user-agent-icon-user", title: "Real User") do
+          icon("user")
+        end
+      end
+    end
+
+    def icon(name)
+      @icons ||= {}
+
+      # https://www.iconfinder.com/iconsets/vivid
+      @icons[name] ||= 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)
+      dt = RailsPerformance::Reports::BaseReport.time_in_app_time_zone(e)
+      I18n.l(dt, format: "%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 :slow
+        "is-active" if controller_name == "rails_performance" && action_name == "slow"
+      when :sidekiq
+        "is-active" if controller_name == "rails_performance" && action_name == "sidekiq"
+      when :delayed_job
+        "is-active" if controller_name == "rails_performance" && action_name == "delayed_job"
+      when :grape
+        "is-active" if controller_name == "rails_performance" && action_name == "grape"
+      when :rake
+        "is-active" if controller_name == "rails_performance" && action_name == "rake"
+      when :custom
+        "is-active" if controller_name == "rails_performance" && action_name == "custom"
+      end
+    end
+  end
+end

data/app/views/rails_performance/javascripts/app.js

@@ -22,7 +22,7 @@ function showTIRChart(div, data, addon, name) {
           },
           formatter: function() {
               if (this.y == 0) {
-                return 'n/a';
+                return false; 
               }
             return this.y + addon;
           }
@@ -107,7 +107,7 @@ function showRTChart(div, data) {
           },
           formatter: function() {
               if (this.y == 0) {
-                return 'n/a';
+                return false;
               }
               return this.y + ' ms';
           }

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

@@ -0,0 +1,3 @@
+<%= link_to request.original_url + '.csv', class: 'icon download_icon' do %>
+  <%= icon('download') %>
+<% end %>

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

@@ -1,6 +1,13 @@
 <div class="card">
   <div class="card-content">
-    <h2 class="subtitle">Crash Report</h2>
+    <div class="columns is-vcentered">
+      <div class="column">
+      <h2 class="subtitle">Crash Report</h2>
+      </div>
+      <div class="column is-narrow">
+        <%= render "export" %>
+      </div>
+    </div>
     <table class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>

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

@@ -6,14 +6,16 @@
       <div class="column">
         <h2 class="subtitle">Recent Requests (last <%= RailsPerformance.recent_requests_time_window / 60 %> minutes)<h2>
       </div>
-      <div class="column right-text is-size-5 has-text-right">
-        <label id="autoupdate_label">
-          <input id="autoupdate" type="checkbox"/>
-          Auto-update
-        </label>
+      <div class="column is-narrow">
+        <%= render "export" %> 
       </div>
     </div>
-
+    <div class="has-text-right">
+      <label id="autoupdate_label">
+        <input id="autoupdate" type="checkbox" />
+        Auto-update
+      </label>
+    </div>
     <table id="recent" class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>

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

@@ -1,6 +1,13 @@
 <div class="card">
   <div class="card-content">
-    <h2 class="subtitle">Requests (path, total number, average response time)</h2>
+    <div class="columns is-vcentered">
+      <div class="column">
+        <h2 class="subtitle">Requests (path, total number, average response time)</h2>
+      </div>
+      <div class="column is-narrow">
+        <%= render "export" %> 
+      </div>
+    </div>
     <table class="table is-fullwidth is-hoverable is-narrow">
       <thead>
         <tr>

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

@@ -4,7 +4,10 @@
   <div class="card-content">
     <div class="columns">
       <div class="column">
-        <h2 class="subtitle">Slow Requests (last <%= RailsPerformance.slow_requests_time_window / 60 %> minutes + slower then <%= RailsPerformance.slow_requests_threshold %>ms)<h2>
+        <h2 class="subtitle">Slow Requests (last <%= RailsPerformance.slow_requests_time_window / 60 %> minutes + slower than <%= RailsPerformance.slow_requests_threshold %>ms)<h2>
+      </div>
+      <div class="column is-narrow">
+        <%= render "export" %> 
       </div>
     </div>
 

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

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

data/app/views/rails_performance/stylesheets/style.css

@@ -56,6 +56,12 @@
   height: 24px;
 }
 
+.download_icon svg {
+  width: 24px;
+  height: 24px;
+  color: red;
+}
+
 .user-agent-icon svg {
   width: 12px;
   height: 12px;

data/config/routes.rb

@@ -1,26 +1,24 @@
 RailsPerformance::Engine.routes.draw do
-  get '/'          => 'rails_performance#index', as: :rails_performance
+  get "/" => "rails_performance#index", :as => :rails_performance
 
-  get '/requests'  => 'rails_performance#requests', as: :rails_performance_requests
-  get '/crashes'   => 'rails_performance#crashes', as: :rails_performance_crashes
-  get '/recent'    => 'rails_performance#recent', as: :rails_performance_recent
-  get '/slow'      => 'rails_performance#slow', as: :rails_performance_slow
+  get "/requests" => "rails_performance#requests", :as => :rails_performance_requests
+  get "/crashes" => "rails_performance#crashes", :as => :rails_performance_crashes
+  get "/recent" => "rails_performance#recent", :as => :rails_performance_recent
+  get "/slow" => "rails_performance#slow", :as => :rails_performance_slow
 
-  get '/trace/:id'  => 'rails_performance#trace', as: :rails_performance_trace
-  get '/summary'    => 'rails_performance#summary', as: :rails_performance_summary
+  get "/trace/:id" => "rails_performance#trace", :as => :rails_performance_trace
+  get "/summary" => "rails_performance#summary", :as => :rails_performance_summary
 
-  get '/sidekiq'    => 'rails_performance#sidekiq', as: :rails_performance_sidekiq
-  get '/delayed_job'=> 'rails_performance#delayed_job', as: :rails_performance_delayed_job
-  get '/grape'      => 'rails_performance#grape', as: :rails_performance_grape
-  get '/rake'       => 'rails_performance#rake', as: :rails_performance_rake
-  get '/custom'     => 'rails_performance#custom', as: :rails_performance_custom
+  get "/sidekiq" => "rails_performance#sidekiq", :as => :rails_performance_sidekiq
+  get "/delayed_job" => "rails_performance#delayed_job", :as => :rails_performance_delayed_job
+  get "/grape" => "rails_performance#grape", :as => :rails_performance_grape
+  get "/rake" => "rails_performance#rake", :as => :rails_performance_rake
+  get "/custom" => "rails_performance#custom", :as => :rails_performance_custom
 end
 
 Rails.application.routes.draw do
-  begin
-    mount RailsPerformance::Engine => RailsPerformance.mount_at, as: 'rails_performance'
-  rescue ArgumentError
-      # already added
-      # this code exist here because engine not includes routing automatically
-  end
+  mount RailsPerformance::Engine => RailsPerformance.mount_at, :as => "rails_performance"
+rescue ArgumentError
+  # already added
+  # this code exist here because engine not includes routing automatically
 end

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

@@ -1,5 +1,5 @@
 class RailsPerformance::InstallGenerator < Rails::Generators::Base
-  source_root File.expand_path('templates', __dir__)
+  source_root File.expand_path("templates", __dir__)
   desc "Generates initial config for rails_performance gem"
 
   def copy_initializer_file

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

@@ -1,38 +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']
-
-  # 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