query_owl 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1269c2c24be94cd4ebf8ef07d12fa3e5da1aa2c1573256779f641d3f0a089c6e
-  data.tar.gz: 891f6323d6a6ffd95b6e73e131ddbf2f556e90703f5aa67819d92a3bdf0b4ccb
+  metadata.gz: 2654c621778910c1a0b1926398480e21b967f86c63ff45b642e635d80bfebcd0
+  data.tar.gz: 54245db5c8aa3a64869f3ce18b9c95b662d01ba58a042150ea551f19e1bf7299
 SHA512:
-  metadata.gz: 6fe7f83cbb596f8616ffdd11ccea40c4c2c485fa16b303f783a0b6b3a551eef4b8313e353585c8990061832227926738931fa582f9d2de8860b819afad301b96
-  data.tar.gz: 87244c9aba6eff9996e97d1f5a3727b8fbf283d6b10647c05fb903d4d7833bc464fdd0c26db84895f8ed7dbc7e290bc6c22f5f225f01360649d03859b9e2dfb7
+  metadata.gz: 5d1a2a46359810b4f5e482097264c6d1d402c4344f5cf29b672d89a9c834c04e81936f07f3111454abf549e12c5a30614e6829c5d62563860de6b625220ce234
+  data.tar.gz: 41561e881c73aac6ed2ce8b7d3fc4f1a9f83d35fe92f4473713d274978451d9d7cd4ae7fada1af25739d3222457216ae13fdfb015b41bc8cf87116ee8aaa9b1a

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

@@ -34,6 +34,13 @@ QueryOwl.configure do |config|
   # Disabled by default (nil). Useful for persistence across restarts.
   # config.log_file = Rails.root.join("log/query_owl.log").to_s
 
+  # Paths to skip entirely — accepts strings (prefix match) or regexes.
+  # Useful for health check endpoints and other high-frequency low-value paths.
+  # config.ignore_paths = ["/up", "/healthz", %r{^/assets/}]
+
+  # Controllers to skip — matched against the Rails controller name (e.g. "rails/health").
+  # config.ignore_controllers = ["rails/health", "admin/metrics"]
+
   # Notifiers receive each detected event via #call(event).
   # Defaults to [QueryOwl::Notifiers::Logger] which writes to Rails.logger.
   # Use Console for TTY-aware colorized output (yellow: N+1, red: slow query).

data/lib/query_owl/configuration.rb

@@ -5,7 +5,8 @@ module QueryOwl
 
     attr_reader :log_level, :backtrace_filter
     attr_accessor :enabled, :slow_query_threshold_ms, :n_plus_one_threshold, :backtrace_lines,
-                  :raise_on_n_plus_one, :event_store_size, :dashboard_enabled, :log_file
+                  :raise_on_n_plus_one, :event_store_size, :dashboard_enabled, :log_file,
+                  :ignore_paths, :ignore_controllers
 
     def notifiers
       @notifiers ||= [Notifiers::Logger.new]
@@ -31,6 +32,8 @@ module QueryOwl
       @event_store_size        = 100
       @dashboard_enabled       = Rails.env.development?
       @log_file                = nil
+      @ignore_paths            = []
+      @ignore_controllers      = []
     end
 
     def log_level=(level)

data/lib/query_owl/middleware.rb

@@ -4,41 +4,63 @@ module QueryOwl
       @app = app
     end
 
-    def raise_on_n_plus_one!(events)
-      event = events.find { |e| e[:type] == :n_plus_one }
-      return unless event
-
-      raise NPlusOneError, "N+1 detected: #{event[:sql]} (#{event[:count]} times) #{event[:backtrace].first}"
-    end
-
     def call(env)
+      tracking = false
       return @app.call(env) unless QueryOwl.config.enabled
+      return @app.call(env) if ignored_path?(env["PATH_INFO"])
 
+      tracking = true
       QueryTracker.start!
       EagerLoadTracker.start!
       @app.call(env)
     ensure
-      params  = env["action_dispatch.request.path_parameters"] || {}
-      RequestContext.set(controller: params[:controller], action: params[:action], path: env["PATH_INFO"])
-      queries    = QueryTracker.stop!
-      eager_data = EagerLoadTracker.stop!
-      context    = RequestContext.current
-      RequestContext.clear
-      events     = (Detector.detect_n_plus_one(queries) +
+      if tracking
+        params     = env["action_dispatch.request.path_parameters"] || {}
+        RequestContext.set(controller: params[:controller], action: params[:action], path: env["PATH_INFO"])
+        queries    = QueryTracker.stop!
+        eager_data = EagerLoadTracker.stop!
+        context    = RequestContext.current
+        RequestContext.clear
+
+        unless ignored_controller?(context[:controller])
+          events = (Detector.detect_n_plus_one(queries) +
                     Detector.detect_slow_queries(queries) +
                     Detector.detect_unused_eager_loads(eager_data))
                    .map { |e| e.merge(context) }
-      events.each do |event|
-        QueryOwl.config.notifiers.each do |notifier|
-          notifier.call(event)
-        rescue => e
-          Rails.logger.error "[QueryOwl] Notifier #{notifier.class} raised: #{e.message}"
+          events.each do |event|
+            QueryOwl.config.notifiers.each do |notifier|
+              notifier.call(event)
+            rescue => e
+              Rails.logger.error "[QueryOwl] Notifier #{notifier.class} raised: #{e.message}"
+            end
+          end
+          Logger.log_summary(events)
+          events.each { |e| EventStore.push(e) }
+          FileLogger.append(events)
+          raise_on_n_plus_one!(events) if QueryOwl.config.raise_on_n_plus_one
         end
       end
-      Logger.log_summary(events)
-      events.each { |e| EventStore.push(e) }
-      FileLogger.append(events)
-      raise_on_n_plus_one!(events) if QueryOwl.config.raise_on_n_plus_one
     end
+
+    def raise_on_n_plus_one!(events)
+      event = events.find { |e| e[:type] == :n_plus_one }
+      return unless event
+
+      raise NPlusOneError, "N+1 detected: #{event[:sql]} (#{event[:count]} times) #{event[:backtrace].first}"
+    end
+
+    private
+
+      def ignored_path?(path)
+        QueryOwl.config.ignore_paths.any? do |pattern|
+          pattern.is_a?(Regexp) ? pattern.match?(path) : path.start_with?(pattern.to_s)
+        end
+      end
+
+      def ignored_controller?(controller)
+        return false unless controller
+
+        QueryOwl.config.ignore_controllers.any? { |name| name.to_s == controller }
+      end
   end
 end

data/lib/query_owl/version.rb

@@ -1,3 +1,3 @@
 module QueryOwl
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/tasks/query_owl_tasks.rake

@@ -1,4 +1,8 @@
-# desc "Explaining what the task does"
-# task :query_owl do
-#   # Task goes here
-# end
+namespace :query_owl do
+  desc "Clear all events from the QueryOwl in-memory event store"
+  task clear: :environment do
+    count = QueryOwl::EventStore.size
+    QueryOwl::EventStore.clear
+    puts "[QueryOwl] Event store cleared (#{count} event#{"s" if count != 1} removed)."
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_owl
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Chuck Smith