pg-locks-monitor 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1cdcf1754671326b02e939ec99c90c2cd8d696bdcbdc82c6c84b378e0365f3b
-  data.tar.gz: ad862bd65e1db50465ee1456ac18619abeb9f9f10dded487f335348f036b5d1c
+  metadata.gz: f95c5c531f0c74143c8fa74417344e1e5b3e400b06f910528541a69ee89f0aaa
+  data.tar.gz: fd704b6c9562678541aaaa1cbd98ab997281a529cbfba35f0235466000de0599
 SHA512:
-  metadata.gz: f20cb497a1ba37843441cb244fb581ab26ad7181ea1310c4c8d1db75f243fdac3ea05c9ec0b460b1c9bfe23827cb46360885fb24fef8747879d57342d4ad28cd
-  data.tar.gz: 9e9493e65efff88e07b33c08f8c7886b7b42b45939d07afe904600c7a9036896255756bcb7a7451754482f03bd150feb89db052a4766e8716e9f230832ed4b61
+  metadata.gz: 0c467b40b8114d8ca11a5aa89b91e5d0d3637a287d041e8f2d383f0465798d38e8d20f0248408fa4dbce90ef6eb74ef3bb022f78815fb3d676c07272279892b6
+  data.tar.gz: 9fdcecb73e646f43a2143db60a12d01f0cc766ed9ee633a63ca1254cce82c7de5688c1594c518b7adf269aed67a77d8da2c4e25a363372beaf19fa9d91b253c5

data/README.md

@@ -36,6 +36,9 @@ PgLocksMonitor.configure do |config|
   config.slack_channel = ""
 
   config.notifier_class = PgLocksMonitor::DefaultNotifier
+
+  config.locks_filter_proc = ->(lock) { true }
+  config.blocking_filter_proc = ->(lock) { true }
 end
 ```
 
@@ -49,7 +52,8 @@ end
 - `slack_webhook_url` - webhook necessary for Slack notification to work
 - `slack_channel` - the name of the target Slack channel
 - `notifier_class` - customizable notifier class
-
+- `locks_filter_proc` - configurable filter to exclude locks based on any custom logic
+- `blocking_filter_proc` - configurable filter to exclude blocking locks based on any custom logic
 
 ## Testing the notification channels
 
@@ -177,6 +181,36 @@ A background job that schedules itself is not the cleanest pattern. So alternati
 
 A recommended frequency of invocation depends on your app's traffic. From my experience, even 1 minute apart snapshots can provide a lot of valuable data, but it all depends on how often the locks are occurring in your Rails application.
 
+## Filter procs
+
+You can modify `locks_filter_proc` and `blocking_filter_proc` to exclude locks from getting reported. For example, here's how you can report only locks that originated from the Puma server process:
+
+`config/initializers/pg_locks_monitor.rb`
+```ruby
+PgLocksMonitor.configure do |config|
+  # ...
+
+  config.locks_filter_proc = -> (lock) {
+    lock.fetch("application").downcase.include?("puma")
+  }
+end
+```
+
+or exclude blocking locks which are affecting only the Sidekiq process:
+
+`config/initializers/pg_locks_monitor.rb`
+```ruby
+PgLocksMonitor.configure do |config|
+  # ...
+
+  config.blocking_filter_proc = -> (lock) {
+    lock.fetch("blocked_sql_app").downcase.include?("sidekiq")
+  }
+end
+```
+
+Please beware that configuring these procs does not overwrite the min duration settings, i.e., `locks_min_duration_ms` and `blocking_min_duration_ms`.
+
 ## Custom notifier class
 
 `PgLocksMonitor::DefaultNotifier` supports sending lock notifications with `Rails.logger` or to a Slack channel. If you want to use different notification channels you can define your custom notifier like that:

data/lib/pg-locks-monitor.rb

@@ -6,14 +6,13 @@ require "pg"
 module PgLocksMonitor
   def self.snapshot!
     locks = RailsPgExtras.locks(
-      in_format: :hash, args: {
-        limit: configuration.locks_limit,
-      },
+      in_format: :hash,
     ).select do |lock|
       if (age = lock.fetch("age"))
         (ActiveSupport::Duration.parse(age).to_f * 1000) > configuration.locks_min_duration_ms
       end
-    end
+    end.select(&configuration.locks_filter_proc)
+      .first(configuration.locks_limit)
 
     if locks.present? && configuration.monitor_locks
       configuration.notifier_class.call(locks)
@@ -21,7 +20,8 @@ module PgLocksMonitor
 
     blocking = RailsPgExtras.blocking(in_format: :hash).select do |block|
       (ActiveSupport::Duration.parse(block.fetch("blocking_duration")).to_f * 1000) > configuration.blocking_min_duration_ms
-    end
+    end.select(&configuration.blocking_filter_proc)
+      .first(configuration.locks_limit)
 
     if blocking.present? && configuration.monitor_blocking
       configuration.notifier_class.call(blocking)

data/lib/pg_locks_monitor/configuration.rb

@@ -13,6 +13,8 @@ module PgLocksMonitor
       slack_webhook_url: nil,
       slack_channel: nil,
       notifier_class: PgLocksMonitor::DefaultNotifier,
+      locks_filter_proc: ->(lock) { true },
+      blocking_filter_proc: ->(lock) { true },
     }
 
     attr_accessor *DEFAULT.keys
@@ -43,6 +45,9 @@ PgLocksMonitor.configure do |config|
   config.slack_channel = "#{DEFAULT[:slack_channel]}"
 
   config.notifier_class = #{DEFAULT[:notifier_class]}
+
+  config.locks_filter_proc = ->(lock) { true }
+  config.blocking_filter_proc = ->(lock) { true }
 end
 CONFIG
   end

data/lib/pg_locks_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgLocksMonitor
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg-locks-monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - pawurb