Class: Skylight::Config

Inherits:
Object show all
Defined in:
lib/skylight/config.rb

Constant Summary collapse

MUTEX =

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. 

Mutex.new
ENV_TO_KEY =

Map environment variable keys with Skylight configuration keys

{
  # == Authentication ==
  'AUTHENTICATION' => :'authentication',

  # == Version ==
  'VERSION' => :'version',

  # == App settings ==
  'ROOT'          => :'root',
  'APPLICATION'   => :'application',
  'HOSTNAME'      => :'hostname',
  'SESSION_TOKEN' => :'session_token',

  # == Logging ==
  'LOG_FILE'       => :'log_file',
  'LOG_LEVEL'      => :'log_level',
  'ALERT_LOG_FILE' => :'alert_log_file',

  # == Proxy ==
  'PROXY_URL' => :'proxy_url',

  # == Instrumenter ==
  "IGNORED_ENDPOINT" => :'ignored_endpoint',

  # == Skylight Remote ==
  "AUTH_URL"                     => :'auth_url',
  "AUTH_HTTP_DEFLATE"            => :'auth_http_deflate',
  "AUTH_HTTP_CONNECT_TIMEOUT"    => :'auth_http_connect_timeout',
  "AUTH_HTTP_READ_TIMEOUT"       => :'auth_http_read_timeout',
  "REPORT_URL"                   => :'report_url',
  "REPORT_HTTP_DEFLATE"          => :'report_http_deflate',
  "REPORT_HTTP_CONNECT_TIMEOUT"  => :'report_http_connect_timeout',
  "REPORT_HTTP_READ_TIMEOUT"     => :'report_http_read_timeout',

  # == Native agent settings ==
  #
  "LAZY_START"                   => :'daemon.lazy_start',
  "DAEMON_EXEC_PATH"             => :'daemon.exec_path',
  "DAEMON_LIB_PATH"              => :'daemon.lib_path',
  "PIDFILE_PATH"                 => :'daemon.pidfile_path',
  "SOCKDIR_PATH"                 => :'daemon.sockdir_path',
  "BATCH_QUEUE_DEPTH"            => :'daemon.batch_queue_depth',
  "BATCH_SAMPLE_SIZE"            => :'daemon.batch_sample_size',
  "BATCH_FLUSH_INTERVAL"         => :'daemon.batch_flush_interval',
  "DAEMON_TICK_INTERVAL"         => :'daemon.tick_interval',
  "DAEMON_SANITY_CHECK_INTERVAL" => :'daemon.sanity_check_interval',
  "DAEMON_INACTIVITY_TIMEOUT"    => :'daemon.inactivity_timeout',
  "CLIENT_MAX_TRIES"             => :'daemon.max_connect_tries',
  "CLIENT_CONN_TRY_WIN"          => :'daemon.connect_try_window',
  "MAX_PRESPAWN_JITTER"          => :'daemon.max_prespawn_jitter',
  "DAEMON_WAIT_TIMEOUT"          => :'daemon.wait_timeout',
  "CLIENT_CHECK_INTERVAL"        => :'daemon.client_check_interval',
  "CLIENT_QUEUE_DEPTH"           => :'daemon.client_queue_depth',
  "CLIENT_WRITE_TIMEOUT"         => :'daemon.client_write_timeout',
  "SSL_CERT_PATH"                => :'daemon.ssl_cert_path',
  "SSL_CERT_DIR"                 => :'daemon.ssl_cert_dir',

  # == Legacy env vars ==
  #
  'AGENT_LOCKFILE'      => :'agent.lockfile',
  'AGENT_SOCKFILE_PATH' => :'agent.sockfile_path',
}
DEFAULTS =

Default values for Skylight configuration keys

{
  :'version'              => VERSION,
  :'auth_url'             => 'https://auth.skylight.io/agent',
  :'daemon.lazy_start'    => true,
  :'daemon.ssl_cert_path' => Util::SSL.ca_cert_file_or_default,
  :'daemon.ssl_cert_dir'  => Util::SSL.ca_cert_dir,

  # == Legacy ==
  :'log_file'                => '-'.freeze,
  :'log_level'               => 'INFO'.freeze,
  :'alert_log_file'          => '-'.freeze,
  :'hostname'                => Util::Hostname.default_hostname,
  :'agent.keepalive'         => 60,
  :'agent.interval'          => 5,
  :'agent.sample'            => 200,
  :'agent.max_memory'        => 256, # MB
  :'report.host'             => 'agent.skylight.io'.freeze,
  :'report.port'             => 443,
  :'report.ssl'              => true,
  :'report.deflate'          => true,
  :'accounts.host'           => 'www.skylight.io'.freeze,
  :'accounts.port'           => 443,
  :'accounts.ssl'            => true,
  :'accounts.deflate'        => false,
  :'me.credentials_path'     => '~/.skylight',
  :'metrics.report_interval' => 60
}
REQUIRED = 
{
:'authentication' => "authentication token",
:'hostname'       => "server hostname",
:'report.host'    => "skylight remote host",
:'report.port'    => "skylight remote port" }
ALWAYS_INCLUDE_IN_ENV = 
[
:version,
:'daemon.lazy_start',
:'daemon.lib_path',
:'daemon.exec_path',
:'daemon.ssl_cert_dir',
:'daemon.ssl_cert_path' ]
LEGACY =

