Module: Datadog::Contrib::Rails::Patcher

Includes:
Patcher
Defined in:
lib/ddtrace/contrib/rails/patcher.rb

Overview

Patcher enables patching of ‘rails’ module.

Class Method Summary collapse

Methods included from Patcher

included

Class Method Details

.add_logger(app) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 55

def add_logger(app)
  # check if lograge key exists
  if app.config.respond_to?(:lograge) && app.config.lograge.enabled
    Datadog::Contrib::Rails::LogInjection.add_lograge_logger(app)
  # if lograge isn't set, check if tagged logged is enabed.
  # if so, add proc that injects trace identifiers for tagged logging.
  elsif (logger = app.config.logger) && logger.is_a?(::ActiveSupport::TaggedLogging)
    Datadog::Contrib::Rails::LogInjection.add_as_tagged_logging_logger(app)
  else
    Datadog.logger.warn("Unabe to enable Datadog Trace context, Logger #{logger} is not supported")
  end
end

.add_middleware(app) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 41

def add_middleware(app)
  # Add trace middleware
  app.middleware.insert_before(0, Datadog::Contrib::Rack::TraceMiddleware)

  # Insert right after Rails exception handling middleware, because if it's before,
  # it catches and swallows the error. If it's too far after, custom middleware can find itself
  # between, and raise exceptions that don't end up getting tagged on the request properly.
  # e.g lost stack trace.
  app.middleware.insert_after(
    ActionDispatch::ShowExceptions,
    Datadog::Contrib::Rails::ExceptionMiddleware
  )
end

.after_intialize(app) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 74

def after_intialize(app)
  do_once(:rails_after_initialize, for: app) do
    # Finish configuring the tracer after the application is initialized.
    # We need to wait for some things, like application name, middleware stack, etc.
    setup_tracer
  end
end

.before_intialize(app) ⇒ Object 



31
32
33
34
35
36
37
38
39
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 31

def before_intialize(app)
  do_once(:rails_before_initialize, for: app) do
    # Middleware must be added before the application is initialized.
    # Otherwise the middleware stack will be frozen.
    # Sometimes we don't want to activate middleware e.g. OpenTracing, etc.
    add_middleware(app) if Datadog.configuration[:rails][:middleware]
    add_logger(app) if Datadog.configuration[:rails][:log_injection]
  end
end

.patch ⇒ Object 



20
21
22
23
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 20

def patch
  patch_before_intialize
  patch_after_intialize
end

.patch_after_intialize ⇒ Object 



68
69
70
71
72
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 68

def patch_after_intialize
  ::ActiveSupport.on_load(:after_initialize) do
    Datadog::Contrib::Rails::Patcher.after_intialize(self)
  end
end

.patch_before_intialize ⇒ Object 



25
26
27
28
29
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 25

def patch_before_intialize
  ::ActiveSupport.on_load(:before_initialize) do
    Datadog::Contrib::Rails::Patcher.before_intialize(self)
  end
end

.setup_tracer ⇒ Object

Configure Rails tracing with settings



83
84
85
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 83

def setup_tracer
  Datadog::Contrib::Rails::Framework.setup
end

.target_version ⇒ Object 



16
17
18
 
# File 'lib/ddtrace/contrib/rails/patcher.rb', line 16

def target_version
  Integration.version
end