redis_queued_locks 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7924e5055147fe7c2e0ff65e59ca7e82dc0ae81ce2c880cced9c914307fb1821
-  data.tar.gz: e6921c3d151ae3d227ad130989562f96266954c47c8358ecd82f76afc922c362
+  metadata.gz: 5d3c20255c1b685b5f7fbb2d9441808cb6e8522e231e9eafa84dac0b7a968a9c
+  data.tar.gz: d1dd021fa7b303f1066fc942cd1a8df70869585b80ca8a88bb1e5c69de364192
 SHA512:
-  metadata.gz: e0b1deaefb5638a96392c759a903661ad3175e45b128e605f0939889c56974c6f6ea2f887884a883fcd8843aec5423bd384a7c8d24644a42ff4e0c6737e0340e
-  data.tar.gz: ffaea4bd5b9c57802b99c754e2defb6e16ad9cff3e82855b4a8e6e3f93538ba648dbc84f3cd85200017f47bbc9f4d26a7bbb5d910776c79b19adbc02e5a002ed
+  metadata.gz: e3671472cd833f8a53f10f2bb2a7ae5dcb29f3d48edae159b72e50db25c7a63d80c7e062663fcffb5512001e8198a2aebdec9e8f36414b13785684b762309905
+  data.tar.gz: cf5ede3990749e71137e9c12a63a6f588595db40d4971f76f0fedeb0c72d0343a7c7df14d26952e1a0eeb467de509115d6bbfe723628403e6321a549252d0a1a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.15.0] - 2025-10-17
+### Changed
+- `"redis_queud_locks.release_locks_of"` instrumentation event payload now includes `hst_id` and `acq_id`;
+
 ## [1.14.0] - 2025-10-17
 ### Added
 - `#clear_locks_of`/`#release_locks_of`
@@ -271,17 +275,17 @@
 
 ## [0.0.31] - 2024-03-25
 ### Changed
-- `:metadata` renamed to `:instrument` in order to reflect it's domain area;
+- `:metadata` renamed to `:instrument` in order to reflect its domain area;
 - `:metadata` is renamed to `:meta` and reserved for future updates;
 
 ## [0.0.30] - 2024-03-23
 ### Fixed
 - Re-enqueue problem: fixed a problem when the expired lock requests were infinitly re-added to the lock queue
   and immediately removed from the lock queue rather than being re-positioned. It happens when the lock request
