Module: ActionController::Tracer

Defined in:
lib/rails/action_controller/tracer.rb

Constant Summary collapse

COMPONENT = 
"ActionController".freeze

Class Method Summary collapse

Class Method Details

.disable ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/rails/action_controller/tracer.rb', line 17

def disable
  @subscribers.each do |subscriber|
    ::ActiveSupport::Notifications.unsubscribe(subscriber)
  end
  @subscribers.clear
  self
end

.instrument(tracer: OpenTracing.global_tracer, active_span: nil) ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'lib/rails/action_controller/tracer.rb', line 7

def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
  @subscribers = []
  @subscribers << ::ActiveSupport::Notifications.subscribe('start_processing.action_controller') do |*args|
    ActionController::Tracer.start_processing(tracer: tracer, active_span: active_span, args: args)
  end
  @subscribers << ::ActiveSupport::Notifications.subscribe('process_action.action_controller') do |*args|
    ActionController::Tracer.process_action(tracer: tracer, active_span: active_span, args: args)
  end
end

.process_action(tracer: OpenTracing.global_tracer, active_span: nil, args: {}) ⇒ Object 



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
 
# File 'lib/rails/action_controller/tracer.rb', line 62

def process_action(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
  event, start, finish, id, payload = *args

  path = payload.fetch(:path)
  name = "#{payload.fetch(:controller)}##{payload.fetch(:action)} #{path}"
  tags = {
    'component' => COMPONENT,
    'span.kind' => 'client',
    'http.method' => payload.fetch(:method),
    'http.status_code' => payload.fetch(:status),
    'http.path' => path,
    'view.runtime' => payload.fetch(:view_runtime),
    'db.runtime' => payload.fetch(:db_runtime),
  }

  if !Rails::Tracer::Defer.enabled
    # write out the span
    span = tracer.start_span(name,
                             child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
                             start_time: start,
                             tags: tags)

    span.finish(end_time: finish)
  else
    # defer the spans if full_trace is configured
    spaninfo = {
      'event' => event,
      'name' => name,
      'start' => start,
      'finish' => finish,
      'tags' => tags,
    }

    Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
  end
end

.start_processing(tracer: OpenTracing.global_tracer, active_span: nil, args: {}) ⇒ Object 



25
26
27
28
29
30
31
32
33
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
 
# File 'lib/rails/action_controller/tracer.rb', line 25

def start_processing(tracer: OpenTracing.global_tracer, active_span: nil, args: {})
  event, start, finish, id, payload = *args

  # extract the rack context, if it exists
  # it seems like this might be the earliest place env is available
  rack_span = Rails::Tracer::SpanHelpers.rack_span(payload)
  Rails::Tracer::Defer.add_parent(id, rack_span)

  path = payload.fetch(:path)
  name = "#{payload.fetch(:controller)}##{payload.fetch(:action)} #{event} #{path}"
  tags = {
    'component' => COMPONENT,
    'span.kind' => 'client',
    'http.method' => payload.fetch(:method),
    'http.path' => path,
  }

  if !Rails::Tracer::Defer.enabled
    span = tracer.start_span(name,
                             child_of: active_span.respond_to?(:call) ? active_span.call : active_span,
                             start_time: start,
                             tags: tags)

    span.finish(end_time: finish)
  else
    spaninfo = {
      'event' => event,
      'name' => name,
      'start' => start,
      'finish' => finish,
      'tags' => tags,
    }

    Rails::Tracer::Defer.defer_span(id: id, spaninfo: spaninfo)
  end
end