Class: BmcDaemonLib::Conf

Inherits:
Object
  • Object
show all
Extended by:
Chamber
Defined in:
lib/bmc-daemon-lib/conf.rb

Constant Summary collapse

PIDFILE_DIR = 
"/tmp/"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.app_env ⇒ Object

Returns the value of attribute app_env.



16
17
18
 
# File 'lib/bmc-daemon-lib/conf.rb', line 16

def app_env
  @app_env
end

.app_libs ⇒ Object (readonly)

Returns the value of attribute app_libs.



18
19
20
 
# File 'lib/bmc-daemon-lib/conf.rb', line 18

def app_libs
  @app_libs
end

.app_name ⇒ Object (readonly)

Returns the value of attribute app_name.



19
20
21
 
# File 'lib/bmc-daemon-lib/conf.rb', line 19

def app_name
  @app_name
end

.app_root ⇒ Object (readonly)

Returns the value of attribute app_root.



17
18
19
 
# File 'lib/bmc-daemon-lib/conf.rb', line 17

def app_root
  @app_root
end

.app_spec ⇒ Object (readonly)

Returns the value of attribute app_spec.



22
23
24
 
# File 'lib/bmc-daemon-lib/conf.rb', line 22

def app_spec
  @app_spec
end

.app_started ⇒ Object (readonly)

Returns the value of attribute app_started.



21
22
23
 
# File 'lib/bmc-daemon-lib/conf.rb', line 21

def app_started
  @app_started
end

.app_ver ⇒ Object (readonly)

Returns the value of attribute app_ver.



20
21
22
 
# File 'lib/bmc-daemon-lib/conf.rb', line 20

def app_ver
  @app_ver
end

.files ⇒ Object (readonly)

Returns the value of attribute files.



23
24
25
 
# File 'lib/bmc-daemon-lib/conf.rb', line 23

def files
  @files
end

.host ⇒ Object (readonly)

Returns the value of attribute host.



24
25
26
 
# File 'lib/bmc-daemon-lib/conf.rb', line 24

def host
  @host
end

Class Method Details

.add_config(path) ⇒ Object 



247
248
249
 
# File 'lib/bmc-daemon-lib/conf.rb', line 247

def self.add_config path
  @files << File.expand_path(path) if path && File.readable?(path)
end

.at(*path) ⇒ Object

Direct access to any depth



106
107
108
109
 
# File 'lib/bmc-daemon-lib/conf.rb', line 106

def self.at *path
  ensure_init
  path.reduce(Conf) { |m, key| m && m[key.to_s] }
end

.dump ⇒ Object 



100
101
102
103
 
# File 'lib/bmc-daemon-lib/conf.rb', line 100

def self.dump
  ensure_init
  to_hash.to_yaml(indent: 4, useheader: true, useversion: false )
end

.ensure_init ⇒ Object 



253
254
255
256
257
 
# File 'lib/bmc-daemon-lib/conf.rb', line 253

def self.ensure_init
  unless @initialized
    fail ConfigInitiRequired, "ensure_init: Conf.init(app_root) should be invoked beforehand"
  end
end

.feature?(name) ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/bmc-daemon-lib/conf.rb', line 128

def self.feature? name
  ensure_init

  # Guess if the specific feature si available
  case name
  when :newrelic
    return false if Gem.datadir('newrelic_rpm').nil?
    return false if self.at(:newrelic, :enabled) == false
    return false if self.at(:newrelic, :disabled) == true
    return self.at(:newrelic, :license) || false
  when :rollbar
    return false if Gem.datadir('rollbar').nil?
    return false if self.at(:rollbar, :enabled) == false
    return false if self.at(:rollbar, :disabled) == true
    return self.at(:rollbar, :token) || false
  end
  return false
end

.generate(what) ⇒ Object

Defaults generators



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
173
174
175
176
 
# File 'lib/bmc-daemon-lib/conf.rb', line 148

def self.generate what
  ensure_init
  return case what

  when :user_agent
    "#{@app_name}/#{@app_ver}" if @app_name && @app_ver

  when :config_defaults
    "#{@app_root}/defaults.yml" if @app_root

  when :config_etc
    "/etc/#{@app_name}.yml" if @app_name

  when :process_name
    parts = [@app_name, @app_env]
    parts << self[:port] if self[:port]
    parts.join('-')

  when :pidfile
    process_name = self.generate(:process_name)
    File.expand_path "#{process_name}.pid", PIDFILE_DIR

  when :config_message
    config_defaults = self.generate(:config_defaults)
    config_etc = self.generate(:config_etc)

    "A default configuration is available (#{config_defaults}) and can be copied to the default location (#{config_etc}): \n sudo cp #{config_defaults} #{config_etc}"
  end
end

.init(app_root) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
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
 
# File 'lib/bmc-daemon-lib/conf.rb', line 27