-  ttl reached the queue ttl, and the new request now had the dead score forever (fix: it's score now will be correctly
+  ttl reached the queue ttl, and the new request now had the dead score forever (fix: its score now will be correctly
   recalculated from the current time at the dead score time moment);
 ### Added
-- Logging: more detailed logs to the `RedisQueuedLocks::Acquier::AcquierLock` logic and it's sub-modules:
+- Logging: more detailed logs to the `RedisQueuedLocks::Acquier::AcquierLock` logic and its sub-modules:
   - added new logs;
   - added `queue_ttl` to each log;
 

data/README.md

@@ -104,7 +104,7 @@ Provides flexible invocation flow, parametrized limits (lock request ttl, lock t
 
 <sup>\[[back to top](#table-of-contents)\]</sup>
 
-> Each lock request is put into the request queue (each lock is hosted by it's own queue separately from other queues) and processed in order of their priority (FIFO). Each lock request lives some period of time (RTTL) which guarantees that the request queue will never be stacked.
+> Each lock request is put into the request queue (each lock is hosted by its own queue separately from other queues) and processed in order of their priority (FIFO). Each lock request lives some period of time (RTTL) which guarantees that the request queue will never be stacked.
 
 > In addition to the classic "queued" (FIFO) strategy RQL supports "random" (RANDOM) lock obtaining strategy when any acquirer from the lock queue can obtain the lock regardless the position in the queue.
 
@@ -577,8 +577,8 @@ def lock(
   - `false` by default;
 - `block` - (optional) `[Block]`
   - A block of code that should be executed after the successfully acquired lock.
-  - If block is **passed** the obtained lock will be released after the block execution or it's ttl (what will happen first);
-  - If block is **not passed** the obtained lock will be released after it's ttl;
+  - If block is **passed** the obtained lock will be released after the block execution or its ttl (what will happen first);
+  - If block is **not passed** the obtained lock will be released after its ttl;
   - If you want the block to have a TTL too and this TTL to be the same as TTL of the lock
     use `timed: true` option (`rql.lock("my_lock", timed: true, ttl: 5_000) { ... }`)
 
@@ -722,7 +722,7 @@ rql.lock_info("my_lock")
 
 - (`:queue_ttl`) setting a short limit of time to the lock request queue position (if a process fails to acquire
   the lock within this period of time (and before timeout/retry_count limits occurs of course) -
-  it's lock request will be moved to the end of queue):
+  its lock request will be moved to the end of queue):
 
 ```ruby
 rql.lock("my_lock", queue_ttl: 5, timeout: 10_000, retry_count: nil)
@@ -1596,7 +1596,7 @@ Accepts:
 - `:dead_ttl` - (optional) `[Integer]`
   - lock request ttl after which a lock request is considered dead;
   - has a preconfigured value in `config['dead_request_ttl']` (1 day by default);
-- `:sacn_size` - (optional) `[Integer]`
+- `:scan_size` - (optional) `[Integer]`
   - the batch of scanned keys for Redis'es SCAN command;
   - has a preconfigured valie in `config['lock_release_batch_size']`;
 - `:logger` - (optional) `[::Logger,#debug]`
@@ -2286,13 +2286,15 @@ Detalized event semantics and payload structure:
 
 ##### `"redis_queued_locks.release_locks_of"`
 - <sup>\[[back to the list](#instrumentation-events)\]</sup>
-- an event signalizes about the released locks of the cocnrete host and acquirer;
+- an event signalizes about the released locks (and removement from lock queues) of the concrete host and acquirer;
 - raised from `#clear_locks_of` and `#clear_current_locks` (`#release_locks_of` and `#release_current_locks` respectively);
 - payload:
   - `:rel_time` - `float`/`milliseconds` - time spent on "release locks of" operation;
   - `:at` - `float`/`epoch` - the time when the opertaion has ended; 
+  - `:acq_id` - `string` - refused acquirer identifier;
+  - `:hst_id` - `string` - refused host identifier;
   - `:rel_key_cnt` - `integer` - released locks count;
-  - `:tch_queue_cnt` - `:integer` - the number of queues from which the cocnrete host/acquirer was removed;
+  - `:tch_queue_cnt` - `:integer` - the number of queues from which the concrete host/acquirer was removed;
 
 ---
 
@@ -2355,7 +2357,7 @@ Detalized event semantics and payload structure:
   - `unlock_on:`-option in lock/lock! logic in order to support auto-unlocking on any exception rasaied under the invoked block (invoked under the lock);
   - **Research**: support for `Valkey` database backend (https://github.com/valkey-io/valkey) (https://valkey.io/);
   - **Research**: support for `Garnet` database backend (https://microsoft.github.io/) (https://github.com/microsoft/garnet);
-  - add a library-level exception, when RQL-related key in Redis (required for it's logic) has incompatible type (means: some other program uses our key with their own type and logic and RQL can't work properly);
+  - add a library-level exception, when RQL-related key in Redis (required for its logic) has incompatible type (means: some other program uses our key with their own type and logic and RQL can't work properly);
 ---
 
 ## Build and Develop

data/github_ci/ruby3.3.gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: ..
   specs:
-    redis_queued_locks (1.13.0)
+    redis_queued_locks (1.15.0)
       redis-client (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.2)
+    activesupport (8.0.3)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -34,10 +34,10 @@ GEM
     ast (2.4.3)
     base64 (0.3.0)
     benchmark (0.4.1)
-    bigdecimal (3.2.1)
+    bigdecimal (3.3.1)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
+    connection_pool (2.5.4)
     csv (3.3.5)
     diff-lcs (1.6.2)
     docile (1.4.1)
@@ -56,7 +56,7 @@ GEM
     fileutils (1.7.3)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.12.2)
+    json (2.15.1)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     listen (3.9.0)
@@ -64,43 +64,43 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     method_source (1.1.0)
-    minitest (5.25.5)
+    minitest (5.26.0)
     mutex_m (0.3.0)
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
+    prism (1.6.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.8.1)
-    rack (3.1.15)
+    rack (3.2.3)
     rainbow (3.1.1)
     rake (13.3.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rbs (3.9.4)
+    rbs (3.9.5)
       logger
-    redis-client (0.24.0)
+    redis-client (0.26.1)
       connection_pool
-    regexp_parser (2.10.0)
+    regexp_parser (2.11.3)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.4)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
+    rspec-mocks (3.13.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-retry (0.6.2)
       rspec-core (> 3.3)
-    rspec-support (3.13.4)
+    rspec-support (3.13.6)
     rubocop (1.75.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -112,7 +112,7 @@ GEM
       rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-capybara (2.22.1)
@@ -155,8 +155,8 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
-    simplecov-lcov (0.8.0)
+    simplecov-html (0.13.2)
+    simplecov-lcov (0.9.0)
     simplecov_json_formatter (0.1.4)
     steep (1.10.0)
       activesupport (>= 5.1)
@@ -180,10 +180,10 @@ GEM
       unicode-display_width (>= 1.1.1, < 4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.0.4)
     zlib (3.2.1)
 
 PLATFORMS
@@ -214,4 +214,4 @@ DEPENDENCIES
   steep
 
 BUNDLED WITH
-   2.6.9
+   2.7.2

data/lib/redis_queued_locks/acquirer/release_locks_of.rb

@@ -73,10 +73,18 @@ module RedisQueuedLocks::Acquirer::ReleaseLocksOf
     #     despite the enabled instrumentation sampling;
     #   - makes sense when instrumentation sampling is enabled;
     # @return [Hash<Symbol,Any>]
-    #   Format: { ok: true, result: Hash<Symbol,Numeric> }
+    #   Format: {
+    #     ok: true,
+    #     result: {
+    #       rel_key_cnt: Integer,
+    #       tch_queue_cnt: Integer,
+    #       rel_time: Numeric
+    #     }
+    #   }
     #
     # @api private
     # @since 1.14.0
+    # @version 1.15.0
     # rubocop:disable Metrics/MethodLength
     def release_locks_of(
       refused_host_id,
@@ -125,6 +133,8 @@ module RedisQueuedLocks::Acquirer::ReleaseLocksOf
       run_non_critical do
         instrumenter.notify('redis_queued_locks.release_locks_of', {
           at: time_at,
+          hst_id: refused_host_id,
+          acq_id: refused_acquirer_id,
           rel_time: rel_time,
           rel_key_cnt: result[:rel_key_cnt],
           tch_queue_cnt: result[:tch_queue_cnt]

data/lib/redis_queued_locks/swarm.rb

@@ -158,7 +158,7 @@ class RedisQueuedLocks::Swarm
   end
 
   # @option zombie_ttl [Integer]
-  # @option lock_sacn_size [Integer]
+  # @option lock_scan_size [Integer]
   # @return [Hash<Symbol,Set<String>>]
   #
   # @api public

data/lib/redis_queued_locks/version.rb

@@ -5,6 +5,6 @@ module RedisQueuedLocks
   #
   # @api public
   # @since 0.0.1
-  # @version 1.14.0
-  VERSION = '1.14.0'
+  # @version 1.15.0
+  VERSION = '1.15.0'
 end

data/redis_queued_locks.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
     "|> Distributed locks with \"prioritized lock acquisition queue\" capabilities " \
     "based on the Redis Database.\n" \
     "|> Each lock request is put into the request queue " \
-    "(each lock is hosted by it's own queue separately from other queues) and processed " \
+    "(each lock is hosted by its own queue separately from other queues) and processed " \
     "in order of their priority (FIFO).\n" \
     "|> Each lock request lives some period of time (RTTL) " \
     "(with requeue capabilities) which guarantees the request queue will never be stacked.\n" \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Rustam Ibragimov
@@ -25,7 +25,7 @@ dependencies:
         version: '0.20'
 description: |-
   |> Distributed locks with "prioritized lock acquisition queue" capabilities based on the Redis Database.
-  |> Each lock request is put into the request queue (each lock is hosted by it's own queue separately from other queues) and processed in order of their priority (FIFO).
+  |> Each lock request is put into the request queue (each lock is hosted by its own queue separately from other queues) and processed in order of their priority (FIFO).
   |> Each lock request lives some period of time (RTTL) (with requeue capabilities) which guarantees the request queue will never be stacked.
   |> In addition to the classic `queued` (FIFO) strategy RQL supports `random` (RANDOM) lock obtaining strategy when any acquirer from the lock queue can obtain the lock regardless the position in the queue.
   |> Provides flexible invocation flow, parametrized limits (lock request ttl, lock ttl, queue ttl, lock attempts limit, fast failing, etc), logging and instrumentation.