Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiicod/yii2-jobqueue
Multi processes job queue
https://github.com/yiicod/yii2-jobqueue
multi-process queue yii2-jobs yii2-queue
Last synced: about 1 month ago
JSON representation
Multi processes job queue
- Host: GitHub
- URL: https://github.com/yiicod/yii2-jobqueue
- Owner: yiicod
- Created: 2017-08-25T11:14:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-27T15:56:12.000Z (over 6 years ago)
- Last Synced: 2024-11-08T23:57:21.399Z (2 months ago)
- Topics: multi-process, queue, yii2-jobs, yii2-queue
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Yii Job Queue based on Illuminate Queue
=======================================
[](https://packagist.org/packages/yiicod/yii2-jobqueue) [](https://packagist.org/packages/yiicod/yii2-jobqueue) [](https://scrutinizer-ci.com/g/yiicod/yii2-jobqueue/?branch=master)[](https://codeclimate.com/github/yiicod/yii2-jobqueue)
Provides Illuminate queues implementation for Yii 2 using mongodb as main storage.
#### Base config:
```php
'bootstrap' => [
'jobqueue'
],
'components' => [
'jobqueue' => [
'class' => \yiicod\jobqueue\JobQueue::class
],
'mongodb' => [
'class' => '\yii\mongodb\Connection',
'dsn' => 'mongodb://@localhost:27017/mydatabase',
],
]
```
#### Console config (simple fork)
```php
'bootstrap' => [
'jobqueue'
],
'controllerMap' => [
'job-queue' => [
'class' => \yiicod\jobqueue\commands\JobQueueCommand::class,
]
],
'components' => [
'jobqueue' => [
'class' => \yiicod\jobqueue\JobQueue::class
],
'mongodb' => [
'class' => '\yii\mongodb\Connection',
'dsn' => 'mongodb://@localhost:27017/mydatabase',
],
]
```
###### Start worker:
Run worker daemon with console command:
```php
$ php yii job-queue/start
```
Stop worker daemon:
```php
$ php yii job-queue/stop
```
#### Console config + PM2(http://pm2.keymetrics.io/). This variant more preferable for console configuration.
```php
'bootstrap' => [
'jobqueue'
],
'controllerMap' => [
'job-queue' => [
'class' => \yiicod\jobqueue\commands\WorkerCommand::class,
]
],
'components' => [
'jobqueue' => [
'class' => \yiicod\jobqueue\JobQueue::class
],
'mongodb' => [
'class' => '\yii\mongodb\Connection',
'dsn' => 'mongodb://@localhost:27017/mydatabase',
],
]
```
###### pm2 config:
```json
{
"apps": [
{
"name": "job-queue",
"script": "yii",
"args": [
"job-queue/work"
],
"exec_interpreter": "php",
"exec_mode": "fork_mode",
"max_memory_restart": "1G",
"watch": false,
"merge_logs": true,
"out_file": "runtime/logs/job_queue.log",
"error_file": "runtime/logs/job_queue.log"
}
]
}
```
###### Run PM2 daemons
```bash
pm2 start daemons-app.json
```
Note: Don't forget configure mongodb
#### Adding jobs to queue:
Create your own handler which implements yiicod\jobqueue\base\JobQueueInterface
OR extends yiicod\jobqueue\handlers\JobQueue
and run parent::fire($job, $data) to restart db connection before job process
```php
JobQueue::push(<--YOUR JOB QUEUE CLASS NAME->>, $data, $queue, $connection);
// Optional: $queue, $connection
```
Note: $data - additional data to your handler
#### Queue configuration:
Add jobqueue component with connections parameters, specially with "MongoThreadQueue" driver and connection name ("default" in example)
```php
'jobqueue' => [
'class' => \yiicod\jobqueue\JobQueue::class,
'connections' => [
'default' => [
'driver' => 'mongo-thread',
'table' => 'yii-jobs',
'queue' => 'default',
'connection' => 'mongodb', // Default mongodb connection
'expire' => 60,
'limit' => 1, // How many parallel process should run at the same time
],
]
]
```
Worker will take jobs from mongo database and run them by thread with defined driver using "mongo-thread" command in the background
Available events:
_________________
In Worker::class:
```php
EVENT_RAISE_BEFORE_JOB = 'raiseBeforeJobEvent';
EVENT_RAISE_AFTER_JOB = 'raiseAfterJobEvent';
EVENT_RAISE_EXCEPTION_OCCURED_JOB = 'raiseExceptionOccurredJobEvent';
EVENT_RAISE_FAILED_JOB = 'raiseFailedJobEvent';
EVENT_STOP = 'stop';
```