lograge-sql 2.4.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4741be36b981948cc0562664564b910b3bf0ed6bb02a0f39e0af3798bc66f5b6
-  data.tar.gz: 92d89a6ddae169b32be1b2512dcbc8fd06843891cc464873899c464be761efb5
+  metadata.gz: 411c0c5825eb7d03f50656e01258c6e1f496b714e52fb5accdf688fd83ad2dc8
+  data.tar.gz: 216a5da3c96a4e968242b67da4c1d049519ad04481282a3455d587927075fe6a
 SHA512:
-  metadata.gz: 14c80d0b256734c869b82f6652afebc1f3e1b64e465c1c4e49b7dfe1407ebe28771b070abde47a4b7a14e85a082e3e5c47d88c867ae064bedda2b83f150d2eb8
-  data.tar.gz: 40176ec3866decded7e8801b41a5521abe466f5d52858d5040e70b341e7132412377c1fa6d6d12859dcbc28594e7ddad3037bdee747747ac8b98409e70c038a1
+  metadata.gz: d1f070808821acc5193c216f1586cb41eda7dc7a411446d1fab0f29bb6948672e704a7112f5658b504386f476e5a08ae7797415f01fdf260188bb5c83aeb31c3
+  data.tar.gz: 3df2ef7fbc138431e8e43963f0a1ba9ca39af1165447f5dfd93c1cdf1b6a4fd84da9da9255de0ad37bc92cd1b7d6199d59c393bbfc6aa6138453336c3d72a66f

data/README.md

@@ -45,6 +45,20 @@ Rails.application.configure do
 end
 ```
 
+### Filtering sql queries by name
+
+You can filter out queries using the `query_name_denylist` configuration. 
+This takes an array of regular expressions to match against the query name. If the query name matches any of the regular expressions, it will be ignored. By default, `lograge-sql` ignores queries named `SCHEMA` and queries from the `SolidCable` namespace.
+If you are using Solid Cable in your project, be careful  when removing this default value as it will cause a [memory leak](https://github.com/iMacTia/lograge-sql/issues/59).
+
+```ruby
+# config/initializers/lograge.rb
+Rails.application.configure do
+  # Defaults is [/\ASCHEMA\z/, /\ASolidCable::/]
+  config.lograge_sql.query_name_denylist << /\AEXACT NAME TO IGNORE\z/
+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:

data/lib/lograge/active_record_log_subscriber.rb

@@ -33,7 +33,7 @@ module Lograge
     end
 
     def valid?(event)
-      return false if event.payload[:name] == 'SCHEMA'
+      return false if event.payload[:name]&.match?(Lograge::Sql.query_name_denylist)
 
       # 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

data/lib/lograge/sql/version.rb

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

data/lib/lograge/sql.rb

@@ -15,13 +15,16 @@ module Lograge
       attr_accessor :min_duration_ms
       # Filter SQL query
       attr_accessor :query_filter
+      # Filter wich SQL queries to store
+      attr_accessor :query_name_denylist
 
       # Initialise configuration with fallback to default values
-      def setup(config)
+      def setup(config) # rubocop:disable Metrics/AbcSize
         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
         Lograge::Sql.query_filter    = config.query_filter
+        Lograge::Sql.query_name_denylist = Regexp.union(config.query_name_denylist || [/\ASCHEMA\z/, /\ASolidCable::/])
 
         # Disable existing ActiveRecord logging
         unsubscribe_log_subscribers unless config.keep_default_active_record_log

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lograge-sql
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2024-11-25 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.3'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement