lograge-sql 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '066994b5ce1417ea75cdcb9328eb91c0deb1a2e4530119a2a698356aaccedb28'
-  data.tar.gz: 151e948e7fbd209d7048b4c8fe92afa83d1f9012974abc7d2daf24c29caa2da7
+  metadata.gz: 6df7e9d756f02019ce93cbac6c0b19a275035a9d0fe74c631aa699eecf149f6f
+  data.tar.gz: d34996be2888e4d234d914de95ee092e2b2380181dd70f4b70b2fe84fdc7cc97
 SHA512:
-  metadata.gz: 3ade265153ed67c440a4135daf39ffe9479adeb5c89b3780f0f91fabf28f96199be19aa646fe1170c0a67a9505fdfcf4172df2d085d0b8f178fb4994888217f2
-  data.tar.gz: 1372c45b1944a73f5a209e9d6581856bb16819a90c3ffc6ab5e0e75158e0e48783ec236dd11aa6883af5c0d7731913a5fe3e1dfddf5e665312fe73821a32e804
+  metadata.gz: 9ef329876869d54eab7e71bf64345917185dfc2ad06d33cb3649689ddaa51ea7b257a425f5b1fb2c39da57b6b26e051d2a13a2d1687b51e99b8813f39be7e12f
+  data.tar.gz: c15d0baabaaede38e6d949fe64d1abf1f14229ac2160b3d8b6a3b70a2ea117e49f0b4c36693f467622d42af862a1dd27d89e3066d44938a4d83bf35633cc170c

data/README.md

@@ -1,7 +1,7 @@
 # Lograge::Sql
 
 [![Gem Version](https://badge.fury.io/rb/lograge-sql.svg)](https://badge.fury.io/rb/lograge-sql)
-[![Build Status](https://travis-ci.org/iMacTia/lograge-sql.svg)](https://travis-ci.org/iMacTia/lograge-sql)
+[![CI](https://github.com/iMacTia/lograge-sql/actions/workflows/ci.yml/badge.svg)](https://github.com/iMacTia/lograge-sql/actions/workflows/ci.yml)
 
 Lograge::Sql is an extension to the famous [Lograge](https://github.com/roidrage/lograge) gem, which adds SQL queries to the Lograge Event and disable default ActiveRecord logging.
 This is extremely useful if you're using Lograge together with the ELK stack.
@@ -29,7 +29,23 @@ By default, Lograge::Sql disables default logging on ActiveRecord. To preserve d
 config.lograge_sql.keep_default_active_record_log = true
 ```
 
-## Customization
+## Configuration
+
+### Minimum query duration threshold
+
+By default, `lograge-sql` stores all queries, but you can set a `min_duration_ms` config.
+When you do so, only queries that run for AT LEAST `min_duration_ms` milliseconds will be logged, and all others will be ignored.
+This can be really helpful if you want to detect `Slow SQL queries`.
+
+```ruby
+# config/initializers/lograge.rb
+Rails.application.configure do
+  # Defaults is zero
+  config.lograge_sql.min_duration_ms = 5000 # milliseconds
+end
+```
+
+### Output Customization
 
 By default, the format is a string concatenation of the query name, the query duration and the query itself joined by `\n` newline:
 
@@ -66,11 +82,10 @@ Rails.application.configure do
 end
 ```
 
-#### Thread-safety
+### Thread-safety
 
 [Depending on the web server in your project](https://github.com/steveklabnik/request_store#the-problem) you might benefit from improved thread-safety by adding [`request_store`](https://github.com/steveklabnik/request_store) to your Gemfile. It will be automatically picked up by `lograge-sql`.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iMacTia/lograge-sql.
-

data/lib/lograge/active_record_log_subscriber.rb

@@ -6,11 +6,26 @@ module Lograge
     # Every time there's an SQL query, stores it into the Thread.
     # They'll later be access from the RequestLogSubscriber.
     def sql(event)
-      ActiveRecord::LogSubscriber.runtime += event.duration
+      increase_runtime_duration(event)
       return if event.payload[:name] == 'SCHEMA'
 
+      # Only store SQL events if `event.duration` is greater than the configured +min_duration+
+      # No need to check if +min_duration+ is present before as it defaults to 0
+      return if event.duration.to_f.round(2) < Lograge::Sql.min_duration_ms.to_f
+
       Lograge::Sql.store[:lograge_sql_queries] ||= []
       Lograge::Sql.store[:lograge_sql_queries] << Lograge::Sql.extract_event.call(event)
     end
+
+    private
+
+    # Add the event duration to the overall ActiveRecord::LogSubscriber.runtime;
+    # note we don't do this when `keep_default_active_record_log` is enabled,
+    # as ActiveRecord is already adding the duration.
+    def increase_runtime_duration(event)
+      return if Rails.application.config.lograge_sql.keep_default_active_record_log
+
+      ActiveRecord::LogSubscriber.runtime += event.duration
+    end
   end
 end

data/lib/lograge/sql/version.rb

@@ -3,6 +3,6 @@
 module Lograge
   module Sql
     # Gem version
-    VERSION = '2.0.0'
+    VERSION = '2.2.0'
   end
 end

data/lib/lograge/sql.rb

@@ -11,18 +11,17 @@ module Lograge
       attr_accessor :formatter
       # Extract information from SQL event
       attr_accessor :extract_event
+      # Filter SQL events by duration
+      attr_accessor :min_duration_ms
 
       # Initialise configuration with fallback to default values
       def setup(config)
-        Lograge::Sql.formatter     = config.formatter     || default_formatter
-        Lograge::Sql.extract_event = config.extract_event || default_extract_event
+        Lograge::Sql.formatter       = config.formatter       || default_formatter
+        Lograge::Sql.extract_event   = config.extract_event   || default_extract_event
+        Lograge::Sql.min_duration_ms = config.min_duration_ms || 0
 
         # Disable existing ActiveRecord logging
-        unless config.keep_default_active_record_log
-          ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-            Lograge.unsubscribe(:active_record, subscriber) if subscriber.is_a?(ActiveRecord::LogSubscriber)
-          end
-        end
+        unsubscribe_log_subscribers unless config.keep_default_active_record_log
 
         return unless defined?(Lograge::ActiveRecordLogSubscriber)
 
@@ -51,6 +50,12 @@ module Lograge
           "#{event.payload[:name]} (#{event.duration.to_f.round(2)}) #{event.payload[:sql]}"
         end
       end
+
+      def unsubscribe_log_subscribers
+        ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+          Lograge.unsubscribe(:active_record, subscriber) if subscriber.is_a?(ActiveRecord::LogSubscriber)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lograge-sql
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement