waterdrop 2.4.8 → 2.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fab3f2b565a128bcc34f8d8bd10b36b0bd9546d1c52109a97ad87449fcd1731
-  data.tar.gz: 891f381590986451b330f74ac0ab56e6d2873d84a778d33bf470db1fe5e8447d
+  metadata.gz: 1ea085fa5ca2adea3def9f04dc8ec1d228aea2cb073ec9b41dc10efd08f2fcc4
+  data.tar.gz: b830060cefaf8fef9e5aa68c52534300146f05eb17f151ef720eaad934208bdc
 SHA512:
-  metadata.gz: de29a31f2d498bfd04577ddd7edec90603d1226bc9b355d3e65e62fae0e2cb0f89bc5708a0734425df0fc5458adcb01e5b59775fda3daaceab1de586b41ed07d
-  data.tar.gz: 052ea95a7c819c42ba62c1275b4895cf9b034e429ef34af0d4556965dd28cd0a9307a0a5613f3a126b4e41da6b0cfe8042e3f614045929203faca67c496d4352
+  metadata.gz: 5ab0511f78ef3f1abc12c85334880df782e375ff23a14a2304b97ec78beea81a04659ec17b60a135f1e94e545463531b9202ebbc59c0273d7094b7d40b64c9a4
+  data.tar.gz: c1a94e01292ff4a4d4e18ae7d88714b71d68f2e36cec9dd497087d0f359e65b9a94b77d66977e3a4e233152ae657bb0d83b1421fe0409e52d419efe3e163b813

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # WaterDrop changelog
 
