README.md in karafka-sidekiq-backend-1.4.2 vs README.md in karafka-sidekiq-backend-1.4.3
- old
+ new
@@ -1,10 +1,18 @@
# Karafka Sidekiq Backend
+## Deprecation notice
+
+This backend was designed to compensate for lack of multi-threading in Karafka. After Karafka `2.0` release, this backend development won't be continued.
+
+We will **still** support it for Karafka `1.4` but it won't work with Karafka `2.0`. We will however provide an extensive guide on how you can achieve similar functionality with Sidekiq yourself.
+
+## About
+
[](https://github.com/karafka/sidekiq-backend/actions?query=workflow%3Aci)
[](http://badge.fury.io/rb/karafka-sidekiq-backend)
-[](https://gitter.im/karafka/karafka)
+[](https://slack.karafka.io)
[Karafka Sidekiq Backend](https://github.com/karafka/sidekiq-backend) provides support for consuming (processing) received Kafka messages inside of Sidekiq workers.
## Installations
@@ -47,11 +55,11 @@
consumer_group :videos_consumer do
topic :binary_video_details do
backend :sidekiq
consumer Videos::DetailsConsumer
worker Workers::DetailsWorker
- interchanger Interchangers::MyCustomInterchanger
+ interchanger Interchangers::MyCustomInterchanger.new
end
end
end
```
@@ -62,11 +70,11 @@
There are two options you can set inside of the ```topic``` block:
| Option | Value type | Description |
|--------------|------------|-------------------------------------------------------------------------------------------------------------------|
| worker | Class | Name of a worker class that we want to use to schedule perform code |
-| interchanger | Class | Name of an interchanger class that we want to use to pass the incoming data to Sidekiq |
+| interchanger | Instance | Instance of an interchanger class that we want to use to pass the incoming data to Sidekiq |
### Workers
Karafka by default will build a worker that will correspond to each of your consumers (so you will have a pair - consumer and a worker). All of them will inherit from ```ApplicationWorker``` and will share all its settings.
@@ -100,11 +108,11 @@
```ruby
App.routes.draw do
consumer_group :videos_consumer do
topic :binary_video_details do
consumer Videos::DetailsConsumer
- interchanger Interchangers::MyCustomInterchanger
+ interchanger Interchangers::MyCustomInterchanger.new
end
end
end
```
Each custom interchanger should define `encode` to encode params before they get stored in Redis, and `decode` to convert the params to hash format, as shown below:
@@ -130,12 +138,10 @@
* [Karafka Sidekiq Backend Actions CI](https://github.com/karafka/sidekiq-backend/actions?query=workflow%3Aci)
* [Karafka Sidekiq Backend Coditsu](https://app.coditsu.io/karafka/repositories/karafka-sidekiq-backend)
## Note on contributions
-First, thank you for considering contributing to Karafka! It's people like you that make the open source community such a great community!
+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!
-Each pull request must pass all the RSpec specs and meet our quality requirements.
+Each pull request must pass all the RSpec specs, integration tests 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.
-
-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/karafka-sidekiq-backend/builds/commit_builds) of Karafka Sidekiq Backend repository.
+Fork it, update and wait for the Github Actions results.