waterdrop 2.0.7 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 261d7b8295e2e1b3a6b9658d4409dc58ff8c336e8e5d6064e80d92c8e3215bbe
-  data.tar.gz: f67bad60fe2cd37ac1658533ceec0daa1ec9ab527bb022da7f1cc40ccde89088
+  metadata.gz: 5a4c3c32e28e4581626a6cf8a10c5dc3aa2dcb72cb3f2517977353c8b6cc4248
+  data.tar.gz: 8d23eb9276f9d5b2138d69542a79403a1a110bd0c02b45e9d11c9e94b7d62fab
 SHA512:
-  metadata.gz: e0529057c22d4b76c61f788f038e8fb024785aa3a2c89c266cfe2b50d1f2b44e8a96e16ca626f62e721d4ae48fe4afac7113e32e5cd5ccbc5e7adf36aa0558af
-  data.tar.gz: 31241cad722c315aefab9d4ad2613908f053bf3c905779e8fe5c6f1975fbc866b34526442386c1faec2e2386d5f5332c4b7e80a326aa8aca9b8ab1b94e51d572
+  metadata.gz: 384c1d42739f1e01b22439a85c9adb06fdad444f9b709040e9c87e99adb32ce9aee757ea2c8f7b26b2c22e282a36e6c1f1a48df8b471508967d605e36dc646ef
+  data.tar.gz: bfa16b5ff002e36db5e3b45ba823710b5d0c3eda7e32d8f4666b42661cf6de4807d1000887f91d045a890fca2a6afaa68218439c215557430fa992db8123468c

data/.github/workflows/ci.yml

@@ -1,5 +1,7 @@
 name: ci
 
+concurrency: ci-${{ github.ref }}
+
 on:
   pull_request:
   push:
@@ -14,12 +16,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.1'
           - '3.0'
           - '2.7'
           - '2.6'
           - 'jruby-9.3.1.0'
         include:
-          - ruby: '3.0'
+          - ruby: '3.1'
             coverage: 'true'
     steps:
       - uses: actions/checkout@v2
@@ -59,7 +62,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.1
       - name: Install latest bundler
         run: gem install bundler --no-document
       - name: Install Diffend plugin

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.1.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # WaterDrop changelog
 
+## 2.1.0 (2022-01-03)
+- Ruby 3.1 support
+- Change the error notification key from `error.emitted` to `error.occurred`.
+- Normalize error tracking and make all the places publish errors into the same notification endpoint (`error.occurred`).
+- Start semantic versioning WaterDrop.
+
 ## 2.0.7 (2021-12-03)
 - Source code metadata url added to the gemspec
 - Replace `:producer` with `:producer_id` in events and update `StdoutListener` accordingly. This change aligns all the events in terms of not publishing the whole producer object in the events.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.0.7)
+    waterdrop (2.1.0)
       concurrent-ruby (>= 1.1)
       dry-configurable (~> 0.13)
       dry-monitor (~> 0.5)
@@ -69,9 +69,9 @@ GEM
     mini_portile2 (2.7.1)
     minitest (5.14.4)
     rake (13.0.6)
-    rdkafka (0.11.0)
+    rdkafka (0.11.1)
       ffi (~> 1.15)
-      mini_portile2 (~> 2.7)
+      mini_portile2 (~> 2.6)
       rake (> 12)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -109,4 +109,4 @@ DEPENDENCIES
   waterdrop!
 
 BUNDLED WITH
-   2.2.31
+   2.3.4

data/README.md

@@ -290,7 +290,7 @@ Note: The metrics returned may not be completely consistent between brokers, top
 
 ### Error notifications
 
-Aside from errors related to publishing messages like `buffer.flushed_async.error`, WaterDrop allows you to listen to errors that occur in its internal background threads. Things like reconnecting to Kafka upon network errors and others unrelated to publishing messages are all available under `error.emitted` 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.
+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|
@@ -298,10 +298,10 @@ producer = WaterDrop::Producer.new do |config|
   config.kafka = { 'bootstrap.servers': 'localhost:9090' }
 end
 
