lograge-sql 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0794c5325c6cc647ab9e133b0ac1ebfee558311f12b26861c0776866a6cc27fb'
-  data.tar.gz: b2bae9007ad19926f3ba0fed85bb6a965b942e70a537ed50b4230f071834af8f
+  metadata.gz: 8eeabf2a3a00c53b0d7483d6dd84659f2434eb90f0741183370a1559bf9eab1d
+  data.tar.gz: da0adc7fa61626a386b563d622234c02971da52f310e687f313b95cf074a6434
 SHA512:
-  metadata.gz: 72222b28288cc38a14533c3a3babe408aa2d834dc19ba7f323ac9f7aeca167d55ad7ba2fc3af777e35fa643f7850901378282ee6865bbe4246edc410dff68ad2
-  data.tar.gz: f4a956079f4562b3f24737adc851fb78ca41d70b6e8555e3eda42c436b0c88af28a109d3db4e54c2b36c1d0d21ef67a8c344bcb5a5b22b7884d2b9268fbca0cd
+  metadata.gz: fcc84f05b613c82c0b00d9747d6a07976c324e1acef7a6b7b7e98987adb1b319ffcbfe92752682b579ed0eaeb00651431ec9046119dccac8df66a0750a050924
+  data.tar.gz: 333ff533242871fcbb4ea2130da71fbdf232625c32b206634fca0f374b7e96e1b2d0b66c0dcccb7ec2799b00b015bcfcde953e54732e5d42d84f4cec6cbb12b4

data/README.md

@@ -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,19 +82,16 @@ Rails.application.configure do
 end
 ```
 
-`Lograge-sql` only stores any events by `min_duration_ms` condition.
-It very helpful if you want to detect `Slow SQL queries`
+### Filtering out sensitive info in SQL logs
+By default, `lograge-sql` will log full query but if you have sensitive data that need to be filtered out, you can set `query_filter` config:
 
 ```ruby
-# config/initializers/lograge.rb
 Rails.application.configure do
-  # Set limitted of SQL duration if you want to filter (unit: milliseconds)
-  # Defaults is zero
-  config.lograge_sql.min_duration_ms = 5000
+  config.lograge_sql.query_filter = ->(query) { query.gsub(/custom_regexp/, "[FILTERED]".freeze) }
 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`.
 

data/lib/lograge/active_record_log_subscriber.rb

@@ -4,17 +4,13 @@ module Lograge
   # Log subscriber to replace ActiveRecord's default one
   class ActiveRecordLogSubscriber < ActiveSupport::LogSubscriber
     # Every time there's an SQL query, stores it into the Thread.
-    # They'll later be access from the RequestLogSubscriber.
+    # They'll later be accessed from the RequestLogSubscriber.
     def sql(event)
       increase_runtime_duration(event)
-      return if event.payload[:name] == 'SCHEMA'
+      return unless valid?(event)
 
-      # 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)
+      filter_query(event)
+      store(event)
     end
 
     private
@@ -27,5 +23,27 @@ module Lograge
 
       ActiveRecord::LogSubscriber.runtime += event.duration
     end
+
+    def filter_query(event)
+      return unless Lograge::Sql.query_filter
+
+      # Filtering out sensitive info in SQL query if custom query_filter is provided
+      event.payload[:sql] = Lograge::Sql.query_filter.call(event.payload[:sql])
+    end
+
+    def valid?(event)
+      return false 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 false if event.duration.to_f.round(2) < Lograge::Sql.min_duration_ms.to_f
+
+      true
+    end
+
+    def store(event)
+      Lograge::Sql.store[:lograge_sql_queries] ||= []
+      Lograge::Sql.store[:lograge_sql_queries] << Lograge::Sql.extract_event.call(event)
+    end
   end
 end

data/lib/lograge/sql/version.rb

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

data/lib/lograge/sql.rb

@@ -13,12 +13,15 @@ module Lograge
       attr_accessor :extract_event
       # Filter SQL events by duration
       attr_accessor :min_duration_ms
+      # Filter SQL query
+      attr_accessor :query_filter
 
       # 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.min_duration_ms = config.min_duration_ms || 0
+        Lograge::Sql.query_filter    = config.query_filter
 
         # 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.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-25 00:00:00.000000000 Z
+date: 2023-10-18 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