Class: OneApm::Configuration::EnvironmentSource

Inherits:
Support::DottedHash show all
Defined in:
lib/one_apm/configuration/environment_source.rb

Constant Summary collapse

OA_SUPPORTED_PREFIXES = 
/^oneapm_/i
OA_SPECIAL_CASE_KEYS = 
[
  'ONEAPM_ENV', # read by OneApm::Probe::Frameworks::Ruby
  'ONEAPM_LOG'  # read by set_log_file
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Support::DottedHash

#inspect, symbolize, #to_hash

Constructor Details

#initialize ⇒ EnvironmentSource

Returns a new instance of EnvironmentSource.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/one_apm/configuration/environment_source.rb', line 15

def initialize
  set_log_file
  set_config_file

  @alias_map = {}
  @type_map = {}

  DEFAULTS.each do |config_setting, value|
    self.type_map[config_setting] = value[:type]
    set_aliases(config_setting, value)
  end

  set_values_from_one_apm_environment_variables
end

Instance Attribute Details

#alias_map ⇒ Object

Returns the value of attribute alias_map.



13
14
15
 
# File 'lib/one_apm/configuration/environment_source.rb', line 13

def alias_map
  @alias_map
end

#type_map ⇒ Object

Returns the value of attribute type_map.



13
14
15
 
# File 'lib/one_apm/configuration/environment_source.rb', line 13

def type_map
  @type_map
end

Instance Method Details

#collect_one_apm_environment_variable_keys ⇒ Object 



106
107
108
 
# File 'lib/one_apm/configuration/environment_source.rb', line 106

def collect_one_apm_environment_variable_keys
  ENV.keys.select { |key| key.match(OA_SUPPORTED_PREFIXES) }
end

#convert_environment_key_to_config_key(key) ⇒ Object 



101
102
103
104
 
# File 'lib/one_apm/configuration/environment_source.rb', line 101

def convert_environment_key_to_config_key(key)
  stripped_key = key.gsub(OA_SUPPORTED_PREFIXES, '').downcase.to_sym
  self.alias_map[stripped_key] || stripped_key
end

#set_aliases(config_setting, value) ⇒ Object 



30
31
32
33
34
35
36
37
 
# File 'lib/one_apm/configuration/environment_source.rb', line 30

def set_aliases(config_setting, value)
  set_dotted_alias(config_setting)

  return unless value[:aliases]
  value[:aliases].each do |config_alias|
    self.alias_map[config_alias] = config_setting
  end
end

#set_config_file ⇒ Object 



59
60
61
 
# File 'lib/one_apm/configuration/environment_source.rb', line 59

def set_config_file
  self[:config_path] = ENV['ONEAPM_CONFIG'] if ENV['ONEAPM_CONFIG']
end

#set_dotted_alias(original_config_setting) ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'lib/one_apm/configuration/environment_source.rb', line 39

def set_dotted_alias(original_config_setting)
  config_setting = original_config_setting.to_s

  if config_setting.include? '.'
    config_alias = config_setting.gsub(/\./,'_').to_sym
    self.alias_map[config_alias] = original_config_setting
  end
end

#set_key_by_type(config_key, environment_key) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/one_apm/configuration/environment_source.rb', line 77

def set_key_by_type(config_key, environment_key)
  value = ENV[environment_key]
  type = self.type_map[config_key]

  if type == String
    self[config_key] = value
  elsif type == Fixnum
    self[config_key] = value.to_i
  elsif type == Float
    self[config_key] = value.to_f
  elsif type == Symbol
    self[config_key] = value.to_sym
  elsif type == OneApm::Configuration::Boolean
    if value =~ /false|off|no/i
      self[config_key] = false
    elsif value != nil
      self[config_key] = true
    end
  else
    OneApm::Manager.logger.info("#{environment_key} does not have a corresponding configuration setting (#{config_key} does not exist).")
    self[config_key] = value
  end
end

#set_log_file ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/one_apm/configuration/environment_source.rb', line 48

def set_log_file
  if ENV['ONEAPM_LOG']
    if ENV['ONEAPM_LOG'].upcase == 'STDOUT'
      self[:log_file_path] = self[:log_file_name] = 'STDOUT'
    else
      self[:log_file_path] = File.dirname(ENV['ONEAPM_LOG'])
      self[:log_file_name] = File.basename(ENV['ONEAPM_LOG'])
    end
  end
end

#set_value_from_environment_variable(key) ⇒ Object 



72
73
74
75
 
# File 'lib/one_apm/configuration/environment_source.rb', line 72

def set_value_from_environment_variable(key)
  config_key = convert_environment_key_to_config_key(key)
  set_key_by_type(config_key, key)
end

#set_values_from_one_apm_environment_variables ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/one_apm/configuration/environment_source.rb', line 63

def set_values_from_one_apm_environment_variables
  env_var_keys = collect_one_apm_environment_variable_keys

  env_var_keys.each do |key|
    next if OA_SPECIAL_CASE_KEYS.include?(key.upcase)
    set_value_from_environment_variable(key)
  end
end