redis_queued_locks 1.5.0 → 1.7.0

data/lib/redis_queued_locks/acquier/acquire_lock/instr_visitor.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 1.7.0
+module RedisQueuedLocks::Acquier::AcquireLock::InstrVisitor
+  extend self
+
+  # @param instrumenter [#notify]
+  # @param instr_sampled [Boolean]
+  # @param lock_key [String]
+  # @param ttl [Integer, NilClass]
+  # @param acq_id [String]
+  # @param ts [Numeric]
+  # @param acq_time [Numeric]
+  # @param instrument [NilClass,Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def extendable_reentrant_lock_obtained(
+    instrumenter,
+    instr_sampled,
+    lock_key,
+    ttl,
+    acq_id,
+    ts,
+    acq_time,
+    instrument
+  )
+    return unless instr_sampled
+    instrumenter.notify('redis_queued_locks.extendable_reentrant_lock_obtained', {
+      lock_key:, ttl:, acq_id:, ts:, acq_time:, instrument:
+    }) rescue nil
+  end
+
+  # @param instrumenter [#notify]
+  # @param instr_sampled [Boolean]
+  # @param lock_key [String]
+  # @param ttl [Integer, NilClass]
+  # @param acq_id [String]
+  # @param ts [Numeric]
+  # @param acq_time [Numeric]
+  # @param instrument [NilClass,Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def reentrant_lock_obtained(
+    instrumenter,
+    instr_sampled,
+    lock_key,
+    ttl,
+    acq_id,
+    ts,
+    acq_time,
+    instrument
+  )
+    return unless instr_sampled
+    instrumenter.notify('redis_queued_locks.reentrant_lock_obtained', {
+      lock_key:, ttl:, acq_id:, ts:, acq_time:, instrument:
+    }) rescue nil
+  end
+
+  # @param instrumenter [#notify]
+  # @param instr_sampled [Boolean]
+  # @param lock_key [String]
+  # @param ttl [Integer, NilClass]
+  # @param acq_id [String]
+  # @param ts [Numeric]
+  # @param acq_time [Numeric]
+  # @param instrument [NilClass,Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def lock_obtained(
+    instrumenter,
+    instr_sampled,
+    lock_key,
+    ttl,
+    acq_id,
+    ts,
+    acq_time,
+    instrument
+  )
+    return unless instr_sampled
+    instrumenter.notify('redis_queued_locks.lock_obtained', {
+      lock_key:, ttl:, acq_id:, ts:, acq_time:, instrument:
+    }) rescue nil
+  end
+
+  # @param instrumenter [#notify]
+  # @param instr_sampled [Boolean]
+  # @param lock_key [String]
+  # @param ttl [Integer, NilClass]
+  # @param acq_id [String]
+  # @param ts [Numeric]
+  # @param acq_time [Numeric]
+  # @param hold_time [Numeric]
+  # @param instrument [NilClass,Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def reentrant_lock_hold_completes(
+    instrumenter,
+    instr_sampled,
+    lock_key,
+    ttl,
+    acq_id,
+    ts,
+    acq_time,
+    hold_time,
+    instrument
+  )
+    return unless instr_sampled
+    instrumenter.notify('redis_queued_locks.reentrant_lock_hold_completes', {
+      hold_time:, ttl:, acq_id:, ts:, lock_key:, acq_time:, instrument:
+    }) rescue nil
+  end
+
+  # @param instrumenter [#notify]
+  # @param instr_sampled [Boolean]
+  # @param lock_key [String]
+  # @param ttl [Integer, NilClass]
+  # @param acq_id [String]
+  # @param ts [Numeric]
+  # @param acq_time [Numeric]
+  # @param hold_time [Numeric]
+  # @param instrument [NilClass,Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def lock_hold_and_release(
+    instrumenter,
+    instr_sampled,
+    lock_key,
+    ttl,
+    acq_id,
+    ts,
+    acq_time,
+    hold_time,
+    instrument
+  )
+    return unless instr_sampled
+    instrumenter.notify('redis_queued_locks.lock_hold_and_release', {
+      hold_time:, ttl:, acq_id:, ts:, lock_key:, acq_time:, instrument:
+    }) rescue nil
+  end
+end

