While building your web application, you may have some tasks, such as parsing and storing an uploaded CSV file, that take too long to perform during a typical web request. Thankfully, Laravel allows you to easily create queued jobs that may be processed in the background. By moving time intensive tasks to a queue, your application can respond to web requests with blazing speed and provide a better user experience to your customers. Show
Laravel queues provide a unified queueing API across a variety of different queue backends, such as Amazon SQS, Redis, or even a relational database. Laravel's queue configuration options are stored in your application's
41 configuration file. In this file, you will find connection configurations for each of the queue drivers that are included with the framework, including the database, Amazon SQS, Redis, and Beanstalkd drivers, as well as a synchronous driver that will execute jobs immediately (for use during local development). A
42 queue driver is also included which discards queued jobs. Note Laravel now offers Horizon, a beautiful dashboard and configuration system for your Redis powered queues. Check out the full Horizon documentation for more information. Connections Vs. QueuesBefore getting started with Laravel queues, it is important to understand the distinction between "connections" and "queues". In your
41 configuration file, there is a
44 configuration array. This option defines the connections to backend queue services such as Amazon SQS, Beanstalk, or Redis. However, any given queue connection may have multiple "queues" which may be thought of as different stacks or piles of queued jobs. Note that each connection configuration example in the
45 configuration file contains a
45 attribute. This is the default queue that jobs will be dispatched to when they are sent to a given connection. In other words, if you dispatch a job without explicitly defining which queue it should be dispatched to, the job will be placed on the queue that is defined in the
45 attribute of the connection configuration:
Some applications may not need to ever push jobs onto multiple queues, instead preferring to have one simple queue. However, pushing jobs to multiple queues can be especially useful for applications that wish to prioritize or segment how jobs are processed, since the Laravel queue worker allows you to specify which queues it should process by priority. For example, if you push jobs to a
48 queue, you may run a worker that gives them higher processing priority:
Driver Notes & PrerequisitesDatabaseIn order to use the
49 queue driver, you will need a database table to hold the jobs. To generate a migration that creates this table, run the
50 Artisan command. Once the migration has been created, you may migrate your database using the
51 command:
Finally, don't forget to instruct your application to use the
49 driver by updating the
53 variable in your application's
54 file:
RedisIn order to use the
55 queue driver, you should configure a Redis database connection in your
56 configuration file. Warning Redis Cluster If your Redis queue connection uses a Redis Cluster, your queue names must contain a . This is required in order to ensure all of the Redis keys for a given queue are placed into the same hash slot:
Blocking When using the Redis queue, you may use the
60 configuration option to specify how long the driver should wait for a job to become available before iterating through the worker loop and re-polling the Redis database. Adjusting this value based on your queue load can be more efficient than continually polling the Redis database for new jobs. For instance, you may set the value to
61 to indicate that the driver should block for five seconds while waiting for a job to become available:
Warning Other Driver PrerequisitesThe following dependencies are needed for the listed queue drivers. These dependencies may be installed via the Composer package manager:
Creating JobsGenerating Job ClassesBy default, all of the queueable jobs for your application are stored in the
68 directory. If the
68 directory doesn't exist, it will be created when you run the
70 Artisan command:
The generated class will implement the
71 interface, indicating to Laravel that the job should be pushed onto the queue to run asynchronously. Note Job stubs may be customized using . Class StructureJob classes are very simple, normally containing only a
72 method that is invoked when the job is processed by the queue. To get started, let's take a look at an example job class. In this example, we'll pretend we manage a podcast publishing service and need to process the uploaded podcast files before they are published:
In this example, note that we were able to pass an Eloquent model directly into the queued job's constructor. Because of the
73 trait that the job is using, Eloquent models and their loaded relationships will be gracefully serialized and unserialized when the job is processing. If your queued job accepts an Eloquent model in its constructor, only the identifier for the model will be serialized onto the queue. When the job is actually handled, the queue system will automatically re-retrieve the full model instance and its loaded relationships from the database. This approach to model serialization allows for much smaller job payloads to be sent to your queue driver.
72 Method Dependency Injection The
72 method is invoked when the job is processed by the queue. Note that we are able to type-hint dependencies on the
72 method of the job. The Laravel service container automatically injects these dependencies. If you would like to take total control over how the container injects dependencies into the
72 method, you may use the container's
78 method. The
78 method accepts a callback which receives the job and the container. Within the callback, you are free to invoke the
72 method however you wish. Typically, you should call this method from the
81 method of your
82 service provider:
Warning Queued RelationshipsBecause all loaded Eloquent model relationships also get serialized when a job is queued, the serialized job string can sometimes become quite large. Furthermore, when a job is deserialized and model relationships are re-retrieved from the database, they will be retrieved in their entirety. Any previous relationship constraints that were applied before the model was serialized during the job queueing process will not be applied when the job is deserialized. Therefore, if you wish to work with a subset of a given relationship, you should re-constrain that relationship within your queued job. Or, to prevent relations from being serialized, you can call the
84 method on the model when setting a property value. This method will return an instance of the model without its loaded relationships:
If you are using PHP constructor property promotion and would like to indicate that an Eloquent model should not have its relations serialized, you may use the
85 attribute:
0 If a job receives a collection or array of Eloquent models instead of a single model, the models within that collection will not have their relationships restored when the job is deserialized and executed. This is to prevent excessive resource usage on jobs that deal with large numbers of models. Unique JobsWarning Sometimes, you may want to ensure that only one instance of a specific job is on the queue at any point in time. You may do so by implementing the
92 interface on your job class. This interface does not require you to define any additional methods on your class:
1 In the example above, the
93 job is unique. So, the job will not be dispatched if another instance of the job is already on the queue and has not finished processing. In certain cases, you may want to define a specific "key" that makes the job unique or you may want to specify a timeout beyond which the job no longer stays unique. To accomplish this, you may define
94 and
95 properties or methods on your job class:
2 In the example above, the
93 job is unique by a product ID. So, any new dispatches of the job with the same product ID will be ignored until the existing job has completed processing. In addition, if the existing job is not processed within one hour, the unique lock will be released and another job with the same unique key can be dispatched to the queue. Warning If your application dispatches jobs from multiple web servers or containers, you should ensure that all of your servers are communicating with the same central cache server so that Laravel can accurately determine if a job is unique. Keeping Jobs Unique Until Processing BeginsBy default, unique jobs are "unlocked" after a job completes processing or fails all of its retry attempts. However, there may be situations where you would like your job to unlock immediately before it is processed. To accomplish this, your job should implement the
97 contract instead of the
92 contract:
3 Unique Job LocksBehind the scenes, when a
92 job is dispatched, Laravel attempts to acquire a with the
94 key. If the lock is not acquired, the job is not dispatched. This lock is released when the job completes processing or fails all of its retry attempts. By default, Laravel will use the default cache driver to obtain this lock. However, if you wish to use another driver for acquiring the lock, you may define a
01 method that returns the cache driver that should be used:
4 Note If you only need to limit the concurrent processing of a job, use the job middleware instead. Encrypted JobsLaravel allows you to ensure the privacy and integrity of a job's data via encryption. To get started, simply add the
03 interface to the job class. Once this interface has been added to the class, Laravel will automatically encrypt your job before pushing it onto a queue:
5 Job MiddlewareJob middleware allow you to wrap custom logic around the execution of queued jobs, reducing boilerplate in the jobs themselves. For example, consider the following
72 method which leverages Laravel's Redis rate limiting features to allow only one job to process every five seconds:
6 While this code is valid, the implementation of the
72 method becomes noisy since it is cluttered with Redis rate limiting logic. In addition, this rate limiting logic must be duplicated for any other jobs that we want to rate limit. Instead of rate limiting in the handle method, we could define a job middleware that handles rate limiting. Laravel does not have a default location for job middleware, so you are welcome to place job middleware anywhere in your application. In this example, we will place the middleware in an
06 directory:
7 As you can see, like route middleware, job middleware receive the job being processed and a callback that should be invoked to continue processing the job. After creating job middleware, they may be attached to a job by returning them from the job's
07 method. This method does not exist on jobs scaffolded by the
70 Artisan command, so you will need to manually add it to your job class:
8 Note Job middleware can also be assigned to queueable event listeners, mailables, and notifications. Rate LimitingAlthough we just demonstrated how to write your own rate limiting job middleware, Laravel actually includes a rate limiting middleware that you may utilize to rate limit jobs. Like , job rate limiters are defined using the
09 facade's
10 method. For example, you may wish to allow users to backup their data once per hour while imposing no such limit on premium customers. To accomplish this, you may define a
09 in the
81 method of your
13:
9 In the example above, we defined an hourly rate limit; however, you may easily define a rate limit based on minutes using the
14 method. In addition, you may pass any value you wish to the
15 method of the rate limit; however, this value is most often used to segment rate limits by customer:
0 Once you have defined your rate limit, you may attach the rate limiter to your job using the
16 middleware. Each time the job exceeds the rate limit, this middleware will release the job back to the queue with an appropriate delay based on the rate limit duration.
1 Releasing a rate limited job back onto the queue will still increment the job's total number of
17. You may wish to tune your
18 and
19 properties on your job class accordingly. Or, you may wish to use the to define the amount of time until the job should no longer be attempted. If you do not want a job to be retried when it is rate limited, you may use the
21 method:
2 Note Preventing Job OverlapsLaravel includes an
23 middleware that allows you to prevent job overlaps based on an arbitrary key. This can be helpful when a queued job is modifying a resource that should only be modified by one job at a time. For example, let's imagine you have a queued job that updates a user's credit score and you want to prevent credit score update job overlaps for the same user ID. To accomplish this, you can return the
02 middleware from your job's
07 method:
3 Any overlapping jobs of the same type will be released back to the queue. You may also specify the number of seconds that must elapse before the released job will be attempted again:
4 If you wish to immediately delete any overlapping jobs so that they will not be retried, you may use the
21 method:
5 The
02 middleware is powered by Laravel's atomic lock feature. Sometimes, your job may unexpectedly fail or timeout in such a way that the lock is not released. Therefore, you may explicitly define a lock expiration time using the
28 method. For example, the example below will instruct Laravel to release the
02 lock three minutes after the job has started processing:
6 Warning The Sharing Lock Keys Across Job ClassesBy default, the
02 middleware will only prevent overlapping jobs of the same class. So, although two different job classes may use the same lock key, they will not be prevented from overlapping. However, you can instruct Laravel to apply the key across job classes using the
38 method:
7 Throttling ExceptionsLaravel includes a
39 middleware that allows you to throttle exceptions. Once the job throws a given number of exceptions, all further attempts to execute the job are delayed until a specified time interval lapses. This middleware is particularly useful for jobs that interact with third-party services that are unstable. For example, let's imagine a queued job that interacts with a third-party API that begins throwing exceptions. To throttle exceptions, you can return the
40 middleware from your job's
07 method. Typically, this middleware should be paired with a job that implements :
8 The first constructor argument accepted by the middleware is the number of exceptions the job can throw before being throttled, while the second constructor argument is the number of minutes that should elapse before the job is attempted again once it has been throttled. In the code example above, if the job throws 10 exceptions within 5 minutes, we will wait 5 minutes before attempting the job again. When a job throws an exception but the exception threshold has not yet been reached, the job will typically be retried immediately. However, you may specify the number of minutes such a job should be delayed by calling the
42 method when attaching the middleware to the job:
9 Internally, this middleware uses Laravel's cache system to implement rate limiting, and the job's class name is utilized as the cache "key". You may override this key by calling the
15 method when attaching the middleware to your job. This may be useful if you have multiple jobs interacting with the same third-party service and you would like them to share a common throttling "bucket":
0 Note Dispatching JobsOnce you have written your job class, you may dispatch it using the
45 method on the job itself. The arguments passed to the
45 method will be given to the job's constructor:
1 If you would like to conditionally dispatch a job, you may use the
47 and
48 methods:
2 In new Laravel applications, the
49 driver is the default queue driver. This driver executes jobs synchronously in the foreground of the current request, which is often convenient during local development. If you would like to actually begin queueing jobs for background processing, you may specify a different queue driver within your application's
41 configuration file. Delayed DispatchingIf you would like to specify that a job should not be immediately available for processing by a queue worker, you may use the
51 method when dispatching the job. For example, let's specify that a job should not be available for processing until 10 minutes after it has been dispatched:
3 Warning The Amazon SQS queue service has a maximum delay time of 15 minutes. Dispatching After The Response Is Sent To BrowserAlternatively, the
52 method delays dispatching a job until after the HTTP response is sent to the user's browser if your web server is using FastCGI. This will still allow the user to begin using the application even though a queued job is still executing. This should typically only be used for jobs that take about a second, such as sending an email. Since they are processed within the current HTTP request, jobs dispatched in this fashion do not require a queue worker to be running in order for them to be processed:
4 You may also
45 a closure and chain the
54 method onto the
45 helper to execute a closure after the HTTP response has been sent to the browser:
5 Synchronous DispatchingIf you would like to dispatch a job immediately (synchronously), you may use the
56 method. When using this method, the job will not be queued and will be executed immediately within the current process:
6 Jobs & Database TransactionsWhile it is perfectly fine to dispatch jobs within database transactions, you should take special care to ensure that your job will actually be able to execute successfully. When dispatching a job within a transaction, it is possible that the job will be processed by a worker before the parent transaction has committed. When this happens, any updates you have made to models or database records during the database transaction(s) may not yet be reflected in the database. In addition, any models or database records created within the transaction(s) may not exist in the database. Thankfully, Laravel provides several methods of working around this problem. First, you may set the
57 connection option in your queue connection's configuration array:
7 When the
57 option is
59, you may dispatch jobs within database transactions; however, Laravel will wait until the open parent database transactions have been committed before actually dispatching the job. Of course, if no database transactions are currently open, the job will be dispatched immediately. If a transaction is rolled back due to an exception that occurs during the transaction, the jobs that were dispatched during that transaction will be discarded. Note Specifying Commit Dispatch Behavior InlineIf you do not set the
57 queue connection configuration option to
59, you may still indicate that a specific job should be dispatched after all open database transactions have been committed. To accomplish this, you may chain the
64 method onto your dispatch operation:
8 Likewise, if the
57 configuration option is set to
59, you may indicate that a specific job should be dispatched immediately without waiting for any open database transactions to commit:
9 Job ChainingJob chaining allows you to specify a list of queued jobs that should be run in sequence after the primary job has executed successfully. If one job in the sequence fails, the rest of the jobs will not be run. To execute a queued job chain, you may use the
67 method provided by the
68 facade. Laravel's command bus is a lower level component that queued job dispatching is built on top of:
0 In addition to chaining job class instances, you may also chain closures:
1 Warning Chain Connection & QueueIf you would like to specify the connection and queue that should be used for the chained jobs, you may use the
70 and
71 methods. These methods specify the queue connection and queue name that should be used unless the queued job is explicitly assigned a different connection / queue:
2 Chain FailuresWhen chaining jobs, you may use the
72 method to specify a closure that should be invoked if a job within the chain fails. The given callback will receive the
73 instance that caused the job failure:
3 Warning Customizing The Queue & ConnectionDispatching To A Particular QueueBy pushing jobs to different queues, you may "categorize" your queued jobs and even prioritize how many workers you assign to various queues. Keep in mind, this does not push jobs to different queue "connections" as defined by your queue configuration file, but only to specific queues within a single connection. To specify the queue, use the
71 method when dispatching the job:
4 Alternatively, you may specify the job's queue by calling the
71 method within the job's constructor:
5 Dispatching To A Particular ConnectionIf your application interacts with multiple queue connections, you may specify which connection to push a job to using the
70 method:
6 You may chain the
70 and
71 methods together to specify the connection and the queue for a job:
7 Alternatively, you may specify the job's connection by calling the
70 method within the job's constructor:
8 Specifying Max Job Attempts / Timeout ValuesMax AttemptsIf one of your queued jobs is encountering an error, you likely do not want it to keep retrying indefinitely. Therefore, Laravel provides various ways to specify how many times or for how long a job may be attempted. One approach to specifying the maximum number of times a job may be attempted is via the
81 switch on the Artisan command line. This will apply to all jobs processed by the worker unless the job being processed specifies the number of times it may be attempted:
9 If a job exceeds its maximum number of attempts, it will be considered a "failed" job. For more information on handling failed jobs, consult the . If
82 is provided to the
40 command, the job will be retried indefinitely. You may take a more granular approach by defining the maximum number of times a job may be attempted on the job class itself. If the maximum number of attempts is specified on the job, it will take precedence over the
81 value provided on the command line:
0 Time Based AttemptsAs an alternative to defining how many times a job may be attempted before it fails, you may define a time at which the job should no longer be attempted. This allows a job to be attempted any number of times within a given time frame. To define the time at which a job should no longer be attempted, add a
20 method to your job class. This method should return a
86 instance:
1 Note Max ExceptionsSometimes you may wish to specify that a job may be attempted many times, but should fail if the retries are triggered by a given number of unhandled exceptions (as opposed to being released by the
89 method directly). To accomplish this, you may define a
19 property on your job class:
2 In this example, the job is released for ten seconds if the application is unable to obtain a Redis lock and will continue to be retried up to 25 times. However, the job will fail if three unhandled exceptions are thrown by the job. TimeoutOften, you know roughly how long you expect your queued jobs to take. For this reason, Laravel allows you to specify a "timeout" value. By default, the timeout value is 60 seconds. If a job is processing for longer than the number of seconds specified by the timeout value, the worker processing the job will exit with an error. Typically, the worker will be restarted automatically by a . The maximum number of seconds that jobs can run may be specified using the
91 switch on the Artisan command line:
3 If the job exceeds its maximum attempts by continually timing out, it will be marked as failed. You may also define the maximum number of seconds a job should be allowed to run on the job class itself. If the timeout is specified on the job, it will take precedence over any timeout specified on the command line:
4 Sometimes, IO blocking processes such as sockets or outgoing HTTP connections may not respect your specified timeout. Therefore, when using these features, you should always attempt to specify a timeout using their APIs as well. For example, when using Guzzle, you should always specify a connection and request timeout value. Warning The
Failing On TimeoutIf you would like to indicate that a job should be marked as on timeout, you may define the
93 property on the job class:
5 Error HandlingIf an exception is thrown while the job is being processed, the job will automatically be released back onto the queue so it may be attempted again. The job will continue to be released until it has been attempted the maximum number of times allowed by your application. The maximum number of attempts is defined by the
81 switch used on the
40 Artisan command. Alternatively, the maximum number of attempts may be defined on the job class itself. More information on running the queue worker . Manually Releasing A JobSometimes you may wish to manually release a job back onto the queue so that it can be attempted again at a later time. You may accomplish this by calling the
89 method:
6 By default, the
89 method will release the job back onto the queue for immediate processing. However, you may instruct the queue to not make the job available for processing until a given number of seconds has elapsed by passing an integer or date instance to the
89 method:
7 Manually Failing A JobOccasionally you may need to manually mark a job as "failed". To do so, you may call the
99 method:
8 If you would like to mark your job as failed because of an exception that you have caught, you may pass the exception to the
99 method. Or, for convenience, you may pass a string error message which will be converted to an exception for you:
9 Note For more information on failed jobs, check out the . Job BatchingLaravel's job batching feature allows you to easily execute a batch of jobs and then perform some action when the batch of jobs has completed executing. Before getting started, you should create a database migration to build a table which will contain meta information about your job batches, such as their completion percentage. This migration may be generated using the
01 Artisan command:
0 Defining Batchable JobsTo define a batchable job, you should as normal; however, you should add the
02 trait to the job class. This trait provides access to a
03 method which may be used to retrieve the current batch that the job is executing within:
1 Dispatching BatchesTo dispatch a batch of jobs, you should use the
03 method of the
68 facade. Of course, batching is primarily useful when combined with completion callbacks. So, you may use the
06,
72, and
08 methods to define completion callbacks for the batch. Each of these callbacks will receive an
09 instance when they are invoked. In this example, we will imagine we are queueing a batch of jobs that each process a given number of rows from a CSV file:
2 The batch's ID, which may be accessed via the
10 property, may be used to for information about the batch after it has been dispatched. Warning Naming BatchesSome tools such as Laravel Horizon and Laravel Telescope may provide more user-friendly debug information for batches if batches are named. To assign an arbitrary name to a batch, you may call the
12 method while defining the batch:
3 Batch Connection & QueueIf you would like to specify the connection and queue that should be used for the batched jobs, you may use the
70 and
71 methods. All batched jobs must execute within the same connection and queue:
4 Chains & BatchesYou may define a set of within a batch by placing the chained jobs within an array. For example, we may execute two job chains in parallel and execute a callback when both job chains have finished processing:
5 Conversely, you may run batches of jobs within a by defining batches within the chain. For example, you could first run a batch of jobs to release multiple podcasts then a batch of jobs to send the release notifications:
6 Adding Jobs To BatchesSometimes it may be useful to add additional jobs to a batch from within a batched job. This pattern can be useful when you need to batch thousands of jobs which may take too long to dispatch during a web request. So, instead, you may wish to dispatch an initial batch of "loader" jobs that hydrate the batch with even more jobs:
7 In this example, we will use the
15 job to hydrate the batch with additional jobs. To accomplish this, we may use the
16 method on the batch instance that may be accessed via the job's
03 method:
8 Warning You may only add jobs to a batch from within a job that belongs to the same batch. Inspecting BatchesThe
09 instance that is provided to batch completion callbacks has a variety of properties and methods to assist you in interacting with and inspecting a given batch of jobs:
9 Returning Batches From RoutesAll
09 instances are JSON serializable, meaning you can return them directly from one of your application's routes to retrieve a JSON payload containing information about the batch, including its completion progress. This makes it convenient to display information about the batch's completion progress in your application's UI. To retrieve a batch by its ID, you may use the
68 facade's
21 method:
0 Cancelling BatchesSometimes you may need to cancel a given batch's execution. This can be accomplished by calling the
22 method on the
09 instance:
1 As you may have noticed in the previous examples, batched jobs should typically determine if their corresponding batch has been cancelled before continuing execution. However, for convenience, you may assign the
24 to the job instead. As its name indicates, this middleware will instruct Laravel to not process the job if its corresponding batch has been cancelled:
2 Batch FailuresWhen a batched job fails, the
72 callback (if assigned) will be invoked. This callback is only invoked for the first job that fails within the batch. Allowing FailuresWhen a job within a batch fails, Laravel will automatically mark the batch as "cancelled". If you wish, you may disable this behavior so that a job failure does not automatically mark the batch as cancelled. This may be accomplished by calling the
26 method while dispatching the batch:
3 Retrying Failed Batch JobsFor convenience, Laravel provides a
27 Artisan command that allows you to easily retry all of the failed jobs for a given batch. The
27 command accepts the UUID of the batch whose failed jobs should be retried:
4 Pruning BatchesWithout pruning, the
29 table can accumulate records very quickly. To mitigate this, you should schedule the
30 Artisan command to run daily:
5 By default, all finished batches that are more than 24 hours old will be pruned. You may use the
31 option when calling the command to determine how long to retain batch data. For example, the following command will delete all batches that finished over 48 hours ago:
6 Sometimes, your
32 table may accumulate batch records for batches that never completed successfully, such as batches where a job failed and that job was never retried successfully. You may instruct the
30 command to prune these unfinished batch records using the
34 option:
7 Likewise, your
32 table may also accumulate batch records for cancelled batches. You may instruct the
30 command to prune these cancelled batch records using the
37 option:
8 Storing Batches In DynamoDBLaravel also provides support for storing batch meta information in DynamoDB instead of a relational database. However, you will need to manually create a DynamoDB table to store all of the batch records. Typically, this table should be named
29, but you should name the table based on the value of the
39 configuration value within your application's
45 configuration file. DynamoDB Batch Table ConfigurationThe
29 table should have a string primary partition key named
42 and a string primary sort key named
43. The
42 portion of the key will contain your application's name as defined by the
12 configuration value within your application's
46 configuration file. Since the application name is part of the DynamoDB table's key, you can use the same table to store job batches for multiple Laravel applications. In addition, you may define
47 attribute for your table if you would like to take advantage of . DynamoDB ConfigurationNext, install the AWS SDK so that your Laravel application can communicate with Amazon DynamoDB:
9 Then, set the
48 configuration option's value to
88. In addition, you should define
50,
51, and
52 configuration options within the
53 configuration array. These options will be used to authenticate with AWS. When using the
88 driver, the
55 configuration option is unnecessary:
0 Pruning Batches In DynamoDBWhen utilizing DynamoDB to store job batch information, the typical pruning commands used to prune batches stored in a relational database will not work. Instead, you may utilize DynamoDB's native TTL functionality to automatically remove records for old batches. If you defined your DynamoDB table with a
47 attribute, you may define configuration parameters to instruct Laravel how to prune batch records. The
57 configuration value defines the name of the attribute holding the TTL, while the
58 configuration value defines the number of seconds after which a batch record can be removed from the DynamoDB table, relative to the last time the record was updated:
1 Queueing ClosuresInstead of dispatching a job class to the queue, you may also dispatch a closure. This is great for quick, simple tasks that need to be executed outside of the current request cycle. When dispatching closures to the queue, the closure's code content is cryptographically signed so that it can not be modified in transit:
2 Using the
72 method, you may provide a closure that should be executed if the queued closure fails to complete successfully after exhausting all of your queue's :
3 Warning Running The Queue WorkerThe
40 Command Laravel includes an Artisan command that will start a queue worker and process new jobs as they are pushed onto the queue. You may run the worker using the
40 Artisan command. Note that once the
40 command has started, it will continue to run until it is manually stopped or you close your terminal:
4 Note You may include the
67 flag when invoking the
40 command if you would like the processed job IDs to be included in the command's output:
5 Remember, queue workers are long-lived processes and store the booted application state in memory. As a result, they will not notice changes in your code base after they have been started. So, during your deployment process, be sure to . In addition, remember that any static state created or modified by your application will not be automatically reset between jobs. Alternatively, you may run the
69 command. When using the
69 command, you don't have to manually restart the worker when you want to reload your updated code or reset the application state; however, this command is significantly less efficient than the
40 command:
6 Running Multiple Queue WorkersTo assign multiple workers to a queue and process jobs concurrently, you should simply start multiple
40 processes. This can either be done locally via multiple tabs in your terminal or in production using your process manager's configuration settings. , you may use the
73 configuration value. Specifying The Connection & QueueYou may also specify which queue connection the worker should utilize. The connection name passed to the
74 command should correspond to one of the connections defined in your
41 configuration file:
7 By default, the
40 command only processes jobs for the default queue on a given connection. However, you may customize your queue worker even further by only processing particular queues for a given connection. For example, if all of your emails are processed in an
77 queue on your
55 queue connection, you may issue the following command to start a worker that only processes that queue:
8 Processing A Specified Number Of JobsThe
79 option may be used to instruct the worker to only process a single job from the queue:
9 The
80 option may be used to instruct the worker to process the given number of jobs and then exit. This option may be useful when combined with so that your workers are automatically restarted after processing a given number of jobs, releasing any memory they may have accumulated:
0 Processing All Queued Jobs & Then ExitingThe
81 option may be used to instruct the worker to process all jobs and then exit gracefully. This option can be useful when processing Laravel queues within a Docker container if you wish to shutdown the container after the queue is empty:
1 Processing Jobs For A Given Number Of SecondsThe
82 option may be used to instruct the worker to process jobs for the given number of seconds and then exit. This option may be useful when combined with so that your workers are automatically restarted after processing jobs for a given amount of time, releasing any memory they may have accumulated:
2 Worker Sleep DurationWhen jobs are available on the queue, the worker will keep processing jobs with no delay in between jobs. However, the
83 option determines how many seconds the worker will "sleep" if there are no jobs available. Of course, while sleeping, the worker will not process any new jobs:
3 Resource ConsiderationsDaemon queue workers do not "reboot" the framework before processing each job. Therefore, you should release any heavy resources after each job completes. For example, if you are doing image manipulation with the GD library, you should free the memory with
84 when you are done processing the image. Queue PrioritiesSometimes you may wish to prioritize how your queues are processed. For example, in your
41 configuration file, you may set the default
45 for your
55 connection to
88. However, occasionally you may wish to push a job to a
48 priority queue like so:
4 To start a worker that verifies that all of the
48 queue jobs are processed before continuing to any jobs on the
88 queue, pass a comma-delimited list of queue names to the
74 command:
5 Queue Workers & DeploymentSince queue workers are long-lived processes, they will not notice changes to your code without being restarted. So, the simplest way to deploy an application using queue workers is to restart the workers during your deployment process. You may gracefully restart all of the workers by issuing the
93 command:
6 This command will instruct all queue workers to gracefully exit after they finish processing their current job so that no existing jobs are lost. Since the queue workers will exit when the
93 command is executed, you should be running a process manager such as to automatically restart the queue workers. Note The queue uses the cache to store restart signals, so you should verify that a cache driver is properly configured for your application before using this feature. Job Expirations & TimeoutsJob ExpirationIn your
41 configuration file, each queue connection defines a
96 option. This option specifies how many seconds the queue connection should wait before retrying a job that is being processed. For example, if the value of
96 is set to
98, the job will be released back onto the queue if it has been processing for 90 seconds without being released or deleted. Typically, you should set the
96 value to the maximum number of seconds your jobs should reasonably take to complete processing. Warning Worker TimeoutsThe
40 Artisan command exposes a
91 option. By default, the
91 value is 60 seconds. If a job is processing for longer than the number of seconds specified by the timeout value, the worker processing the job will exit with an error. Typically, the worker will be restarted automatically by a :
7 The
96 configuration option and the
91 CLI option are different, but work together to ensure that jobs are not lost and that jobs are only successfully processed once. Warning Supervisor ConfigurationIn production, you need a way to keep your
40 processes running. A
40 process may stop running for a variety of reasons, such as an exceeded worker timeout or the execution of the
93 command. For this reason, you need to configure a process monitor that can detect when your
40 processes exit and automatically restart them. In addition, process monitors can allow you to specify how many
40 processes you would like to run concurrently. Supervisor is a process monitor commonly used in Linux environments and we will discuss how to configure it in the following documentation. Installing SupervisorSupervisor is a process monitor for the Linux operating system, and will automatically restart your
40 processes if they fail. To install Supervisor on Ubuntu, you may use the following command:
8 Note If configuring and managing Supervisor yourself sounds overwhelming, consider using Laravel Forge, which will automatically install and configure Supervisor for your production Laravel projects. Configuring SupervisorSupervisor configuration files are typically stored in the
16 directory. Within this directory, you may create any number of configuration files that instruct supervisor how your processes should be monitored. For example, let's create a
17 file that starts and monitors
40 processes:
9 In this example, the
73 directive will instruct Supervisor to run eight
40 processes and monitor all of them, automatically restarting them if they fail. You should change the
21 directive of the configuration to reflect your desired queue connection and worker options. Warning Starting SupervisorOnce the configuration file has been created, you may update the Supervisor configuration and start the processes using the following commands:
00 For more information on Supervisor, consult the Supervisor documentation. Dealing With Failed JobsSometimes your queued jobs will fail. Don't worry, things don't always go as planned! Laravel includes a convenient way to . After an asynchronous job has exceeded this number of attempts, it will be inserted into the
23 database table. that fail are not stored in this table and their exceptions are immediately handled by the application. A migration to create the
23 table is typically already present in new Laravel applications. However, if your application does not contain a migration for this table, you may use the
25 command to create the migration:
01 When running a process, you may specify the maximum number of times a job should be attempted using the
81 switch on the
40 command. If you do not specify a value for the
81 option, jobs will only be attempted once or as many times as specified by the job class'
29 property:
02 Using the
30 option, you may specify how many seconds Laravel should wait before retrying a job that has encountered an exception. By default, a job is immediately released back onto the queue so that it may be attempted again:
03 If you would like to configure how many seconds Laravel should wait before retrying a job that has encountered an exception on a per-job basis, you may do so by defining a
42 property on your job class:
04 If you require more complex logic for determining the job's backoff time, you may define a
42 method on your job class:
05 You may easily configure "exponential" backoffs by returning an array of backoff values from the
42 method. In this example, the retry delay will be 1 second for the first retry, 5 seconds for the second retry, 10 seconds for the third retry, and 10 seconds for every subsequent retry if there are more attempts remaining:
06 Cleaning Up After Failed JobsWhen a particular job fails, you may want to send an alert to your users or revert any actions that were partially completed by the job. To accomplish this, you may define a
34 method on your job class. The
73 instance that caused the job to fail will be passed to the
34 method:
07 Warning Retrying Failed JobsTo view all of the failed jobs that have been inserted into your
23 database table, you may use the
40 Artisan command:
08 The
40 command will list the job ID, connection, queue, failure time, and other information about the job. The job ID may be used to retry the failed job. For instance, to retry a failed job that has an ID of
42, issue the following command:
09 If necessary, you may pass multiple IDs to the command:
10 You may also retry all of the failed jobs for a particular queue:
11 To retry all of your failed jobs, execute the
43 command and pass
44 as the ID:
12 If you would like to delete a failed job, you may use the
45 command:
13 Note To delete all of your failed jobs from the
23 table, you may use the
49 command:
14 Ignoring Missing ModelsWhen injecting an Eloquent model into a job, the model is automatically serialized before being placed on the queue and re-retrieved from the database when the job is processed. However, if the model has been deleted while the job was waiting to be processed by a worker, your job may fail with a
50. For convenience, you may choose to automatically delete jobs with missing models by setting your job's
51 property to
59. When this property is set to
59, Laravel will quietly discard the job without raising an exception:
15 Pruning Failed JobsYou may prune the records in your application's
23 table by invoking the
55 Artisan command:
16 By default, all the failed job records that are more than 24 hours old will be pruned. If you provide the
56 option to the command, only the failed job records that were inserted within the last N number of hours will be retained. For example, the following command will delete all the failed job records that were inserted more than 48 hours ago:
17 Storing Failed Jobs In DynamoDBLaravel also provides support for storing your failed job records in DynamoDB instead of a relational database table. However, you must manually create a DynamoDB table to store all of the failed job records. Typically, this table should be named
23, but you should name the table based on the value of the
58 configuration value within your application's
45 configuration file. The
23 table should have a string primary partition key named
42 and a string primary sort key named
62. The
42 portion of the key will contain your application's name as defined by the
12 configuration value within your application's
46 configuration file. Since the application name is part of the DynamoDB table's key, you can use the same table to store failed jobs for multiple Laravel applications. In addition, ensure that you install the AWS SDK so that your Laravel application can communicate with Amazon DynamoDB:
9 Next, set the
66 configuration option's value to
88. In addition, you should define
50,
51, and
52 configuration options within the failed job configuration array. These options will be used to authenticate with AWS. When using the
88 driver, the
72 configuration option is unnecessary:
19 Disabling Failed Job StorageYou may instruct Laravel to discard failed jobs without storing them by setting the
66 configuration option's value to
42. Typically, this may be accomplished via the
75 environment variable:
20 Failed Job EventsIf you would like to register an event listener that will be invoked when a job fails, you may use the
76 facade's
77 method. For example, we may attach a closure to this event from the
81 method of the
13 that is included with Laravel:
21 Clearing Jobs From QueuesNote If you would like to delete all jobs from the default queue of the default connection, you may do so using the
81 Artisan command:
22 You may also provide the
83 argument and
45 option to delete jobs from a specific connection and queue:
23 Warning Clearing jobs from queues is only available for the SQS, Redis, and database queue drivers. In addition, the SQS message deletion process takes up to 60 seconds, so jobs sent to the SQS queue up to 60 seconds after you clear the queue might also be deleted. Monitoring Your QueuesIf your queue receives a sudden influx of jobs, it could become overwhelmed, leading to a long wait time for jobs to complete. If you wish, Laravel can alert you when your queue job count exceeds a specified threshold. To get started, you should schedule the
85 command to run every minute. The command accepts the names of the queues you wish to monitor as well as your desired job count threshold:
24 Scheduling this command alone is not enough to trigger a notification alerting you of the queue's overwhelmed status. When the command encounters a queue that has a job count exceeding your threshold, an
86 event will be dispatched. You may listen for this event within your application's
87 in order to send a notification to you or your development team:
25 TestingWhen testing code that dispatches jobs, you may wish to instruct Laravel to not actually execute the job itself, since the job's code can be tested directly and separately of the code that dispatches it. Of course, to test the job itself, you may instantiate a job instance and invoke the
72 method directly in your test. You may use the
76 facade's
90 method to prevent queued jobs from actually being pushed to the queue. After calling the
76 facade's
90 method, you may then assert that the application attempted to push jobs to the queue:
26 You may pass a closure to the
93 or
94 methods in order to assert that a job was pushed that passes a given "truth test". If at least one job was pushed that passes the given truth test then the assertion will be successful:
27 Faking A Subset Of JobsIf you only need to fake specific jobs while allowing your other jobs to execute normally, you may pass the class names of the jobs that should be faked to the
90 method:
28 You may fake all jobs except for a set of specified jobs using the
96 method:
29 Testing Job ChainsTo test job chains, you will need to utilize the
68 facade's faking capabilities. The
68 facade's
99 method may be used to assert that a was dispatched. The
99 method accepts an array of chained jobs as its first argument:
30 As you can see in the example above, the array of chained jobs may be an array of the job's class names. However, you may also provide an array of actual job instances. When doing so, Laravel will ensure that the job instances are of the same class and have the same property values of the chained jobs dispatched by your application:
31 You may use the
01 method to assert that a job was pushed without a chain of jobs:
32 Testing Chained BatchesIf your job chain , you may assert that the chained batch matches your expectations by inserting a
02 definition within your chain assertion:
33 Testing Job BatchesThe
68 facade's
04 method may be used to assert that a was dispatched. The closure given to the
04 method receives an instance of
06, which may be used to inspect the jobs within the batch:
34 You may use the
07 method to assert that a given number of batches were dispatched:
35 You may use
08 to assert that no batches were dispatched:
36 Testing Job / Batch InteractionIn addition, you may occasionally need to test an individual job's interaction with its underlying batch. For example, you may need to test if a job cancelled further processing for its batch. To accomplish this, you need to assign a fake batch to the job via the
09 method. The
09 method returns a tuple containing the job instance and the fake batch:
37 Job EventsUsing the
11 and
12 methods on the
76 facade, you may specify callbacks to be executed before or after a queued job is processed. These callbacks are a great opportunity to perform additional logging or increment statistics for a dashboard. Typically, you should call these methods from the
81 method of a service provider. For example, we may use the
13 that is included with Laravel:
38 Using the
16 method on the
76 facade, you may specify callbacks that execute before the worker attempts to fetch a job from a queue. For example, you might register a closure to rollback any transactions that were left open by a previously failed job: |