waterdrop 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2ef3d3916d6b0e59c191c8a81ad88cc33424a4ee4ff4c7c12e65e5ad3c79ba3
-  data.tar.gz: 1e02c7ae97e7c85e1d4aa12fe5e7c2b5611add6d41b15949fc17830382e4d99d
+  metadata.gz: 616222bb9061a061dbe807b3c490c04fc368b0f457dc70e27b27c5cc049b1271
+  data.tar.gz: f6330179e3db7aea799360ca51a09fa56d9d7bbc757925bf482a901c90e4e76d
 SHA512:
-  metadata.gz: c58aaaec32bbe3c1a930a0366447e5f69e3551619ad48ea243787b1fa487fdb3f17b5e17fd409ef956b0793dba3550a914ac15015e93cd4d81fa992f59040f7e
-  data.tar.gz: 00f6e291c053a46c650936a7d0e03a1c20f7631d5b597df30aa1b0f2ae614873b16c8bdf58a7081f3438e894d3f20c006e736826b2adf76e12c2be49e8f42b48
+  metadata.gz: e09358bf7a02acca118f62f869f3f53bf417356e9f28f32187c578af5debfd6d602463b13082cfc79a3a12042e2e2efcedb000fd45009802bc186249dee4a6bb
+  data.tar.gz: 81fe2d98e27704662201408c47746f8a800a955143f260afcbc2e4f3c3d44f34b5b27fbfdedb7bfe642e1fd3df966265f2e69585cc59cc3c4941005e17238079

data/.diffend.yml

@@ -0,0 +1,3 @@
+project_id: 'ee590bc9-f375-4832-ac8e-beb174b49aa5'
+shareable_id: '1325b111-b957-4fd8-bd6f-fead41e06034'
+shareable_key: 'd29c6230-8bf6-479b-83ff-98f374d3466e'

data/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: ci
+
+on:
+  push:
+  schedule:
+    - cron:  '0 1 * * *'
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '2.6'
+          - '2.5'
+          - 'jruby'
+        include:
+          - ruby: '2.7'
+            coverage: 'true'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+          bundle config set without 'tools benchmarks docs'
+      - name: Bundle install
+        run: |
+          bundle config set without development
+          bundle install --jobs 4 --retry 3
+      - name: Run Kafka with docker-compose
+        run: docker-compose up -d
+      - name: Run all tests
+        env:
+          GITHUB_COVERAGE: ${{matrix.coverage}}
+        run: bundle exec rspec
+  coditsu:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Run Coditsu
+        run: \curl -sSL https://api.coditsu.io/run/ci | bash

data/.gitignore

@@ -4,6 +4,7 @@
 /vendor/ruby/
 /ruby/
 app.god
