Class: Labkit::Tracing::Rails::ActionViewSubscriber

Inherits:
Object
  • Object
show all
Includes:
RailsCommon
Defined in:
lib/labkit/tracing/rails/action_view_subscriber.rb

Overview

ActionViewSubscriber bridges action view notifications to the distributed tracing subsystem

Constant Summary collapse

COMPONENT_TAG = 
"ActionView"
RENDER_TEMPLATE_NOTIFICATION_TOPIC = 
"render_template.action_view"
RENDER_COLLECTION_NOTIFICATION_TOPIC = 
"render_collection.action_view"
RENDER_PARTIAL_NOTIFICATION_TOPIC = 
"render_partial.action_view"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RailsCommon

#generate_span_for_notification

Class Method Details

.instrument ⇒ Object

Instruments Rails ActionView events for opentracing. Returns a lambda, which, when called will unsubscribe from the notifications



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/labkit/tracing/rails/action_view_subscriber.rb', line 18

def self.instrument
  subscriber = new

  subscriptions = [
    ActiveSupport::Notifications.subscribe(RENDER_TEMPLATE_NOTIFICATION_TOPIC) do |_, start, finish, _, payload|
      subscriber.notify_render_template(start, finish, payload)
    end,
    ActiveSupport::Notifications.subscribe(RENDER_COLLECTION_NOTIFICATION_TOPIC) do |_, start, finish, _, payload|
      subscriber.notify_render_collection(start, finish, payload)
    end,
    ActiveSupport::Notifications.subscribe(RENDER_PARTIAL_NOTIFICATION_TOPIC) do |_, start, finish, _, payload|
      subscriber.notify_render_partial(start, finish, payload)
    end,
  ]

  create_unsubscriber subscriptions
end

Instance Method Details

#notify_render_collection(start, finish, payload) ⇒ Object 



41
42
43
 
# File 'lib/labkit/tracing/rails/action_view_subscriber.rb', line 41

def notify_render_collection(start, finish, payload)
  generate_span_for_notification("render_collection", start, finish, payload, tags_for_render_collection(payload))
end

#notify_render_partial(start, finish, payload) ⇒ Object 



45
46
47
 
# File 'lib/labkit/tracing/rails/action_view_subscriber.rb', line 45

def notify_render_partial(start, finish, payload)
  generate_span_for_notification("render_partial", start, finish, payload, tags_for_render_partial(payload))
end

#notify_render_template(start, finish, payload) ⇒ Object

For more information on the payloads: guides.rubyonrails.org/active_support_instrumentation.html



37
38
39
 
# File 'lib/labkit/tracing/rails/action_view_subscriber.rb', line 37

def notify_render_template(start, finish, payload)
  generate_span_for_notification("render_template", start, finish, payload, tags_for_render_template(payload))
end