postgres-vacuum-monitor 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9e8b90692a2b1bbadc40202497aae4af9a3e088b8c5a47869396ba5d14e796
-  data.tar.gz: 7db2e649f6c350a613e6b765f0cf9fe4f10cae9a4b0aa05f47a585519a029ad3
+  metadata.gz: 4fdc95cbf83e6d6ea5fe51fa31fc1f42fbb5fa6ea3e3d514b7c7ec5f01f1c24c
+  data.tar.gz: 4b501cf4b4a06403ff4f97806062d0d343281fee0e05b9be5b2a869c1056b811
 SHA512:
-  metadata.gz: 7668c76a3666dfa35a70c26a923b2a9aebd1f0d1d96c3f4f5fe868dcba9c6f2ec4e15edcf1dbba07b17ab460b04d898c3468709e0dfd54532d6b503ca02f63f7
-  data.tar.gz: 284047bdc67471afda8abc017e377d3536de6e1593bfcc9993bc8ff16d5be562194b4f552f36ef150259c51b34571fcfc5b6ada56767da6fb2469d48c50aeca0
+  metadata.gz: a3f13ae2ee50cf641f96bb629d9e994f422b0642c0b59ec7852356e9c37bebc26685ea37ac037c3921b50fac5fae7c05719f6780c6d06c6103fb9bc15aba4d55
+  data.tar.gz: ccc2959571873fbec25bb9d70cd8c22346335081e685fc585db5a06df615e8192036e5da32629f6b44d1cbe3fb44dcc5160f4c1d66dbf595ccb8d3725cf6bec5

data/.circleci/config.yml

@@ -94,10 +94,11 @@ workflows:
           matrix:
             parameters:
               gemfile:
-                - "gemfiles/activerecord_6_1.gemfile"
-                - "gemfiles/activerecord_7_0.gemfile"
-                - "gemfiles/activerecord_7_1.gemfile"
+                - gemfiles/activerecord_6_1.gemfile
+                - gemfiles/activerecord_7_0.gemfile
+                - gemfiles/activerecord_7_1.gemfile
               ruby_version:
-                - "3.0.6"
-                - "3.1.4"
-                - "3.2.2"
+                - 3.0.6
+                - 3.1.4
+                - 3.2.2
+                - 3.3.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # postgres-vacuum-monitor
 
+## v0.17.0
+- Increased default `monitor_max_run_time_seconds` to 60 seconds.
+- Added `monitor_statement_timeout_seconds` (defaults to 10 seconds) to limit query runtime.
+- Eagerly clear connection pools when a `ActiveRecord::StatementInvalid` or `ActiveRecord::ConnectionTimeoutError`
+  is encountered to attempt to clear bad connections.
+
 ## v0.16.0
 - Add `max_attempts` and `max_run_time` to `Postgres::Vacuum::Jobs::MonitorJob` to avoid backing up the queue. The
   defaults are 1 attempt and 10 seconds, but they can be configured with `monitor_max_attempts` and

data/README.md

@@ -37,8 +37,10 @@ Postgres::Vacuum::Monitor.configure do |config|
   config.long_running_transaction_threshold_seconds = 10 * 60
   # Optionally change `max_attempts` of the monitor job (default 1)
   config.monitor_max_attempts = 3
-  # Optionally change `max_run_time` of the monitor job (default 10 seconds)
+  # Optionally change `max_run_time` of the monitor job (default 60 seconds)
   config.monitor_max_run_time_seconds = 5
+  # Optionally change the statement timeout of queries (default 10 seconds)
+  config.monitor_statement_timeout_seconds = 5
 end
 ```
 

data/Rakefile

@@ -2,7 +2,6 @@
 
 require 'bundler/gem_tasks'
 require 'bundler/setup'
-Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |task|

data/lib/postgres/vacuum/configuration.rb

@@ -4,19 +4,22 @@ module Postgres
   module Vacuum
     class Configuration
       DEFAULT_LONG_RUNNING_TRANSACTION_THRESHOLD_SECONDS = 5 * 60
-      DEFAULT_MONITOR_MAX_RUN_TIME_SECONDS = 10
+      DEFAULT_MONITOR_MAX_RUN_TIME_SECONDS = 60
       DEFAULT_MONITOR_MAX_ATTEMPTS = 1
+      DEFAULT_MONITOR_STATEMENT_TIMEOUT_SECONDS = 10
 
       attr_accessor :monitor_reporter_class_name,
                     :long_running_transaction_threshold_seconds,
                     :monitor_max_run_time_seconds,
-                    :monitor_max_attempts
+                    :monitor_max_attempts,
+                    :monitor_statement_timeout_seconds
 
       def initialize
         self.monitor_reporter_class_name = nil
         self.long_running_transaction_threshold_seconds = DEFAULT_LONG_RUNNING_TRANSACTION_THRESHOLD_SECONDS
         self.monitor_max_run_time_seconds = DEFAULT_MONITOR_MAX_RUN_TIME_SECONDS
         self.monitor_max_attempts = DEFAULT_MONITOR_MAX_ATTEMPTS
+        self.monitor_statement_timeout_seconds = DEFAULT_MONITOR_STATEMENT_TIMEOUT_SECONDS
       end
     end
   end

data/lib/postgres/vacuum/jobs/monitor_job.rb

@@ -98,14 +98,42 @@ module Postgres
           databases = Set.new
           ActiveRecord::Base.connection_handler.connection_pools.map do |connection_pool|
             db_name = connection_pool.db_config.configuration_hash[:database]
+            next unless databases.add?(db_name)
+
+            # ActiveRecord allocates a connection pool per call to `.establish_connection`
+            # As a result, multiple pools might interact with the same database, so we use
+            # the database name to dedupe.
+            connection_pool.with_connection do |connection|
+              original_timeout = statement_timeout(connection)
+              set_statement_timeout(connection, "#{configured_timeout_seconds}s")
+
+              yield(db_name, connection)
+            ensure
+              set_statement_timeout(connection, original_timeout)
+            end
 
-            # activerecord allocates a connection pool per call to establish_connection
-            # multiple pools might interact with the same database so we use the
-            # database name to dedup
-            connection_pool.with_connection { |conn| yield(db_name, conn) } if databases.add?(db_name)
+          # We want to avoid hanging onto a bad connection that would cause all future
+          # jobs to fail, so we eagerly clear the pool.
+          rescue ActiveRecord::StatementInvalid, ActiveRecord::ConnectionTimeoutError
+            connection_pool.disconnect!
+            raise
           end
         end
 
+        def statement_timeout(connection)
+          result = connection.execute('SHOW statement_timeout').first
+          result['statement_timeout'] if result.present?
+        end
+
+        def set_statement_timeout(connection, timeout)
+          query = ActiveRecord::Base.sanitize_sql(['SET statement_timeout = ?', timeout])
+          connection.execute(query)
+        end
+
+        def configured_timeout_seconds
+          Postgres::Vacuum::Monitor.configuration.monitor_statement_timeout_seconds
+        end
+
         ConfigurationError = Class.new(StandardError)
       end
     end

data/lib/postgres/vacuum/monitor/version.rb

@@ -3,7 +3,7 @@
 module Postgres
   module Vacuum
     module Monitor
-      VERSION = '0.16.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postgres-vacuum-monitor
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Fernando Garces
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal