query_owl 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5db617fa85bce1a43d851809139bd43015afd92263bd203ac0114921dd94c525
-  data.tar.gz: 4ebf287c62f2779448c2277d416147d7b426332a2dd927f6a1a8485498c76638
+  metadata.gz: 1269c2c24be94cd4ebf8ef07d12fa3e5da1aa2c1573256779f641d3f0a089c6e
+  data.tar.gz: 891f6323d6a6ffd95b6e73e131ddbf2f556e90703f5aa67819d92a3bdf0b4ccb
 SHA512:
-  metadata.gz: e3ec2642c611837a83dc96fdf8fc7eb669a99c6ae140fc3ad5bb1439a5b2db4349a9038a87a4af8e61fe1156e2d6fcbe43535641a2c51dd3bbcc41f9652ec88c
-  data.tar.gz: 2b2fe57db0a34c3289ef76a6170c4ea0d36d441eb733571ce87d8b506e1772b54d1e63841a8719d009a7ffd52a708b8ce5ad19c36e22839ceb3d33111700ae8b
+  metadata.gz: 6fe7f83cbb596f8616ffdd11ccea40c4c2c485fa16b303f783a0b6b3a551eef4b8313e353585c8990061832227926738931fa582f9d2de8860b819afad301b96
+  data.tar.gz: 87244c9aba6eff9996e97d1f5a3727b8fbf283d6b10647c05fb903d4d7833bc464fdd0c26db84895f8ed7dbc7e290bc6c22f5f225f01360649d03859b9e2dfb7

data/app/assets/stylesheets/query_owl/_03_table.css

@@ -26,4 +26,9 @@
 }
 
 .qo-table tr:last-child td { border-bottom: none; }
