Class: Bluepill::Process
- Inherits:
-
Object
- Object
- Bluepill::Process
- Defined in:
- lib/bluepill/process.rb
Constant Summary collapse
- CONFIGURABLE_ATTRIBUTES =
[ :pre_start_command, :start_command, :stop_command, :restart_command, :stdout, :stderr, :stdin, :daemonize, :pid_file, :working_dir, :environment, :start_grace_time, :stop_grace_time, :restart_grace_time, :uid, :gid, :cache_actual_pid, :monitor_children, :child_process_factory, :pid_command, :auto_start, :supplementary_groups, :stop_signals ]
Instance Attribute Summary collapse
-
#children ⇒ Object
readonly
Returns the value of attribute children.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#name ⇒ Object
Returns the value of attribute name.
-
#process_running ⇒ Object
Returns the value of attribute process_running.
-
#skip_ticks_until ⇒ Object
Returns the value of attribute skip_ticks_until.
-
#statistics ⇒ Object
readonly
Returns the value of attribute statistics.
-
#triggers ⇒ Object
Returns the value of attribute triggers.
-
#watches ⇒ Object
Returns the value of attribute watches.
Instance Method Summary collapse
- #actual_pid ⇒ Object
- #actual_pid=(pid) ⇒ Object
- #add_trigger(name, options = {}) ⇒ Object
-
#add_watch(name, options = {}) ⇒ Object
Watch related methods.
- #cache_actual_pid? ⇒ Boolean
- #clean_threads ⇒ Object
- #clear_pid ⇒ Object
- #daemonize? ⇒ Boolean
- #determine_initial_state ⇒ Object
-
#dispatch!(event, reason = nil) ⇒ Object
State machine methods.
- #handle_user_command(cmd) ⇒ Object
-
#initialize(process_name, checks, options = {}) ⇒ Process
constructor
A new instance of Process.
- #monitor_children? ⇒ Boolean
- #notify_triggers(transition) ⇒ Object
- #pid_from_command ⇒ Object
- #pid_from_file ⇒ Object
- #pre_start_process ⇒ Object
- #prepare_command(command) ⇒ Object
-
#process_running?(force = false) ⇒ Boolean
System Process Methods.
- #record_transition(transition) ⇒ Object
- #refresh_children! ⇒ Object
- #restart_process ⇒ Object
- #run_watches ⇒ Object
- #signal_process(code) ⇒ Object
-
#skip_ticks_for(seconds) ⇒ Object
Internal State Methods.
- #skipping_ticks? ⇒ Boolean
- #start_process ⇒ Object
- #stop_process ⇒ Object
- #system_command_options ⇒ Object
- #tick ⇒ Object
- #unlink_pid ⇒ Object
- #with_timeout(secs, &blk) ⇒ Object
Constructor Details
#initialize(process_name, checks, options = {}) ⇒ Process
Returns a new instance of Process.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/bluepill/process.rb', line 106 def initialize(process_name, checks, = {}) @name = process_name @event_mutex = Monitor.new @watches = [] @triggers = [] @children = [] @threads = [] @statistics = ProcessStatistics.new @actual_pid = [:actual_pid] self.logger = [:logger] checks.each do |name, opts| if Trigger[name] self.add_trigger(name, opts) else self.add_watch(name, opts) end end # These defaults are overriden below if it's configured to be something else. @monitor_children = false @cache_actual_pid = true @start_grace_time = @stop_grace_time = @restart_grace_time = 3 @environment = {} CONFIGURABLE_ATTRIBUTES.each do |attribute_name| self.send("#{attribute_name}=", [attribute_name]) if .has_key?(attribute_name) end # Let state_machine do its initialization stuff super() # no arguments intentional end |
Instance Attribute Details
#children ⇒ Object (readonly)
Returns the value of attribute children.
50 51 52 |
# File 'lib/bluepill/process.rb', line 50 def children @children end |
#logger ⇒ Object
Returns the value of attribute logger.
48 49 50 |
# File 'lib/bluepill/process.rb', line 48 def logger @logger end |
#name ⇒ Object
Returns the value of attribute name.
48 49 50 |
# File 'lib/bluepill/process.rb', line 48 def name @name end |
#process_running ⇒ Object
Returns the value of attribute process_running.
48 49 50 |
# File 'lib/bluepill/process.rb', line 48 def process_running @process_running end |
#skip_ticks_until ⇒ Object
Returns the value of attribute skip_ticks_until.
48 49 50 |
# File 'lib/bluepill/process.rb', line 48 def skip_ticks_until @skip_ticks_until end |
#statistics ⇒ Object (readonly)
Returns the value of attribute statistics.
50 51 52 |
# File 'lib/bluepill/process.rb', line 50 def statistics @statistics end |
#triggers ⇒ Object
Returns the value of attribute triggers.
48 49 50 |
# File 'lib/bluepill/process.rb', line 48 def triggers @triggers end |
#watches ⇒ Object
Returns the value of attribute watches.
48 49 50 |
# File 'lib/bluepill/process.rb', line 48 def watches @watches end |
Instance Method Details
#actual_pid ⇒ Object
410 411 412 |
# File 'lib/bluepill/process.rb', line 410 def actual_pid pid_command ? pid_from_command : pid_from_file end |
#actual_pid=(pid) ⇒ Object
434 435 436 437 |
# File 'lib/bluepill/process.rb', line 434 def actual_pid=(pid) ProcessJournal.append_pid_to_journal(name, pid) # be sure to always log the pid @actual_pid = pid end |
#add_trigger(name, options = {}) ⇒ Object
201 202 203 |
# File 'lib/bluepill/process.rb', line 201 def add_trigger(name, = {}) self.triggers << Trigger[name].new(self, .merge(:logger => self.logger)) end |
#add_watch(name, options = {}) ⇒ Object
Watch related methods
197 198 199 |
# File 'lib/bluepill/process.rb', line 197 def add_watch(name, = {}) self.watches << ConditionWatch.new(name, .merge(:logger => self.logger)) end |
#cache_actual_pid? ⇒ Boolean
406 407 408 |
# File 'lib/bluepill/process.rb', line 406 def cache_actual_pid? !!@cache_actual_pid end |
#clean_threads ⇒ Object
384 385 386 387 |
# File 'lib/bluepill/process.rb', line 384 def clean_threads @threads.each { |t| t.kill } @threads.clear end |
#clear_pid ⇒ Object
439 440 441 |
# File 'lib/bluepill/process.rb', line 439 def clear_pid @actual_pid = nil end |
#daemonize? ⇒ Boolean
389 390 391 |
# File 'lib/bluepill/process.rb', line 389 def daemonize? !!self.daemonize end |
#determine_initial_state ⇒ Object
229 230 231 232 233 234 235 |
# File 'lib/bluepill/process.rb', line 229 def determine_initial_state if self.process_running?(true) self.state = 'up' else self.state = (auto_start == false) ? 'unmonitored' : 'down' # we need to check for false value end end |
#dispatch!(event, reason = nil) ⇒ Object
State machine methods
169 170 171 172 173 174 |
# File 'lib/bluepill/process.rb', line 169 def dispatch!(event, reason = nil) @event_mutex.synchronize do @statistics.record_event(event, reason) self.send("#{event}") end end |
#handle_user_command(cmd) ⇒ Object
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/bluepill/process.rb', line 237 def handle_user_command(cmd) case cmd when "start" if self.process_running?(true) logger.warning("Refusing to re-run start command on an already running process.") else dispatch!(:start, "user initiated") end when "stop" stop_process dispatch!(:unmonitor, "user initiated") when "restart" restart_process when "unmonitor" # When the user issues an unmonitor cmd, reset any triggers so that # scheduled events gets cleared triggers.each {|t| t.reset! } dispatch!(:unmonitor, "user initiated") end end |
#monitor_children? ⇒ Boolean
393 394 395 |
# File 'lib/bluepill/process.rb', line 393 def monitor_children? !!self.monitor_children end |
#notify_triggers(transition) ⇒ Object
192 193 194 |
# File 'lib/bluepill/process.rb', line 192 def notify_triggers(transition) self.triggers.each {|trigger| trigger.notify(transition)} end |
#pid_from_command ⇒ Object
429 430 431 432 |
# File 'lib/bluepill/process.rb', line 429 def pid_from_command pid = %x{#{pid_command}}.strip (pid =~ /\A\d+\z/) ? pid.to_i : nil end |
#pid_from_file ⇒ Object
414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/bluepill/process.rb', line 414 def pid_from_file return @actual_pid if cache_actual_pid? && @actual_pid @actual_pid = begin if pid_file if File.exists?(pid_file) str = File.read(pid_file) str.to_i if str.size > 0 else logger.warning("pid_file #{pid_file} does not exist or cannot be read") nil end end end end |
#pre_start_process ⇒ Object
297 298 299 300 301 302 303 304 305 |
# File 'lib/bluepill/process.rb', line 297 def pre_start_process return unless pre_start_command logger.warning "Executing pre start command: #{pre_start_command}" result = System.execute_blocking(pre_start_command, self.) unless result[:exit_code].zero? logger.warning "Pre start command execution returned non-zero exit code:" logger.warning result.inspect end end |
#prepare_command(command) ⇒ Object
480 481 482 |
# File 'lib/bluepill/process.rb', line 480 def prepare_command(command) command.to_s.gsub("{{PID}}", actual_pid.to_s) end |
#process_running?(force = false) ⇒ Boolean
System Process Methods
259 260 261 262 263 264 265 266 |
# File 'lib/bluepill/process.rb', line 259 def process_running?(force = false) @process_running = nil if force # clear existing state if forced @process_running ||= signal_process(0) # the process isn't running, so we should clear the PID self.clear_pid unless @process_running @process_running end |
#record_transition(transition) ⇒ Object
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/bluepill/process.rb', line 176 def record_transition(transition) unless transition.loopback? @transitioned = true # When a process changes state, we should clear the memory of all the watches self.watches.each { |w| w.clear_history! } # Also, when a process changes state, we should re-populate its child list if self.monitor_children? self.logger.warning "Clearing child list" self.children.clear end logger.info "Going from #{transition.from_name} => #{transition.to_name}" end end |
#refresh_children! ⇒ Object
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
# File 'lib/bluepill/process.rb', line 458 def refresh_children! # First prune the list of dead children @children.delete_if {|child| !child.process_running?(true) } # Add new found children to the list new_children_pids = System.get_children(self.actual_pid) - @children.map {|child| child.actual_pid} unless new_children_pids.empty? logger.info "Existing children: #{@children.collect{|c| c.actual_pid}.join(",")}. Got new children: #{new_children_pids.inspect} for #{actual_pid}" end # Construct a new process wrapper for each new found children new_children_pids.each do |child_pid| ProcessJournal.append_pid_to_journal(name, child_pid) name = "<child(pid:#{child_pid})>" logger = self.logger.prefix_with(name) child = self.child_process_factory.create_child_process(name, child_pid, logger) @children << child end end |
#restart_process ⇒ Object
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
# File 'lib/bluepill/process.rb', line 361 def restart_process if restart_command cmd = self.prepare_command(restart_command) logger.warning "Executing restart command: #{cmd}" with_timeout(restart_grace_time) do result = System.execute_blocking(cmd, self.) unless result[:exit_code].zero? logger.warning "Restart command execution returned non-zero exit code:" logger.warning result.inspect end end self.skip_ticks_for(restart_grace_time) else logger.warning "No restart_command specified. Must stop and start to restart" self.stop_process # the tick will bring it back. end end |
#run_watches ⇒ Object
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/bluepill/process.rb', line 205 def run_watches now = Time.now.to_i threads = self.watches.collect do |watch| [watch, Thread.new { Thread.current[:events] = watch.run(self.actual_pid, now) }] end @transitioned = false threads.inject([]) do |events, (watch, thread)| thread.join if thread[:events].size > 0 logger.info "#{watch.name} dispatched: #{thread[:events].join(',')}" thread[:events].each do |event| events << [event, watch.to_s] end end events end.each do |(event, reason)| break if @transitioned self.dispatch!(event, reason) end end |
#signal_process(code) ⇒ Object
397 398 399 400 401 402 403 404 |
# File 'lib/bluepill/process.rb', line 397 def signal_process(code) code = code.to_s.upcase if code.is_a?(String) || code.is_a?(Symbol) ::Process.kill(code, actual_pid) true rescue Exception => e logger.err "Failed to signal process #{actual_pid} with code #{code}: #{e}" false end |
#skip_ticks_for(seconds) ⇒ Object
Internal State Methods
448 449 450 451 452 |
# File 'lib/bluepill/process.rb', line 448 def skip_ticks_for(seconds) # TODO: should this be addative or longest wins? # i.e. if two calls for skip_ticks_for come in for 5 and 10, should it skip for 10 or 15? self.skip_ticks_until = (self.skip_ticks_until || Time.now.to_i) + seconds.to_i end |
#skipping_ticks? ⇒ Boolean
454 455 456 |
# File 'lib/bluepill/process.rb', line 454 def skipping_ticks? self.skip_ticks_until && self.skip_ticks_until > Time.now.to_i end |
#start_process ⇒ Object
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/bluepill/process.rb', line 268 def start_process ProcessJournal.kill_all_from_journal(name) # be sure nothing else is running from previous runs pre_start_process logger.warning "Executing start command: #{start_command}" if self.daemonize? daemon_id = System.daemonize(start_command, self.) if daemon_id > 0 ProcessJournal.append_pid_to_journal(name, daemon_id) children.each {|child| child_pid = child.actual_id ProcessJournal.append_pid_to_journal(name, child_id) } if self.monitor_children? end daemon_id else # This is a self-daemonizing process with_timeout(start_grace_time) do result = System.execute_blocking(start_command, self.) unless result[:exit_code].zero? logger.warning "Start command execution returned non-zero exit code:" logger.warning result.inspect end end end self.skip_ticks_for(start_grace_time) end |
#stop_process ⇒ Object
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/bluepill/process.rb', line 307 def stop_process if monitor_children System.get_children(self.actual_pid).each do |child_pid| ProcessJournal.append_pid_to_journal(name, child_pid) end end if stop_command cmd = self.prepare_command(stop_command) logger.warning "Executing stop command: #{cmd}" with_timeout(stop_grace_time) do result = System.execute_blocking(cmd, self.) unless result[:exit_code].zero? logger.warning "Stop command execution returned non-zero exit code:" logger.warning result.inspect end end elsif stop_signals # issue stop signals with configurable delay between each logger.warning "Sending stop signals to #{actual_pid}" @threads << Thread.new(self, stop_signals.clone) do |process, stop_signals| signal = stop_signals.shift logger.info "Sending signal #{signal} to #{process.actual_pid}" process.signal_process(signal) # send first signal until stop_signals.empty? # we already checked to make sure stop_signals had an odd number of items delay = stop_signals.shift signal = stop_signals.shift logger.debug "Sleeping for #{delay} seconds" sleep delay #break unless signal_process(0) #break unless the process can be reached unless process.signal_process(0) logger.debug "Process has terminated." break end logger.info "Sending signal #{signal} to #{process.actual_pid}" process.signal_process(signal) end end else logger.warning "Executing default stop command. Sending TERM signal to #{actual_pid}" signal_process("TERM") end ProcessJournal.kill_all_from_journal(name) # finish cleanup self.unlink_pid # TODO: we only write the pid file if we daemonize, should we only unlink it if we daemonize? self.skip_ticks_for(stop_grace_time) end |
#system_command_options ⇒ Object
484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/bluepill/process.rb', line 484 def { :uid => self.uid, :gid => self.gid, :working_dir => self.working_dir, :environment => self.environment, :pid_file => self.pid_file, :logger => self.logger, :stdin => self.stdin, :stdout => self.stdout, :stderr => self.stderr, :supplementary_groups => self.supplementary_groups } end |
#tick ⇒ Object
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/bluepill/process.rb', line 139 def tick return if self.skipping_ticks? self.skip_ticks_until = nil # clear the memoization per tick @process_running = nil # Deal with thread cleanup here since the stopping state isn't used clean_threads if self.unmonitored? # run state machine transitions super if self.up? self.run_watches if self.monitor_children? refresh_children! children.each {|child| child.tick} end end end |
#unlink_pid ⇒ Object
443 444 445 |
# File 'lib/bluepill/process.rb', line 443 def unlink_pid System.delete_if_exists(pid_file) end |
#with_timeout(secs, &blk) ⇒ Object
499 500 501 502 503 504 505 506 |
# File 'lib/bluepill/process.rb', line 499 def with_timeout(secs, &blk) Timeout.timeout(secs.to_f, &blk) rescue Timeout::Error logger.err "Execution is taking longer than expected. Unmonitoring." logger.err "Did you forget to tell bluepill to daemonize this process?" self.dispatch!("unmonitor") end |