Module: OpenTelemetry::Instrumentation::ActiveSupport

Defined in:
lib/opentelemetry/instrumentation/active_support.rb,
lib/opentelemetry/instrumentation/active_support/version.rb,
lib/opentelemetry/instrumentation/active_support/instrumentation.rb,
lib/opentelemetry/instrumentation/active_support/span_subscriber.rb

Overview

rubocop:disable Style/Documentation

Defined Under Namespace

Classes: Instrumentation, SpanSubscriber

Constant Summary collapse

VERSION = 
'0.12.1'
LEGACY_NAME_FORMATTER = 
->(name) { name.split('.')[0..1].reverse.join(' ') }

Class Method Summary collapse

Class Method Details

.subscribe(tracer, pattern, notification_payload_transform = nil, disallowed_notification_payload_keys = nil, kind: nil, span_name_formatter: nil) ⇒ Object

A very hacky way to make sure that OpenTelemetry::Instrumentation::ActiveSupport::SpanSubscriber gets invoked first Rails 6+ https://github.com/rails/rails/blob/0f0ec9908e25af36df2d937dc431f626a4102b3d/activesupport/lib/active_support/notifications/fanout.rb#L51



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
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/opentelemetry/instrumentation/active_support/span_subscriber.rb', line 32

def self.subscribe(
  tracer,
  pattern,
  notification_payload_transform = nil,
  disallowed_notification_payload_keys = nil,
  kind: nil,
  span_name_formatter: nil
)
  subscriber = OpenTelemetry::Instrumentation::ActiveSupport::SpanSubscriber.new(
    pattern: pattern,
    tracer: tracer,
    notification_payload_transform: notification_payload_transform,
    disallowed_notification_payload_keys: disallowed_notification_payload_keys,
    kind: kind,
    span_name_formatter: span_name_formatter
  )

  subscriber_object = ::ActiveSupport::Notifications.subscribe(pattern, subscriber)

  # this can be removed once we drop support for Rails < 7.2
  # see https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/707 for more context
  if ::ActiveSupport::Notifications.notifier.respond_to?(:synchronize)
    ::ActiveSupport::Notifications.notifier.synchronize do
      subscribers = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern]

      if subscribers.nil?
        OpenTelemetry.handle_error(
          message: 'Unable to move OTEL ActiveSupport Notifications subscriber to the front of the notifications list which may cause incomplete traces.' \
                   'Please report an issue here: ' \
                   'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/new?labels=bug&template=bug_report.md&title=ActiveSupport%20Notifications%20subscribers%20list%20is%20nil'
        )
      else
        subscribers.unshift(
          subscribers.delete(subscriber_object)
        )
      end
    end
  end
  subscriber_object
end