gouda 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4b5340ec99f15fe7a62bc9a63642862219dc149d38d2e7e519f2ed655747e0
-  data.tar.gz: 817fe1a0ef4a2b107ad07ce28c3e627e79ffe3cf5fb1be06089165e07e432ec5
+  metadata.gz: 5b26bf19a2b7e37c30fe63354512873c56dc8784b97acf7b3f56bebc9358db71
+  data.tar.gz: cdeee22468899bfd3bcf8ff6914e1b8ff67a9a23f12c1613df51cce8c7b18393
 SHA512:
-  metadata.gz: 0aa57b5dedc0a7fe3126d965fe377ebb00dc8f407d7a01877886b57c2f35f45bd2c254d370949a65ec44f3704353b2741509ff099acc0c285aa752ab500805a1
-  data.tar.gz: 29f6d58da6179f0af817c541fdf9e0ca2fbf00fa83cab2d69c780a221761b26d08679a02419afbba93070d7d19babed436727a2cf994471fa94aabf7c359a7b8
+  metadata.gz: 59c31a696c8e64ba06af1f8b5eedaed7d9aec0dbc76130e6797bdd76badedf37f82a6a0c582686483b855211ed157ee25096689deb347cda44e4af896cf7b5dc
+  data.tar.gz: 8ed39bae53908ebfd1d6f48ad3fb99e0eef6c2cd922a9df4bc42e3a3e8059dfc8e996d240bc593cb5087025ae29d634c5f021997db67d9c63131bedac422abf2

data/CHANGELOG.md

@@ -52,3 +52,7 @@
 ## [0.1.11] - 2024-07-03
 
 - Fix: make sure the Gouda logger config does not get used during Rails initialization
+
+## [0.1.12] - 2024-07-03
+
+- When doing polling, suppress DEBUG-level messages. This will stop Gouda spamming the logs with SQL in dev/test environments.

data/lib/gouda/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gouda
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

data/lib/gouda/worker.rb

@@ -83,12 +83,13 @@ module Gouda
     end
 
     def call
-      # return false unless Rails.application # Rails is still booting and there is no application defined
-
       Gouda.config.app_executor.wrap do
-        Gouda::Workload.waiting_to_start(queue_constraint: @queue_constraint).none?
+        Gouda.suppressing_sql_logs { Gouda::Workload.waiting_to_start(queue_constraint: @queue_constraint).none? }
       end
-    rescue # If the DB connection cannot be checked out etc
+    rescue
+      # It is possible that in this scenario we do not have a database set up yet, for example,
+      # or we are unable to connect to the DB for whatever reason. In that case we should
+      # return `false` so that the worker can poll again later.
       false
     end
   end
@@ -158,13 +159,14 @@ module Gouda
         # a stale timestamp can indicate to us that the job was orphaned and is marked as "executing"
         # even though the worker it was running on has failed for whatever reason.
         # Later on we can figure out what to do with those jobs (re-enqueue them or toss them)
-        Gouda::Workload.where(id: executing_workload_ids.to_a, state: "executing").update_all(executing_on: worker_id, last_execution_heartbeat_at: Time.now.utc)
+        Gouda.suppressing_sql_logs do # these updates will also be very frequent with long-running jobs
+          Gouda::Workload.where(id: executing_workload_ids.to_a, state: "executing").update_all(executing_on: worker_id, last_execution_heartbeat_at: Time.now.utc)
+        end
 
         # Find jobs which just hung and clean them up (mark them as "finished" and enqueue replacement workloads if possible)
         Gouda::Workload.reap_zombie_workloads
       rescue => e
         Gouda.instrument(:exception, {exception: e})
-
         warn "Uncaught exception during housekeeping (#{e.class} - #{e}"
       end
 

data/lib/gouda/workload.rb

@@ -115,9 +115,9 @@ class Gouda::Workload < ActiveRecord::Base
       payload[:retried_checkouts_due_to_concurrent_exec] = 0
       uncached do # Necessary because we SELECT with a clock_timestamp() which otherwise gets cached by ActiveRecord query cache
         transaction do
-          jobs.first.tap do |job|
-            job&.update!(state: "executing", executing_on: executing_on, last_execution_heartbeat_at: Time.now.utc, execution_started_at: Time.now.utc)
-          end
+          job = Gouda.suppressing_sql_logs { jobs.first } # Silence SQL output as this gets called very frequently
+          job&.update!(state: "executing", executing_on: executing_on, last_execution_heartbeat_at: Time.now.utc, execution_started_at: Time.now.utc)
+          job
         rescue ActiveRecord::RecordNotUnique
           # It can happen that due to a race the `execution_concurrency_key NOT IN` does not capture
           # a job which _just_ entered the "executing" state, apparently after we do our SELECT. This will happen regardless

data/lib/gouda.rb

@@ -81,6 +81,20 @@ module Gouda
     Rails.try(:logger) || ActiveJob::Base.try(:logger) || @fallback_gouda_logger
   end
 
+  def self.suppressing_sql_logs(&blk)
+    # This is used for frequently-called methods that poll the DB. If logging is done at a low level (DEBUG)
+    # those methods print a lot of SQL into the logs, on every poll. While that is useful if
+    # you collect SQL queries from the logs, in most cases - especially if this is used
+    # in a side-thread inside Puma - the output might be quite annoying. So silence the
+    # logger when we poll, but just to INFO. Omitting DEBUG-level messages gets rid of the SQL.
+    if Gouda::Workload.logger
+      Gouda::Workload.logger.silence(Logger::INFO, &blk)
+    else
+      # In tests (and at earlier stages of the Rails boot cycle) the global ActiveRecord logger may be nil
+      yield
+    end
+  end
+
   def self.instrument(channel, options, &block)
     ActiveSupport::Notifications.instrument("#{channel}.gouda", options, &block)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gouda
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Sebastian van Hesteren