Class: Adhearsion::Initializer

Inherits:
Object
  • Object
show all
Defined in:
lib/adhearsion/initializer.rb

Constant Summary collapse

DEFAULT_PID_FILE_NAME = 
'adhearsion.pid'
InitializationFailedError = 
Class.new Adhearsion::Error

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Initializer

Creation of pid_files

- You may want to have Adhearsion create a process identification
  file when it boots so that a crash monitoring program such as
  Monit can reboot if necessary or so the init script can kill it
  for system shutdowns.
- To have Adhearsion create a pid file in the default location (i.e.
  AHN_INSTALL_DIR/adhearsion.pid), supply :pid_file with 'true'. Otherwise
  one is not created UNLESS it is running in daemon mode, in which
  case one is created. You can force Adhearsion to not create one
  even in daemon mode by supplying "false".



31
32
33
34
35
36
37
38
 
# File 'lib/adhearsion/initializer.rb', line 31

def initialize(options = {})
  @@started = true
  @path     = path
  @mode     = options[:mode]
  @pid_file = options[:pid_file].nil? ? ENV['PID_FILE'] : options[:pid_file]
  @loaded_init_files  = options[:loaded_init_files]
  Adhearsion.root = '.'
end

Instance Attribute Details

#daemon ⇒ Object (readonly)

Returns the value of attribute daemon.



18
19
20
 
# File 'lib/adhearsion/initializer.rb', line 18

def daemon
  @daemon
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



18
19
20
 
# File 'lib/adhearsion/initializer.rb', line 18

def path
  @path
end

#pid_file ⇒ Object (readonly)

Returns the value of attribute pid_file.



18
19
20
 
# File 'lib/adhearsion/initializer.rb', line 18

def pid_file
  @pid_file
end

Class Method Details

.start(*args, &block) ⇒ Object 



11
12
13
 
# File 'lib/adhearsion/initializer.rb', line 11

def start(*args, &block)
  new(*args, &block).start
end

Instance Method Details

#catch_termination_signal ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/adhearsion/initializer.rb', line 136

def catch_termination_signal
  self_read, self_write = IO.pipe

  %w(INT TERM HUP ALRM ABRT).each do |sig|
    trap sig do
      self_write.puts sig
    end
  end

  Thread.new do
    begin
      while readable_io = IO.select([self_read])
        signal = readable_io.first[0].gets.strip
        handle_signal signal
      end
    rescue => e
      logger.error "Crashed reading signals"
      logger.error e
      exit 1
    end
  end
end

#create_pid_file(pid = nil) ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/adhearsion/initializer.rb', line 301

def create_pid_file(pid = nil)
  return unless pid_file

  logger.debug "Creating PID file #{pid_file}"

  File.open pid_file, 'w' do |file|
    file.puts pid || ::Process.pid
  end

  Events.register_callback :shutdown do
    File.delete(pid_file) if File.exists?(pid_file)
  end
end

#daemonize! ⇒ Object 



256
257
258
259
260
261
 
# File 'lib/adhearsion/initializer.rb', line 256

def daemonize!
  logger.info "Daemonizing now!"
  Adhearsion::CustomDaemonizer.daemonize resolve_log_file_path do |pid|
    create_pid_file pid
  end
end

#debugging_items ⇒ Object 



79
80
81
82
83
84
85
86
 
# File 'lib/adhearsion/initializer.rb', line 79

def debugging_items
  [
    "OS: #{RbConfig::CONFIG['host_os']} - RUBY: #{RUBY_ENGINE} #{RUBY_VERSION}",
    "Environment: #{ENV.inspect}",
    Adhearsion.config.description(:all),
    "Gem versions: #{Gem.loaded_specs.inject([]) { |c,g| c << "#{g[0]} #{g[1].version}" }}"
  ]
end

#debugging_log ⇒ Object 



88
89
90
91
92
 
# File 'lib/adhearsion/initializer.rb', line 88

def debugging_log
  debugging_items.each do |item|
    logger.trace item
  end
end

#default_pid_path ⇒ Object 



113
114
115
 
# File 'lib/adhearsion/initializer.rb', line 113

def default_pid_path
  File.join Adhearsion.config.root, DEFAULT_PID_FILE_NAME
end

#handle_signal(signal) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/adhearsion/initializer.rb', line 159

