waterdrop 2.8.9 → 2.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d6b4d4ba3d3fe608324d53cf91c1d07278e810369ec9cf140520d9b065a30c1
-  data.tar.gz: b661659c9aa6facfe8eaf2b29eecd809937dbaf2b15557673c257e09f9a0f357
+  metadata.gz: 8ed8d57d7b79987870f918e97b3ffeee07c6c68b75a506bd11f29abe8778f21f
+  data.tar.gz: 86fe1bdb3d1963ef3783a254dbf0c7ae3ad61dc5608eeca5a41dcc2bbd454c1b
 SHA512:
-  metadata.gz: 6d4f5323e204d8c9d8ae2f0d1eea282b1096ed1c28554bb8e46038b08679c554ebae21b9a1c7546a8c2ad5db0ca1876a882318b04aab2b671973a012364e3276
-  data.tar.gz: 2a6b018f76dd052016352af3878d29522ea5a0d1c8fba1edfa453bfd084bdfa2a7e9e20ec57fd0bc8e6de0ea3117b200fd5450bde022a7e233dc5b5461da4455
+  metadata.gz: 22949a9ec65e4e6c0532ad469747989c4971de5320c705cf704371440b2d21b6edd83504eb77e56192ec0043c04334c91892813f3b1d01418e88d1f996064949
+  data.tar.gz: 9cecd0e2e56209d14eac2c896d9f2086973874de78e478e758404eb31d17e1b9abcf66e54011a1e9341dad215bac5de8fdafcc29ef38e0a6c8f43ca8eb82a301

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # WaterDrop changelog
 
+## 2.8.10 (2025-09-25)
+- [Enhancement] Add `#close` alias for `WaterDrop::ConnectionPool#shutdown` to align with producer API for consistent interface across both individual producers and connection pools.
+- [Enhancement] Add `WaterDrop.monitor` method as the preferred alias for `WaterDrop.instrumentation` to align with per-producer API naming convention. The `instrumentation` method remains available as a deprecated alias for backward compatibility.
+
 ## 2.8.9 (2025-09-23)
 - [Enhancement] Add connection pool lifecycle events to global instrumentation for improved observability. Events include `connection_pool.created`, `connection_pool.setup`, `connection_pool.shutdown`, `connection_pool.reload`, and `connection_pool.reloaded`.
 - [Enhancement] Add default connection pool transactional direct API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.8.9)
+    waterdrop (2.8.10)
       karafka-core (>= 2.4.9, < 3.0.0)
       karafka-rdkafka (>= 0.20.0)
       zeitwerk (~> 2.3)

data/lib/waterdrop/connection_pool.rb

@@ -126,6 +126,11 @@ module WaterDrop
         )
       end
 
+      # Alias for shutdown to align with producer API
+      # WaterDrop producers use #close, so we alias connection pool #shutdown to #close
+      # for API consistency across both individual producers and connection pools
+      alias close shutdown
+
       # Reload the global connection pool
       def reload
         return unless @default_pool
@@ -244,6 +249,11 @@ module WaterDrop
       )
     end
 
+    # Alias for shutdown to align with producer API
+    # WaterDrop producers use #close, so we alias connection pool #shutdown to #close
+    # for API consistency across both individual producers and connection pools
+    alias close shutdown
+
     # Reload all connections in the pool
     # Useful for configuration changes or error recovery
     def reload

data/lib/waterdrop/version.rb

@@ -3,5 +3,5 @@
 # WaterDrop library
 module WaterDrop
   # Current WaterDrop version
-  VERSION = '2.8.9'
+  VERSION = '2.8.10'
 end

data/lib/waterdrop.rb

@@ -17,7 +17,7 @@ module WaterDrop
       Pathname.new(File.expand_path('..', __dir__))
     end
 
-    # @return [WaterDrop::Instrumentation::ClassMonitor] global instrumentation monitor for
+    # @return [WaterDrop::Instrumentation::ClassMonitor] global monitor for
     #   class-level event subscriptions. This allows external libraries to subscribe to WaterDrop
     #   lifecycle events without needing producer instance references.
     #
@@ -25,13 +25,16 @@ module WaterDrop
     #   instance events
     #
     # @example Subscribe to producer creation events
-    #   WaterDrop.instrumentation.subscribe('producer.created') do |event|
+    #   WaterDrop.monitor.subscribe('producer.created') do |event|
     #     producer = event[:producer]
     #     # Configure producer or add middleware
     #   end
-    def instrumentation
+    def monitor
       @instrumentation ||= Instrumentation::ClassMonitor.new
     end
+
+    # @deprecated Use #monitor instead. This method is provided for backward compatibility only.
+    alias instrumentation monitor
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 2.8.9
+  version: 2.8.10
 platform: ruby
 authors:
 - Maciej Mensfeld