refactor!: split out active support from rails gem (#880)

Author: robertlaurin

instrumentation/rails/lib/opentelemetry/instrumentation/rails/fanout.rb renamed to instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/fanout.rb

@@ -6,7 +6,7 @@
 
 module OpenTelemetry
   module Instrumentation
-    module Rails
+    module ActionView
       # This is a replacement for the default Fanout notifications queue, which adds special
       # handling around returned context from the SpanSubscriber notification handlers.
       # Used together, it allows us to trace arbitrary ActiveSupport::Notifications safely.

instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/instrumentation.rb

@@ -22,9 +22,14 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
           Gem.loaded_specs['actionview'].version >= MINIMUM_VERSION
         end
 
+        option :disallowed_notification_payload_keys, default: [],  validate: :array
+        option :notification_payload_transform,       default: nil, validate: :callable
+
         private
 
         def require_dependencies
+          require_relative 'fanout'
+          require_relative 'span_subscriber'
           require_relative 'railtie'
         end
       end

instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/railtie.rb

@@ -16,12 +16,12 @@ module ActionView
       # This Railtie sets up subscriptions to relevant ActionView notifications
       class Railtie < ::Rails::Railtie
         config.before_initialize do
-          OpenTelemetry::Instrumentation::Rails::Instrumentation.instance.install({})
+          ::ActiveSupport::Notifications.notifier = Fanout.new
         end
 
         config.after_initialize do
           SUBSCRIPTIONS.each do |subscription_name|
-            subscriber = OpenTelemetry::Instrumentation::Rails::SpanSubscriber.new(
+            subscriber = OpenTelemetry::Instrumentation::ActionView::SpanSubscriber.new(
               name: subscription_name,
               tracer: ActionView::Instrumentation.instance.tracer
             )

instrumentation/rails/lib/opentelemetry/instrumentation/rails/span_subscriber.rb renamed to instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/span_subscriber.rb

@@ -6,7 +6,7 @@
 
 module OpenTelemetry
   module Instrumentation
-    module Rails
+    module ActionView
       # The SpanSubscriber is a special ActiveSupport::Notification subscription
       # handler which turns notifications into generic spans, taking care to handle
       # context appropriately.
@@ -50,7 +50,7 @@ def finish(_name, _id, payload) # rubocop:disable Metrics/AbcSize
         private
 
         def instrumentation_config
-          Rails::Instrumentation.instance.config
+          ActionView::Instrumentation.instance.config
         end
 
         def transform_payload(payload)

instrumentation/action_view/opentelemetry-instrumentation-action_view.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'opentelemetry-sdk'
+  spec.add_development_dependency 'rails'
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rubocop', '~> 0.73.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'

instrumentation/rails/test/opentelemetry/instrumentation/rails/fanout_test.rb renamed to instrumentation/action_view/test/opentelemetry/instrumentation/action_view/fanout_test.rb

@@ -6,21 +6,21 @@
 
 require 'test_helper'
 
-describe OpenTelemetry::Instrumentation::Rails::Fanout do
-  let(:tracer) { OpenTelemetry::Instrumentation::Rails::Instrumentation.instance.tracer }
+describe OpenTelemetry::Instrumentation::ActionView::Fanout do
+  let(:tracer) { OpenTelemetry::Instrumentation::ActionView::Instrumentation.instance.tracer }
   let(:exporter) { EXPORTER }
   let(:spans) { exporter.finished_spans }
   let(:last_span) { spans.last }
   let(:span_subscriber) do
-    OpenTelemetry::Instrumentation::Rails::SpanSubscriber.new(
+    OpenTelemetry::Instrumentation::ActionView::SpanSubscriber.new(
       name: 'bar.foo',
       tracer: tracer
     )
   end
 
   before do
     exporter.reset
-    ::ActiveSupport::Notifications.notifier = OpenTelemetry::Instrumentation::Rails::Fanout.new
+    ::ActiveSupport::Notifications.notifier = OpenTelemetry::Instrumentation::ActionView::Fanout.new
   end
 
   it 'sorts span subscribers first' do

instrumentation/rails/test/opentelemetry/instrumentation/rails/span_subscriber_test.rb renamed to instrumentation/action_view/test/opentelemetry/instrumentation/action_view/span_subscriber_test.rb

@@ -6,13 +6,13 @@
 
 require 'test_helper'
 
-describe OpenTelemetry::Instrumentation::Rails::SpanSubscriber do
-  let(:instrumentation) { OpenTelemetry::Instrumentation::Rails::Instrumentation.instance }
+describe OpenTelemetry::Instrumentation::ActionView::SpanSubscriber do
+  let(:instrumentation) { OpenTelemetry::Instrumentation::ActionView::Instrumentation.instance }
   let(:tracer) { instrumentation.tracer }
   let(:exporter) { EXPORTER }
   let(:last_span) { exporter.finished_spans.last }
   let(:subscriber) do
-    OpenTelemetry::Instrumentation::Rails::SpanSubscriber.new(
+    OpenTelemetry::Instrumentation::ActionView::SpanSubscriber.new(
       name: 'bar.foo',
       tracer: tracer
     )
@@ -30,7 +30,7 @@
   end
 
   it 'uses the provided tracer' do
-    subscriber = OpenTelemetry::Instrumentation::Rails::SpanSubscriber.new(
+    subscriber = OpenTelemetry::Instrumentation::ActionView::SpanSubscriber.new(
       name: 'oh.hai',
       tracer: OpenTelemetry.tracer_provider.tracer('foo')
     )

instrumentation/rails/lib/opentelemetry/instrumentation/rails/instrumentation.rb

@@ -23,15 +23,11 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
         end
 
         option :enable_recognize_route, default: false, validate: :boolean
-        option :disallowed_notification_payload_keys, default: [], validate: :array
-        option :notification_payload_transform, default: nil, validate: :callable
 
         private
 
         def require_dependencies
           require_relative 'patches/action_controller/metal'
-          require_relative 'fanout'
-          require_relative 'span_subscriber'
         end
 
         def require_railtie

instrumentation/rails/lib/opentelemetry/instrumentation/rails/railtie.rb

@@ -12,8 +12,6 @@ module Rails
       # the Rails application through its initialization hooks.
       class Railtie < ::Rails::Railtie
         config.before_initialize do |app|
-          ::ActiveSupport::Notifications.notifier = Fanout.new
-
           OpenTelemetry::Instrumentation::ActiveRecord::Instrumentation.instance.install({})
           OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({})