opentelemetry-instrumentation-action_view 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c7bcecc2f3949e79523c0406503212f2bc54477aaf4dd677314e164a09067c
-  data.tar.gz: 042d4e54e62d8650079a50066e6a9b739524f5fa47f68cf9980e41c0babdaa92
+  metadata.gz: 62bb2b892d835cb28873c5dd2e5a682ef3a041853a05a8cad2e697c5d4e55d55
+  data.tar.gz: 3033a19d95b625d9503344aa907d5fdd51ef8275c7f3a9e9978aee3eafd6416f
 SHA512:
-  metadata.gz: 165bcf906fd27e99c35acbd3421375544a9fc7531eef8939f75713fa6b2f94b557c5d6e929981928cf1fcca71683f9c2120535ce30ff6bab0ea36569a51fd9b5
-  data.tar.gz: f2ee6bfee8771aae53d7301ad9c0eb56df55996fde55a4b5a38b2c9d2d9cf3ea7e06be7621d6dbdbf83f4d802bbc026455b65389cc601e6e8a40310c22432911
+  metadata.gz: 2ebd63ee4576b464dccce7fe51abd02c3b3eb86411a1d4b709e39c2590c0d09999ae8dc5f63c551be1f4a4003ec89dd1972c58eb29138d175312a6839a66fe5e
+  data.tar.gz: 54cd21b7714c1d78790eed3ab1627b6eaf5142f26016b3e3dbd57083adda41466500effbbb5170d5693fa190d89fdc4df9b428ba3a2e507639101126ef5fd6f3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-action_view
 
+### v0.1.3 / 2021-10-06
+
+* FIXED: Do not replace fanout 
+
 ### v0.1.2 / 2021-09-29
 
 * (No significant changes)

data/README.md

@@ -36,6 +36,22 @@ end
 
 Example usage can be seen in the `./example/trace_request_demonstration.ru` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/action_view/example/trace_request_demonstration.ru)
 
+## Known issues
+
+ActionView instrumentation uses ActiveSupport notifications and in the case when a subscriber raises in start method an unclosed span would break successive spans ends. Example:
+
+```ruby
+class CrashingEndSubscriber
+  def start(name, id, payload)
+    raise 'boom'
+  end
+
+  def finish(name, id, payload) end
+end
+
+::ActiveSupport::Notifications.subscribe('render_template.action_view', CrashingStartSubscriber.new)
+```
+
 ## How can I get involved?
 
 The `opentelemetry-instrumentation-action_view` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.

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

@@ -28,7 +28,6 @@ module OpenTelemetry
         private
 
         def require_dependencies
-          require_relative 'fanout'
           require_relative 'span_subscriber'
           require_relative 'railtie'
         end

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

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

data/lib/opentelemetry/instrumentation/action_view/span_subscriber.rb

@@ -6,10 +6,27 @@
 
 module OpenTelemetry
   module Instrumentation
+    # rubocop:disable Style/Documentation
     module ActionView
       # The SpanSubscriber is a special ActiveSupport::Notification subscription
       # handler which turns notifications into generic spans, taking care to handle
       # context appropriately.
+
+      # A very hacky way to make sure that OpenTelemetry::Instrumentation::ActionView::SpanSubscriber
+      # gets invoked first
+      def self.subscribe(pattern = nil, callable = nil)
+        ActiveSupport::Notifications.subscribe(pattern, callable)
+        ::ActiveSupport::Notifications.notifier.synchronize do
+          if ::Rails::VERSION::MAJOR == 6
+            s = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern].pop
+            ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern].unshift(s)
+          else
+            s = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@subscribers).pop
+            ::ActiveSupport::Notifications.notifier.instance_variable_get(:@subscribers).unshift(s)
+          end
+        end
+      end
+
       class SpanSubscriber
         ALWAYS_VALID_PAYLOAD_TYPES = [TrueClass, FalseClass, String, Numeric, Symbol].freeze
 
@@ -18,16 +35,20 @@ module OpenTelemetry
           @tracer = tracer
         end
 
-        def start(_name, _id, payload)
+        def start(name, id, payload)
           span = @tracer.start_span(@span_name, kind: :internal)
           token = OpenTelemetry::Context.attach(
             OpenTelemetry::Trace.context_with_span(span)
           )
+          payload.merge!(
+            __opentelemetry_span: span,
+            __opentelemetry_ctx_token: token
+          )
 
           [span, token]
         end
 
-        def finish(_name, _id, payload) # rubocop:disable Metrics/AbcSize
+        def finish(name, id, payload) # rubocop:disable Metrics/AbcSize
           span = payload.delete(:__opentelemetry_span)
           token = payload.delete(:__opentelemetry_ctx_token)
           return unless span && token
@@ -86,4 +107,5 @@ module OpenTelemetry
       end
     end
   end
+  # rubocop:enable Style/Documentation
 end

data/lib/opentelemetry/instrumentation/action_view/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionView
-      VERSION = '0.1.2'
+      VERSION = '0.1.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-action_view
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -206,7 +206,6 @@ files:
 - lib/opentelemetry-instrumentation-action_view.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/action_view.rb
-- lib/opentelemetry/instrumentation/action_view/fanout.rb
 - lib/opentelemetry/instrumentation/action_view/instrumentation.rb
 - lib/opentelemetry/instrumentation/action_view/railtie.rb
 - lib/opentelemetry/instrumentation/action_view/span_subscriber.rb
@@ -215,10 +214,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.1.2/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.1.3/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/action_view
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.1.2
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.1.3
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/instrumentation/action_view/fanout.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-#
-require 'delegate'
-
-module OpenTelemetry
-  module Instrumentation
-    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.
-      class Fanout < DelegateClass(::ActiveSupport::Notifications::Fanout)
-        def initialize(notifier = ::ActiveSupport::Notifications::Fanout.new)
-          super(notifier)
-        end
-
-        def start(name, id, payload)
-          listeners_for(name).map do |s|
-            result = [s]
-            state = s.start(name, id, payload)
-            if state.is_a?(Array) && state[0].is_a?(OpenTelemetry::Trace::Span) && state[1] # rubocop:disable Style/IfUnlessModifier
-              result << state
-            end
-
-            result
-          end
-        end
-
-        def finish(name, id, payload, listeners = listeners_for(name))
-          listeners.each do |(s, arr)|
-            span, token = arr
-            if span.is_a?(OpenTelemetry::Trace::Span) && token
-              s.finish(
-                name,
-                id,
-                payload.merge(
-                  __opentelemetry_span: span,
-                  __opentelemetry_ctx_token: token
-                )
-              )
-            else
-              s.finish(name, id, payload)
-            end
-          end
-        end
-
-        def listeners_for(name)
-          listeners = super
-          listeners.sort_by do |l|
-            l.instance_variable_get(:@delegate).is_a?(SpanSubscriber) ? -1 : 1
-          end
-        end
-      end
-    end
-  end
-end