pg-locks-monitor 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcbbfc8c0f63bbfd2f2c06abfb5db0e98ed2f5d6da39dc227089501f9734ec86
-  data.tar.gz: 370e8706b301323367dd9685be5ac5e5e8fcb7c47a73c06e6a337cf590db331c
+  metadata.gz: d1cdcf1754671326b02e939ec99c90c2cd8d696bdcbdc82c6c84b378e0365f3b
+  data.tar.gz: ad862bd65e1db50465ee1456ac18619abeb9f9f10dded487f335348f036b5d1c
 SHA512:
-  metadata.gz: e4ce44f0a435f65a9cbb3e69b185bcfe6939a7e4e44cb5ac687abeab7e2a7b83eb794b2407fae7fae34db152e5fd4b0332e65c01e895e851e5c2dc1a791d8a30
-  data.tar.gz: 585cd6b764cc4a42582b8f0eca28ec4569f8e5cb9b7175df15745aef4af1a0e5634803c4dfe06af4737e759ad8cc4d2ea9d992ef39f6fa21e0b1ee4e8bd57186
+  metadata.gz: f20cb497a1ba37843441cb244fb581ab26ad7181ea1310c4c8d1db75f243fdac3ea05c9ec0b460b1c9bfe23827cb46360885fb24fef8747879d57342d4ad28cd
+  data.tar.gz: 9e9493e65efff88e07b33c08f8c7886b7b42b45939d07afe904600c7a9036896255756bcb7a7451754482f03bd150feb89db052a4766e8716e9f230832ed4b61

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.
@@ -36,9 +40,9 @@ 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
@@ -49,7 +53,7 @@ end
 
 ## 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 +140,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:

data/lib/pg-locks-monitor.rb

@@ -10,7 +10,9 @@ module PgLocksMonitor
         limit: configuration.locks_limit,
       },
     ).select do |lock|
-      (ActiveSupport::Duration.parse(lock.fetch("age")).to_f * 1000) > configuration.locks_min_duration_ms
+      if (age = lock.fetch("age"))
+        (ActiveSupport::Duration.parse(age).to_f * 1000) > configuration.locks_min_duration_ms
+      end
     end
 
     if locks.present? && configuration.monitor_locks

data/lib/pg_locks_monitor/tasks/all.rake

@@ -16,7 +16,7 @@ namespace :pg_locks_monitor do
   end
 
   desc "Check for currently active locks"
-  task :snapshot do
+  task snapshot: :environment do
     PgLocksMonitor.snapshot!
   end
 end

data/lib/pg_locks_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-locks-monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 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