+example.rb
 
 # minimal Rails specific artifacts
 db/*.sqlite3
@@ -12,6 +13,7 @@ db/*.sqlite3
 *.gem
 *.~
 /.coditsu/local.yml
+.byebug_history
 
 # various artifacts
 **.war

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.7.2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # WaterDrop changelog
 
+## 2.0.0 (2020-12-13)
+- Redesign of the whole API (see `README.md` for the use-cases and the current API)
+- Replace `ruby-kafka` with `rdkafka`
+- Switch license from `MIT` to `LGPL-3.0`
+- #113 - Add some basic validations of the kafka scope of the config (Azdaroth)
+- Global state removed
+- Redesigned metrics that use `rdkafka` internal data + custom diffing
+- Restore JRuby support
+
 ## 1.4.0 (2020-08-25)
 - Release to match Karafka 1.4 versioning.
 

data/Gemfile

@@ -2,9 +2,18 @@
 
 source 'https://rubygems.org'
 
+plugin 'diffend'
+
 gemspec
 
+gem 'rdkafka'
+
+group :development do
+  gem 'byebug'
+end
+
 group :test do
+  gem 'factory_bot'
   gem 'rspec'
   gem 'simplecov'
 end

data/Gemfile.lock

@@ -1,24 +1,26 @@
 PATH
   remote: .
   specs:
-    waterdrop (1.4.0)
-      delivery_boy (>= 0.2, < 2.x)
+    waterdrop (2.0.0)
+      concurrent-ruby (>= 1.1)
       dry-configurable (~> 0.8)
       dry-monitor (~> 0.3)
-      dry-validation (~> 1.2)
-      ruby-kafka (>= 0.7.8)
+      dry-validation (~> 1.3)
+      rdkafka (>= 0.6.0)
       zeitwerk (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
     concurrent-ruby (1.1.7)
-    delivery_boy (1.0.1)
-      king_konf (~> 0.3)
-      ruby-kafka (~> 1.0)
     diff-lcs (1.4.4)
-    digest-crc (0.6.1)
-      rake (~> 13.0)
     docile (1.3.2)
     dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
@@ -27,7 +29,7 @@ GEM
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-events (0.2.0)
@@ -35,8 +37,8 @@ GEM
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.3)
-    dry-logic (1.0.7)
+    dry-initializer (3.0.4)
+    dry-logic (1.0.8)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
@@ -45,7 +47,7 @@ GEM
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-events (~> 0.2)
-    dry-schema (1.5.3)
+    dry-schema (1.5.6)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -60,43 +62,59 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.5.4)
+    dry-validation (1.6.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.5)
-    king_konf (0.3.7)
+      dry-schema (~> 1.5, >= 1.5.2)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    ffi (1.13.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.2)
     rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rdkafka (0.8.1)
+      ffi (~> 1.9)
+      mini_portile2 (~> 2.1)
+      rake (>= 12.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    ruby-kafka (1.2.0)
-      digest-crc
-    simplecov (0.19.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    simplecov (0.20.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    zeitwerk (2.4.0)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.3)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
+  byebug
+  factory_bot
+  rdkafka
   rspec
   simplecov
   waterdrop!
 
 BUNDLED WITH
-   2.1.4
+   2.2.0

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -1,17 +1,25 @@
 # WaterDrop
 
-[![Build Status](https://travis-ci.org/karafka/waterdrop.svg)](https://travis-ci.org/karafka/waterdrop)
+**Note**: Documentation presented here refers to WaterDrop `2.0.0.pre1`.
+
+WaterDrop `2.0` does **not** work with Karafka `1.*` and aims to either work as a standalone producer outside of Karafka `1.*` ecosystem or as a part of not yet released Karafka `2.0.*`.
+
+Please refer to [this](https://github.com/karafka/waterdrop/tree/1.4) branch and it's documentation for details about WaterDrop `1.*` usage.
+
+[![Build Status](https://github.com/karafka/waterdrop/workflows/ci/badge.svg)](https://github.com/karafka/waterdrop/actions?query=workflow%3Aci)
 [![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Gem used to send messages to Kafka in an easy way with an extra validation layer. It is a part of the [Karafka](https://github.com/karafka/karafka) ecosystem.
 
-WaterDrop is based on Zendesks [delivery_boy](https://github.com/zendesk/delivery_boy) gem.
+It:
 
-It is:
-
- - Thread safe
- - Supports sync and async producers
- - Working with 0.11+ Kafka
+ - Is thread safe
+ - Supports sync producing
+ - Supports async producing
+ - Supports buffering
+ - Supports producing messages to multiple clusters
+ - Supports multiple delivery policies
+ - Works with Kafka 1.0+ and Ruby 2.5+
 
 ## Installation
 
@@ -36,82 +44,213 @@ bundle install
 WaterDrop is a complex tool, that contains multiple configuration options. To keep everything organized, all the configuration options were divided into two groups:
 
 - WaterDrop options - options directly related to Karafka framework and it's components
-- Ruby-Kafka driver options - options related to Ruby-Kafka/Delivery boy
+- Kafka driver options - options related to `Kafka`
 
-To apply all those configuration options, you need to use the ```#setup``` method:
+To apply all those configuration options, you need to create a producer instance and use the ```#setup``` method:
 
 ```ruby
-WaterDrop.setup do |config|
+producer = WaterDrop::Producer.new
+
+producer.setup do |config|
   config.deliver = true
-  config.kafka.seed_brokers = %w[kafka://localhost:9092]
+  config.kafka = {
+    'bootstrap.servers': 'localhost:9092',
+    'request.required.acks': 1
+  }
+end
+```
+
+or you can do the same while initializing the producer:
+
+```ruby
+producer = WaterDrop::Producer.new do |config|
+  config.deliver = true
+  config.kafka = {
+    'bootstrap.servers': 'localhost:9092',
+    'request.required.acks': 1
+  }
 end
 ```
 
 ### WaterDrop configuration options
 
-| Option                      | Description                                                      |
-|-----------------------------|------------------------------------------------------------------|
-| client_id                   | This is how the client will identify itself to the Kafka brokers |
-| logger                      | Logger that we want to use                                       |
-| deliver                     | Should we send messages to Kafka                                 |
+| Option             | Description                                                     |
+|--------------------|-----------------------------------------------------------------|
+| `id`               | id of the producer for instrumentation and logging              |
+| `logger`           | Logger that we want to use                                      |
+| `deliver`          | Should we send messages to Kafka or just fake the delivery      |
+| `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 |
 
-### Ruby-Kafka driver and Delivery boy configuration options
+### Kafka configuration options
 
-**Note:** We've listed here only **the most important** configuration options. If you're interested in all the options, please go to the [config.rb](https://github.com/karafka/waterdrop/blob/master/lib/water_drop/config.rb) file for more details.
+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.
+
+## Usage
 
-**Note:** All the options are subject to validations. In order to check what is and what is not acceptable, please go to the [config.rb validation schema](https://github.com/karafka/waterdrop/blob/master/lib/water_drop/schemas/config.rb) file.
+Please refer to the [documentation](https://www.rubydoc.info/github/karafka/waterdrop) in case you're interested in the more advanced API.
 
-| Option                   | Description                                                                                                                                           |
-|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
-| raise_on_buffer_overflow | Should we raise an exception, when messages can't be sent in an async way due to the message buffer overflow or should we just drop them              |
-| delivery_interval        | The number of seconds between background message deliveries. Disable timer-based background deliveries by setting this to 0.                          |
-| delivery_threshold       | The number of buffered messages that will trigger a background message delivery. Disable buffer size based background deliveries by setting this to 0.|
-| required_acks            | The number of Kafka replicas that must acknowledge messages before they're considered as successfully written.                                        |
-| ack_timeout              | A timeout executed by a broker when the client is sending messages to it.                                                                             |
-| max_retries              | The number of retries when attempting to deliver messages.                                                                                            |
-| retry_backoff            | The number of seconds to wait after a failed attempt to send messages to a Kafka broker before retrying.                                              |
-| max_buffer_bytesize      | The maximum number of bytes allowed in the buffer before new messages are rejected.                                                                   |
-| max_buffer_size          | The maximum number of messages allowed in the buffer before new messages are rejected.                                                                |
-| max_queue_size           | The maximum number of messages allowed in the queue before new messages are rejected.                                                                 |
-| sasl_plain_username      | The username used to authenticate.                                                                                                                    |
-| sasl_plain_password      | The password used to authenticate.                                                                                                                    |
+### Basic usage
 
-This configuration can be also placed in *config/initializers* and can vary based on the environment:
+To send Kafka messages, just create a producer and use it:
 
 ```ruby
-WaterDrop.setup do |config|
-  config.deliver = Rails.env.production?
-  config.kafka.seed_brokers = [Rails.env.production? ? 'kafka://prod-host:9091' : 'kafka://localhost:9092']
+producer = WaterDrop::Producer.new
+
+producer.setup do |config|
+  config.kafka = { 'bootstrap.servers': 'localhost:9092' }
 end
+
+producer.produce_sync(topic: 'my-topic', payload: 'my message')
+
+# or for async
+producer.produce_async(topic: 'my-topic', payload: 'my message')
+
+# or in batches
+producer.produce_many_sync(
+  [
+    { topic: 'my-topic', payload: 'my message'},
+    { topic: 'my-topic', payload: 'my message'}
+  ]
+)
+
+# both sync and async
+producer.produce_many_async(
+  [
+    { topic: 'my-topic', payload: 'my message'},
+    { topic: 'my-topic', payload: 'my message'}
+  ]
+)
+
+# Don't forget to close the producer once you're done to flush the internal buffers, etc
+producer.close
 ```
 
-## Usage
+Each message that you want to publish, will have its value checked.
+
+Here are all the things you can provide in the message hash:
+
+| Option      | Required | Value type    | Description                                           |
+|-------------|----------|---------------|-------------------------------------------------------|
+| `topic`     | true     | String        | The Kafka topic that should be written to             |
+| `payload`   | true     | String        | Data you want to send to Kafka                        |
+| `key`       | false    | String        | The key that should be set in the Kafka message       |
+| `partition` | false    | Integer       | A specific partition number that should be written to |
+| `timestamp` | false    | Time, Integer | The timestamp that should be set on the message       |
+| `headers`   | false    | Hash          | Headers for the message                               |
+
+Keep in mind, that message you want to send should be either binary or stringified (to_s, to_json, etc).
 
-To send Kafka messages, just use one of the producers:
+### Buffering
+
+WaterDrop producers support buffering of messages, which means that you can easily implement periodic flushing for long running processes as well as buffer several messages to be flushed the same moment:
 
 ```ruby
-WaterDrop::SyncProducer.call('message', topic: 'my-topic')
-# or for async
-WaterDrop::AsyncProducer.call('message', topic: 'my-topic')
+producer = WaterDrop::Producer.new
+
+producer.setup do |config|
+  config.kafka = { 'bootstrap.servers': 'localhost:9092' }
+end
+
+time = Time.now - 10
+
+while time < Time.now
+  time += 1
+  producer.buffer(topic: 'times', payload: Time.now.to_s)
+end
+
+puts "The messages buffer size #{producer.messages.size}"
+producer.flush_sync
+puts "The messages buffer size #{producer.message.size}"
+
+producer.close
 ```
 
-Both ```SyncProducer``` and ```AsyncProducer``` accept following options:
+## Instrumentation
 
-| Option              | Required | Value type | Description                                                         |
-|-------------------- |----------|------------|---------------------------------------------------------------------|
-| ```topic```         | true     | String     | The Kafka topic that should be written to                           |
-| ```key```           | false    | String     | The key that should be set in the Kafka message                     |
-| ```partition```     | false    | Integer    | A specific partition number that should be written to               |
-| ```partition_key``` | false    | String     | A string that can be used to deterministically select the partition |
-| ```create_time```   | false    | Time       | The timestamp that should be set on the message                     |
-| ```headers```       | false    | Hash       | Headers for the message                                             |
+Each of the producers after the `#setup` is done, has a custom monitor to which you can subscribe.
 
-Keep in mind, that message you want to send should be either binary or stringified (to_s, to_json, etc).
+```ruby
+producer = WaterDrop::Producer.new
+
+producer.setup do |config|
+  config.kafka = { 'bootstrap.servers': 'localhost:9092' }
+end
+
+producer.monitor.subscribe('message.produced_async') do |event|
+  puts "A message was produced to '#{event[:message][:topic]}' topic!"
+end
+
+producer.produce_async(topic: 'events', payload: 'data')
+
+producer.close
+```
+
+See the `WaterDrop::Instrumentation::Monitor::EVENTS` for the list of all the supported events.
+
+### Usage statistics
+
+WaterDrop may be configured to emit internal metrics at a fixed interval by setting the `kafka` `statistics.interval.ms` configuration property to a value > `0`. Once that is done, emitted statistics are available after subscribing to the `statistics.emitted` publisher event.
+
+The statistics include all of the metrics from `librdkafka` (full list [here](https://github.com/edenhill/librdkafka/blob/master/STATISTICS.md)) as well as the diff of those against the previously emitted values.
+
+For several attributes like `txmsgs`, `librdkafka` publishes only the totals. In order to make it easier to track the progress (for example number of messages sent between statistics emitted events), WaterDrop diffs all the numeric values against previously available numbers. All of those metrics are available under the same key as the metric but with additional `_d` postfix:
+
+
+```ruby
+producer = WaterDrop::Producer.new do |config|
+  config.kafka = {
+    'bootstrap.servers': 'localhost:9092',
+    'statistics.interval.ms': 2_000 # emit statistics every 2 seconds
+  }
+end
+
+producer.monitor.subscribe('statistics.emitted') do |event|
+  sum = event[:statistics]['txmsgs']
+  diff = event[:statistics]['txmsgs_d']
+
+  p "Sent messages: #{sum}"
+  p "Messages sent from last statistics report: #{diff}"
+end
+
+sleep(2)
+
+# Sent messages: 0
+# Messages sent from last statistics report: 0
+
+20.times { producer.produce_async(topic: 'events', payload: 'data') }
+
+# Sent messages: 20
+# Messages sent from last statistics report: 20
+
+sleep(2)
+
+20.times { producer.produce_async(topic: 'events', payload: 'data') }
+
+# Sent messages: 40
+# Messages sent from last statistics report: 20
+
+sleep(2)
+
+# Sent messages: 40
+# Messages sent from last statistics report: 0
+
+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.
+
+### 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.
+
+To tackle this [obstacle](https://github.com/appsignal/rdkafka-ruby/issues/15) related to rdkafka, WaterDrop adds finalizer to each of the producers to close the rdkafka client before the Ruby process is shutdown. Due to the [nature of the finalizers](https://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/), this implementation prevents producers from being GCed (except upon VM shutdown) and can cause memory leaks if you don't use persistent/long-lived producers in a long-running process or if you don't use the `#close` method of a producer when it is no longer needed. Creating a producer instance for each message is anyhow a rather bad idea, so we recommend not to.
 
 ## References
 
+* [WaterDrop code documentation](https://www.rubydoc.info/github/karafka/waterdrop)
 * [Karafka framework](https://github.com/karafka/karafka)
-* [WaterDrop Travis CI](https://travis-ci.org/karafka/waterdrop)
+* [WaterDrop Actions CI](https://github.com/karafka/waterdrop/actions?query=workflow%3Ac)
 * [WaterDrop Coditsu](https://app.coditsu.io/karafka/repositories/waterdrop)
 
 ## Note on contributions