Class: NewRelic::Agent::Configuration::DefaultSource

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/new_relic/agent/configuration/default_source.rb

Constant Summary collapse

BOOLEAN_MAP = 
{
  'true' => true,
  'yes' => true,
  'on' => true,
  'false' => false,
  'no' => false,
  'off' => false
}.freeze
DEFAULT_LOG_DIR = 
'log/'.freeze
SEMICOLON = 
';'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DefaultSource

Returns a new instance of DefaultSource.



53
54
55
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 53

def initialize
  @defaults = default_values
end

Instance Attribute Details

#defaults ⇒ Object (readonly) 



48
49
50
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 48

def defaults
  @defaults
end

Class Method Details

.agent_enabled ⇒ Object 



159
160
161
162
163
164
165
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 159

def self.agent_enabled
  proc {
    NewRelic::Agent.config[:enabled] &&
      (NewRelic::Agent.config[:test_mode] || NewRelic::Agent.config[:monitor_mode]) &&
      NewRelic::Agent::Autostart.agent_should_start?
  }
end

.allowlist_for(key) ⇒ Object 



73
74
75
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 73

def self.allowlist_for(key)
  value_from_defaults(key, :allowlist)
end

.api_host ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 217

def self.api_host
  # only used for deployment task
  proc do
    api_version = if NewRelic::Agent.config[:api_key].nil? || NewRelic::Agent.config[:api_key].empty?
      'rpm'
    else
      'api'
    end
    api_region = 'eu.' if String(NewRelic::Agent.config[:license_key]).start_with?('eu')

    "#{api_version}.#{api_region}newrelic.com"
  end
end

.app_name ⇒ Object 



179
180
181
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 179

def self.app_name
  proc { NewRelic::Control.instance.env }
end

.audit_log_path ⇒ Object 



169
170
171
172
173
174
175
176
177
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 169

def self.audit_log_path
  proc {
    log_file_path = NewRelic::Agent.config[:log_file_path]
    wants_stdout = (log_file_path.casecmp(NewRelic::STANDARD_OUT) == 0)
    audit_log_dir = wants_stdout ? DEFAULT_LOG_DIR : log_file_path

    File.join(audit_log_dir, 'newrelic_audit.log')
  }
end

.boolean_for(key, value) ⇒ Object 



77
78
79
80
81
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 77

def self.boolean_for(key, value)
  string_value = (value.respond_to?(:call) ? value.call : value).to_s

  BOOLEAN_MAP.fetch(string_value, nil)
end

.config_path ⇒ Object 



126
127
128
129
130
131
132
133
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 126

def self.config_path
  proc {
    found_path = NewRelic::Agent.config[:config_search_paths].detect do |file|
      File.expand_path(file) if File.exist?(file)
    end
    found_path || NewRelic::EMPTY_STR
  }
end

.config_search_paths ⇒ Object 



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
117
118
119
120
121
122
123
124
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 91

def self.config_search_paths
  proc {
    yaml = 'newrelic.yml'
    config_yaml = File.join('config', yaml)
    erb = 'newrelic.yml.erb'
    config_erb = File.join('config', erb)

    paths = [config_yaml, yaml, config_erb, erb]

    if NewRelic::Control.instance.root
      paths << File.join(NewRelic::Control.instance.root, config_yaml)
      paths << File.join(NewRelic::Control.instance.root, yaml)
      paths << File.join(NewRelic::Control.instance.root, config_erb)
      paths << File.join(NewRelic::Control.instance.root, erb)
    end

    if ENV['HOME']
      paths << File.join(ENV['HOME'], '.newrelic', yaml)
      paths << File.join(ENV['HOME'], yaml)
      paths << File.join(ENV['HOME'], '.newrelic', erb)
      paths << File.join(ENV['HOME'], erb)
    end

    # If we're packaged for warbler, we can tell from GEM_HOME
    # the following line needs else branch coverage
    if ENV['GEM_HOME'] && ENV['GEM_HOME'].end_with?('.jar!') # rubocop:disable Style/SafeNavigation
      app_name = File.basename(ENV['GEM_HOME'], '.jar!')
      paths << File.join(ENV['GEM_HOME'], app_name, config_yaml)
      paths << File.join(ENV['GEM_HOME'], app_name, config_erb)
    end

    paths
  }
end

.convert_to_constant_list(raw_value) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 274

def self.convert_to_constant_list(raw_value)
  return NewRelic::EMPTY_ARRAY if raw_value.nil? || raw_value.empty?

  constants = convert_to_list(raw_value).map! do |class_name|
    const = ::NewRelic::LanguageSupport.constantize(class_name)
    NewRelic::Agent.logger.warn("Ignoring invalid constant '#{class_name}' in #{raw_value}") unless const
    const
  end
  constants.compact!
  constants
end

.convert_to_hash(value) ⇒ Object

Raises:

  • (ArgumentError) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 249

def self.convert_to_hash(value)
  return value if value.is_a?(Hash)

  if value.is_a?(String)
    return value.split(',').each_with_object({}) do |item, hash|
      key, value = item.split('=')
      hash[key] = value
    end
  end

  raise ArgumentError.new(
    "Config value '#{value}' of " \
    "class #{value.class} couldn't be turned into a Hash."
  )
end

.convert_to_list(value) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 238

def self.convert_to_list(value)
  case value
  when String
    value.split(/\s*,\s*/)
  when Array
    value
  else
    raise ArgumentError.new("Config value '#{value}' couldn't be turned into a list.")
  end
end

.convert_to_list_on_semicolon(value) ⇒ Object 



266
267
268
269
270
271
272
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 266

def self.convert_to_list_on_semicolon(value)
  case value
  when Array then value
  when String then value.split(SEMICOLON)
  else NewRelic::EMPTY_ARRAY
  end
end

.convert_to_regexp_list(raw_value) ⇒ Object 



231
232
233
234
235
236
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 231

def self.convert_to_regexp_list(raw_value)
  value_list = convert_to_list(raw_value)
  value_list.map do |value|
    /#{value}/
  end
end

.default_for(key) ⇒ Object 



83
84
85
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 83

def self.default_for(key)
  value_from_defaults(key, :default)
end

.default_settings(key) ⇒ Object 



65
66
67
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 65

def self.default_settings(key)
  ::NewRelic::Agent::Configuration::DEFAULTS[key]
end

.dispatcher ⇒ Object 



183
184
185
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 183

def self.dispatcher
  proc { NewRelic::Control.instance.local_env.discovered_dispatcher }
end

.framework ⇒ Object 



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

def self.framework
  proc {
    case
    when defined?(::NewRelic::TEST) then :test
    when defined?(::Rails::VERSION)
      case Rails::VERSION::MAJOR
      when 3
        :rails3
      when 4..8
        :rails_notifications
      else
        ::NewRelic::Agent.logger.warn("Detected untested Rails version #{Rails::VERSION::STRING}")
        :rails_notifications
      end
    when defined?(::Padrino) && defined?(::Padrino::PathRouter::Router) then :padrino
    when defined?(::Sinatra) && defined?(::Sinatra::Base) then :sinatra
    when defined?(::Roda) then :roda
    when defined?(::Grape) then :grape
    when defined?(::NewRelic::IA) then :external
    else :ruby
    end
  }
end

.host ⇒ Object 



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 206

def self.host
  proc do
    regex = /\A(?<identifier>.+?)x/
    if matches = regex.match(String(NewRelic::Agent.config[:license_key]))
      "collector.#{matches['identifier']}.nr-data.net"
    else
      'collector.newrelic.com'
    end
  end
end

.profiling_available ⇒ Object 



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 195

def self.profiling_available
  proc {
    begin
      require 'ruby-prof'
      true
    rescue LoadError
      false
    end
  }
end

.thread_profiler_enabled ⇒ Object 



187
188
189
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 187

def self.thread_profiler_enabled
  proc { NewRelic::Agent::Threading::BacktraceService.is_supported? }
end

.transaction_tracer_transaction_threshold ⇒ Object 



191
192
193
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 191

def self.transaction_tracer_transaction_threshold
  proc { NewRelic::Agent.config[:apdex_t] * 4 }
end

.transform_for(key) ⇒ Object 



87
88
89
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 87

def self.transform_for(key)
  value_from_defaults(key, :transform)
end

.value_from_defaults(key, subkey) ⇒ Object 



69
70
71
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 69

def self.value_from_defaults(key, subkey)
  default_settings(key)&.send(:[], subkey)
end

Instance Method Details

#default_values ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/new_relic/agent/configuration/default_source.rb', line 57

def default_values
  result = {}
  ::NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
    result[key] = value[:default]
  end
  result
end