inner_performance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b0f7620adf9d09e4c9a58a007fdf054d5a89760ad099e8d699bc3deff12f00d
+  data.tar.gz: 271e25fe6de8f021a05ac78ac295cbcf3b8c69ebde3b798151526143776eed86
+SHA512:
+  metadata.gz: 1cdcbbef0725de7a886b2c10ad2a392d0bfe77c9591bdebc4d26219bba832caf25694a7a79d4ef9476748db9e576e48214db5edf896e0688906e6f36bedb4e2d
+  data.tar.gz: 3321bac2c9273787a3b3d0a3c6ed84e8a0a702be9cb180fada9bd5188eca7412ca5e2275702e20b043da06699a945ea8da82cc296be8145521bc4bb036b1b212

data/README.md

@@ -0,0 +1,80 @@
+# InnerPerformance
+Database-backed modest performance monitoring tool for your Rails app.
+
+<img width="1188" alt="image" src="https://github.com/user-attachments/assets/cb659c76-8139-4ee0-b683-d6acef227dc6">
+
+## Installation
+Add `inner_performance` gem to your bundle
+
+```ruby
+$ bundle add inner_performance
+```
+
+Install migrations
+
+```ruby
+$ rails inner_performance:install:migrations
+$ rails db:migrate
+```
+
+Mount UI in `routes.rb` (don't forget to protect it!)
+
+```ruby
+mount InnerPerformance::Engine, at: '/inner_performance'
+```
+
+## Configuration
+
+inner_performance comes with some good defaults but in order to customize
+them, you have a following options available:
+
+```ruby
+InnerPerformance.configure do |config|
+  config.sample_rates = {
+    # 2% of all the requests will be stored and analyzed. I would
+    # recommend keeping it low because otherwise your database will
+    # get full of events quite fast. It will also probably impact
+    # your app's performance. As an example: In a Spree shop with
+    # approx. 170 requests per minute, keeping it at default 2%
+    # provides me more than enough data to analyze and locate the
+    # bottlenecks.
+    'process_action.action_controller' => 2,
+
+    # 100% of all the jobs will be stored and analyzed.
+    'perform.active_job' => 100
+  }
+
+  # For how long events should be stored. All the ones that exceeds
+  # this limit will be cleared out by InnerPerformance::CleanupJob.
+  config.events_retention = 1.week
+
+  # Used mostly by UI. Tells the UI what's the middle range when it
+  # comes to event duration. For the example below, all the durations
+  # between 0 and 200ms will be considered fast, all the ones between
+  # 200ms and 999ms will be considered medium and all above 999ms will
+  # be considered slow.
+  config.medium_duration_range = [200, 999]
+
+  # Rules for ignoring an event. There are two rules applied by default:
+  # * sample_rates - operates on configured sample rate and drops events
+  #   which do not got lucky when drawing a random number
+  # * InnerPerformance job namespace - we don't want to save events for
+  #   the job that saves the events because that leeds to infinite loop.
+  #   Better not remove this rule as it will lead to stack overflow.
+  config.ignore_rules.push(
+    proc { |event| event.is_a?(ActiveSupport::Notifications::Event) }
+  )
+end
+```
+
+`InnerPerformance` will produce an infinite amount of event records so in order
+to clean them up, you should periodically run
+`InnerPerformance::CleanupJob.perform_later`.
+
+# Alternatives
+
+* [rails_performance](https://github.com/igorkasyanchuk/rails_performance) - much better but depends on Redis
+
+## License
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/inner_performance_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/inner_performance .css

data/app/assets/stylesheets/inner_performance/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/inner_performance/application_controller.rb

@@ -0,0 +1,4 @@
+module InnerPerformance
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/inner_performance/dashboard_controller.rb

@@ -0,0 +1,17 @@
+module InnerPerformance
+  class DashboardController < ApplicationController
+    def index
+      @q = InnerPerformance::Event.all.ransack(params[:q])
+      @q.sorts = "created_at desc" if @q.sorts.empty?
+      @recent_events = @q.result.limit(100)
+
+      @average_req_duration = InnerPerformance::Events::ProcessActionActionController.all.average(:duration)
+      @average_job_duration = InnerPerformance::Events::PerformActiveJob.average(:duration) || 0
+      @biggest_events = \
+        InnerPerformance::Event.select('SUM(duration) as duration, name, COUNT(*) as count, AVG(duration) as avg_duration')
+                               .group(:name)
+                               .order('duration DESC')
+                               .limit(10)
+    end
+  end
+end

data/app/controllers/inner_performance/events_controller.rb

@@ -0,0 +1,12 @@
+module InnerPerformance
+  class EventsController < ApplicationController
+    include Pagy::Backend
+    include Pagy::Frontend
+
+    def index
+      @q = InnerPerformance::Event.all.ransack(params[:q])
+      @q.sorts = "created_at desc" if @q.sorts.empty?
+      @pagy, @events = pagy(@q.result)
+    end
+  end
+end

data/app/helpers/inner_performance/application_helper.rb

@@ -0,0 +1,15 @@
+module InnerPerformance
+  module ApplicationHelper
+    # Based on https://stackoverflow.com/a/45428183/552936 and
+    # https://datadome.co/learning-center/how-to-reduce-server-response-time/
+    def row_class_from_duration(duration)
+      medium_duration_range = InnerPerformance.configuration.medium_duration_range
+
+      if duration.between?(medium_duration_range[0], medium_duration_range[1])
+        'text-warning'
+      elsif duration >= medium_duration_range[1]
+        'text-danger'
+      end
+    end
+  end
+end

data/app/jobs/inner_performance/application_job.rb

@@ -0,0 +1,4 @@
+module InnerPerformance
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/inner_performance/cleanup_job.rb

@@ -0,0 +1,7 @@
+module InnerPerformance
+  class CleanupJob < ApplicationJob
+    def perform
+      InnerPerformance::Event.where('created_at >= ?', InnerPerformance.configuration.events_retention)
+    end
+  end
+end

data/app/jobs/inner_performance/save_event_job.rb

@@ -0,0 +1,15 @@
+module InnerPerformance
+  class SaveEventJob < ApplicationJob
+    def perform(type:, created_at:, event:, name:, duration:, db_runtime:, properties: {})
+      InnerPerformance::Event.create(
+        type: type,
+        created_at: created_at,
+        event: event,
+        name: name,
+        duration: duration,
+        db_runtime: db_runtime,
+        properties: properties
+      )
+    end
+  end
+end

data/app/mailers/inner_performance/application_mailer.rb

@@ -0,0 +1,6 @@
+module InnerPerformance
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/inner_performance/application_record.rb

@@ -0,0 +1,5 @@
+module InnerPerformance
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/inner_performance/event.rb

@@ -0,0 +1,13 @@
+module InnerPerformance
+  class Event < ApplicationRecord
+    serialize :properties, coder: JSON
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["created_at", "db_runtime", "duration", "event", "format", "id", "name"]
+    end
+
+    def self.ransackable_associations(auth_object = nil)
+      []
+    end
+  end
+end

data/app/models/inner_performance/events/perform_active_job.rb

@@ -0,0 +1,6 @@
+module InnerPerformance
+  module Events
+    class PerformActiveJob < InnerPerformance::Event
+    end
+  end
+end

data/app/models/inner_performance/events/process_action_action_controller.rb

@@ -0,0 +1,6 @@
+module InnerPerformance
+  module Events
+    class ProcessActionActionController < InnerPerformance::Event
+    end
+  end
+end

data/app/views/inner_performance/dashboard/index.html.erb

@@ -0,0 +1,54 @@
+<div class="row mb-4">
+  <div class="col-auto">
+    <div class="card">
+      <div class="card-body">
+        <span class="card-subtitle d-block">Avg. request duration</span>
+        <span class="card-title h1 d-block mb-0"><%= number_to_human(@average_req_duration, units: { unit: 'ms' }) %></span>
+      </div>
+    </div>
+  </div>
+
+  <div class="col-auto">
+    <div class="card">
+      <div class="card-body">
+        <span class="card-subtitle d-block">Avg. job duration</span>
+        <span class="card-title h1 d-block mb-0"><%= number_to_human(@average_job_duration, units: { unit: 'ms' }) %></span>
+      </div>
+    </div>
+  </div>
+</div>
+
+<h4>Most time consuming</h4>
+<table class="table table-hover">
+  <thead>
+    <th>Name</th>
+    <th class="text-end">Count</th>
+    <th class="text-end">Avg. duration</th>
+    <th class="text-end">Total duration</th>
+  </thead>
+  <tbody>
+    <% @biggest_events.each do |event| %>
+      <tr>
+        <td><%= link_to event.name, events_path(q: { name_eq: event.name }) %></td>
+        <td class="text-end"><%= event.count %></td>
+        <td class="text-end <%= row_class_from_duration(event.avg_duration) %>"><%= number_to_human(event.avg_duration, units: { unit: 'ms' }) %></td>
+        <td class="text-end"><%= number_to_human(event.duration, units: { unit: 'ms' }) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<h4 class="mt-4">Recent events</h4>
+<table class="table table-hover">
+  <thead>
+    <th><%= sort_link @q, :name, hide_indicator: true %></th>
+    <th><%= sort_link @q, :duration, hide_indicator: true %></th>
+    <th><%= sort_link @q, :db_runtime, hide_indicator: true %></th>
+    <th class="text-end"><%= sort_link @q, :created_at, hide_indicator: true %></th>
+  </thead>
+  <tbody>
+    <% @recent_events.each do |event| %>
+      <%= render event.becomes(InnerPerformance::Event) %>
+    <% end %>
+  </tbody>
+</table>

data/app/views/inner_performance/events/_event.html.erb

@@ -0,0 +1,8 @@
+<tr>
+  <td><%= link_to event.name, events_path(q: { name_eq: event.name }) %></td>
+  <td class="<%= row_class_from_duration(event.duration) %>">
+    <%= number_to_human(event.duration, units: { unit: 'ms' }) %>
+  </td>
+  <td><%= number_to_human(event.db_runtime, units: { unit: 'ms' }) %></td>
+  <td class="text-end"><%= event.created_at %></td>
+</tr>

data/app/views/inner_performance/events/index.html.erb

@@ -0,0 +1,30 @@
+<%= search_form_for @q, class: 'mb-4' do |f| %>
+  <div class="row align-items-end">
+    <div class="col-10">
+      <%= f.label :name_eq, class: 'form-label' %>
+      <%= f.select :name_eq, options_for_select(InnerPerformance::Event.all.pluck(:name).uniq, f.object.name_eq),
+                             { include_blank: true },
+                             { class: 'form-select' } %>
+    </div>
+
+    <div class="col-2 text-end">
+      <%= f.submit 'Filter', class: 'btn btn-primary' %>
+    </div>
+  </div>
+<% end %>
+
+<table class="table table-hover">
+  <thead>
+    <th><%= sort_link @q, :name, hide_indicator: true %></th>
+    <th><%= sort_link @q, :duration, hide_indicator: true %></th>
+    <th><%= sort_link @q, :db_runtime, hide_indicator: true %></th>
+    <th class="text-end"><%= sort_link @q, :created_at, hide_indicator: true %></th>
+  </thead>
+  <tbody>
+    <% @events.each do |event| %>
+      <%= render event.becomes(InnerPerformance::Event) %>
+    <% end %>
+  </tbody>
+</table>
+
+<%== pagy_nav(@pagy) if @pagy.pages > 1 %>

data/app/views/layouts/inner_performance/application.html.erb

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>☯️ Inner performance</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "inner_performance/application", media: "all" %>
+
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
+</head>
+<body>
+
+<nav class="navbar navbar-expand-lg bg-body-tertiary">
+  <div class="container">
+    <a class="navbar-brand" href="<%= root_path %>">☯️ InnerPerformance</a>
+
+    <div class="ml-auto">
+      <ul class="navbar-nav me-auto mb-2 mb-lg-0">
+        <li class="nav-item">
+          <a class="nav-link" href="<%= events_path %>">Events</a>
+        </li>
+      </ul>
+    </div>
+  </div>
+</nav>
+
+<div class="container pt-4">
+  <%= yield %>
+</div>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+InnerPerformance::Engine.routes.draw do
+  mount InnerPerformance::Engine, at: '/performance'
+
+  resources :events, only: [:index]
+
+  root to: "dashboard#index"
+end

data/db/migrate/20241123121600_create_inner_performance_events.rb

@@ -0,0 +1,13 @@
+class CreateInnerPerformanceEvents < ActiveRecord::Migration[7.1]
+  def change
+    create_table :inner_performance_events, force: :cascade do |t|
+      t.string "event"
+      t.string "name"
+      t.decimal "duration"
+      t.decimal "db_runtime"
+      t.datetime "created_at", null: false
+      t.datetime "updated_at", null: false
+      t.text "properties", default: "{}"
+    end
+  end
+end

data/db/migrate/20241124111458_add_type_to_inner_performance_events.rb

@@ -0,0 +1,5 @@
+class AddTypeToInnerPerformanceEvents < ActiveRecord::Migration[8.0]
+  def change
+    add_column :inner_performance_events, :type, :string
+  end
+end

data/lib/inner_performance/configuration.rb

@@ -0,0 +1,21 @@
+module InnerPerformance
+  class Configuration
+    attr_accessor :sample_rates
+    attr_accessor :events_retention
+    attr_accessor :medium_duration_range
+    attr_accessor :ignore_rules
+
+    def initialize
+      @sample_rates = {
+        'process_action.action_controller' => 2,
+        'perform.active_job' => 100
+      }
+      @events_retention = 1.week
+      @medium_duration_range = [200, 999]
+      @ignore_rules = [
+        proc { |event| rand(100) <= InnerPerformance.configuration.sample_rates[event.name.to_s] },
+        proc { |event| (event.payload[:job]&.class&.name || '').exclude?('InnerPerformance') }
+      ]
+    end
+  end
+end

data/lib/inner_performance/engine.rb

@@ -0,0 +1,13 @@
+module InnerPerformance
+  class Engine < ::Rails::Engine
+    isolate_namespace InnerPerformance
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'inner_performance.install' do
+      InnerPerformance.install!
+    end
+  end
+end

data/lib/inner_performance/version.rb

@@ -0,0 +1,3 @@
+module InnerPerformance
+  VERSION = "0.1.0"
+end

data/lib/inner_performance.rb

@@ -0,0 +1,55 @@
+require "inner_performance/version"
+require "inner_performance/engine"
+require "inner_performance/configuration"
+
+require "ransack"
+require "pagy"
+
+module InnerPerformance
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def install!
+      ActiveSupport::Notifications.subscribe "process_action.action_controller" do |event|
+        if save_event?(event)
+          InnerPerformance::SaveEventJob.perform_later(
+            type: InnerPerformance::Events::ProcessActionActionController.name,
+            created_at: event.payload[:started],
+            event: event.name,
+            name: "#{event.payload[:controller]}##{event.payload[:action]}",
+            duration: event.duration,
+            db_runtime: event.payload[:db_runtime],
+            properties: {
+              view_runtime: event.payload[:view_runtime]
+            }
+          )
+        end
+      end
+
+      ActiveSupport::Notifications.subscribe "perform.active_job" do |event|
+        if save_event?(event)
+          InnerPerformance::SaveEventJob.perform_later(
+            type: InnerPerformance::Events::PerformActiveJob.name,
+            created_at: event.payload[:started],
+            event: event.name,
+            name: event.payload[:job].class.name,
+            duration: event.duration,
+            db_runtime: event.payload[:db_runtime]
+          )
+        end
+      end
+    end
+
+    def save_event?(event)
+      InnerPerformance.configuration.ignore_rules.each_with_object([]) do |rule, arr|
+        arr << rule.call(event)
+      end.all? { |r| r == true }
+    end
+  end
+end

data/lib/tasks/inner_performance_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :inner_performance do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: inner_performance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mbajur
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.5
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.5
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec-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: Database-backed modest performance monitoring tool for your Rails app.
+email:
+- mbajur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/inner_performance_manifest.js
+- app/assets/stylesheets/inner_performance/application.css
+- app/controllers/inner_performance/application_controller.rb
+- app/controllers/inner_performance/dashboard_controller.rb
+- app/controllers/inner_performance/events_controller.rb
+- app/helpers/inner_performance/application_helper.rb
+- app/jobs/inner_performance/application_job.rb
+- app/jobs/inner_performance/cleanup_job.rb
+- app/jobs/inner_performance/save_event_job.rb
+- app/mailers/inner_performance/application_mailer.rb
+- app/models/inner_performance/application_record.rb
+- app/models/inner_performance/event.rb
+- app/models/inner_performance/events/perform_active_job.rb
+- app/models/inner_performance/events/process_action_action_controller.rb
+- app/views/inner_performance/dashboard/index.html.erb
+- app/views/inner_performance/events/_event.html.erb
+- app/views/inner_performance/events/index.html.erb
+- app/views/layouts/inner_performance/application.html.erb
+- config/routes.rb
+- db/migrate/20241123121600_create_inner_performance_events.rb
+- db/migrate/20241124111458_add_type_to_inner_performance_events.rb
+- lib/inner_performance.rb
+- lib/inner_performance/configuration.rb
+- lib/inner_performance/engine.rb
+- lib/inner_performance/version.rb
+- lib/tasks/inner_performance_tasks.rake
+homepage: https://github.com/mbajur
+licenses: []
+metadata:
+  homepage_uri: https://github.com/mbajur
+  source_code_uri: https://github.com/mbajur/inner_performance
+  changelog_uri: https://github.com/mbajur/inner_performance
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Database-backed modest performance monitoring tool for your Rails app.
+test_files: []