Auto-removal of jobs
Last updated
Was this helpful?
Last updated
Was this helpful?
By default, when your queue jobs are completed (or failed), they are stored in two special sets, the "completed" and the "failed" set. This is useful so that you can examine the results of your jobs, particularly in the early stages of development. However, as the solution reaches a production-grade level, we usually need to restrict the number of finished jobs to be kept, so that we do not fill Redis with data that is not particularly useful.
BullMQ supports different strategies for auto-removing finalized jobs. These strategies are configured on the Job's options and .
The simplest option is to set removeOnComplete
/removeOnFail
to true
, in this case, all jobs will be removed automatically as soon as they are finalized:
Jobs will be deleted regardless of their names.
It is also possible to specify a maximum number of jobs to keep. A good practice is to keep a handful of completed jobs and a much larger value of failed jobs:
One of the strategies to implement idempotence with BullMQ is to use unique job ids. When you add a job with an id that exists already in the queue, the new job is ignored and a duplicated event is triggered. It is important to keep this in mind when activating auto removal of jobs, since a job that has been removed will not be considered part of the queue anymore, and will not affect any future jobs that could have the same Id.
Another possibility is to keep jobs up to a certain age. The removeOn
option accepts a object, that includes an age
and a count
fields. The age
is used to specify how old jobs to keep (in seconds), and the count
can be used to limit the total amount to keep. The count
option is useful in cases we get an unexpected amount of jobs in a very short time, in this case we may just want to limit to a certain amount to avoid running out of memory.
💡