Maps legacy config keys to new config keys

{
  :'agent.sockfile_path' => :'daemon.sockdir_path',
  :'agent.pidfile_path'  => :'agent.lockfile',
}
VALIDATORS = 
{
  :'agent.interval' => [lambda { |v, c| Integer === v && v > 0 }, "must be an integer greater than 0"]
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Config

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 Config.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/skylight/config.rb', line 146

def initialize(*args)
  attrs = {}

  if Hash === args.last
    attrs = args.pop.dup
  end

  @values   = {}
  @priority = {}
  @regexp   = nil

  p = attrs.delete(:priority)

  if @environment = args[0]
    @regexp = /^#{Regexp.escape(@environment)}\.(.+)$/
  end

  attrs.each do |k, v|
    self[k] = v
  end

  if p
    p.each do |k, v|
      @priority[Config.remap_key(k)] = v
    end
  end
end

Instance Attribute Details

#environment ⇒ Object (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. 



143
144
145
 
# File 'lib/skylight/config.rb', line 143

def environment
  @environment
end

Class Method Details

.detect_proxy_url(env) ⇒ Object 



242
243
244
245
246
247
 
# File 'lib/skylight/config.rb', line 242

def self.detect_proxy_url(env)
  if u = env['HTTP_PROXY'] || env['http_proxy']
    u = "http://#{u}" unless u =~ %r[://]
    u
  end
end

.load(opts = {}, env = ENV) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/skylight/config.rb', line 174

def self.load(opts = {}, env = ENV)
  attrs   = {}
  version = nil

  path = opts.delete(:file)
  environment = opts.delete(:environment)

  if path
    error = nil
    begin
      attrs = YAML.load_file(path)
      error = "empty file" unless attrs
      error = "invalid format" if attrs && !attrs.is_a?(Hash)
    rescue Exception => e
      error = e.message
    end

    raise ConfigError, "could not load config file; msg=#{error}" if error

    version = File.mtime(path).to_i
  end

  if env
    attrs[:priority] = remap_env(env)
  end

  config = new(environment, attrs)

  opts.each do |k, v|
    config[k] = v
  end

  config
end

.remap_env(env) ⇒ 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. 



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

def self.remap_env(env)
  ret = {}

  return ret unless env

  ret[:proxy_url] = detect_proxy_url(env)

  env.each do |k, val|
    # Support deprecated SK_ key prefix
    next unless k =~ /^(?:SK|SKYLIGHT)_(.+)$/

    if key = ENV_TO_KEY[$1]
      ret[key] =
        case val
        when /^false$/i      then false
        when /^true$/i       then true
        when /^(nil|null)$/i then nil
        when /^\d+$/         then val.to_i
        when /^\d+\.\d+$/    then val.to_f
        else val
        end
    end
  end

  ret
end

.remap_key(key) ⇒ Object 



209
210
211
212
 
# File 'lib/skylight/config.rb', line 209

def self.remap_key(key)
  key = key.to_sym
  LEGACY[key] || key
end

Instance Method Details

#alert_logger ⇒ Object 



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/skylight/config.rb', line 437

def alert_logger
  @alert_logger ||=
    begin
      MUTEX.synchronize do
        unless l = @alert_logger
          out = get(:'alert_log_file')

          if out == '-'
            out = Util::AlertLogger.new(load_logger)
          elsif !(IO === out)
            out = File.expand_path(out, root)
            FileUtils.mkdir_p(File.dirname(out))
          end

          l = Logger.new(out)
          l.level = Logger::DEBUG
        end

        l
      end
    end
end

#alert_logger=(logger) ⇒ Object 



460
461
462
 
# File 'lib/skylight/config.rb', line 460

def alert_logger=(logger)
  @alert_logger = logger
end

#check_permissions(pidfile, sockdir_path) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/skylight/config.rb', line 272

def check_permissions(pidfile, sockdir_path)
  pidfile_root = File.dirname(pidfile)

  FileUtils.mkdir_p pidfile_root
  FileUtils.mkdir_p sockdir_path

  if File.exist?(pidfile)
    if !FileTest.writable?(pidfile)
      raise ConfigError, "File `#{pidfile}` not writable. Please set daemon.pidfile_path or daemon.sockdir_path in your config to a writable path"
    end
  else
    if !FileTest.writable?(pidfile_root)
      raise ConfigError, "Directory `#{pidfile_root}` not writable. Please set daemon.pidfile_path or daemon.sockdir_path in your config to a writable path"
    end
  end

  unless FileTest.writable?(sockdir_path)
    raise ConfigError, "Directory `#{sockdir_path}` not writable. Please set daemon.sockdir_path in your config to a writable path"
  end
end

#duration_ms(key, default = nil) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/skylight/config.rb', line 348

def duration_ms(key, default = nil)
  if (v = self[key]) && v.to_s =~ /^\s*(\d+)(s|sec|ms|micros|nanos)?\s*$/
    v = $1.to_i
    case $2
    when "ms"
      v
    when "micros"
      v / 1_000
    when "nanos"
      v / 1_000_000
    else # "s", "sec", nil
      v * 1000
    end
  else
    default
  end
end

#gc ⇒ 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. 



403
404
405
 
# File 'lib/skylight/config.rb', line 403

def gc
  @gc ||= GC.new(self, get('gc.profiler', VM::GC.new))
end

#get(key, default = nil, &blk) ⇒ Object Also known as: [] 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/skylight/config.rb', line 298

def get(key, default = nil, &blk)
  key = Config.remap_key(key)

  return @priority[key] if @priority.key?(key)
  return @values[key]   if @values.key?(key)
  return DEFAULTS[key]  if DEFAULTS.key?(key)

  if default
    return default
  elsif blk
    return blk.call(key)
  end

  nil
end

#ignore_token? ⇒ Boolean

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:

  • (Boolean) 


408
409
410
 
# File 'lib/skylight/config.rb', line 408

def ignore_token?
  get('test.ignore_token')
end

#ignored_endpoints ⇒ 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. 



413
414
415
416
417
418
419
420
 
# File 'lib/skylight/config.rb', line 413

def ignored_endpoints
  @ignored_endpoints ||=
    begin
      val = Array(get(:'ignored_endpoint'))
      val.concat(Array(get(:'ignored_endpoints')))
      val
    end
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
296
 
# File 'lib/skylight/config.rb', line 293

def key?(key)
  key = Config.remap_key(key)
  @priority.key?(key) || @values.key?(key)
end

#logger ⇒ Object 



426
427
428
429
430
431
 
# File 'lib/skylight/config.rb', line 426

def logger
  @logger ||=
    MUTEX.synchronize do
      load_logger
    end
end

#logger=(logger) ⇒ Object 



433
434
435
 
# File 'lib/skylight/config.rb', line 433

def logger=(logger)
  @logger = logger
end

#root ⇒ Object 



422
423
424
 
# File 'lib/skylight/config.rb', line 422

def root
  self[:root] || Dir.pwd
end

#set(key, val, scope = nil) ⇒ Object Also known as: []= 



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
 
# File 'lib/skylight/config.rb', line 316

def set(key, val, scope = nil)
  if scope
    key = [scope, key].join('.')
  end

  if Hash === val
    val.each do |k, v|
      set(k, v, key)
    end
  else
    k = Config.remap_key(key)

    if validator = VALIDATORS[k]
      blk, msg = validator

      unless blk.call(val, self)
        error_msg = "invalid value for #{k} (#{val})"
        error_msg << ", #{msg}" if msg
        raise ConfigError, error_msg
      end
    end

    if @regexp && k =~ @regexp
      @priority[$1.to_sym] = val
    end

    @values[k] = val
  end
end

#skip_validation? ⇒ Boolean

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:

  • (Boolean) 


250
251
252
 
# File 'lib/skylight/config.rb', line 250

def skip_validation?
  !!get(:skip_validation)
end

#to_env ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/skylight/config.rb', line 366

def to_env
  ret = []

  ENV_TO_KEY.each do |k, v|
    next if LEGACY[v]
    c = get(v)
    # Always need to pass daemon lib_path config even when default
    if c != DEFAULTS[v] || ALWAYS_INCLUDE_IN_ENV.include?(v)
      ret << "SKYLIGHT_#{k}" << cast_for_env(c) if c
    end
  end

  ret << "SKYLIGHT_VALIDATE_AUTHENTICATION"
  ret << "false"

  ret
end

#validate! ⇒ 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. 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/skylight/config.rb', line 255

def validate!
  return true if skip_validation?

  REQUIRED.each do |k, v|
    unless get(k)
      raise ConfigError, "#{v} required"
    end
  end

  sockdir_path = self[:'daemon.sockdir_path'] || File.expand_path('.')
  pidfile_path = self[:'daemon.pidfile_path'] || File.expand_path('skylight.pid', sockdir_path)

  check_permissions(pidfile_path, sockdir_path)

  true
end

#write(path) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/skylight/config.rb', line 384

def write(path)
  FileUtils.mkdir_p(File.dirname(path))

  File.open(path, 'w') do |f|
    f.puts <<-YAML
---
# The authentication token for the application.
authentication: #{self[:authentication]}
    YAML
  end
end