lograge-sql 2.3.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9111536f41dbfa19e93c81046f55a53e8dd4a25afcca73279b47b30475f75954
-  data.tar.gz: b43db3a11e0b3dbdfa7bb4f921d95e72ff78d57c3eb8e9f4bc534683f9df945d
+  metadata.gz: 3c9d368981a6231cc03eb7b015ab7847fdcc77220c881fc7dd4aa633e74c09b8
+  data.tar.gz: aca838791bae71fff0612ac59212e7ccc70597d11cd4916572ad303a858ac811
 SHA512:
-  metadata.gz: a0875e72c3883b97291b7a23f9f0f86389b68ff70a2ef6cbfdc8d7dfaae90da8bf2f17e3876e11c8aea105416bdc908519fda25326effacafad02fb46ee9c47c
-  data.tar.gz: f59abb9c350112083eeeb2dd1d28ee37d75295542ae441f0cdf275192560e334f1f7bf2f147e19d05036016ca174683bebc42b1a6bcd22a8eb095574e42d5338
+  metadata.gz: e0f1485cbf50c44020d64730a9f7f06843f9105b5c5cb07319285185a299b02bdd669661a8ed644531feb97d61f3e7da39eea2b8918d2f16ed6c53b6cff9d506
+  data.tar.gz: cf39a5e5af70750a6908e33d33993228000b1681d8ffb978f9fa9c64bda68e065c0017e4fafbdac389957d903b075e57a332788ac77a4db90218ce4a614e2605

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?(Regexp.union(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.3.2'
+    VERSION = '2.5.0'
   end
 end

data/lib/lograge/sql.rb

@@ -15,6 +15,8 @@ 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)
@@ -22,6 +24,7 @@ module Lograge
         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 = 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.3.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-18 00:00:00.000000000 Z
+date: 2024-11-13 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.2'
+        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.2'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement