Class: Atatus::Config Private

Inherits:
Object
  • Object
show all
Extended by:
Options, Deprecations
Defined in:
lib/atatus/config.rb,
lib/atatus/config/bytes.rb,
lib/atatus/config/options.rb,
lib/atatus/config/duration.rb,
lib/atatus/config/regexp_list.rb,
lib/atatus/config/round_float.rb,
lib/atatus/config/server_info.rb,
lib/atatus/config/log_level_map.rb,
lib/atatus/config/wildcard_pattern_list.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Modules: Options Classes: Bytes, Duration, LogLevelMap, RegexpList, RoundFloat, ServerInfo, WildcardPatternList

Constant Summary collapse

SANITIZE_FIELD_NAMES_DEFAULT =

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. 

%w[password passwd pwd secret *key *token* *session* *credit* *card* *auth* set-cookie].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Options

extended

Methods included from Deprecations

deprecate

Constructor Details

#initialize(options = {}) {|_self| ... } ⇒ 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.

rubocop:enable Layout/LineLength, Layout/ExtraSpacing

Yields:

  • (_self)

Yield Parameters:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/atatus/config.rb', line 122

def initialize(options = {})
  @options = load_schema

  assign(options)

  # Pick out config_file specifically as we need it now to load it,
  # but still need the other env vars to have precedence
  env = load_env
  if (env_config_file = env.delete(:config_file))
    self.config_file = env_config_file
  end

  assign(load_config_file(self.environment))
  assign(env)

  yield self if block_given?

  if self.logger.nil? || self.log_path
    self.logger = build_logger
  end

  @__view_paths ||= []
  @__root_path ||= Dir.pwd
end

Instance Attribute Details

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



147
148
149
 
# File 'lib/atatus/config.rb', line 147

def __root_path
  @__root_path
end

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



147
148
149
 
# File 'lib/atatus/config.rb', line 147

def __view_paths
  @__view_paths
end

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



147
148
149
 
# File 'lib/atatus/config.rb', line 147

def logger
  @logger
end

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



149
150
151
 
# File 'lib/atatus/config.rb', line 149

def options
  @options
end

Instance Method Details

#app=(app) ⇒ 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. 



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/atatus/config.rb', line 198

def app=(app)
  case app_type?(app)
  when :sinatra
    set_sinatra(app)
  when :rails
    set_rails(app)
  else
    self.service_name = 'ruby'
  end
end

#assign(update) ⇒ 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. 



151
152
153
154
 
# File 'lib/atatus/config.rb', line 151

def assign(update)
  return unless update
  update.each { |key, value| send(:"#{key}=", value) }
end

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/atatus/config.rb', line 156

def available_instrumentations
  %w[
    action_dispatch
    azure_storage_table
    delayed_job
    dynamo_db
    elasticsearch
    faraday
    http
    json
    mongo
    net_http
    rake
    racecar
    redis
    resque
    s3
    sequel
    shoryuken
    sidekiq
    sinatra
    sneakers
    sns
    sqs
    sucker_punch
    tilt
  ]
end

#collect_metrics? ⇒ 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) 


213
214
215
 
# File 'lib/atatus/config.rb', line 213

def collect_metrics?
  metrics_interval > 0
end

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



185
186
187
 
# File 'lib/atatus/config.rb', line 185

def enabled_instrumentations
  available_instrumentations - disable_instrumentations
end

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



251
252
253
 
# File 'lib/atatus/config.rb', line 251

def inspect
  super.split.first + '>'
end

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



111
112
113
 
# File 'lib/atatus/config.rb', line 111

def log_ecs_formatting
  log_ecs_reformatting
end

#log_ecs_formatting=(value) ⇒ 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. 



115
116
117
 
# File 'lib/atatus/config.rb', line 115

def log_ecs_formatting=(value)
  @options[:log_ecs_reformatting].set(value)
end

#replace_options(new_options) ⇒ 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. 



189
190
191
192
193
194
195
196
 
# File 'lib/atatus/config.rb', line 189

def replace_options(new_options)
  return if new_options.nil? || new_options.empty?
  options_copy = @options.dup
  new_options.each do |key, value|
    options_copy.fetch(key.to_sym).set(value)
  end
  @options = options_copy
end

#span_frames_min_duration=(value) ⇒ 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. 



221
222
223
224
 
# File 'lib/atatus/config.rb', line 221

def span_frames_min_duration=(value)
  super
  @span_frames_min_duration_us = nil
end

#span_frames_min_duration? ⇒ 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) 


217
218
219
 
# File 'lib/atatus/config.rb', line 217

def span_frames_min_duration?
  span_frames_min_duration != 0
end

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



226
227
228
 
# File 'lib/atatus/config.rb', line 226

def span_frames_min_duration_us
  @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
end

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/atatus/config.rb', line 230

def ssl_context
  return unless use_ssl?

  @ssl_context ||=
    OpenSSL::SSL::SSLContext.new.tap do |context|
      if server_ca_cert_file
        context.ca_file = server_ca_cert_file
      else
        context.cert_store =
          OpenSSL::X509::Store.new.tap(&:set_default_paths)
      end

      context.verify_mode =
        if verify_server_cert
          OpenSSL::SSL::VERIFY_PEER
        else
          OpenSSL::SSL::VERIFY_NONE
        end
    end
end

#use_ssl? ⇒ 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) 


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

def use_ssl?
  server_url.start_with?('https')
end

#version ⇒ 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
 
# File 'lib/atatus/config.rb', line 255

def version
  @version ||= ServerInfo.new(self).version
end