Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rapideinternet/laravel-queue-kafka
Kafka Queue driver for Laravel
https://github.com/rapideinternet/laravel-queue-kafka
laravel queue-drivers
Last synced: 5 days ago
JSON representation
Kafka Queue driver for Laravel
- Host: GitHub
- URL: https://github.com/rapideinternet/laravel-queue-kafka
- Owner: rapideinternet
- License: mit
- Created: 2017-08-03T15:49:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:13:20.000Z (about 1 year ago)
- Last Synced: 2024-03-15T09:09:00.956Z (11 months ago)
- Topics: laravel, queue-drivers
- Language: PHP
- Size: 71.3 KB
- Stars: 168
- Watchers: 8
- Forks: 56
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kafka Queue driver for Laravel
======================
[](https://packagist.org/packages/rapide/laravel-queue-kafka)
[](https://travis-ci.org/rapideinternet/laravel-queue-kafka)
[](https://packagist.org/packages/rapide/laravel-queue-kafka)
[](https://styleci.io/repos/99249783)
[](LICENSE)
#### Installation
1. Install [librdkafka c library](https://github.com/edenhill/librdkafka)
```bash
$ cd /tmp
$ mkdir librdkafka
$ cd librdkafka
$ git clone https://github.com/edenhill/librdkafka.git .
$ ./configure
$ make
$ make install
```
2. Install the [php-rdkafka](https://github.com/arnaud-lb/php-rdkafka) PECL extension
```bash
$ pecl install rdkafka
```
3. a. Add the following to your php.ini file to enable the php-rdkafka extension
`extension=rdkafka.so`
b. Check if rdkafka is installed
__Note:__ If you want to run this on php-fpm restart your php-fpm first.
php -i | grep rdkafka
Your output should look something like this
rdkafka
rdkafka support => enabled
librdkafka version (runtime) => 1.0.0-RC2
librdkafka version (build) => 0.11.4.0
4. Install this package via composer using:
composer require rapide/laravel-queue-kafka
5. Add LaravelQueueKafkaServiceProvider to `providers` array in `config/app.php`:
Rapide\LaravelQueueKafka\LaravelQueueKafkaServiceProvider::class,
If you are using Lumen, put this in `bootstrap/app.php`
$app->register(Rapide\LaravelQueueKafka\LumenQueueKafkaServiceProvider::class);
6. Add these properties to `.env` with proper values:
QUEUE_DRIVER=kafka
7. If you want to run a worker for a specific consumer group
export KAFKA_CONSUMER_GROUP_ID="group2" && php artisan queue:work --sleep=3 --tries=3
Explaination of consumergroups can be found in this article
http://blog.cloudera.com/blog/2018/05/scalability-of-kafka-messaging-using-consumer-groups/
#### Usage
Once you completed the configuration you can use Laravel Queue API. If you used other queue drivers you do not need to change anything else. If you do not know how to use Queue API, please refer to the official Laravel documentation: http://laravel.com/docs/queues
#### Testing
Run the tests with:
``` bash
vendor/bin/phpunit
```
#### Acknowledgement
This library is inspired by [laravel-queue-rabbitmq](https://github.com/vyuldashev/laravel-queue-rabbitmq) by vyuldashev.
And the Kafka implementations by [Superbalist](https://github.com/Superbalist/php-pubsub-kafka) be sure to check those out.
#### Contribution
You can contribute to this package by discovering bugs and opening issues. Please, add to which version of package you create pull request or issue.
#### Supported versions of Laravel
Tested on: [5.4, 5.5, 5.6, 5.7]
#### New version is underway
A version for Laravel 6,7,8 is underway.
Also supporting the new RdKafka library