Indexed by TopGit from live GitHub metadata: tobi/delayed_job has 2.2k stars, written primarily in Ruby. Database backed asynchronous priority queue -- Extracted from Shopify
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Delayed_job (or DJ) encapsulates the common pattern of asynchronously executing longer tasks in the background.
It is a direct extraction from Shopify where the job table is responsible for a multitude of core tasks. Amongst those tasks are:
sending massive newsletters
image resizing
http downloads
updating smart collections
updating solr, our search server, after product changes
batch imports
spam checks
h2. Setup
The library evolves around a delayed_jobs table which can be created by using:
script/generate delayed_job
The created table looks as follows:
create_table :delayed_jobs, :force => true do |table|
table.integer :priority, :default => 0 # Allows some jobs to jump to the front of the queue
table.integer :attempts, :default => 0 # Provides for retries, but still fail eventually.
table.text :handler # YAML-encoded string of the object that will do work
table.string :last_error # reason for last failure (See Note below)
table.datetime :run_at # When to run. Could be Time.now for immediately, or sometime in the future.
table.datetime :locked_at # Set when a client is working on this object
table.datetime :failed_at # Set when all retries have failed (actually, by default, the record is deleted instead)
table.string :locked_by # Who is working on this object (if locked)
table.timestamps
end
On failure, the job is scheduled again in 5 seconds + N ** 4, where N is the number of retries.
The default @MAX_ATTEMPTS@ is @25@. After this, the job either deleted (default), or left in the database with "failed_at" set.
With the default of 25 attempts, the last retry will be 20 days later, with the last interval being almost 100 hours.
The default @MAX_RUN_TIME@ is @4.hours@. If your job takes longer than that, another computer could pick it up. It's up to you to
make sure your job doesn't exceed this time. You should set this to the longest time you think the job could take.
By default, it will delete failed jobs (and it always deletes successful jobs). If you want to keep failed jobs, set
@Delayed::Job.destroy_failed_jobs = false@. The failed jobs will be marked with non-null failed_at.
Here is an example of changing job parameters in Rails:
# config/initializers/delayed_job_config.rb
Delayed::Job.destroy_failed_jobs = false
silence_warnings do
Delayed::Job.const_set("MAX_ATTEMPTS", 3)
Delayed::Job.const_set("MAX_RUN_TIME", 5.minutes)
end
Note: If your error messages are long, consider changing last_error field to a :text instead of a :string (255 character limit).
h2. Usage
Jobs are simple ruby objects with a method called perform. Any object which responds to perform can be stuffed into the jobs table.
Job objects are serialized to yaml so that they can later be resurrected by the job runner.
class NewsletterJob < Struct.new(:text, :emails)
def perform
emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
end
end
Delayed::Job.enqueue NewsletterJob.new('lorem ipsum...', Customers.find(:all).collect(&:email))
There is also a second way to get jobs in the queue: send_later.
This will simply create a @Delayed::PerformableMethod@ job in the jobs table which serializes all the parameters you pass to it. There are some special smarts for active record objects
which are stored as their text representation and loaded from the database fresh when the job is actually run later.
h2. Running the jobs
You can invoke @rake jobs:work@ which will start working off jobs. You can cancel the rake task with @CTRL-C@.
You can also run by writing a simple @script/job_runner@, and invoking it externally:
Workers can be running on any computer, as long as they have access to the database and their clock is in sync. You can even
run multiple workers on per computer, but you must give each one a unique name:
3.times do |n|
worker = Delayed::Worker.new
worker.name = 'worker-' + n.to_s
worker.start
end
Keep in mind that each worker will check the database at least every 5 seconds.
Note: The rake task will exit if the database has any network connectivity problems.
h3. Cleaning up
You can invoke @rake jobs:clear@ to delete all jobs in the queue.
h3. Changes
1.7.0: Added failed_at column which can optionally be set after a certain amount of failed job attempts. By default failed job attempts are destroyed after about a month.
1.6.0: Renamed locked_until to locked_at. We now store when we start a given job instead of how long it will be locked by the worker. This allows us to get a reading on how long a job took to execute.
1.5.0: Job runners can now be run in parallel. Two new database columns are needed: locked_until and locked_by. This allows us to use pessimistic locking instead of relying on row level locks. This enables us to run as many worker processes as we need to speed up queue processing.
1.2.0: Added #send_later to Object for simpler job creation
TopGit's last sync did not record any GitHub topics for tobi/delayed_job. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on tobi/delayed_job?
The most recent commit recorded on tobi/delayed_job was 6.0 years ago, based on the GitHub push timestamp. The repository has 1.2k forks — one of the better signals of community interest.
How many stars does tobi/delayed_job have?
tobi/delayed_job has 2.2k GitHub stars — refresh the page for the live number, or check github.com/tobi/delayed_job. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is tobi/delayed_job open source?
Yes — tobi/delayed_job ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/tobi/delayed_job.
Where can I see tobi/delayed_job in action?
The project maintains a homepage at http://tobi.github.com/delayed_job. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about tobi/delayed_job?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/tobi/delayed_job is the definitive source.
Read full README in the tab above.
Still deciding about delayed_job?
One click hands the question to an AI along with this page — see what it says about delayed_job.