-.qo-table tr:hover td      { background: #fafafa; }
+.qo-table tr:hover td      { background: #fafafa; }
+
+.qo-table td:nth-child(2) { max-width: 320px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
+
+.qo-request  { white-space: nowrap; }
+.qo-path     { font-family: ui-monospace, "SFMono-Regular", Menlo, monospace; font-size: 11px; opacity: .7; }

data/app/views/query_owl/slow_queries/index.html.erb

@@ -12,6 +12,7 @@
         <th>Type</th>
         <th>SQL / Details</th>
         <th>Info</th>
+        <th>Request</th>
         <th>Recorded At</th>
         <th>Backtrace</th>
       </tr>
@@ -25,6 +26,14 @@
             <% if event[:count] %>count: <%= event[:count] %><% end %>
             <% if event[:duration_ms] %><%= event[:duration_ms] %>ms<% end %>
           </td>
+          <td class="qo-request qo-muted">
+            <% if event[:controller] || event[:action] %>
+              <span class="qo-monospace"><%= [event[:controller], event[:action]].compact.join("#") %></span>
+            <% end %>
+            <% if event[:path] %>
+              <br><span class="qo-path"><%= event[:path] %></span>
+            <% end %>
+          </td>
           <td class="qo-muted"><%= event[:recorded_at]&.strftime("%H:%M:%S") %></td>
           <td class="qo-monospace qo-muted"><%= Array(event[:backtrace]).first %></td>
         </tr>

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

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module QueryOwl
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a QueryOwl initializer in config/initializers."
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/query_owl.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+QueryOwl.configure do |config|
+  # Enable or disable all QueryOwl tracking.
+  # Defaults to true in development, false elsewhere.
+  # config.enabled = Rails.env.development?
+
+  # Flag N+1 queries when the same SQL pattern fires this many times per request.
+  # config.n_plus_one_threshold = 2
+
+  # Flag individual queries that take longer than this (in milliseconds).
+  # config.slow_query_threshold_ms = 100
+
+  # Log level for QueryOwl warnings (:debug, :info, or :warn).
+  # config.log_level = :warn
+
+  # Number of backtrace frames captured per query.
+  # config.backtrace_lines = 5
+
+  # Custom backtrace filter — a callable that receives a line and returns true to keep it.
+  # Defaults to stripping gem paths and QueryOwl internals.
+  # config.backtrace_filter = ->(line) { line.start_with?("app/") }
+
+  # Raise QueryOwl::NPlusOneError instead of logging when an N+1 is detected.
+  # Useful in CI test suites where silent warnings are easy to miss.
+  # config.raise_on_n_plus_one = false
+
+  # Maximum number of events retained in the in-memory ring buffer.
+  # config.event_store_size = 100
+
+  # Enable the HTML dashboard at GET /slow_queries (when the engine is mounted).
+  # Defaults to true in development, false elsewhere.
+  # config.dashboard_enabled = Rails.env.development?
+
+  # Append each detected event as a JSON line to this file path.
+  # Disabled by default (nil). Useful for persistence across restarts.
+  # config.log_file = Rails.root.join("log/query_owl.log").to_s
+
+  # 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).
+  # Use Stdout for non-request contexts (jobs, Rake tasks).
+  # config.notifiers = [QueryOwl::Notifiers::Console.new]
+end

data/lib/query_owl/configuration.rb

@@ -5,7 +5,20 @@ 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
+                  :raise_on_n_plus_one, :event_store_size, :dashboard_enabled, :log_file
+
+    def notifiers
+      @notifiers ||= [Notifiers::Logger.new]
+    end
+
+    def notifiers=(arr)
+      arr.each do |notifier|
+        unless notifier.respond_to?(:call)
+          raise ArgumentError, "notifiers must respond to #call (#{notifier.class} does not)"
+        end
+      end
+      @notifiers = arr
+    end
 
     def initialize
       @enabled                 = Rails.env.development?
@@ -17,6 +30,7 @@ module QueryOwl
       @raise_on_n_plus_one     = false
       @event_store_size        = 100
       @dashboard_enabled       = Rails.env.development?
+      @log_file                = nil
     end
 
     def log_level=(level)

data/lib/query_owl/event_store.rb

@@ -4,7 +4,7 @@ module QueryOwl
       def push(event)
         mutex.synchronize do
           ensure_buffer_size
-          buffer[@write_pos] = event.merge(recorded_at: Time.now)
+          buffer[@write_pos] = event.merge(recorded_at: Time.current)
           @write_pos = (@write_pos + 1) % capacity
           @stored    = [@stored + 1, capacity].min
         end

data/lib/query_owl/file_logger.rb

@@ -0,0 +1,28 @@
+require "json"
+require "fileutils"
+
+module QueryOwl
+  class FileLogger
+    class << self
+      def append(events)
+        return if events.empty?
+
+        path = QueryOwl.config.log_file
+        return unless path
+
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, "a") do |f|
+          events.each { |e| f.puts(JSON.generate(serializable(e))) }
+        end
+      rescue => e
+        Rails.logger.error "[QueryOwl] FileLogger failed: #{e.message}"
+      end
+
+      private
+
+        def serializable(event)
+          event.transform_values { |v| v.is_a?(Symbol) ? v.to_s : v }
+        end
+    end
+  end
+end

data/lib/query_owl/middleware.rb

@@ -18,14 +18,26 @@ module QueryOwl
       EagerLoadTracker.start!
       @app.call(env)
     ensure
-      queries     = QueryTracker.stop!
-      eager_data  = EagerLoadTracker.stop!
-      events      = Detector.detect_n_plus_one(queries) +
+      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) +
                     Detector.detect_slow_queries(queries) +
-                    Detector.detect_unused_eager_loads(eager_data)
-      Logger.log_events(events)
+                    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}"
+        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

data/lib/query_owl/notifiers/console.rb

