Class: Puppet::Daemon Private

Inherits:
Object show all
Defined in:
lib/puppet/daemon.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Run periodic actions and a network server in a daemonized process.

A Daemon has 3 parts:

* config reparse
* (optional) an agent that responds to #run
* (optional) a server that response to #stop, #start, and #wait_for_shutdown

The config reparse will occur periodically based on Settings. The server will be started and is expected to manage its own run loop (and so not block the start call). The server will, however, still be waited for by using the #wait_for_shutdown method. The agent is run periodically and a time interval based on Settings. The config reparse will update this time interval when needed.

The Daemon is also responsible for signal handling, starting, stopping, running the agent on demand, and reloading the entire process. It ensures that only one Daemon is running by using a lockfile.

Constant Summary collapse

SIGNAL_CHECK_INTERVAL =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

5

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pidfile, scheduler = Puppet::Scheduler::Scheduler.new()) ⇒ Daemon

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Daemon


29
30
31
32
33
# File 'lib/puppet/daemon.rb', line 29

def initialize(pidfile, scheduler = Puppet::Scheduler::Scheduler.new())
  @scheduler = scheduler
  @pidfile = pidfile
  @signals = []
end

Instance Attribute Details

#agentObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


26
27
28
# File 'lib/puppet/daemon.rb', line 26

def agent
  @agent
end

#argvObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


26
27
28
# File 'lib/puppet/daemon.rb', line 26

def argv
  @argv
end

#serverObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


26
27
28
# File 'lib/puppet/daemon.rb', line 26

def server
  @server
end

#signalsObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


27
28
29
# File 'lib/puppet/daemon.rb', line 27

def signals
  @signals
end

Class Method Details

.close_streamsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Close stdin/stdout/stderr so that we can finish our transition into 'daemon' mode.


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/puppet/daemon.rb', line 60

def self.close_streams()
  Puppet.debug("Closing streams for daemon mode")
  begin
    $stdin.reopen "/dev/null"
    $stdout.reopen "/dev/null", "a"
    $stderr.reopen $stdout
    Puppet::Util::Log.reopen
    Puppet.debug("Finished closing streams for daemon mode")
  rescue => detail
    Puppet.err "Could not start #{Puppet.run_mode.name}: #{detail}"
    Puppet::Util::replace_file("/tmp/daemonout", 0644) do |f|
      f.puts "Could not start #{Puppet.run_mode.name}: #{detail}"
    end
    exit(12)
  end
end

Instance Method Details

#close_streamsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Convenience signature for calling Puppet::Daemon.close_streams


78
79
80
# File 'lib/puppet/daemon.rb', line 78

def close_streams()
  Puppet::Daemon.close_streams
end

#daemonizeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Put the daemon into the background.


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/puppet/daemon.rb', line 40

def daemonize
  pid = fork
  if pid
    Process.detach(pid)
    exit(0)
  end

  create_pidfile

  # Get rid of console logging
  Puppet::Util::Log.close(:console)

  Process.setsid
  Dir.chdir("/")

  close_streams
end

#daemonnameObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


35
36
37
# File 'lib/puppet/daemon.rb', line 35

def daemonname
  Puppet.run_mode.name
end

#reexecObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:


82
83
84
85
86
87
88
# File 'lib/puppet/daemon.rb', line 82

def reexec
  raise Puppet::DevError, _("Cannot reexec unless ARGV arguments are set") unless argv
  command = $0 + " " + argv.join(" ")
  Puppet.notice "Restarting with '#{command}'"
  stop(:exit => false)
  exec(command)
end

#reloadObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


90
91
92
93
94
95
# File 'lib/puppet/daemon.rb', line 90

def reload
  return unless agent
  agent.run({:splay => false})
rescue Puppet::LockError
  Puppet.notice "Not triggering already-running agent"
end

#reopen_logsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


102
103
104
# File 'lib/puppet/daemon.rb', line 102

def reopen_logs
  Puppet::Util::Log.reopen
end

#restartObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


97
98
99
100
# File 'lib/puppet/daemon.rb', line 97

def restart
  Puppet::Application.restart!
  reexec unless agent and agent.running?
end

#set_signal_trapsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Trap a couple of the main signals. This should probably be handled in a way that anyone else can register callbacks for traps, but, eh.


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/puppet/daemon.rb', line 108

def set_signal_traps
  [:INT, :TERM].each do |signal|
    Signal.trap(signal) do
      Puppet.notice "Caught #{signal}; exiting"
      stop
    end
  end

  # extended signals not supported under windows
  if !Puppet::Util::Platform.windows?
    signals = {:HUP => :restart, :USR1 => :reload, :USR2 => :reopen_logs }
    signals.each do |signal, method|
      Signal.trap(signal) do
        Puppet.notice "Caught #{signal}; storing #{method}"
        @signals << method
      end
    end
  end
end

#startObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:


141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/puppet/daemon.rb', line 141

def start
  create_pidfile

  raise Puppet::DevError, _("Daemons must have an agent, server, or both") unless agent or server

  # Start the listening server, if required.
  server.start if server

  # Finally, loop forever running events - or, at least, until we exit.
  run_event_loop

  server.wait_for_shutdown if server
end

#stop(args = {:exit => true}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Stop everything


129
130
131
132
133
134
135
136
137
138
139
# File 'lib/puppet/daemon.rb', line 129

def stop(args = {:exit => true})
  Puppet::Application.stop!

  server.stop if server

  remove_pidfile

  Puppet::Util::Log.close_all

  exit if args[:exit]
end