Module: Resque::Pool::CLI

Extended by:
CLI, Logging
Includes:
Logging
Included in:
CLI
Defined in:
lib/resque/pool/cli.rb

Constant Summary

Constants included from Logging

Logging::PROCLINE_PREFIX

Instance Method Summary collapse

Methods included from Logging

app, is_log?, log, log_worker, procline, reopen_logs!

Instance Method Details

#daemonize ⇒ Object 



95
96
97
98
99
100
101
 
# File 'lib/resque/pool/cli.rb', line 95

def daemonize
  raise 'First fork failed' if (pid = fork) == -1
  exit unless pid.nil?
  Process.setsid
  raise 'Second fork failed' if (pid = fork) == -1
  exit unless pid.nil?
end

#manage_pidfile(pidfile) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/resque/pool/cli.rb', line 115

def manage_pidfile(pidfile)
  return unless pidfile
  pid = Process.pid
  if File.exist? pidfile
    if process_still_running? pidfile
      raise "Pidfile already exists at #{pidfile} and process is still running."
    else
      File.delete pidfile
    end
  else
    FileUtils.mkdir_p File.dirname(pidfile)
  end
  File.open pidfile, "w" do |f|
    f.write pid
  end
  at_exit do
    if Process.pid == pid
      File.delete pidfile
    end
  end
end

#obtain_shared_lock(lock_path) ⇒ Object

Obtain a lock on a file that will be held for the lifetime of the process. This aids in concurrent daemonized deployment with process managers like upstart since multiple pools can share a lock, but not a pidfile.



107
108
109
110
111
112
113
 
# File 'lib/resque/pool/cli.rb', line 107

def obtain_shared_lock(lock_path)
  return unless lock_path
  @lock_file = File.open(lock_path, 'w')
  unless @lock_file.flock(File::LOCK_SH)
    fail "unable to obtain shared lock on #{@lock_file}"
  end
end

#parse_options(argv = nil) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/resque/pool/cli.rb', line 24

def parse_options(argv=nil)
  opts = {}
  parser = OptionParser.new do |opt|
    opt.banner = <<-EOS.gsub(/^            /, '')
      resque-pool is the best way to manage a group (pool) of resque workers

      When daemonized, stdout and stderr default to resque-pool.stdxxx.log files in
      the log directory and pidfile defaults to resque-pool.pid in the current dir.

      Usage:
         resque-pool [options]
    EOS

    opt.separator ""
    opt.separator "Basic Options:"
    opt.on('-c', '--config PATH', "Alternate path to config file") { |c| opts[:config] = c }
    opt.on('-a', '--appname NAME', "Alternate appname (default is directory name)") { |c| opts[:appname] = c }
    opt.on("-E", '--environment ENVIRONMENT', "Set RAILS_ENV/RACK_ENV/RESQUE_ENV") { |c| opts[:environment] = c }

    opt.separator ""
    opt.separator "Logging options:"
    opt.on('-o', '--stdout FILE', "Redirect stdout to logfile") { |c| opts[:stdout] = c }
    opt.on('-e', '--stderr FILE', "Redirect stderr to logfile") { |c| opts[:stderr] = c }
    opt.on('--nosync', "Don't sync logfiles on every write") { opts[:nosync] = true }

    opt.separator ""
    opt.separator "Daemon options:"
    opt.on("-d", '--daemon', "Run as a background daemon") {
      opts[:daemon] = true
      opts[:stdout]  ||= "log/resque-pool.stdout.log"
      opts[:stderr]  ||= "log/resque-pool.stderr.log"
      opts[:pidfile] ||= "tmp/pids/resque-pool.pid" unless opts[:no_pidfile]
    }
    opt.on("-k", '--kill-others', "Shutdown any other Resque Pools on startup") { opts[:killothers] = true }
    opt.on("-p", '--pidfile FILE', "PID file location") { |c|
      opts[:pidfile] = c
      opts[:no_pidfile] = false
    }
    opt.on('--no-pidfile', "Force no pidfile, even if daemonized") {
      opts[:pidfile] = nil
      opts[:no_pidfile] = true
    }
    opt.on('-l', '--lock FILE', "Open a shared lock on a file") {|c| opts[:lock_file] = c }
    opt.on("-H", "--hot-swap", "Set appropriate defaults to hot-swap a new pool for a running pool") {|c|
      opts[:pidfile] = nil
      opts[:no_pidfile] = true
      opts[:lock_file] ||= "tmp/resque-pool.lock"
      opts[:killothers] = true
    }
    opt.on('--single-process-group', "Workers remain in the same process group as the master") { opts[:single_process_group] = true }

    opt.separator ""
    opt.separator "Signal handling options:"
    opt.on('--term-graceful-wait', "On TERM signal, wait for workers to shut down gracefully") { opts[:term_graceful_wait] = true }
    opt.on('--term-graceful',      "On TERM signal, shut down workers gracefully") { opts[:term_graceful] = true }
    opt.on('--term-immediate',     "On TERM signal, shut down workers immediately (default)") { opts[:term_immediate] = true }

    opt.separator ""
    opt.separator "Worker options:"
    opt.on("-s", '--spawn-delay MS', Integer, "Delay in milliseconds between spawning missing workers") { |c| opts[:spawn_delay] = c }

    opt.separator ""
    opt.separator "Other options:"
    opt.on("-h", "--help", "Show this help text.") { puts opt; exit }
    opt.on("-v", "--version", "Show Version"){ puts "resque-pool #{VERSION} (c) nicholas a. evans"; exit}
  end
  parser.parse!(argv || parser.default_argv)

  opts