def handle_signal(signal)
  case signal
  when 'INT', 'TERM'
    logger.info "Received SIG#{signal}. Shutting down."
    Adhearsion::Process.shutdown
  when 'HUP'
    logger.debug "Received SIGHUP. Reopening logfiles."
    Adhearsion::Logging.reopen_logs
  when 'ALRM'
    logger.debug "Received SIGALRM. Toggling trace logging."
    Adhearsion::Logging.toggle_trace!
  when 'ABRT'
    logger.info "Received ABRT signal. Forcing stop."
    Adhearsion::Process.force_stop
  end
end

#init_get_logging_appenders ⇒ Object 



210
211
212
 
# File 'lib/adhearsion/initializer.rb', line 210

def init_get_logging_appenders
  @file_loggers ||= memoize_logging_appenders
end

#init_plugins ⇒ Object 



240
241
242
 
# File 'lib/adhearsion/initializer.rb', line 240

def init_plugins
  Plugin.init_plugins
end

#initialize_exception_logger ⇒ Object 



295
296
297
298
299
 
# File 'lib/adhearsion/initializer.rb', line 295

def initialize_exception_logger
  Events.register_handler :exception do |e, l|
    (l || logger).error e
  end
end

#initialize_log_paths ⇒ Object

Creates the relative paths associated to log files i.e.

  • log_file = “log/adhearsion.log” => creates ‘log’ folder

  • log_file = “log/test/adhearsion.log” => creates ‘log’ and ‘log/test’ folders



275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/adhearsion/initializer.rb', line 275

def initialize_log_paths
  outputters = Array(Adhearsion.config.platform.logging.outputters)
  outputters.select{|o| o.is_a?(String)}.each do |o|
    o = o.split("/")
    unless o[0].empty? # only if relative path
      o.pop # not consider filename
      o.inject("") do |path, folder|
        path = path.concat(folder).concat("/")
        Dir.mkdir(path) unless File.directory? path
        path
      end
    end
  end
end

#join_important_threads ⇒ Object

This method will block Thread.main() until calling join() has returned for all Threads in Adhearsion::Process.important_threads. Note: important_threads won’t always contain Thread instances. It simply requires the objects respond to join().



327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/adhearsion/initializer.rb', line 327

def join_important_threads
  # Note: we're using this ugly accumulator to ensure that all threads have ended since IMPORTANT_THREADS will almost
  # certainly change sizes after this method is called.
  index = 0
  until index == Adhearsion::Process.important_threads.size
    begin
      Adhearsion::Process.important_threads[index].join
    rescue => e
      logger.error "Error after joining Thread #{Thread.inspect}. #{e.message}"
    ensure
      index = index + 1
    end
  end
end

#launch_console ⇒ Object 



263
264
265
266
267
268
269
 
# File 'lib/adhearsion/initializer.rb', line 263

def launch_console
  Thread.new do
    catching_standard_errors do
      Adhearsion::Console.run
    end
  end
end

#load_config_file ⇒ Object 



196
197
198
 
# File 'lib/adhearsion/initializer.rb', line 196

def load_config_file
  require "#{Adhearsion.config.root}/config/adhearsion.rb"
end

#load_events_file ⇒ Object 



200
201
202
203
 
# File 'lib/adhearsion/initializer.rb', line 200

def load_events_file
  path = "#{Adhearsion.config.root}/config/events.rb"
  require path if File.exists?(path)
end

#load_lib_folder ⇒ Boolean

Loads files in application lib folder

Returns:

  • (Boolean) —

    if files have been loaded (lib folder is configured to not nil and actually exists)



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/adhearsion/initializer.rb', line 179

def load_lib_folder
  return false if Adhearsion.config.platform.lib.nil?

  lib_folder = [Adhearsion.config.platform.root, Adhearsion.config.platform.lib].join '/'
  return false unless File.directory? lib_folder

  $LOAD_PATH.unshift lib_folder

  Dir.chdir lib_folder do
    rbfiles = File.join "**", "*.rb"
    Dir.glob(rbfiles).each do |file|
      require "#{lib_folder}/#{file}"
    end
  end
  true
end

#load_routes_file ⇒ Object 



205
206
207
208
 
# File 'lib/adhearsion/initializer.rb', line 205

def load_routes_file
  path = "#{Adhearsion.config.root}/config/routes.rb"
  require path if File.exists?(path)
end

#memoize_logging_appenders ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/adhearsion/initializer.rb', line 214

