Module: Datadog::Contrib::Rails::ActionController

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

Overview

Code used to create and handle ‘rails.action_controller’ spans.

Class Method Summary collapse

Methods included from Patcher

included

Methods included from Patcher::CommonMethods

#do_once, #done?, #without_warnings

Class Method Details

.exception_controller?(payload) ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ddtrace/contrib/rails/action_controller.rb', line 78

def self.exception_controller?(payload)
  exception_controller_class = Datadog.configuration[:rails][:exception_controller]
  controller = payload.fetch(:controller)
  headers = payload.fetch(:headers)

  # If no exception controller class has been set,
  # guess whether this is an exception controller from the headers.
  if exception_controller_class.nil?
    !headers[:request_exception].nil?
  # If an exception controller class has been specified,
  # check if the controller is a kind of the exception controller class.
  elsif exception_controller_class.is_a?(Class) || exception_controller_class.is_a?(Module)
    controller <= exception_controller_class
  # Otherwise if the exception controller class is some other value (like false)
  # assume that this controller doesn't handle exceptions.
  else
    false
  end
end

.finish_processing(payload) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ddtrace/contrib/rails/action_controller.rb', line 34

def self.finish_processing(payload)
  # retrieve the tracing context and the latest active span
  tracing_context = payload.fetch(:tracing_context)
  env = payload.fetch(:env)
  span = tracing_context[:dd_request_span]
  return unless span && !span.finished?

  begin
    # Set the resource name, if it's still the default name
    if span.resource == span.name
      span.resource = "#{payload.fetch(:controller)}##{payload.fetch(:action)}"
    end

    # Set the resource name of the Rack request span unless this is an exception controller.
    unless exception_controller?(payload)
      rack_request_span = env[Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
      rack_request_span.resource = span.resource if rack_request_span
    end

    # Set analytics sample rate
    Utils.set_analytics_sample_rate(span)

    # Associate with runtime metrics
    Datadog.runtime_metrics.associate_with_span(span)

    span.set_tag(Ext::TAG_ROUTE_ACTION, payload.fetch(:action))
    span.set_tag(Ext::TAG_ROUTE_CONTROLLER, payload.fetch(:controller))

    exception = payload[:exception_object]
    if exception.nil?
      # [christian] in some cases :status is not defined,
      # rather than firing an error, simply acknowledge we don't know it.
      status = payload.fetch(:status, '?').to_s
      span.status = 1 if status.starts_with?('5')
    elsif Utils.exception_is_error?(exception)
      span.set_error(exception)
    end
  ensure
    span.finish()
  end
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end

.instrument ⇒ Object 



13
14
15
16
17
18
 
# File 'lib/ddtrace/contrib/rails/action_controller.rb', line 13

def self.instrument
  # patch Rails core components
  do_once(:instrument) do
    Datadog::RailsActionPatcher.patch_action_controller
  end
end

.start_processing(payload) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/ddtrace/contrib/rails/action_controller.rb', line 20

def self.start_processing(payload)
  # trace the execution
  tracer = Datadog.configuration[:rails][:tracer]
  service = Datadog.configuration[:rails][:controller_service]
  type = Datadog::Ext::HTTP::TYPE_INBOUND
  span = tracer.trace(Ext::SPAN_ACTION_CONTROLLER, service: service, span_type: type)

  # attach the current span to the tracing context
  tracing_context = payload.fetch(:tracing_context)
  tracing_context[:dd_request_span] = span
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end