waterdrop 1.4.4 → 2.0.0.rc1

data/README.md

@@ -1,17 +1,25 @@
 # WaterDrop
 
-[![Build Status](https://travis-ci.org/karafka/waterdrop.svg)](https://travis-ci.org/karafka/waterdrop)
-[![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
+**Note**: Documentation presented here refers to WaterDrop `2.0.0.pre1`.
 
-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 `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.
 
-WaterDrop is based on Zendesks [delivery_boy](https://github.com/zendesk/delivery_boy) gem.
+[![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)
 
-It is:
+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.
 
- - Thread safe
- - Supports sync and async producers
- - Working with 0.11+ Kafka
+It:
+
+ - 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,88 +44,223 @@ 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 create a producer instance and use the ```#setup``` method:
+
+```ruby
+producer = WaterDrop::Producer.new
+
+producer.setup do |config|
+  config.deliver = true
+  config.kafka = {
+    'bootstrap.servers': 'localhost:9092',
+    'request.required.acks': 1
+  }
+end
+```
 
-To apply all those configuration options, you need to use the ```#setup``` method:
+or you can do the same while initializing the producer:
 
 ```ruby
-WaterDrop.setup do |config|
+producer = WaterDrop::Producer.new do |config|
   config.deliver = true
-  config.kafka.seed_brokers = %w[kafka://localhost:9092]
+  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.
 
-**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.
+## Usage
 
-| 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.                                                                                                                    |
+Please refer to the [documentation](https://www.rubydoc.info/github/karafka/waterdrop) in case you're interested in the more advanced API.
 
-This configuration can be also placed in *config/initializers* and can vary based on the environment:
+### Basic usage
+
+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.
 
-To send Kafka messages, just use one of the producers:
+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).
+
+### 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
 
-First, thank you for considering contributing to the Karafka ecosystem! It's people like you that make the open source community such a great community!
+First, thank you for considering contributing to WaterDrop! It's people like you that make the open source community such a great community!
+
+Each pull request must pass all the RSpec specs and meet our quality requirements.
+
+To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.
 
-Each pull request must pass all the RSpec specs, integration tests and meet our quality requirements.
+Coditsu will automatically check your work against our quality standards. You can find your commit check results on the [builds page](https://app.coditsu.io/karafka/repositories/waterdrop/builds/commit_builds) of WaterDrop repository.
 
-Fork it, update and wait for the Github Actions results.
+[![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka/repositories/waterdrop/builds/commit_builds)

data/certs/mensfeld.pem

@@ -1,25 +1,25 @@
 -----BEGIN CERTIFICATE-----
 MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
-ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjEwODExMTQxNTEzWhcNMjIwODExMTQx
-NTEzWjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
-CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDV2jKH4Ti87GM6nyT6D+ESzTI0MZDj
-ak2/TEwnxvijMJyCCPKT/qIkbW4/f0VHM4rhPr1nW73sb5SZBVFCLlJcOSKOBdUY
-TMY+SIXN2EtUaZuhAOe8LxtxjHTgRHvHcqUQMBENXTISNzCo32LnUxweu66ia4Pd
-1mNRhzOqNv9YiBZvtBf7IMQ+sYdOCjboq2dlsWmJiwiDpY9lQBTnWORnT3mQxU5x
-vPSwnLB854cHdCS8fQo4DjeJBRZHhEbcE5sqhEMB3RZA3EtFVEXOxlNxVTS3tncI
-qyNXiWDaxcipaens4ObSY1C2HTV7OWb7OMqSCIybeYTSfkaSdqmcl4S6zxXkjH1J
-tnjayAVzD+QVXGijsPLE2PFnJAh9iDET2cMsjabO1f6l1OQNyAtqpcyQcgfnyW0z
-g7tGxTYD+6wJHffM9d9txOUw6djkF6bDxyqB8lo4Z3IObCx18AZjI9XPS9QG7w6q
-LCWuMG2lkCcRgASqaVk9fEf9yMc2xxz5o3kCAwEAAaN3MHUwCQYDVR0TBAIwADAL
-BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFBqUFCKCOe5IuueUVqOB991jyCLLMB0GA1Ud
+ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjAwODExMDkxNTM3WhcNMjEwODExMDkx
+NTM3WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
+CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDCpXsCgmINb6lHBXXBdyrgsBPSxC4/
+2H+weJ6L9CruTiv2+2/ZkQGtnLcDgrD14rdLIHK7t0o3EKYlDT5GhD/XUVhI15JE
+N7IqnPUgexe1fbZArwQ51afxz2AmPQN2BkB2oeQHXxnSWUGMhvcEZpfbxCCJH26w
+hS0Ccsma8yxA6hSlGVhFVDuCr7c2L1di6cK2CtIDpfDaWqnVNJEwBYHIxrCoWK5g
+sIGekVt/admS9gRhIMaIBg+Mshth5/DEyWO2QjteTodItlxfTctrfmiAl8X8T5JP
+VXeLp5SSOJ5JXE80nShMJp3RFnGw5fqjX/ffjtISYh78/By4xF3a25HdWH9+qO2Z
+tx0wSGc9/4gqNM0APQnjN/4YXrGZ4IeSjtE+OrrX07l0TiyikzSLFOkZCAp8oBJi
+Fhlosz8xQDJf7mhNxOaZziqASzp/hJTU/tuDKl5+ql2icnMv5iV/i6SlmvU29QNg
+LCV71pUv0pWzN+OZbHZKWepGhEQ3cG9MwvkCAwEAAaN3MHUwCQYDVR0TBAIwADAL
+BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFImGed2AXS070ohfRidiCEhXEUN+MB0GA1Ud
 EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
-c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBADD0/UuTTFgW+CGk2U0RDw2RBOca
-W2LTF/G7AOzuzD0Tc4voc7WXyrgKwJREv8rgBimLnNlgmFJLmtUCh2U/MgxvcilH
-yshYcbseNvjkrtYnLRlWZR4SSB6Zei5AlyGVQLPkvdsBpNegcG6w075YEwzX/38a
-8V9B/Yri2OGELBz8ykl7BsXUgNoUPA/4pHF6YRLz+VirOaUIQ4JfY7xGj6fSOWWz
-/rQ/d77r6o1mfJYM/3BRVg73a3b7DmRnE5qjwmSaSQ7u802pJnLesmArch0xGCT/
-fMmRli1Qb+6qOTl9mzD6UDMAyFR4t6MStLm0mIEqM0nBO5nUdUWbC7l9qXEf8XBE
-2DP28p3EqSuS+lKbAWKcqv7t0iRhhmaod+Yn9mcrLN1sa3q3KSQ9BCyxezCD4Mk2
-R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
-pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
+c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKiHpwoENVrMi94V1zD4o8/6G3AU
+gWz4udkPYHTZLUy3dLznc/sNjdkJFWT3E6NKYq7c60EpJ0m0vAEg5+F5pmNOsvD3
+2pXLj9kisEeYhR516HwXAvtngboUcb75skqvBCU++4Pu7BRAPjO1/ihLSBexbwSS
+fF+J5OWNuyHHCQp+kGPLtXJe2yUYyvSWDj3I2//Vk0VhNOIlaCS1+5/P3ZJThOtm
+zJUBI7h3HgovwRpcnmk2mXTmU4Zx/bCzX8EA6VY0khEvnmiq7S6eBF0H9qH8KyQ6
+EkVLpvmUDFcf/uNaBQdazEMB5jYtwoA8gQlANETNGPi51KlkukhKgaIEDMkBDJOx
+65N7DzmkcyY0/GwjIVIxmRhcrCt1YeCUElmfFx0iida1/YRm6sB2AXqScc1+ECRi
+2DND//YJUikn1zwbz1kT70XmHd97B4Eytpln7K+M1u2g1pHVEPW4owD/ammXNpUy
+nt70FcDD4yxJQ+0YNiHd0N8IcVBM1TMIVctMNQ==
 -----END CERTIFICATE-----

data/config/errors.yml

@@ -1,19 +1,6 @@
 en:
   dry_validation:
     errors:
-      broker_schema: >
-        has an invalid format.
-        Expected schema, host and port number.
-        Example: kafka://127.0.0.1:9092 or kafka+ssl://127.0.0.1:9092
-      ssl_client_cert_with_ssl_client_cert_key: >
-        Both ssl_client_cert and ssl_client_cert_key need to be provided.
-      ssl_client_cert_key_with_ssl_client_cert: >
-        Both ssl_client_cert_key and ssl_client_cert need to be provided.
-      ssl_client_cert_chain_with_ssl_client_cert: >
-        Both ssl_client_cert_chain and ssl_client_cert need to be provided.
-      ssl_client_cert_chain_with_ssl_client_cert_key: >
-        Both ssl_client_cert_chain and ssl_client_cert_key need to be provided.
-      ssl_client_cert_key_password_with_ssl_client_cert_key: >
-        Both ssl_client_cert_key_password and ssl_client_cert_key need to be provided.
-      sasl_oauth_token_provider_respond_to_token: >
-        sasl_oauth_token_provider needs to respond to a #token method.
+      invalid_key_type: all keys need to be of type String
+      invalid_value_type: all values need to be of type String
+      max_payload_size: is more than `max_payload_size` config value

data/lib/water_drop/config.rb

@@ -5,158 +5,57 @@
 module WaterDrop
   # Configuration object for setting up all options required by WaterDrop
   class Config
-    extend Dry::Configurable
-
-    # Config schema definition
-    # @note We use a single instance not to create new one upon each usage
-    SCHEMA = Contracts::Config.new.freeze
-
-    private_constant :SCHEMA
+    include Dry::Configurable
 
     # WaterDrop options
-    # option client_id [String] identifier of this producer
-    setting :client_id, default: 'waterdrop'
-    # option [Instance, nil] logger that we want to use or nil to fallback to ruby-kafka logger
-    setting :logger, default: Logger.new($stdout, level: Logger::WARN)
+    #
+    # option [String] id of the producer. This can be helpful when building producer specific
+    #   instrumentation or loggers. It is not the kafka producer id
+    setting(:id, false) { |id| id || SecureRandom.uuid }
+    # option [Instance] logger that we want to use
+    # @note Due to how rdkafka works, this setting is global for all the producers
+    setting(:logger, false) { |logger| logger || Logger.new($stdout, level: Logger::WARN) }
     # option [Instance] monitor that we want to use. See instrumentation part of the README for
     #   more details
-    setting :monitor, default: WaterDrop::Instrumentation::Monitor.new
+    setting(:monitor, false) { |monitor| monitor || WaterDrop::Instrumentation::Monitor.new }
+    # option [Integer] max payload size allowed for delivery to Kafka
+    setting :max_payload_size, 1_000_012
+    # option [Integer] Wait that long for the delivery report or raise an error if this takes
+    #   longer than the timeout.
+    setting :max_wait_timeout, 5
+    # option [Numeric] how long should we wait between re-checks on the availability of the
+    #   delivery report. In a really robust systems, this describes the min-delivery time
+    #   for a single sync message when produced in isolation
+    setting :wait_timeout, 0.005 # 5 milliseconds
     # option [Boolean] should we send messages. Setting this to false can be really useful when
-    #   testing and or developing because when set to false, won't actually ping Kafka
-    setting :deliver, default: true
-    # option [Boolean] if you're producing messages faster than the framework or the network can
-    #   send them off, ruby-kafka might reject them. If that happens, WaterDrop will either raise
-    #   or ignore - this setting manages that behavior. This only applies to async producer as
-    #   sync producer will always raise upon problems
-    setting :raise_on_buffer_overflow, default: true
-
-    # Settings directly related to the Kafka driver
-    setting :kafka do
-      # option [Array<String>] Array that contains Kafka seed broker hosts with ports
-      setting :seed_brokers
-
-      # Network timeouts
-      # option connect_timeout [Integer] Sets the number of seconds to wait while connecting to
-      # a broker for the first time. When ruby-kafka initializes, it needs to connect to at
-      # least one host.
-      setting :connect_timeout, default: 10
-      # option socket_timeout [Integer] Sets the number of seconds to wait when reading from or
-      # writing to a socket connection to a broker. After this timeout expires the connection
-      # will be killed. Note that some Kafka operations are by definition long-running, such as
-      # waiting for new messages to arrive in a partition, so don't set this value too low
-      setting :socket_timeout, default: 30
-
-      # Buffering for async producer
-      # @option [Integer] The maximum number of bytes allowed in the buffer before new messages
-      #   are rejected.
-      setting :max_buffer_bytesize, default: 10_000_000
-      # @option [Integer] The maximum number of messages allowed in the buffer before new messages
-      #   are rejected.
-      setting :max_buffer_size, default: 1000
-      # @option [Integer] The maximum number of messages allowed in the queue before new messages
-      #   are rejected. The queue is used to ferry messages from the foreground threads of your
-      #   application to the background thread that buffers and delivers messages.
-      setting :max_queue_size, default: 1000
-
-      # option [Integer] A timeout executed by a broker when the client is sending messages to it.
-      #   It defines the number of seconds the broker should wait for replicas to acknowledge the
-      #   write before responding to the client with an error. As such, it relates to the
-      #   required_acks setting. It should be set lower than socket_timeout.
-      setting :ack_timeout, default: 5
-      # option [Integer] The number of seconds between background message
-      #   deliveries. Default is 10 seconds. Disable timer-based background deliveries by
-      #   setting this to 0.
-      setting :delivery_interval, default: 10
-      # option [Integer] The number of buffered messages that will trigger a background message
-      #   delivery. Default is 100 messages. Disable buffer size based background deliveries by
-      #   setting this to 0.
-      setting :delivery_threshold, default: 100
-      # option [Boolean]
-      setting :idempotent, default: false
-      # option [Boolean]
-      setting :transactional, default: false
-      # option [Integer]
-      setting :transactional_timeout, default: 60
-
-      # option [Integer] The number of retries when attempting to deliver messages.
-      setting :max_retries, default: 2
-      # option [Integer]
-      setting :required_acks, default: -1
-      # option [Integer]
-      setting :retry_backoff, default: 1
-
-      # option [Integer] The minimum number of messages that must be buffered before compression is
-      #   attempted. By default only one message is required. Only relevant if compression_codec
-      #   is set.
-      setting :compression_threshold, default: 1
-      # option [Symbol] The codec used to compress messages. Must be either snappy or gzip.
-      setting :compression_codec, default: nil
-
-      # SSL authentication related settings
-      # option ca_cert [String, nil] SSL CA certificate
-      setting :ssl_ca_cert, default: nil
-      # option ssl_ca_cert_file_path [String, nil] SSL CA certificate file path
-      setting :ssl_ca_cert_file_path, default: nil
-      # option ssl_ca_certs_from_system [Boolean] Use the CA certs from your system's default
-      #   certificate store
-      setting :ssl_ca_certs_from_system, default: false
-      # option ssl_verify_hostname [Boolean] Verify the hostname for client certs
-      setting :ssl_verify_hostname, default: true
-      # option ssl_client_cert [String, nil] SSL client certificate
-      setting :ssl_client_cert, default: nil
-      # option ssl_client_cert_key [String, nil] SSL client certificate password
-      setting :ssl_client_cert_key, default: nil
-      # option sasl_gssapi_principal [String, nil] sasl principal
-      setting :sasl_gssapi_principal, default: nil
-      # option sasl_gssapi_keytab [String, nil] sasl keytab
-      setting :sasl_gssapi_keytab, default: nil
-      # option sasl_plain_authzid [String] The authorization identity to use
-      setting :sasl_plain_authzid, default: ''
-      # option sasl_plain_username [String, nil] The username used to authenticate
-      setting :sasl_plain_username, default: nil
-      # option sasl_plain_password [String, nil] The password used to authenticate
-      setting :sasl_plain_password, default: nil
-      # option sasl_scram_username [String, nil] The username used to authenticate
-      setting :sasl_scram_username, default: nil
-      # option sasl_scram_password [String, nil] The password used to authenticate
-      setting :sasl_scram_password, default: nil
-      # option sasl_scram_mechanism [String, nil] Scram mechanism, either 'sha256' or 'sha512'
-      setting :sasl_scram_mechanism, default: nil
-      # option sasl_over_ssl [Boolean] whether to enforce SSL with SASL
-      setting :sasl_over_ssl, default: true
-      # option ssl_client_cert_chain [String, nil] client cert chain or nil if not used
-      setting :ssl_client_cert_chain, default: nil
-      # option ssl_client_cert_key_password [String, nil] the password required to read
-      #   the ssl_client_cert_key
-      setting :ssl_client_cert_key_password, default: nil
-      # @param sasl_oauth_token_provider [Object, nil] OAuthBearer Token Provider instance that
-      #   implements method token.
-      setting :sasl_oauth_token_provider, default: nil
-    end
-
-    class << self
-      # Configuration method
-      # @yield Runs a block of code providing a config singleton instance to it
-      # @yieldparam [WaterDrop::Config] WaterDrop config instance
-      def setup
-        configure do |config|
-          yield(config)
-          validate!(config.to_h)
-        end
+    #   testing and or developing because when set to false, won't actually ping Kafka but will
+    #   run all the validations, etc
+    setting :deliver, true
+    # rdkafka options
+    # @see https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md
+    setting :kafka, {}
+
+    # Configuration method
+    # @yield Runs a block of code providing a config singleton instance to it
+    # @yieldparam [WaterDrop::Config] WaterDrop config instance
+    def setup
+      configure do |config|
+        yield(config)
+        validate!(config.to_h)
       end
+    end
 
-      private
+    private
 
-      # Validates the configuration and if anything is wrong, will raise an exception
-      # @param config_hash [Hash] config hash with setup details
-      # @raise [WaterDrop::Errors::InvalidConfiguration] raised when something is wrong with
-      #   the configuration
-      def validate!(config_hash)
-        validation_result = SCHEMA.call(config_hash)
-        return true if validation_result.success?
+    # Validates the configuration and if anything is wrong, will raise an exception
+    # @param config_hash [Hash] config hash with setup details
+    # @raise [WaterDrop::Errors::ConfigurationInvalidError] raised when something is wrong with
+    #   the configuration
+    def validate!(config_hash)
+      result = Contracts::Config.new.call(config_hash)
+      return true if result.success?
 
-        raise Errors::InvalidConfiguration, validation_result.errors.to_h
-      end
+      raise Errors::ConfigurationInvalidError, result.errors.to_h
     end
   end
 end