@@ -122,7 +122,19 @@ Background tasks in Ruby On Rails made dead simple. run "RAILS_ENV=production ruby #{current_path}/script/daemons stop" run "RAILS_ENV=production ruby #{current_path}/script/daemons start" end + +== CONFIGURATION: + + By default, completed background jobs that are more than one week old + will be cleaned out of the database on application startup, and the daemon + will check for queued background jobs every 5 seconds. + To override these settings, modify your config/daemons.yml file: + + background_fu: + cleanup_interval: :on_startup # :on_startup | :continuous + monitor_interval: 5 # Check every x seconds + == BONUS FEATURES: There are bonus features available if you set README.txt @@ -4,19 +4,20 @@ require File.dirname(__FILE__) + "/../../config/environment" Signal.trap("TERM") { exit } -if Job.included_modules.include?(Job::BonusFeatures) - RAILS_DEFAULT_LOGGER.info("BackgroundFu: Starting daemon (bonus features enabled).") -else - RAILS_DEFAULT_LOGGER.info("BackgroundFu: Starting daemon (bonus features disabled).") +RAILS_DEFAULT_LOGGER.info("BackgroundFu: Starting daemon (bonus features #{Job.included_modules.include?(Job::BonusFeatures) ? "enabled" : "disabled"}).") + +BackgroundFu::CONFIG.each do |k,v| + RAILS_DEFAULT_LOGGER.info "BackgroundFu: #{k}: #{v.to_s}" end +Job.cleanup_finished_jobs if BackgroundFu::CONFIG['cleanup_interval'] == :at_start + loop do if job = Job.find(:first, :conditions => ["state='pending' and start_at <= ?", Time.now], :order => "priority desc, start_at asc") job.get_done! else RAILS_DEFAULT_LOGGER.info("BackgroundFu: Waiting for jobs...") - sleep 5 + sleep BackgroundFu::CONFIG['monitor_interval'] end - - Job.destroy_all(["state='finished' and updated_at < ?", 1.week.ago]) + Job.cleanup_finished_jobs if BackgroundFu::CONFIG['cleanup_interval'] == :continuous end generators/background/templates/background.rb @@ -3,3 +3,6 @@ dir: ../../log multiple: false backtrace: true monitor: true +background_fu: + cleanup_interval: :on_startup # :on_startup or :continuous + monitor_interval: 5 # seconds between checks for queued jobs generators/background/templates/daemons.yml @@ -1,5 +1,8 @@ module BackgroundFu VERSION = "1.0.10" + CONFIG = YAML::load(File.open("#{RAILS_ROOT}/config/daemons.yml"))['background_fu'] || {} + CONFIG['cleanup_interval'] ||= :on_startup + CONFIG['monitor_interval'] ||= 10 end lib/background_fu.rb @@ -76,6 +76,12 @@ class Job < ActiveRecord::Base logger.info("BackgroundFu: Race condition handled (It's OK). Job(id: #{id}).") end + # Delete finished jobs that are more than a week old. + def self.cleanup_finished_jobs + logger.info "BackgroundFu: Cleaning up finished jobs." + Job.destroy_all(["state='finished' and updated_at < ?", 1.week.ago]) + end + def self.generate_state_helpers states.each do |state_name| define_method("#{state_name}?") do lib/job.rb f3753bb751a366f8b1844c17da80235fe04a986a Corey corey@seologic.com http://github.com/ncr/background-fu/commit/f16070c4232c03efaaf75a777a17afd8d5161fed f16070c4232c03efaaf75a777a17afd8d5161fed 2009-03-04T23:40:32-08:00 2009-03-04T21:02:13-08:00 Added ability to configure job check and job cleanup intervals through settings in config/daemons.yml. Updated README.txt includes instructions for overriding these defaults. Judicious use of these settings allows for reduction in number of ongoing database calls. Signed-off-by: Jacek Becela <jacek.becela@gmail.com> 9bdec4ced4ff2c214cd04a040621da5ffa5e2a6b Jacek Becela jacek.becela@gmail.com