data/lib/redis_queued_locks/acquier/acquire_lock/log_visitor.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 1.7.0
+# rubocop:disable Metrics/ModuleLength
+module RedisQueuedLocks::Acquier::AcquireLock::LogVisitor
+  extend self
+
+  # @param logger [::Logger,#debug]
+  # @param log_sampled [Boolean]
+  # @param lock_key [String]
+  # @param queue_ttl [Integer]
+  # @param acquier_id [String]
+  # @param access_strategy [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def start_lock_obtaining(
+    logger,
+    log_sampled,
+    lock_key,
+    queue_ttl,
+    acquier_id,
+    access_strategy
+  )
+    return unless log_sampled
+
+    logger.debug do
+      "[redis_queued_locks.start_lock_obtaining] " \
+      "lock_key => '#{lock_key}' " \
+      "queue_ttl => #{queue_ttl} " \
+      "acq_id => '#{acquier_id}' " \
+      "acs_strat => '#{access_strategy}'"
+    end rescue nil
+  end
+
+  # @param logger [::Logger,#debug]
+  # @param log_sampled [Boolean]
+  # @param lock_key [String]
+  # @param queue_ttl [Integer]
+  # @param acquier_id [String]
+  # @param access_strategy [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def start_try_to_lock_cycle(
+    logger,
+    log_sampled,
+    lock_key,
+    queue_ttl,
+    acquier_id,
+    access_strategy
+  )
+    return unless log_sampled
+
+    logger.debug do
+      "[redis_queued_locks.start_try_to_lock_cycle] " \
+      "lock_key => '#{lock_key}' " \
+      "queue_ttl => #{queue_ttl} " \
+      "acq_id => '#{acquier_id}' " \
+      "acs_strat => '#{access_strategy}'"
+    end rescue nil
+  end
+
+  # @param logger [::Logger,#debug]
+  # @param log_sampled [Boolean]
+  # @param lock_key [String]
+  # @param queue_ttl [Integer]
+  # @param acquier_id [String]
+  # @param access_strategy [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def dead_score_reached__reset_acquier_position(
+    logger,
+    log_sampled,
+    lock_key,
+    queue_ttl,
+    acquier_id,
+    access_strategy
+  )
+    return unless log_sampled
+
+    logger.debug do
+      "[redis_queued_locks.dead_score_reached__reset_acquier_position] " \
+      "lock_key => '#{lock_key}' " \
+      "queue_ttl => #{queue_ttl} " \
+      "acq_id => '#{acquier_id}' " \
+      "acs_strat => '#{access_strategy}'"
+    end rescue nil
+  end
+
+  # @param logger [::Logger,#debug]
+  # @param log_sampled [Boolean]
+  # @param lock_key [String]
+  # @param queue_ttl [Integer]
+  # @param acquier_id [String]
+  # @param acq_time [Numeric]
+  # @param access_strategy [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def extendable_reentrant_lock_obtained(
+    logger,
+    log_sampled,
+    lock_key,
+    queue_ttl,
+    acquier_id,
+    acq_time,
+    access_strategy
+  )
+    return unless log_sampled
+
+    logger.debug do
+      "[redis_queued_locks.extendable_reentrant_lock_obtained] " \
+      "lock_key => '#{lock_key}' " \
+      "queue_ttl => #{queue_ttl} " \
+      "acq_id => '#{acquier_id}' " \
+      "acs_strat => '#{access_strategy}' " \
+      "acq_time => #{acq_time} (ms)"
+    end rescue nil
+  end
+
+  # @param logger [::Logger,#debug]
+  # @param log_sampled [Boolean]
+  # @param lock_key [String]
+  # @param queue_ttl [Integer]
+  # @param acquier_id [String]
+  # @param acq_time [Numeric]
+  # @param access_strategy [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def reentrant_lock_obtained(
+    logger,
+    log_sampled,
+    lock_key,
+    queue_ttl,
+    acquier_id,
+    acq_time,
+    access_strategy
+  )
+    return unless log_sampled
+
+    logger.debug do
+      "[redis_queued_locks.reentrant_lock_obtained] " \
+      "lock_key => '#{lock_key}' " \
+      "queue_ttl => #{queue_ttl} " \
+      "acq_id => '#{acquier_id}' " \
+      "acs_strat => '#{access_strategy}' " \
+      "acq_time => #{acq_time} (ms)"
+    end rescue nil
+  end
+
+  # @param logger [::Logger,#debug]
+  # @param log_sampled [Boolean]
+  # @param lock_key [String]
+  # @param queue_ttl [Integer]
+  # @param acquier_id [String]
+  # @param acq_time [Numeric]
+  # @param access_strategy [Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 1.7.0
+  def lock_obtained(
+    logger,
+    log_sampled,
+    lock_key,
+    queue_ttl,
+    acquier_id,
+    acq_time,
+    access_strategy
+  )
+    return unless log_sampled
+
+    logger.debug do
+      "[redis_queued_locks.lock_obtained] " \
+      "lock_key => '#{lock_key}' " \
+      "queue_ttl => #{queue_ttl} " \
+      "acq_id => '#{acquier_id}' " \
+      "acs_strat => '#{access_strategy}' " \
+      "acq_time => #{acq_time} (ms)"
+    end rescue nil
+  end
+end
+# rubocop:enable Metrics/ModuleLength