Class: Sensu::Settings

Inherits:
Object
  • Object
show all
Includes:
Utilities
Defined in:
lib/sensu/settings.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utilities

#deep_diff, #deep_merge, #indifferent_hash, #redact_sensitive, #retry_until_true, #testing?, #with_indifferent_access

Constructor Details

#initializeSettings

Returns a new instance of Settings.



7
8
9
10
11
12
13
14
15
16
# File 'lib/sensu/settings.rb', line 7

def initialize
  @logger = Logger.get
  @settings = Hash.new
  SETTINGS_CATEGORIES.each do |category|
    @settings[category] = Hash.new
  end
  @indifferent_access = false
  @loaded_env = false
  @loaded_files = Array.new
end

Instance Attribute Details

#indifferent_accessObject (readonly)

Returns the value of attribute indifferent_access.



5
6
7
# File 'lib/sensu/settings.rb', line 5

def indifferent_access
  @indifferent_access
end

#loaded_envObject (readonly)

Returns the value of attribute loaded_env.



5
6
7
# File 'lib/sensu/settings.rb', line 5

def loaded_env
  @loaded_env
end

#loaded_filesObject (readonly)

Returns the value of attribute loaded_files.



5
6
7
# File 'lib/sensu/settings.rb', line 5

def loaded_files
  @loaded_files
end

Instance Method Details

#[](key) ⇒ Object



30
31
32
# File 'lib/sensu/settings.rb', line 30

def [](key)
  to_hash[key]
end

#indifferent_access!Object



18
19
20
21
# File 'lib/sensu/settings.rb', line 18

def indifferent_access!
  @settings = with_indifferent_access(@settings)
  @indifferent_access = true
end

#load_directory(directory) ⇒ Object



118
119
120
121
122
123
# File 'lib/sensu/settings.rb', line 118

def load_directory(directory)
  path = directory.gsub(/\\(?=\S)/, '/')
  Dir.glob(File.join(path, '**/*.json')).each do |file|
    load_file(file)
  end
end

#load_envObject



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/sensu/settings.rb', line 54

def load_env
  if ENV['RABBITMQ_URL']
    @settings[:rabbitmq] = ENV['RABBITMQ_URL']
    @logger.warn('using rabbitmq url environment variable', {
      :rabbitmq_url => ENV['RABBITMQ_URL']
    })
  end
  ENV['REDIS_URL'] ||= ENV['REDISTOGO_URL']
  if ENV['REDIS_URL']
    @settings[:redis] = ENV['REDIS_URL']
    @logger.warn('using redis url environment variable', {
      :redis_url => ENV['REDIS_URL']
    })
  end
  ENV['API_PORT'] ||= ENV['PORT']
  if ENV['API_PORT']
    @settings[:api] ||= Hash.new
    @settings[:api][:port] = ENV['API_PORT']
    @logger.warn('using api port environment variable', {
      :api_port => ENV['API_PORT']
    })
  end
  @indifferent_access = false
  @loaded_env = true
end

#load_file(file) ⇒ Object



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/sensu/settings.rb', line 80

def load_file(file)
  @logger.debug('loading config file', {
    :config_file => file
  })
  if File.file?(file) && File.readable?(file)
    begin
      contents = File.open(file, 'r').read
      config = Oj.load(contents, :mode => :strict)
      merged = deep_merge(@settings, config)
      unless @loaded_files.empty?
        changes = deep_diff(@settings, merged)
        @logger.warn('config file applied changes', {
          :config_file => file,
          :changes => redact_sensitive(changes)
        })
      end
      @settings = merged
      @indifferent_access = false
      @loaded_files << file
    rescue Oj::ParseError => error
      @logger.error('config file must be valid json', {
        :config_file => file,
        :error => error.to_s
      })
      @logger.warn('ignoring config file', {
        :config_file => file
      })
    end
  else
    @logger.error('config file does not exist or is not readable', {
      :config_file => file
    })
    @logger.warn('ignoring config file', {
      :config_file => file
    })
  end
end

#set_envObject



125
126
127
# File 'lib/sensu/settings.rb', line 125

def set_env
  ENV['SENSU_CONFIG_FILES'] = @loaded_files.join(':')
end

#to_hashObject



23
24
25
26
27
28
# File 'lib/sensu/settings.rb', line 23

def to_hash
  unless @indifferent_access
    indifferent_access!
  end
  @settings
end

#validateObject



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/sensu/settings.rb', line 129

def validate
  @logger.debug('validating settings')
  SETTINGS_CATEGORIES.each do |category|
    unless @settings[category].is_a?(Hash)
      invalid(category.to_s + ' must be a hash')
    end
    send(category).each do |details|
      send(('validate_' + category.to_s.chop).to_sym, details)
    end
  end
  case File.basename($0)
  when 'sensu-client'
    validate_client
  when 'sensu-api'
    validate_api
  when 'rspec'
    validate_client
    validate_api
  end
  @logger.debug('settings are valid')
end