@@ -0,0 +1,38 @@
+module QueryOwl
+  module Notifiers
+    class Console
+      YELLOW = "\e[33m"
+      RED    = "\e[31m"
+      RESET  = "\e[0m"
+
+      def call(event)
+        line = format(event)
+        line = apply_color(event[:type], line) if $stdout.tty?
+        $stdout.puts line
+      end
+
+      private
+
+        def format(event)
+          case event[:type]
+          when :n_plus_one
+            "#{QueryOwl::Logger::PREFIX} n_plus_one  #{event[:sql]}  ×#{event[:count]}"
+          when :slow_query
+            "#{QueryOwl::Logger::PREFIX} slow_query  #{event[:sql]}  #{event[:duration_ms]}ms"
+          when :unused_eager_load
+            "#{QueryOwl::Logger::PREFIX} unused_eager_load  #{event[:model]}##{event[:association]}"
+          else
+            "#{QueryOwl::Logger::PREFIX} #{event[:type]}"
+          end
+        end
+
+        def apply_color(type, text)
+          case type
+          when :n_plus_one then "#{YELLOW}#{text}#{RESET}"
+          when :slow_query  then "#{RED}#{text}#{RESET}"
+          else text
+          end
+        end
+    end
+  end
+end

data/lib/query_owl/notifiers/logger.rb

@@ -0,0 +1,9 @@
+module QueryOwl
+  module Notifiers
+    class Logger
+      def call(event)
+        ::Rails.logger.public_send(QueryOwl.config.log_level, "#{QueryOwl::Logger::PREFIX} #{event.to_json}")
+      end
+    end
+  end
+end

data/lib/query_owl/notifiers/stdout.rb

@@ -0,0 +1,9 @@
+module QueryOwl
+  module Notifiers
+    class Stdout
+      def call(event)
+        $stdout.puts "#{QueryOwl::Logger::PREFIX} #{event.to_json}"
+      end
+    end
+  end
+end

data/lib/query_owl/request_context.rb

@@ -0,0 +1,17 @@
+module QueryOwl
+  module RequestContext
+    class << self
+      def set(controller:, action:, path:)
+        Thread.current[:query_owl_request_context] = { controller: controller, action: action, path: path }
+      end
+
+      def current
+        Thread.current[:query_owl_request_context] || {}
+      end
+
+      def clear
+        Thread.current[:query_owl_request_context] = nil
+      end
+    end
+  end
+end

data/lib/query_owl/version.rb

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

data/lib/query_owl.rb

@@ -5,6 +5,11 @@ require "query_owl/eager_load_tracker"
 require "query_owl/event_store"
 require "query_owl/detector"
 require "query_owl/logger"
+require "query_owl/file_logger"
+require "query_owl/notifiers/logger"
+require "query_owl/notifiers/stdout"
+require "query_owl/notifiers/console"
+require "query_owl/request_context"
 require "query_owl/middleware"
 require "query_owl/engine"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_owl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Chuck Smith
@@ -47,15 +47,22 @@ files:
 - app/views/layouts/query_owl/application.html.erb
 - app/views/query_owl/slow_queries/index.html.erb
 - config/routes.rb
+- lib/generators/query_owl/install/install_generator.rb
+- lib/generators/query_owl/install/templates/initializer.rb
 - lib/query_owl.rb
 - lib/query_owl/configuration.rb
 - lib/query_owl/detector.rb
 - lib/query_owl/eager_load_tracker.rb
 - lib/query_owl/engine.rb
 - lib/query_owl/event_store.rb
+- lib/query_owl/file_logger.rb
 - lib/query_owl/logger.rb
 - lib/query_owl/middleware.rb
+- lib/query_owl/notifiers/console.rb
+- lib/query_owl/notifiers/logger.rb
+- lib/query_owl/notifiers/stdout.rb
 - lib/query_owl/query_tracker.rb
+- lib/query_owl/request_context.rb
 - lib/query_owl/version.rb
 - lib/tasks/query_owl_tasks.rake
 homepage: https://github.com/eclectic-coding/query_owl