class ElasticAPM::Config

@api private

Constants

SANITIZE_FIELD_NAMES_DEFAULT

Attributes

__root_path[RW]
__view_paths[RW]
logger[RW]
options[R]

Public Class Methods

new(options = {}) { |self| ... } click to toggle source

rubocop:enable Layout/LineLength, Layout/ExtraSpacing

# File lib/elastic_apm/config.rb, line 115
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)
  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

Public Instance Methods

app=(app) click to toggle source
# File lib/elastic_apm/config.rb, line 191
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) click to toggle source
# File lib/elastic_apm/config.rb, line 144
def assign(update)
  return unless update
  update.each { |key, value| send(:"#{key}=", value) }
end
available_instrumentations() click to toggle source
# File lib/elastic_apm/config.rb, line 149
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?() click to toggle source
# File lib/elastic_apm/config.rb, line 206
def collect_metrics?
  metrics_interval > 0
end
enabled_instrumentations() click to toggle source
# File lib/elastic_apm/config.rb, line 178
def enabled_instrumentations
  available_instrumentations - disable_instrumentations
end
inspect() click to toggle source
Calls superclass method
# File lib/elastic_apm/config.rb, line 244
def inspect
  super.split.first + '>'
end
log_ecs_formatting() click to toggle source
# File lib/elastic_apm/config.rb, line 104
def log_ecs_formatting
  log_ecs_reformatting
end
log_ecs_formatting=(value) click to toggle source
# File lib/elastic_apm/config.rb, line 108
def log_ecs_formatting=(value)
  @options[:log_ecs_reformatting].set(value)
end
replace_options(new_options) click to toggle source
# File lib/elastic_apm/config.rb, line 182
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) click to toggle source
Calls superclass method
# File lib/elastic_apm/config.rb, line 214
def span_frames_min_duration=(value)
  super
  @span_frames_min_duration_us = nil
end
span_frames_min_duration?() click to toggle source
# File lib/elastic_apm/config.rb, line 210
def span_frames_min_duration?
  span_frames_min_duration != 0
end
span_frames_min_duration_us() click to toggle source
# File lib/elastic_apm/config.rb, line 219
def span_frames_min_duration_us
  @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
end
ssl_context() click to toggle source
# File lib/elastic_apm/config.rb, line 223
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?() click to toggle source
# File lib/elastic_apm/config.rb, line 202
def use_ssl?
  server_url.start_with?('https')
end
version() click to toggle source
# File lib/elastic_apm/config.rb, line 248
def version
  @version ||= ServerInfo.new(self).version
end

Private Instance Methods

app_type?(app) click to toggle source
# File lib/elastic_apm/config.rb, line 293
def app_type?(app)
  if defined?(::Rails::Application) && app.is_a?(::Rails::Application)
    return :rails
  end

  if app.is_a?(Class) && app.superclass.to_s == 'Sinatra::Base'
    return :sinatra
  end

  nil
end
build_ecs_logger() click to toggle source
# File lib/elastic_apm/config.rb, line 285
def build_ecs_logger
  require 'ecs_logging/logger'

  ::EcsLogging::Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
    logger.level = log_level
  end
end
build_logger() click to toggle source
# File lib/elastic_apm/config.rb, line 269
def build_logger
  if self.log_ecs_reformatting == 'override'
    begin
      return build_ecs_logger
    rescue LoadError
      logger.info "Attempted to use EcsLogging::Logger but the gem couldn't be " \
        "loaded so a ::Logger was created instead. Check if you have the `ecs-logging` " \
        "gem installed and attempt to start the agent again."
    end
  end

  Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
    logger.level = log_level
  end
end
format_name(str) click to toggle source
# File lib/elastic_apm/config.rb, line 332
def format_name(str)
  str&.gsub('::', '_')
end
load_config_file() click to toggle source
# File lib/elastic_apm/config.rb, line 254
def load_config_file
  return unless File.exist?(config_file)

  read = File.read(config_file)
  evaled = ERB.new(read).result
  YAML.safe_load(evaled)
end
load_env() click to toggle source
# File lib/elastic_apm/config.rb, line 262
def load_env
  @options.values.each_with_object({}) do |option, opts|
    next unless (value = ENV[option.env_key])
    opts[option.key] = value
  end
end
rails_app_name(app) click to toggle source
# File lib/elastic_apm/config.rb, line 324
def rails_app_name(app)
  if ::Rails::VERSION::MAJOR >= 6
    app.class.module_parent_name
  else
    app.class.parent_name
  end
end
set_rails(app) click to toggle source
# File lib/elastic_apm/config.rb, line 312
def set_rails(app)
  self.service_name ||= format_name(service_name || rails_app_name(app))
  self.framework_name ||= 'Ruby on Rails'
  self.framework_version ||= ::Rails::VERSION::STRING
  self.logger ||= ::Rails.logger
  self.log_level ||= ::Rails.logger.log_level

  self.__root_path = ::Rails.root.to_s
  self.__view_paths = app.config.paths['app/views'].existent +
                      [::Rails.root.to_s]
end
set_sinatra(app) click to toggle source
# File lib/elastic_apm/config.rb, line 305
def set_sinatra(app)
  self.service_name = format_name(service_name || app.to_s)
  self.framework_name = framework_name || 'Sinatra'
  self.framework_version = framework_version || ::Sinatra::VERSION
  self.__root_path = Dir.pwd
end