end

#process_still_running?(pidfile) ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/resque/pool/cli.rb', line 137

def process_still_running?(pidfile)
  old_pid = open(pidfile).read.strip.to_i
  old_pid > 0 && Process.kill(0, old_pid)
rescue Errno::ESRCH
  false
rescue Errno::EPERM
  true
rescue ::Exception => e
  $stderr.puts "While checking if PID #{old_pid} is running, unexpected #{e.class}: #{e}"
  true
end

#redirect(opts) ⇒ Object 



149
150
151
152
153
154
155
156
157
 
# File 'lib/resque/pool/cli.rb', line 149

def redirect(opts)
  $stdin.reopen  '/dev/null'        if opts[:daemon]
  # need to reopen as File, or else Resque::Pool::Logging.reopen_logs! won't work
  out = File.new(opts[:stdout], "a") if opts[:stdout] && !opts[:stdout].empty?
  err = File.new(opts[:stderr], "a") if opts[:stderr] && !opts[:stderr].empty?
  $stdout.reopen out if out
  $stderr.reopen err if err
  $stdout.sync = $stderr.sync = true unless opts[:nosync]
end

#run ⇒ Object 



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/resque/pool/cli.rb', line 13

def run
  opts = parse_options
  obtain_shared_lock opts[:lock_file]
  daemonize if opts[:daemon]
  manage_pidfile opts[:pidfile]
  redirect opts
  setup_environment opts
  set_pool_options opts
  start_pool
end

#set_pool_options(opts) ⇒ Object

TODO: global variables are not the best way



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/resque/pool/cli.rb', line 160

def set_pool_options(opts)
  if opts[:daemon]
    Resque::Pool.handle_winch = true
  end
  if opts[:term_graceful_wait]
    Resque::Pool.term_behavior = "graceful_worker_shutdown_and_wait"
  elsif opts[:term_graceful]
    Resque::Pool.term_behavior = "graceful_worker_shutdown"
  elsif ENV["TERM_CHILD"]
    log "TERM_CHILD enabled, so will use 'term-graceful-and-wait' behaviour"
    Resque::Pool.term_behavior = "graceful_worker_shutdown_and_wait"
  end
  if ENV.include?("DYNO") && !ENV["TERM_CHILD"]
    log "WARNING: Are you running on Heroku? You should probably set TERM_CHILD=1"
  end
  if opts[:spawn_delay]
    Resque::Pool.spawn_delay = opts[:spawn_delay] * 0.001
  end
  Resque::Pool.kill_other_pools = !!opts[:killothers]
end

#setup_environment(opts) ⇒ Object 



181
182
183
184
185
186
187
 
# File 'lib/resque/pool/cli.rb', line 181

def setup_environment(opts)
  Resque::Pool.app_name = opts[:appname]    if opts[:appname]
  ENV["RACK_ENV"] = ENV["RAILS_ENV"] = ENV["RESQUE_ENV"] = opts[:environment] if opts[:environment]
  Resque::Pool.log "Resque Pool running in #{ENV["RAILS_ENV"] || "development"} environment"
  ENV["RESQUE_POOL_CONFIG"] = opts[:config] if opts[:config]
  Resque::Pool.single_process_group = opts[:single_process_group]
end

#start_pool ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/resque/pool/cli.rb', line 189

def start_pool
  require 'rake'
  self.const_set :RakeApp, Class.new(Rake::Application) {
    def default_task_name # :nodoc:
      "resque:pool"
    end
  }
  Rake.application = RakeApp.new
  require 'resque/pool/tasks'

  Rake.application.init
  Rake.application.load_rakefile
  Rake.application["resque:pool"].invoke
end