inner_performance 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6fb86a53413ef53d7256b526e4b75dd7d910473fc8d047b97976285ad82a91f
-  data.tar.gz: 60147dd06fb7069a809c402e3cd9aeebf18df7d4921d1df52f0733159390ec22
+  metadata.gz: 761ab8ec52713467243aa93a5b2f82804f4d70f5fcbe8a571f1873e38ad289af
+  data.tar.gz: b05a53a01997aee49f40e0bfc488d34d5257e2edb9c26fac038461b13a811190
 SHA512:
-  metadata.gz: 71ffe8d954c92f5736d9a57d161657dbca3cbbea5303fb42f31a5f007af962096f8a9709a190eb21bb10cfd78004ff628f7548317fc90505971d2f0893a3477b
-  data.tar.gz: cc4a9176b3d7c787f0bd9636c294ffc554471fd3466c1a10c92eb267dd67d273152df7e00fbdb21eee520157b7cdf11a40fa1738b9762eeed8d551fc2648e293
+  metadata.gz: 6754adf03e924da656a5b0c44b492071a8f28772919b989ca5581ea21d82530485f0a9edfc71e8c6609002fcc881ee07670ce5b5bd42adaa04e14b2a99683649
+  data.tar.gz: f6805d89fa9b98230567799fd3db2e4217c99fd36d535938cbd5390908a5f1cb0bca16f001663e734d42d3a733a4d266b161cc0094960b2f60cdb41a7fdb8abc

data/README.md

@@ -17,6 +17,11 @@ $ rails inner_performance:install:migrations
 $ rails db:migrate
 ```
 
+Add inner_performance to `app/assets/config/manifest.js`
+```javascript
+//= link inner_performance/application.css
+```
+
 Mount UI in `routes.rb` (don't forget to protect it!)
 
 ```ruby
@@ -38,7 +43,7 @@ InnerPerformance.configure do |config|
     # 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,
+    'process_action.action_controller' => (Rails.env.production? ? 2 : 100),
 
     # 100% of all the jobs will be stored and analyzed.
     'perform.active_job' => 100
@@ -67,9 +72,12 @@ InnerPerformance.configure do |config|
 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`.
+## Regular Housekeeping
+To ensure optimal performance and avoid data bloat, remember to schedule the cleanup job:
+
+```ruby
+InnerPerformance::CleanupJob.perform_later
+```
 
 # Alternatives
 

data/Rakefile

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

data/app/controllers/inner_performance/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class ApplicationController < ActionController::Base
   end

data/app/controllers/inner_performance/dashboard_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class DashboardController < ApplicationController
     def index

data/app/controllers/inner_performance/events_controller.rb

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

data/app/helpers/inner_performance/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   module ApplicationHelper
     include Pagy::Frontend

data/app/jobs/inner_performance/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class ApplicationJob < ActiveJob::Base
   end

data/app/jobs/inner_performance/cleanup_job.rb

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

data/app/jobs/inner_performance/save_event_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class SaveEventJob < ApplicationJob
     def perform(type:, created_at:, event:, name:, duration:, db_runtime:, properties: {})

data/app/mailers/inner_performance/application_mailer.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
+    default from: 'from@example.com'
+    layout 'mailer'
   end
 end

data/app/models/inner_performance/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/app/models/inner_performance/event.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 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"]
+    def self.ransackable_attributes(_auth_object = nil)
+      %w[created_at db_runtime duration event format id name]
     end
 
-    def self.ransackable_associations(auth_object = nil)
+    def self.ransackable_associations(_auth_object = nil)
       []
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   module Events
     class PerformActiveJob < InnerPerformance::Event

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   module Events
     class ProcessActionActionController < InnerPerformance::Event

data/config/routes.rb

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

data/db/migrate/20241123121600_create_inner_performance_events.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 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: "{}"
+      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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddTypeToInnerPerformanceEvents < ActiveRecord::Migration[7.1]
   def change
     add_column :inner_performance_events, :type, :string

data/lib/inner_performance/configuration.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class Configuration
-    attr_accessor :sample_rates
-    attr_accessor :events_retention
-    attr_accessor :medium_duration_range
-    attr_accessor :ignore_rules
+    attr_accessor :sample_rates, :events_retention, :medium_duration_range, :ignore_rules
 
     def initialize
       @sample_rates = {

data/lib/inner_performance/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
   class Engine < ::Rails::Engine
     isolate_namespace InnerPerformance

data/lib/inner_performance/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InnerPerformance
-  VERSION = "0.1.2"
+  VERSION = '0.1.4'
 end

data/lib/inner_performance.rb

@@ -1,9 +1,11 @@
-require "inner_performance/version"
-require "inner_performance/engine"
-require "inner_performance/configuration"
+# frozen_string_literal: true
 
-require "ransack"
-require "pagy"
+require 'inner_performance/version'
+require 'inner_performance/engine'
+require 'inner_performance/configuration'
+
+require 'ransack'
+require 'pagy'
 
 module InnerPerformance
   class << self
@@ -16,7 +18,7 @@ module InnerPerformance
     end
 
     def install!
-      ActiveSupport::Notifications.subscribe "process_action.action_controller" do |event|
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |event|
         if save_event?(event)
           InnerPerformance::SaveEventJob.perform_later(
             type: InnerPerformance::Events::ProcessActionActionController.name,
@@ -32,7 +34,7 @@ module InnerPerformance
         end
       end
 
-      ActiveSupport::Notifications.subscribe "perform.active_job" do |event|
+      ActiveSupport::Notifications.subscribe 'perform.active_job' do |event|
         if save_event?(event)
           InnerPerformance::SaveEventJob.perform_later(
             type: InnerPerformance::Events::PerformActiveJob.name,
@@ -46,12 +48,11 @@ module InnerPerformance
       end
     end
 
-    # Iterate throug the ignored_rules array and return false on first rule
-    # that returns `true`
+    # Check if all the ignore_rules returns false. If so, save the event.
     def save_event?(event)
-      InnerPerformance.configuration.ignore_rules.each_with_object([]) do |rule, arr|
-        arr << rule.call(event)
-      end.find { |r| r == true }
+      InnerPerformance.configuration.ignore_rules.find do |rule|
+        rule.call(event) == true
+      end.nil?
     end
   end
 end

data/lib/tasks/inner_performance_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :inner_performance do
 #   # Task goes here

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: inner_performance
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - mbajur
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-24 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 7.1.5
 - !ruby/object:Gem::Dependency
-  name: activejob
+  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: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.1
 - !ruby/object:Gem::Dependency
-  name: pagy
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 9.3.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 9.3.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement