Module: Sensu::Daemon

Includes:
Utilities
Included in:
API::Process, Client::Process, Server::Process
Defined in:
lib/sensu/daemon.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utilities

#deep_merge, #find_attribute_value, #random_uuid, #redact_sensitive, #retry_until_true, #substitute_tokens, #testing?

Instance Attribute Details

#start_time ⇒ Object (readonly)

Returns the value of attribute start_time.



37
38
39
 
# File 'lib/sensu/daemon.rb', line 37

def start_time
  @start_time
end

Instance Method Details

#initialize(options = {}) ⇒ Object

Initialize the Sensu process. Set the start time, initial service state, set up the logger, load settings, load extensions, and optionally daemonize the process and/or create a PID file. A subclass may override this method.

Parameters:

  • options (Hash) (defaults to: {}) 


45
46
47
48
49
50
51
52
53
54
 
# File 'lib/sensu/daemon.rb', line 45

def initialize(options={})
  @start_time = Time.now.to_i
  @state = :initializing
  @timers = {:run => []}
  setup_logger(options)
  load_settings(options)
  load_extensions(options)
  setup_spawn
  setup_process(options)
end

#load_extensions(options = {}) ⇒ Object

Load Sensu extensions and log any notices. Set the logger and settings for each extension instance. This method creates the extensions instance variable: ‘@extensions`.

github.com/sensu/sensu-extensions github.com/sensu/sensu-extension

Parameters:

  • options (Hash) (defaults to: {}) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/sensu/daemon.rb', line 147

def load_extensions(options={})
  @extensions = Extensions.get(options)
  log_notices(@extensions.warnings)
  extension_settings = @settings.to_hash.dup
  @extensions.all.each do |extension|
    extension.logger = @logger
    extension.settings = extension_settings
  end
end

#load_settings(options = {}) ⇒ Object

Load Sensu settings. This method creates the settings instance variable: ‘@settings`. If the `validate_config` option is true, this method calls `validate_settings!()` to validate the latest compiled configuration settings and will then exit the process. If the `print_config` option is true, this method calls `print_settings!()` to output the compiled configuration settings and will then exit the process. If there are loading or validation errors, they will be logged (notices), and this method will exit(2) the process.

github.com/sensu/sensu-settings

Parameters:

  • options (Hash) (defaults to: {}) 


127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/sensu/daemon.rb', line 127

def load_settings(options={})
  @settings = Settings.get(options)
  validate_settings!(@settings) if options[:validate_config]
  log_notices(@settings.warnings)
  log_notices(@settings.errors, :fatal)
  print_settings!(@settings) if options[:print_config]
  unless @settings.errors.empty?
    @logger.fatal("SENSU NOT RUNNING!")
    exit 2
  end
end

#log_notices(notices = [], level = :warn) ⇒ Object

Log setting or extension loading notices, sensitive information is redacted.

Parameters:

  • notices (Array) (defaults to: []) —

    to be logged.

  • level (Symbol) (defaults to: :warn) —

    to log the notices at.



73
74
75
76
77
78
 
# File 'lib/sensu/daemon.rb', line 73

def log_notices(notices=[], level=:warn)
  notices.each do |concern|
    message = concern.delete(:message)
    @logger.send(level, message, redact_sensitive(concern))
  end
end

#pause ⇒ Object

Pause the Sensu service and set the service state to ‘:paused`. This method will likely be overridden by a subclass.



188
189
190
 
# File 'lib/sensu/daemon.rb', line 188

def pause
  @state = :paused
end

#print_settings!(settings) ⇒ Object

Print the Sensu settings (JSON) to STDOUT and immediately exit the process with the appropriate exit status code. This method is used while troubleshooting configuration issues, triggered by a CLI argument, e.g. ‘–print_config`. Sensu settings with sensitive values (e.g. passwords) are first redacted.

Parameters:

  • settings (Object) 


106
107
108
109
110
111
 
# File 'lib/sensu/daemon.rb', line 106

def print_settings!(settings)
  redacted_settings = redact_sensitive(settings.to_hash)
  @logger.warn("outputting compiled configuration and exiting")
  puts Sensu::JSON.dump(redacted_settings, :pretty => true)
  exit(settings.errors.empty? ? 0 : 2)
end

#resume ⇒ Object

Resume the paused Sensu service and set the service state to ‘:running`. This method will likely be overridden by a subclass.



194
195
196
 
# File 'lib/sensu/daemon.rb', line 194

def resume
  @state = :running
end

#setup_logger(options = {}) ⇒ Object

Set up the Sensu logger and its process signal traps for log rotation and debug log level toggling. This method creates the logger instance variable: ‘@logger`.

github.com/sensu/sensu-logger

Parameters:

  • options (Hash) (defaults to: {}) 


63
64
65
66
 
# File 'lib/sensu/daemon.rb', line 63

def setup_logger(options={})
  @logger = Logger.get(options)
  @logger.setup_signal_traps
end

#setup_process(options) ⇒ Object

Manage the current process, optionally daemonize and/or write the current process ID to a PID file.

Parameters:

  • options (Hash) 


175
176
177
178
 
# File 'lib/sensu/daemon.rb', line 175

def setup_process(options)
  daemonize if options[:daemonize]
  write_pid(options[:pid_file]) if options[:pid_file]
end

#setup_redis {|Object| ... } ⇒ Object

Set up the Redis connection. Sensu uses Redis as a data store, to store the client registry, current events, etc. The Sensu service will stop gracefully in the event of a Redis error, and pause/resume in the event of connectivity issues. This method creates the Redis instance variable: ‘@redis`.

github.com/sensu/sensu-redis

Yields:

  • (Object) —

    passes initialized and connected Redis connection object to the callback/block.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/sensu/daemon.rb', line 281

def setup_redis
  @logger.debug("connecting to redis", :settings => @settings[:redis])
  Redis.connect(@settings[:redis]) do |connection|
    @redis = connection
    @redis.on_error do |error|
      @logger.error("redis connection error", :error => error.to_s)
    end
    @redis.before_reconnect do
      unless testing?
        @logger.warn("reconnecting to redis")
        pause
      end
    end
    @redis.after_reconnect do
      @logger.info("reconnected to redis")
      resume
    end
    yield(@redis)
  end
end

#setup_signal_traps ⇒ Object

Set up process signal traps. This method uses the ‘STOP_SIGNALS` constant to determine which process signals will result in a graceful service stop. A periodic timer must be used to poll for received signals, as Mutex#lock cannot be used within the context of `trap()`.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/sensu/daemon.rb', line 212

def setup_signal_traps
  @signals = []
  STOP_SIGNALS.each do |signal|
    Signal.trap(signal) do
      @signals << signal
    end
  end
  EM::PeriodicTimer.new(1) do
    signal = @signals.shift
    if STOP_SIGNALS.include?(signal)
      @logger.warn("received signal", :signal => signal)
      stop
    end
  end
end

#setup_spawn ⇒ Object

Set up Sensu spawn, creating a worker to create, control, and limit spawned child processes. This method adjusts the EventMachine thread pool size to accommodate the concurrent process spawn limit and other Sensu process operations.

github.com/sensu/sensu-spawn



163
164
165
166
167
168
169
 
# File 'lib/sensu/daemon.rb', line 163

def setup_spawn
  @logger.info("configuring sensu spawn", :settings => @settings[:sensu][:spawn])
  threadpool_size = @settings[:sensu][:spawn][:limit] + 10
  @logger.debug("setting eventmachine threadpool size", :size => threadpool_size)
  EM.threadpool_size = threadpool_size
  Spawn.setup(@settings[:sensu][:spawn])
end

#setup_transport {|Object| ... } ⇒ Object

Set up the Sensu transport connection. Sensu uses a transport API, allowing it to use various message brokers. By default, Sensu will use the built-in “rabbitmq” transport. The Sensu service will stop gracefully in the event of a transport error, and pause/resume in the event of connectivity issues. This method creates the transport instance variable: ‘@transport`.

github.com/sensu/sensu-transport

Yields:

  • (Object) —

    passes initialized and connected Transport connection object to the callback/block.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/sensu/daemon.rb', line 239

def setup_transport
  transport_name = @settings[:transport][:name]
  transport_settings = @settings[transport_name]
  @logger.debug("connecting to transport", {
    :name => transport_name,
    :settings => transport_settings
  })
  Transport.logger = @logger
  Transport.connect(transport_name, transport_settings) do |connection|
    @transport = connection
    @transport.on_error do |error|
      @logger.error("transport connection error", :error => error.to_s)
      if @settings[:transport][:reconnect_on_error]
        @transport.reconnect
      else
        stop
      end
    end
    @transport.before_reconnect do
      unless testing?
        @logger.warn("reconnecting to transport")
        pause
      end
    end
    @transport.after_reconnect do
      @logger.info("reconnected to transport")
      resume
    end
    yield(@transport)
  end
end

#start ⇒ Object

Start the Sensu service and set the service state to ‘:running`. This method will likely be overridden by a subclass.



182
183
184
 
# File 'lib/sensu/daemon.rb', line 182

def start
  @state = :running
end

#stop ⇒ Object

Stop the Sensu service and set the service state to ‘:stopped`. This method will likely be overridden by a subclass. This method should stop the EventMachine event loop.



201
202
203
204
205
 
# File 'lib/sensu/daemon.rb', line 201

def stop
  @state = :stopped
  @logger.warn("stopping reactor")
  EM::stop_event_loop
end

#validate_settings!(settings) ⇒ Object

Determine if the Sensu settings are valid, if there are load or validation errors, and immediately exit the process with the appropriate exit status code. This method is used to determine if the latest configuration changes are valid prior to restarting the Sensu service, triggered by a CLI argument, e.g. ‘–validate_config`.

Parameters:

  • settings (Object) 


88
89
90
91
92
93
94
95
96
97
 
# File 'lib/sensu/daemon.rb', line 88

def validate_settings!(settings)
  if settings.errors.empty?
    puts "configuration is valid"
    exit
  else
    puts "configuration is invalid"
    puts Sensu::JSON.dump({:errors => @settings.errors}, :pretty => true)
    exit 2
  end
end