def memoize_logging_appenders
  appenders = Array(Adhearsion.config.platform.logging.outputters.dup)
  # Any filename in the outputters array is mapped to a ::Logging::Appenders::File instance
  appenders.map! do |a|
    case a
    when String
      f = File.expand_path(Adhearsion.config.root.dup.concat("/").concat(a)) unless a.start_with?("/")
      ::Logging.appenders.file(f,
        :layout => ::Logging.layouts.pattern(
          :pattern => Adhearsion::Logging.adhearsion_pattern
        ),
       :auto_flushing => 2,
       :flush_period => 2
      )
    else
     a
    end
  end

  if should_daemonize?
    appenders
  else
    appenders += Adhearsion::Logging.default_appenders
  end
end

#need_console? ⇒ Boolean

Returns:

  • (Boolean) 


252
253
254
 
# File 'lib/adhearsion/initializer.rb', line 252

def need_console?
  @mode == :console
end

#resolve_log_file_path ⇒ Object 



129
130
131
132
133
134
 
# File 'lib/adhearsion/initializer.rb', line 129

def resolve_log_file_path
  _log_file = Adhearsion.config.platform.logging.outputters
  _log_file = _log_file[0] if _log_file.is_a?(Array)
  _log_file = File.expand_path(Adhearsion.config.root.dup.concat("/").concat(_log_file)) unless _log_file.start_with?("/")
  _log_file
end

#resolve_pid_file_path ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/adhearsion/initializer.rb', line 117

def resolve_pid_file_path
  @pid_file = if pid_file.equal?(true)
    default_pid_path
  elsif pid_file.equal?(false)
    nil
  elsif pid_file
    File.expand_path pid_file
  else
    should_daemonize? ? default_pid_path : nil
  end
end

#run_plugins ⇒ Object 



244
245
246
 
# File 'lib/adhearsion/initializer.rb', line 244

def run_plugins
  Plugin.run_plugins
end

#set_ahn_proc_name ⇒ Object 



315
316
317
 
# File 'lib/adhearsion/initializer.rb', line 315

def set_ahn_proc_name
  Adhearsion::LinuxProcName.set_proc_name Adhearsion.config.platform.process_name
end

#should_daemonize? ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/adhearsion/initializer.rb', line 248

def should_daemonize?
  @mode == :daemon
end

#start ⇒ Object 



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
 
# File 'lib/adhearsion/initializer.rb', line 40

def start
  catch :boot_aborted do
    resolve_pid_file_path
    load_lib_folder
    load_config_file
    load_events_file
    load_routes_file
    initialize_log_paths

    if should_daemonize?
      daemonize!
    else
      create_pid_file
    end

    Adhearsion.statistics
    start_logging
    debugging_log
    launch_console if need_console?
    catch_termination_signal
    set_ahn_proc_name
    initialize_exception_logger
    update_rails_env_var
    init_plugins

    run_plugins
    trigger_after_initialized_hooks

    Adhearsion::Process.booted if Adhearsion.status == :booting

    logger.info "Adhearsion v#{Adhearsion::VERSION} initialized in \"#{Adhearsion.config.platform.environment}\"!" if Adhearsion.status == :running
  end

  # This method will block until all important threads have finished.
  # When it does, the process will exit.
  join_important_threads
  self
end

#start_logging ⇒ Object 



290
291
292
293
 
# File 'lib/adhearsion/initializer.rb', line 290

def start_logging
  outputters = init_get_logging_appenders
  Adhearsion::Logging.start outputters, Adhearsion.config.platform.logging.level, Adhearsion.config.platform.logging.formatter
end

#trigger_after_initialized_hooks ⇒ Object 



319
320
321
 
# File 'lib/adhearsion/initializer.rb', line 319

def trigger_after_initialized_hooks
  Events.trigger_immediately :after_initialized
end

#update_rails_env_var ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/adhearsion/initializer.rb', line 94

def update_rails_env_var
  env = ENV['AHN_ENV']
  if env && Adhearsion.config.valid_environment?(env.to_sym)
    unless ENV['RAILS_ENV']
      logger.info "Copying AHN_ENV (#{env}) to RAILS_ENV"
      ENV['RAILS_ENV'] = env
    end
  else
    unless ENV['RAILS_ENV']
      env = Adhearsion.config.platform.environment.to_s
      ENV['AHN_ENV'] = env
      logger.info "Setting RAILS_ENV to \"#{env}\""
      ENV['RAILS_ENV'] = env
    end
  end
  logger.warn "AHN_ENV(#{ENV['AHN_ENV']}) does not match RAILS_ENV(#{ENV['RAILS_ENV']})!" unless ENV['RAILS_ENV'] == ENV['AHN_ENV']
  env
end