+## 2.4.10 (2023-01-30)
+- Include `caller` in the error instrumentation to align with Karafka.
+
+## 2.4.9 (2023-01-11)
+- Remove empty debug logging out of `LoggerListener`.
+- Do not lock Ruby version in Karafka in favour of `karafka-core`.
+- Make sure `karafka-core` version is at least `2.0.9` to make sure we run `karafka-rdkafka`.
+
 ## 2.4.8 (2023-01-07)
 - Use monotonic time from Karafka core.
 

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.4.8)
-      karafka-core (>= 2.0.8, < 3.0.0)
+    waterdrop (2.4.10)
+      karafka-core (>= 2.0.9, < 3.0.0)
       zeitwerk (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     byebug (11.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
     factory_bot (6.2.1)
@@ -22,26 +22,26 @@ GEM
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    karafka-core (2.0.8)
+    karafka-core (2.0.9)
       concurrent-ruby (>= 1.1)
-      rdkafka (>= 0.12)
-    mini_portile2 (2.8.1)
-    minitest (5.17.0)
-    rake (13.0.6)
-    rdkafka (0.12.0)
+      karafka-rdkafka (>= 0.12)
+    karafka-rdkafka (0.12.0)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
+    mini_portile2 (2.8.1)
+    minitest (5.17.0)
+    rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
@@ -51,12 +51,12 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     zeitwerk (2.6.6)
 
 PLATFORMS
-  arm64-darwin
+  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -67,4 +67,4 @@ DEPENDENCIES
   waterdrop!
 
 BUNDLED WITH
-   2.4.2
+   2.4.5

data/README.md

@@ -33,6 +33,7 @@ It:
 - [Instrumentation](#instrumentation)
   * [Usage statistics](#usage-statistics)
   * [Error notifications](#error-notifications)
+  * [Acknowledgment notifications](#acknowledgment-notifications)
   * [Datadog and StatsD integration](#datadog-and-statsd-integration)
   * [Forking and potential memory problems](#forking-and-potential-memory-problems)
 - [Middleware](#middleware)
@@ -89,6 +90,8 @@ end
 
 ### WaterDrop configuration options
 
+Some of the options are:
+
 | Option             | Description                                                     |
 |--------------------|-----------------------------------------------------------------|
 | `id`               | id of the producer for instrumentation and logging              |
@@ -97,6 +100,8 @@ end
 | `max_wait_timeout` | Waits that long for the delivery report or raises an error      |
 | `wait_timeout`     | Waits that long before re-check of delivery report availability |
 
+Full list of the root configuration options is available [here](https://github.com/karafka/waterdrop/blob/master/lib/waterdrop/config.rb#L25).
+
 ### Kafka configuration options
 
 You can create producers with different `kafka` settings. Documentation of the available configuration options is available on https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md.
@@ -352,6 +357,65 @@ producer.close
 
 Note: The metrics returned may not be completely consistent between brokers, toppars and totals, due to the internal asynchronous nature of librdkafka. E.g., the top level tx total may be less than the sum of the broker tx values which it represents.
 
+### Error notifications
+
+WaterDrop allows you to listen to all errors that occur while producing messages and in its internal background threads. Things like reconnecting to Kafka upon network errors and others unrelated to publishing messages are all available under `error.occurred` notification key. You can subscribe to this event to ensure your setup is healthy and without any problems that would otherwise go unnoticed as long as messages are delivered.
+
+```ruby
+producer = WaterDrop::Producer.new do |config|
+  # Note invalid connection port...
+  config.kafka = { 'bootstrap.servers': 'localhost:9090' }
+end
+
+producer.monitor.subscribe('error.occurred') do |event|
+  error = event[:error]
+
+  p "WaterDrop error occurred: #{error}"
+end
+
+# Run this code without Kafka cluster
+loop do
+  producer.produce_async(topic: 'events', payload: 'data')
+
+  sleep(1)
+end
+
+# After you stop your Kafka cluster, you will see a lot of those:
+#
+# WaterDrop error occurred: Local: Broker transport failure (transport)
+#
+# WaterDrop error occurred: Local: Broker transport failure (transport)
+```
+
+### Acknowledgment notifications
+
+WaterDrop allows you to listen to Kafka messages' acknowledgment events. This will enable you to monitor deliveries of messages from WaterDrop even when using asynchronous dispatch methods.
+
+That way, you can make sure, that dispatched messages are acknowledged by Kafka.
+
+```ruby
+producer = WaterDrop::Producer.new do |config|
+  config.kafka = { 'bootstrap.servers': 'localhost:9092' }
+end
+
+producer.monitor.subscribe('message.acknowledged') do |event|
+  producer_id = event[:producer_id]
+  offset = event[:offset]
+
+  p "WaterDrop [#{producer_id}] delivered message with offset: #{offset}"
+end
+
+loop do
+  producer.produce_async(topic: 'events', payload: 'data')
+
+  sleep(1)
+end
+
+# WaterDrop [dd8236fff672] delivered message with offset: 32
+# WaterDrop [dd8236fff672] delivered message with offset: 33
+# WaterDrop [dd8236fff672] delivered message with offset: 34
+```
+
 ### Datadog and StatsD integration
 
 WaterDrop comes with (optional) full Datadog and StatsD integration that you can use. To use it:
@@ -385,36 +449,6 @@ You can also find [here](https://github.com/karafka/waterdrop/blob/master/lib/wa
 
 ![Example WaterDrop DD dashboard](https://raw.githubusercontent.com/karafka/misc/master/printscreens/waterdrop_dd_dashboard_example.png)
 
-### Error notifications
-
-WaterDrop allows you to listen to all errors that occur while producing messages and in its internal background threads. Things like reconnecting to Kafka upon network errors and others unrelated to publishing messages are all available under `error.occurred` notification key. You can subscribe to this event to ensure your setup is healthy and without any problems that would otherwise go unnoticed as long as messages are delivered.
-
-```ruby
-producer = WaterDrop::Producer.new do |config|
-  # Note invalid connection port...
-  config.kafka = { 'bootstrap.servers': 'localhost:9090' }
-end
-
-producer.monitor.subscribe('error.occurred') do |event|
-  error = event[:error]
-
-  p "WaterDrop error occurred: #{error}"
-end
-
-# Run this code without Kafka cluster
-loop do
-  producer.produce_async(topic: 'events', payload: 'data')
-
-  sleep(1)
-end
-
-# After you stop your Kafka cluster, you will see a lot of those:
-#
-# WaterDrop error occurred: Local: Broker transport failure (transport)
-#
-# WaterDrop error occurred: Local: Broker transport failure (transport)
-```
-
 ### Forking and potential memory problems
 
 If you work with forked processes, make sure you **don't** use the producer before the fork. You can easily configure the producer and then fork and use it.

data/lib/waterdrop/instrumentation/callbacks/error.rb

@@ -25,6 +25,7 @@ module WaterDrop
 
           @monitor.instrument(
             'error.occurred',
+            caller: self,
             error: error,
             producer_id: @producer_id,
             type: 'librdkafka.error'

data/lib/waterdrop/instrumentation/logger_listener.rb

@@ -82,7 +82,6 @@ module WaterDrop
       # @param event [Dry::Events::Event] event that happened with the details
       def on_producer_closed(event)
         info event, 'Closing producer'
-        debug event, ''
       end
 
       # @param event [Dry::Events::Event] event that happened with the error details
@@ -91,7 +90,6 @@ module WaterDrop
         type = event[:type]
 
         error(event, "Error occurred: #{error} - #{type}")
-        debug(event, '')
       end
 
       private

data/lib/waterdrop/producer/buffer.rb

@@ -110,6 +110,7 @@ module WaterDrop
       rescue *RESCUED_ERRORS => e
         @monitor.instrument(
           'error.occurred',
+          caller: self,
           error: e,
           producer_id: id,
           dispatched: dispatched,

data/lib/waterdrop/version.rb

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

data/waterdrop.gemspec

@@ -16,11 +16,9 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.license       = 'MIT'
 
-  spec.add_dependency 'karafka-core', '>= 2.0.8', '< 3.0.0'
+  spec.add_dependency 'karafka-core', '>= 2.0.9', '< 3.0.0'
   spec.add_dependency 'zeitwerk', '~> 2.3'
 
-  spec.required_ruby_version = '>= 2.7'
-
   if $PROGRAM_NAME.end_with?('gem')
     spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 2.4.8
+  version: 2.4.10
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-01-07 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka-core
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.8
+        version: 2.0.9
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -53,7 +53,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.8
+        version: 2.0.9
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -135,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="