Class: Datadog::Contrib::Configuration::Settings

Inherits:

Object

• Object
• Datadog::Contrib::Configuration::Settings

Includes:

Datadog::Configuration::Base, Patcher

Defined in:

lib/ddtrace/contrib/configuration/settings.rb

Overview

Common settings for all integrations

Direct Known Subclasses

ActionCable::Configuration::Settings, ActionPack::Configuration::Settings, ActionView::Configuration::Settings, ActiveModelSerializers::Configuration::Settings, ActiveRecord::Configuration::Settings, ActiveSupport::Configuration::Settings, Aws::Configuration::Settings, Datadog::Contrib::ConcurrentRuby::Configuration::Settings, Dalli::Configuration::Settings, DelayedJob::Configuration::Settings, Elasticsearch::Configuration::Settings, Ethon::Configuration::Settings, Excon::Configuration::Settings, Faraday::Configuration::Settings, GRPC::Configuration::Settings, Grape::Configuration::Settings, GraphQL::Configuration::Settings, HTTP::Configuration::Settings, Httprb::Configuration::Settings, Kafka::Configuration::Settings, MongoDB::Configuration::Settings, Mysql2::Configuration::Settings, Presto::Configuration::Settings, Que::Configuration::Settings, Racecar::Configuration::Settings, Rack::Configuration::Settings, Rails::Configuration::Settings, Rake::Configuration::Settings, Redis::Configuration::Settings, Resque::Configuration::Settings, RestClient::Configuration::Settings, Sequel::Configuration::Settings, Shoryuken::Configuration::Settings, Sidekiq::Configuration::Settings, Sinatra::Configuration::Settings, Sneakers::Configuration::Settings, SuckerPunch::Configuration::Settings

Constant Summary

DEPRECATION_WARNING =

%(
Explicitly providing a tracer instance is DEPRECATED.
It's recommended to not provide an explicit tracer instance
and let Datadog::Contrib::Configuration::Settings resolve
the correct tracer internally.
).freeze

Instance Method Summary

• #[](name) ⇒ Object
• #[]=(name, value) ⇒ Object
• #configure(options = {}) {|_self| ... } ⇒ Object
• #log_deprecation_warning(method_name) ⇒ Object

Methods included from Patcher

included

Methods included from Patcher::CommonMethods

#do_once, #done?, #without_warnings

Methods included from Datadog::Configuration::Base

included

Instance Method Details

#[](name) ⇒ Object

# File 'lib/ddtrace/contrib/configuration/settings.rb', line 29

def [](name)
  respond_to?(name) ? send(name) : get_option(name)
end

#[]=(name, value) ⇒ Object

# File 'lib/ddtrace/contrib/configuration/settings.rb', line 33

def []=(name, value)
  respond_to?("#{name}=") ? send("#{name}=", value) : set_option(name, value)
end

#configure(options = {}) {|_self| ... } ⇒ Object

Yields:

• (_self)

Yield Parameters:

• _self (Datadog::Contrib::Configuration::Settings) —

  the object that the method was called on

# File 'lib/ddtrace/contrib/configuration/settings.rb', line 21

def configure(options = {})
  self.class.options.dependency_order.each do |name|
    self[name] = options[name] if options.key?(name)
  end

  yield(self) if block_given?
end

#log_deprecation_warning(method_name) ⇒ Object

# File 'lib/ddtrace/contrib/configuration/settings.rb', line 46

def log_deprecation_warning(method_name)
  do_once(method_name) do
    Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}:#{caller.join("\n")}")
  end
end