Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/instasent/instasentresquebundle
The resque bundle provides integration of php-resque to Symfony2. It is inspired from resque, a Redis-backed Ruby library for creating background jobs, placing them on multiple queues, and processing them later.
https://github.com/instasent/instasentresquebundle
php symfony symfony-bundle
Last synced: about 1 month ago
JSON representation
The resque bundle provides integration of php-resque to Symfony2. It is inspired from resque, a Redis-backed Ruby library for creating background jobs, placing them on multiple queues, and processing them later.
- Host: GitHub
- URL: https://github.com/instasent/instasentresquebundle
- Owner: instasent
- Created: 2016-04-15T02:34:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T10:03:55.000Z (6 months ago)
- Last Synced: 2024-10-01T15:27:58.492Z (about 2 months ago)
- Topics: php, symfony, symfony-bundle
- Language: PHP
- Size: 120 KB
- Stars: 4
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Intro to InstasentResqueBundle
> This is a fork from https://github.com/michelsalib/InstasentResqueBundle in order to keep its maintenance.
The Instasent resque bundle provides integration of [php-resque](https://github.com/chrisboulton/php-resque/) to Symfony. It is inspired from resque, a Redis-backed Ruby library for creating background jobs, placing them on multiple queues, and processing them later.
## Features:
- Creating a Job, with container access in order to leverage your Symfony services
- Enqueue a Job with parameters on a given queue
- Creating background worker on a given queue
- A UX to monitor your queues, workers and job statuses
- ability to schedule jobs to run at a specific time or after a number of seconds delay
- ability to auto re-queue failed jobs, with back-off strategies
TODOs:
- Log management
- Job status tracking
- Redis configuration
- Localisation
- Tests
## Screenshots
### Dashboard
## Installation and configuration:
### Requirements
Make sure you have redis installed on your machine: http://redis.io/
### Get the bundle
Add to your `instasent-resque-bundle` to your dependencies:
``` json
{
"require": {
...
"instasent/resque-bundle": "dev-master"
}
...
}
```
To install, run `php composer.phar [update|install]`.
### Add InstasentResqueBundle to your application kernel
``` php
get('instasent_resque.resque');
// create your job
$job = new MyJob();
$job->args = array(
'file' => '/tmp/file',
'content' => 'hello',
);
// enqueue your job
$resque->enqueue($job);
```
## Running a worker on a queue
Executing the following commands will create a work on :
- the `default` queue : `app/console instasent:resque:worker-start default`
- the `q1` and `q2` queue : `app/console instasent:resque:worker-start q1,q2` (separate name with `,`)
- all existing queues : `app/console instasent:resque:worker-start "*"`
You can also run a worker foreground by adding the `--foreground` option;
By default `VERBOSE` environment variable is set when calling php-resque
- `--verbose` option sets `VVERBOSE`
- `--quiet` disables both so no debug output is thrown
See php-resque logging option : https://github.com/chrisboulton/php-resque#logging
## Use monolog from your kernel
You can pass a monolog channel to write your logs, see example in supervisor config. Note: Pass Kernel ENV to resque is to instanciate logger, no for sharing kernel between jobs.
## Running a worker without forking
Sometimes intensive tasks may lose performance with forking mode. We have added a bin/resque-single binary, you can pass kernel file to be loaded only once at start. Be carefull cause if this Worker fails, then you need to restart manually this worker. We recommend to use supervisor to control this, and superlance with memory plugin to restart worker when hits some memory treshold. Be careful too with your code, shared variables, services instances... etc.
## Adding a delayed job to a queue
You can specify that a job is run at a specific time or after a specific delay (in seconds).
From your controller you can do:
``` php
get('instasent_resque.resque');
// create your job
$job = new MyJob();
$job->args = array(
'file' => '/tmp/file',
'content' => 'hello',
);
// enqueue your job to run at a specific \DateTime or int unix timestamp
$resque->enqueueAt(\DateTime|int $at, $job);
// or
// enqueue your job to run after a number of seconds
$resque->enqueueIn($seconds, $job);
```
You must also run a `scheduledworker`, which is responsible for taking items out of the special delayed queue and putting
them into the originally specified queue.
`app/console instasent:resque:scheduledworker-start`
Stop it later with `app/console instasent:resque:scheduledworker-stop`.
Note that when run in background mode it creates a PID file in 'cache//instasent_resque_scheduledworker.pid'. If you
clear your cache while the scheduledworker is running you won't be able to stop it with the `scheduledworker-stop` command.
Alternatively, you can run the scheduledworker in the foreground with the `--foreground` option.
Note also you should only ever have one scheduledworker running, and if the PID file already exists you will have to use
the `--force` option to start a scheduledworker.
## Manage production workers with supervisord
It's probably best to use supervisord (http://supervisord.org) to run the workers in production, rather than re-invent job
spawning, monitoring, stopping and restarting.
Here's a sample conf file
```ini
[program:myapp_phpresque_default]
command = /usr/bin/php /home/sites/myapp/prod/current/vendor/instasent/resque-bundle/Instasent/ResqueBundle/bin/resque
user = myusername
environment = APP_INCLUDE='/home/sites/myapp/prod/current/vendor/autoload.php',VERBOSE='1',QUEUE='default'
stopsignal=QUIT
[program:myapp_phpresque_default_single_worker]
command = /usr/bin/php /home/sites/myapp/prod/current/vendor/instasent/resque-bundle/Instasent/ResqueBundle/bin/resque-single
user = myusername
environment = APP_KERNEL='/home/sites/myapp/prod/current/app/AppKernel.php',APP_INCLUDE='/home/sites/myapp/prod/current/vendor/autoload.php',VERBOSE='1',QUEUE='default'
stopsignal=QUIT
[program:myapp_phpresque_scheduledworker]
command = /usr/bin/php /home/sites/myapp/prod/current/vendor/instasent/resque-bundle/Instasent/ResqueBundle/bin/resque-scheduler
user = myusername
environment = APP_INCLUDE='/home/sites/myapp/prod/current/vendor/autoload.php',VERBOSE='1',RESQUE_PHP='/home/sites/myapp/prod/current/vendor/chrisboulton/php-resque/lib/Resque.php'
stopsignal=QUIT
[program:myapp_phpresque_default_single_worker_logger]
command = /usr/bin/php /home/sites/myapp/prod/current/vendor/instasent/resque-bundle/Instasent/ResqueBundle/bin/resque-single
user = myusername
environment = APP_KERNEL='/home/sites/myapp/prod/current/app/AppKernel.php',LOG_CHANNEL='monolog.logger.custom',APP_INCLUDE='/home/sites/myapp/prod/current/vendor/autoload.php',VERBOSE='1',QUEUE='default'
stopsignal=QUIT
[group:myapp]
programs=myapp_phpresque_default,myapp_phpresque_scheduledworker
```
(If you use a custom Resque prefix, add an extra environment variable: PREFIX='my-resque-prefix')
Then in Capifony you can do
`sudo supervisorctl stop myapp:*` before deploying your app and `sudo supervisorctl start myapp:*` afterwards.
## More features
### Changing the queue
You can change a job queue just by setting the `queue` field of the job:
From within the job:
``` php
queue = 'my_queue';
}
public function run($args)
{
...
}
}
```
Or from outside the job:
``` php
queue = 'my_queue';
```
### Access the container from inside your job
Just extend the `ContainerAwareJob`:
``` php
getContainer()->getDoctrine();
...
}
}
```
### Stop a worker
Use the `app/console instasent:resque:worker-stop` command.
- No argument will display running workers that you can stop.
- Add a worker id to stop it: `app/console instasent:resque:worker-stop ubuntu:3949:default`
- Add the `--all` option to stop all the workers.
### Auto retry
You can have the bundle auto retry failed jobs by adding `retry strategy` for either a specific job, or for all jobs in general:
The following will allow `Some\Job` to retry 3 times.
* right away
* after a 10 second delay
* after a 60 second delay
```yml
instasent_resque:
redis:
....
auto_retry:
Some\Job: [0, 10, 60]
```
Setting strategy for all jobs:
```yml
instasent_resque:
auto_retry: [0, 10, 60]
```
With default strategy for all but specific jobs:
```yml
instasent_resque:
auto_retry:
default: [0, 10, 60]
Some\Job: [0, 10, 120, 240]
Some\Other\Job: [10, 30, 120, 600]
```
The `default` strategy (if provided) will be applied to all jobs that does not have a specific strategy attached. If not provided these jobs will not have auto retry.
You can disable `auto_retry` for selected jobs by using an empty array:
```yml
instasent_resque:
auto_retry:
default: [0, 10, 60]
Some\Job: []
Some\Other\Job: [10, 30, 120, 600]
```
Here `Some\Job` will not have any `auto_retry` attached.
**Please note**
To use the `auto_retry` feature, you must also run the scheduler job:
`app/console instasent:resque:scheduledworker-start`