lograge-sql 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df7e9d756f02019ce93cbac6c0b19a275035a9d0fe74c631aa699eecf149f6f
-  data.tar.gz: d34996be2888e4d234d914de95ee092e2b2380181dd70f4b70b2fe84fdc7cc97
+  metadata.gz: d435c21129588de106963c13febc8cd259660430a9bfdb95894cd626bd658f6c
+  data.tar.gz: 5f942aaff99e144669f4b0b1c7d280fd11a800ab8f7f5ffc37197d891ae5c6b3
 SHA512:
-  metadata.gz: 9ef329876869d54eab7e71bf64345917185dfc2ad06d33cb3649689ddaa51ea7b257a425f5b1fb2c39da57b6b26e051d2a13a2d1687b51e99b8813f39be7e12f
-  data.tar.gz: c15d0baabaaede38e6d949fe64d1abf1f14229ac2160b3d8b6a3b70a2ea117e49f0b4c36693f467622d42af862a1dd27d89e3066d44938a4d83bf35633cc170c
+  metadata.gz: 628036a6a1f5a00e27a67b6c056d883dc183a58ffddb01bf63f717790f77182221301dc7582cf570dd718efa6d73993cb1dec04c3a6ecf3b8b453a06a25d5061
+  data.tar.gz: 405f2fe165ffe7ddbe80816e9ca3b980886d25331986d8b9b0084ffb2b9b656c6f8327d0f03aac930e099333b2c1291f0e5c1f7d2ef1b3b5f8def06260e7f3c5

data/README.md

@@ -82,6 +82,15 @@ Rails.application.configure do
 end
 ```
 
+### 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
+Rails.application.configure do
+  config.lograge_sql.query_filter = ->(query) { query.gsub(/custom_regexp/, "[FILTERED]".freeze) }
+end
+```
+
 ### 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,28 +4,46 @@ 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
 
-    # Add the event duration to the overall ActiveRecord::LogSubscriber.runtime;
+    # Add the event duration to the overall ActiveRecord::RuntimeRegistry.sql_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
+      ActiveRecord::RuntimeRegistry.sql_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.2.0'
+    VERSION = '2.3.1'
   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.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord