require 'ddtrace/pin' require 'ddtrace/ext/app_types' require 'ddtrace/contrib/grape/endpoint' require 'ddtrace/contrib/rack/middlewares' require 'ddtrace/contrib/rails/core_extensions' require 'ddtrace/contrib/rails/action_controller' require 'ddtrace/contrib/rails/action_view' require 'ddtrace/contrib/rails/active_record' require 'ddtrace/contrib/rails/active_support' require 'ddtrace/contrib/rails/utils' # Rails < 3.1 unless defined?(ActiveRecord::Base.connection_config) ActiveRecord::Base.class_eval do class << self def connection_config connection_pool.spec.config end end end end module Datadog module Contrib # TODO[manu]: write docs module Rails # TODO[manu]: write docs module Framework # default configurations for the Rails integration; by default # the Datadog.tracer is enabled, while the Rails auto instrumentation # is kept disabled. DEFAULT_CONFIG = { enabled: true, auto_instrument: false, auto_instrument_redis: false, auto_instrument_grape: false, default_service: 'rails-app', default_controller_service: 'rails-controller', default_cache_service: 'rails-cache', default_grape_service: 'grape', template_base_path: 'views/', tracer: Datadog.tracer, debug: false, trace_agent_hostname: Datadog::Writer::HOSTNAME, trace_agent_port: Datadog::Writer::PORT, env: nil, tags: {} }.freeze # configure Datadog settings # rubocop:disable Metrics/MethodLength def self.configure(config) # tracer defaults # merge default configurations with users settings user_config = config[:config].datadog_trace rescue {} datadog_config = DEFAULT_CONFIG.merge(user_config) datadog_config[:tracer].enabled = datadog_config[:enabled] # set debug logging Datadog::Tracer.debug_logging = datadog_config[:debug] # set the address of the trace agent datadog_config[:tracer].configure( hostname: datadog_config[:trace_agent_hostname], port: datadog_config[:trace_agent_port] ) # set default tracer tags datadog_config[:tracer].set_tags(datadog_config[:tags]) datadog_config[:tracer].set_tags('env' => datadog_config[:env]) if datadog_config[:env] # set default service details datadog_config[:tracer].set_service_info( datadog_config[:default_service], 'rack', Datadog::Ext::AppTypes::WEB ) datadog_config[:tracer].set_service_info( datadog_config[:default_controller_service], 'rails', Datadog::Ext::AppTypes::WEB ) datadog_config[:tracer].set_service_info( datadog_config[:default_cache_service], 'rails', Datadog::Ext::AppTypes::CACHE ) # By default, default service would be guessed from the script # being executed, but here we know better, get it from Rails config. datadog_config[:tracer].default_service = datadog_config[:default_service] if defined?(::ActiveRecord) begin # set default database service details and store it in the configuration conn_cfg = ::ActiveRecord::Base.connection_config() adapter_name = Datadog::Contrib::Rails::Utils.normalize_vendor(conn_cfg[:adapter]) database_service = datadog_config.fetch(:default_database_service, adapter_name) datadog_config[:default_database_service] = database_service datadog_config[:tracer].set_service_info( database_service, adapter_name, Datadog::Ext::AppTypes::DB ) rescue StandardError => e Datadog::Tracer.log.warn("Unable to get database config (#{e}), skipping ActiveRecord instrumentation") end end # update global configurations ::Rails.configuration.datadog_trace = datadog_config end def self.auto_instrument_redis return unless ::Rails.configuration.datadog_trace[:auto_instrument_redis] Datadog::Tracer.log.debug('Enabling auto-instrumentation for Redis client') # patch the Redis library and reload the CacheStore if it was using Redis Datadog::Monkey.patch_module(:redis) # reload the cache store if it's available and it's using Redis return unless defined?(::ActiveSupport::Cache::RedisStore) && defined?(::Rails.cache) && ::Rails.cache.is_a?(::ActiveSupport::Cache::RedisStore) Datadog::Tracer.log.debug('Enabling auto-instrumentation for redis-rails connector') # backward compatibility: Rails 3.x doesn't have `cache=` method cache_store = ::Rails.configuration.cache_store cache_instance = ::ActiveSupport::Cache.lookup_store(cache_store) if ::Rails::VERSION::MAJOR.to_i == 3 silence_warnings { Object.const_set 'RAILS_CACHE', cache_instance } elsif ::Rails::VERSION::MAJOR.to_i > 3 ::Rails.cache = cache_instance end end def self.auto_instrument_grape return unless ::Rails.configuration.datadog_trace[:auto_instrument_grape] # patch the Grape library so that endpoints are traced Datadog::Monkey.patch_module(:grape) # update the Grape pin object pin = Datadog::Pin.get_from(::Grape) return unless pin && pin.enabled? pin.tracer = ::Rails.configuration.datadog_trace[:tracer] pin.service = ::Rails.configuration.datadog_trace[:default_grape_service] end # automatically instrument all Rails component def self.auto_instrument return unless ::Rails.configuration.datadog_trace[:auto_instrument] Datadog::Tracer.log.debug('Enabling auto-instrumentation for core components') # instrumenting Rails framework Datadog::Contrib::Rails::ActionController.instrument() Datadog::Contrib::Rails::ActionView.instrument() Datadog::Contrib::Rails::ActiveRecord.instrument() Datadog::Contrib::Rails::ActiveSupport.instrument() end end end end end