-producer.monitor.subscribe('error.emitted') do |event|
+producer.monitor.subscribe('error.occurred') do |event|
   error = event[:error]
 
-  p "Internal error occurred: #{error}"
+  p "WaterDrop error occurred: #{error}"
 end
 
 # Run this code without Kafka cluster
@@ -313,9 +313,9 @@ end
 
 # After you stop your Kafka cluster, you will see a lot of those:
 #
-# Internal error occurred: Local: Broker transport failure (transport)
+# WaterDrop error occurred: Local: Broker transport failure (transport)
 #
-# Internal error occurred: Local: Broker transport failure (transport)
+# WaterDrop error occurred: Local: Broker transport failure (transport)
 ```
 
 ### Forking and potential memory problems

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

@@ -24,9 +24,10 @@ module WaterDrop
           return unless @client_name == client_name
 
           @monitor.instrument(
-            'error.emitted',
+            'error.occurred',
+            error: error,
             producer_id: @producer_id,
-            error: error
+            type: 'librdkafka.error'
           )
         end
       end

data/lib/water_drop/instrumentation/monitor.rb

@@ -24,13 +24,11 @@ module WaterDrop
         messages.buffered
 
         buffer.flushed_async
-        buffer.flushed_async.error
         buffer.flushed_sync
-        buffer.flushed_sync.error
 
         statistics.emitted
 
-        error.emitted
+        error.occurred
       ].freeze
 
       private_constant :EVENTS

data/lib/water_drop/instrumentation/stdout_listener.rb

@@ -70,15 +70,6 @@ module WaterDrop
         debug(event, messages)
       end
 
-      # @param event [Dry::Events::Event] event that happened with the details
-      def on_buffer_flushed_async_error(event)
-        messages = event[:messages]
-        error = event[:error]
-
-        error(event, "Async flushing of #{messages.size} failed due to: #{error}")
-        debug(event, messages)
-      end
-
       # @param event [Dry::Events::Event] event that happened with the details
       def on_buffer_flushed_sync(event)
         messages = event[:messages]
@@ -87,15 +78,6 @@ module WaterDrop
         debug(event, messages)
       end
 
-      # @param event [Dry::Events::Event] event that happened with the details
-      def on_buffer_flushed_sync_error(event)
-        messages = event[:dispatched]
-        error = event[:error]
-
-        error(event, "Sync flushing of #{messages.size} failed due to: #{error}")
-        debug(event, messages)
-      end
-
       # @param event [Dry::Events::Event] event that happened with the details
       def on_producer_closed(event)
         info event, 'Closing producer'
@@ -103,10 +85,11 @@ module WaterDrop
       end
 
       # @param event [Dry::Events::Event] event that happened with the error details
-      def on_error_emitted(event)
+      def on_error_occurred(event)
         error = event[:error]
+        type = event[:type]
 
-        error(event, "Background thread error emitted: #{error}")
+        error(event, "Error occurred: #{error} - #{type}")
         debug(event, '')
       end
 

data/lib/water_drop/producer/buffer.rb

@@ -103,8 +103,13 @@ module WaterDrop
           )
         end
       rescue *RESCUED_ERRORS => e
-        key = sync ? 'buffer.flushed_sync.error' : 'buffer.flush_async.error'
-        @monitor.instrument(key, producer_id: id, error: e, dispatched: dispatched)
+        @monitor.instrument(
+          'error.occurred',
+          error: e,
+          producer_id: id,
+          dispatched: dispatched,
+          type: sync ? 'buffer.flushed_sync.error' : 'buffer.flush_async.error'
+        )
 
         raise Errors::FlushFailureError.new(dispatched)
       end

data/lib/water_drop/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.1.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -34,7 +34,7 @@ cert_chain:
   R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
   pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
   -----END CERTIFICATE-----
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2022-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -189,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Kafka messaging made easy!