https://github.com/phpmessagebus/eventbus-queue
Event Bus asynchronous queuing with many Producer and Consumer implementations
https://github.com/phpmessagebus/eventbus-queue
amqp amqp-queue beanstalkd consumer event-driven event-driven-microservices event-driven-programming event-sourcing eventbus eventbus-queue middleware php php7 producer producer-consumer queue rabbitmq redisqueue supervisor
Last synced: 2 months ago
JSON representation
Event Bus asynchronous queuing with many Producer and Consumer implementations
- Host: GitHub
- URL: https://github.com/phpmessagebus/eventbus-queue
- Owner: PHPMessageBus
- License: mit
- Created: 2016-04-11T08:56:31.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-16T17:53:11.000Z (about 8 years ago)
- Last Synced: 2025-03-23T22:26:22.063Z (3 months ago)
- Topics: amqp, amqp-queue, beanstalkd, consumer, event-driven, event-driven-microservices, event-driven-programming, event-sourcing, eventbus, eventbus-queue, middleware, php, php7, producer, producer-consumer, queue, rabbitmq, redisqueue, supervisor
- Language: PHP
- Homepage: http://nilportugues.com
- Size: 47.9 KB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EventBus Queue
[](https://travis-ci.org/PHPMessageBus/eventbus-queue) [](https://scrutinizer-ci.com/g/PHPMessageBus/eventbus-queue/?branch=master) [](https://insight.sensiolabs.com/projects/3e4f3e13-a8c1-4f1e-a5ad-42e799915dfe) [](https://packagist.org/packages/nilportugues/eventbus-queue) [](https://packagist.org/packages/nilportugues/eventbus-queue) [](https://packagist.org/packages/nilportugues/eventbus-queue)
[](https://paypal.me/nilportugues)
- [Installation](#installation)
- [Usage](#usage)
- [ProducerEventBus](#producereventbus)
- [Consumer for the ProducerEventBus](#consumer-for-the-producereventbus)
- [EventBusWorker](#eventbusworker)
- [Adapter Configurations](#adapter-configurations)
- [PDOQueue](#pdoqueue)
- [MongoDBQueue](#mongodbqueue)
- [RedisQueue](#redisqueue)
- [PredisQueue](#predisqueue)
- [FileSystemQueue](#filesystemqueue)
- [AmqpQueue](#amqpqueue)
- [BeanstalkdQueue](#beanstalkdqueue)
- [Contribute](#contribute)
- [Support](#support)
- [Authors](#authors)
- [License](#license)
This package is an extension library for **[nilportugues/messagebus](http://github.com/PHPMessageBus/messagebus)**, adding queues to the EventBus implementation.
This package will provide you for the classes necessary to build:
- **The Producer**: code that sends the Event to a Queue by serializing the Event. This happens synchronously.
- **The Consumer**: code that reads in the background, therefore asynchronously, reads and unserializes the Event from the Queue and passes it to the EventBus to do the heavy lifting.
## Why?
It's all about deciding which command logic can be delayed, or hidden away in order to make it faster. And this is what we want to do.
**You never remove a bottleneck, you just move it.** The downside is that we might have to assume a possible delay.
## Installation
In order to start using this project you require to install it using [Composer](https://getcomposer.org):
```
composer require nilportugues/eventbus-queue
```
## Usage
This package will provide you with a new middleware: `ProducerEventBusMiddleware`.
This middleware requires a serializer and a storage that will depend on the Queue Adapter used. Supported adapters are:
- **PDOQueue**: queue built with a SQL database using Doctrine's DBAL.
- **MongoDBQueue**: queue built with MongoDB library.
- **RedisQueue**: queue using the Redis PHP extension.
- **PredisQueue**: queue using the Predis library.
- **FileSystemQueue**: queue built with using the local file system.
- **AmqpQueue**: use RabbitMQ or any queue implementing the Amqp protocol.
- **BeanstalkdQueue**: use Beanstalk as queue.
To set it up, register the `ProducerEventBusMiddleware` to the Event Bus. Because we'll need to define a second EventBus (consumer), we'll call this the `ProducerEventBus`.
#### ProducerEventBus
```php
consume(
$container->get('EventBusQueueAdapter'),
$container->get('ErrorQueue'),
$container->get('ConsumerEventBus')
);
```
Consumer class will run the `consume` method until all events are consumed. Then it will exit. This is optimal to make sure it will not leak memory.
If you need to keep the consumer running forever use server scripts like [Supervisor](http://supervisord.org/).
#### Supervisor Configuration
Supervisor is a process monitor for the Linux operating system, and will automatically restart your workers if they fail. To install Supervisor on Ubuntu, you may use the following command:
```sh
sudo apt-get install supervisor
```
Supervisor configuration files are typically stored in the `/etc/supervisor/conf.d` directory. Within this directory, you may create any number of configuration files that instruct how your processes should be monitored.
For instance, let's create `/etc/supervisor/conf.d/my_worker.conf` so that it starts and monitors a worker script named `my_worker.php`:
```ini
[program:my_worker]
process_name=%(program_name)s_%(process_num)02d
command=php my_worker.php
autostart=true
autorestart=true
user=www-data
numprocs=20
redirect_stderr=true
stdout_logfile=/var/log/my_worker.log
```
In this file, we tell Supervisor that we want 20 instances always running. If the `my_worker.php` ends or fails it will spin up a new one.
In order to make this task run forever, you'll have to type in the following commands:
```sh
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start my_worker
```
## Adapter Configurations
#### PDOQueue
For this to work, you'll be required to create a table in your database.
For instance, sqlite dialect table creation would be:
```sql
CREATE TABLE testAdapterQueue (
id INTEGER PRIMARY KEY AUTOINCREMENT,
event_data TEXT NOT NULL,
event_status CHAR(50),
created_at INTEGER NOT NULL
);
```
#### MongoDBQueue
In order to use it, you require to install PHP 7's mongodb extension.
```
sudo pecl install mongodb
```
#### RedisQueue
In order to use it, you require to install PHP 7's phpredis extension.
```
# Build Redis PHP module
git clone -b php7 https://github.com/phpredis/phpredis.git
sudo mv phpredis/ /etc/ && \
cd /etc/phpredis \
phpize \
./configure \
make && make install \
touch /etc/php/7.0/mods-available/redis.ini \
echo 'extension=redis.so' > /etc/php/7.0/mods-available/redis.ini
```
#### PredisQueue
Nothing, but performs better if phpredis extension is found.
#### FileSystemQueue
Nothing to do.
#### AmqpQueue
Nothing to do other than having access to a amqp server.
#### Beanstalkd
Nothing to do other than having access to a beanstalkd server.
## Contribute
Contributions to the package are always welcome!
* Report any bugs or issues you find on the [issue tracker](https://github.com/PHPMessageBus/event-bus-queue/issues/new).
* You can grab the source code at the package's [Git repository](https://github.com/PHPMessageBus/event-bus-queue).
## Support
Get in touch with me using one of the following means:
- Emailing me at
- Opening an [Issue](https://github.com/PHPMessageBus/event-bus-queue/issues/new)
## Authors
* [Nil Portugués Calderó](http://nilportugues.com)
* [The Community Contributors](https://github.com/PHPMessageBus/event-bus-queue/graphs/contributors)
## License
The code base is licensed under the [MIT license](LICENSE).