pg-locks-monitor 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9127ef19c571c1eda59fa9962c694c6a416f4d2875d6660091cb72479e09d98
-  data.tar.gz: 56a1e90355cad04a9834e2a6eafeb76c9633596a9e786ce639af838757c1e87e
+  metadata.gz: f95c5c531f0c74143c8fa74417344e1e5b3e400b06f910528541a69ee89f0aaa
+  data.tar.gz: fd704b6c9562678541aaaa1cbd98ab997281a529cbfba35f0235466000de0599
 SHA512:
-  metadata.gz: e9d94a09139dd75cfc5672aa863e288ed6654fa4953cf00dbbd62a6ec63e63feb60c99208f0aa0dda2ce01ccadd9cd92b3b58d05200be53bb75579e44bf85f9d
-  data.tar.gz: 6f57a40ce88babd6fcdd176371462c4b6fa40c248da5472ae1cfdcdad685bc17f0a5a3bbf0f152e7de50d48dbc84a18a8443d1ce6ce90bf112278b506e81a839
+  metadata.gz: 0c467b40b8114d8ca11a5aa89b91e5d0d3637a287d041e8f2d383f0465798d38e8d20f0248408fa4dbce90ef6eb74ef3bb022f78815fb3d676c07272279892b6
+  data.tar.gz: 9fdcecb73e646f43a2143db60a12d01f0cc766ed9ee633a63ca1254cce82c7de5688c1594c518b7adf269aed67a77d8da2c4e25a363372beaf19fa9d91b253c5

data/.github/workflows/ci.yml

@@ -83,7 +83,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5432/pg-locks-monitor-test
         run: |
-          bundle exec rspec spec/
+          bundle exec rake test_all
       - name: Run tests for PG 12
         env:
           PG_VERSION: 12
@@ -93,7 +93,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5433/pg-locks-monitor-test
         run: |
-          bundle exec rspec spec/
+          bundle exec rake test_all
       - name: Run tests for PG 13
         env:
           PG_VERSION: 13
@@ -103,7 +103,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5434/pg-locks-monitor-test
         run: |
-          bundle exec rspec spec/
+          bundle exec rake test_all
       - name: Run tests for PG 14
         env:
           PG_VERSION: 14
@@ -113,7 +113,7 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5435/pg-locks-monitor-test
         run: |
-          bundle exec rspec spec/
+          bundle exec rake test_all
       - name: Run tests for PG 15
         env:
           PG_VERSION: 15
@@ -123,5 +123,5 @@ jobs:
           POSTGRES_PASSWORD: secret
           DATABASE_URL: postgresql://postgres:secret@localhost:5436/pg-locks-monitor-test
         run: |
-          bundle exec rspec spec/
+          bundle exec rake test_all
 

data/README.md

@@ -2,6 +2,10 @@
 
 This gem allows to observe database locks generated by a Rails application. By default, locks data is not persisted anywhere in the PostgreSQL logs, so the only way to monitor it is via analyzing the transient state of the `pg_locks` metadata table. `pg-locks-monitor` is a simple tool that makes this process quick to implement and adjust to each app's individual requirements.
 
+You can read [this blogpost](https://pawelurbanek.com/rails-postgresql-locks) for more detailed info on database locks in the Rails apps.
+
+**Shameless plug:** pg-locks-monitor is just one of the tools that I use when conducting [Rails performance audits](https://pawelurbanek.com/). Check out my offer if you need help with optimizing your application.
+
 ## Usage
 
 `PgLocksMonitor` class provides a `snapshot!` method, which notifies selected channels about database locks that match configured criteria.
@@ -32,24 +36,28 @@ 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
 ```
 
 - `locks_limit` - specify the max number of locks to report in a single notification
-- `notify_locks` - observe database locks even if they don't conflict with a different SQL query
+- `monitor_locks` - observe database locks even if they don't conflict with a different SQL query
 - `locks_min_duration_ms` - notify about locks that execeed this duration threshold in milliseconds
-- `notify_blocking` - observe database locks which cause other SQL query to wait from them to release
+- `monitor_blocking` - observe database locks which cause other SQL query to wait from them to release
 - `blocking_min_duration_ms` - notify about blocking locks that execeed this duration threshold in milliseconds
 - `notify_logs` - send notifications about detected locks using `Rails.logger.info` method
 - `notify_slack` - send notifications about detected locks to the configured Slack channel
 - `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
 
-Before configuring a recurring invocation of the `snapshot!` method, it's recommended to first manually trigger the notification to test the configured channels.
+Before enabling a recurring invocation of the `snapshot!` method, it's recommended to first manually trigger the notification to test the configured channels.
 
 You can generate an _"artificial"_ blocking lock and observe it by running the following code in the Rails console:
 
@@ -136,8 +144,6 @@ Here's a sample lock notification:
   },
 ```
 
-You can read [this blogpost](https://pawelurbanek.com/rails-postgresql-locks) for more detailed info on locks in the Rails apps.
-
 ## Background job config
 
 This gem is intended to be used via a recurring background job, but it is agnostic to the background job provider. Here's a sample Sidekiq implementation:
@@ -175,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,12 +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|
-      (ActiveSupport::Duration.parse(lock.fetch("age")).to_f * 1000) > configuration.locks_min_duration_ms
-    end
+      if (age = lock.fetch("age"))
+        (ActiveSupport::Duration.parse(age).to_f * 1000) > configuration.locks_min_duration_ms
+      end
+    end.select(&configuration.locks_filter_proc)
+      .first(configuration.locks_limit)
 
     if locks.present? && configuration.monitor_locks
       configuration.notifier_class.call(locks)
@@ -19,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.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-locks-monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -105,7 +105,6 @@ files:
 - pg-locks-monitor.gemspec
 - spec/configuration_spec.rb
 - spec/default_notifier_spec.rb
-- spec/smoke_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/pawurb/pg-locks-monitor
 licenses:
@@ -134,5 +133,4 @@ summary: Observe PostgreSQL database locks obtained by a Rails application.
 test_files:
 - spec/configuration_spec.rb
 - spec/default_notifier_spec.rb
-- spec/smoke_spec.rb
 - spec/spec_helper.rb

data/spec/smoke_spec.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe PgLocksMonitor do
-end