Module: Datadog::Contrib::Rails::Framework

Defined in:
lib/ddtrace/contrib/rails/framework.rb

Overview

Rails framework code, used to essentially:

  • handle configuration entries which are specific to Datadog tracing

  • instrument parts of the framework when needed

Constant Summary collapse

DEFAULT_CONFIG =

default configurations for the Rails integration; by default the Datadog.tracer is enabled, while the Rails auto instrumentation is kept disabled.

{
  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

Class Method Summary collapse

Class Method Details

.auto_instrument ⇒ Object

automatically instrument all Rails component



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ddtrace/contrib/rails/framework.rb', line 158

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

.auto_instrument_grape ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/ddtrace/contrib/rails/framework.rb', line 144

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

.auto_instrument_redis ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/ddtrace/contrib/rails/framework.rb', line 121

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

.configure(config) ⇒ Object

configure Datadog settings rubocop:disable Metrics/MethodLength



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/ddtrace/contrib/rails/framework.rb', line 56

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