def self.init app_root
  # Permanent flags
  @initialized  = true
  @app_started  = Time.now

  # Default values
  @files        ||= []
  @app_name     ||= "app_name"
  @app_env      ||= "production"
  @host         ||= `hostname`.to_s.chomp.split(".").first

  # Store and clean app_root
  @app_root = File.expand_path(app_root)

  # Try to find any gemspec file
  matches   = Dir["#{@app_root}/*.gemspec"]
  fail ConfigMissingGemspec, "gemspec file not found: #{gemspec_path}" if matches.size < 1
  fail ConfigMultipleGemspec, "gemspec file not found: #{gemspec_path}" if matches.size > 1

  # Load Gemspec (just the only match)
  @spec     = Gem::Specification::load(matches.first)
  @app_name = @spec.name
  @app_ver  = @spec.version
  fail ConfigMissingParameter, "gemspec: missing name" unless @app_name
  fail ConfigMissingParameter, "gemspec: missing version" unless @app_ver

  # Now we know app_name, initalize app_libs
  @app_libs = File.expand_path("lib/#{@app_name}/", @app_root)

  # By default, Newrelic is disabled
  ENV["NEWRELIC_AGENT_ENABLED"] = "false"

  # Add other config files
  add_config generate(:config_defaults)
  add_config generate(:config_etc)

  # Return something
  return @app_name
end

.load_files ⇒ Object 



243
244
245
 
# File 'lib/bmc-daemon-lib/conf.rb', line 243

def self.load_files
  load files: @files, namespaces: { environment: @app_env }
end

.log(origin, message) ⇒ Object 



232
233
234
235
236
237
238
239
 
# File 'lib/bmc-daemon-lib/conf.rb', line 232

def self.log origin, message
  printf(
    "%s %-10s %s \n",
    Time.now.strftime("%Y-%m-%d %H:%M:%S"),
    origin,
    message
    )
end

.logfile_path(pipe) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/bmc-daemon-lib/conf.rb', line 111

def self.logfile_path pipe
  # Access configuration
  path      = Conf.at :logs, :path
  specific  = Conf.at :logs, pipe
  default   = Conf.at :logs, :default

  # Ignore if explicitely disabled
  return nil if specific.nil?

  # Fallback on default path if not provided,
  specific  ||= default
  specific  ||= "default.log"

  # Build logfile_path
  File.expand_path specific.to_s, path.to_s
end

.prepare(args = {}) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/bmc-daemon-lib/conf.rb', line 67

def self.prepare args = {}
  ensure_init

  # Add extra config file and load them all
  add_config args[:config]
  reload!

  # Set Rack env
  ENV["RACK_ENV"] = @app_env.to_s

  # Set up encodings
  Encoding.default_internal = "utf-8"
  Encoding.default_external = "utf-8"

  # Init New Relic, Rollbar
  # prepare_newrelic
  #prepare_rollbar  if self.feature?(:rollbar)

  # Try to access any key to force parsing of the files
  self[:dummy]

rescue Psych::SyntaxError => e
  fail ConfigParseError, e.message
rescue StandardError => e
  fail ConfigOtherError, "#{e.message} \n #{e.backtrace.to_yaml}"
end

.prepare_newrelic ⇒ Object 



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
 
# File 'lib/bmc-daemon-lib/conf.rb', line 178

def self.prepare_newrelic
  # Disable if no config present
  return unless self.feature?(:newrelic)
  section = self[:newrelic]

  # Enable GC profiler
  GC::Profiler.enable

  # Set logfile, license, monitor mode
  ENV["NEW_RELIC_LOG"]          = logfile_path(:newrelic)
  ENV["NEW_RELIC_LICENSE_KEY"]  = section[:license].to_s
  ENV["NEW_RELIC_MONITOR_MODE"] = "true"

  # Build NewRelic app_name if not provided as-is
  if !section[:app_name]
    stack = []
    stack << (section[:prefix] || @app_name)
    stack << section[:platform] if section[:platform]
    stack << @app_env
    text = stack.join('-')
    section[:app_name] = "#{text}; #{text}-#{host}"
  end
  ENV["NEW_RELIC_APP_NAME"]     = section[:app_name].to_s

  # Enable module
  ENV["NEWRELIC_AGENT_ENABLED"] = "true"
end

.prepare_rollbar ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/bmc-daemon-lib/conf.rb', line 206

def self.prepare_rollbar
  # Disable if no config present
  unless self.feature?(:rollbar)
    Rollbar.configure do |config|
      config.enabled = false
    end
    return
  end

  section = self[:rollbar]

  # Configure
  Rollbar.configure do |config|
    config.enabled = true
    config.access_token = section[:token].to_s
    config.code_version = @app_version
    config.environment  = @app_env
    #config.logger       = Logger.new(logfile_path(:rollbar))
    config.logger       = LoggerPool.instance.get :rollbar
    config.use_async = true
  end

  # Notify startup
  Rollbar.info("#{@app_name} #{@app_ver} [#{@host}]")
end

.reload! ⇒ Object

Reload files



95
96
97
98
 
# File 'lib/bmc-daemon-lib/conf.rb', line 95

def self.reload!
  ensure_init
  load_files
end