opentelemetry-instrumentation-action_view 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e198a53133979f37a449a32a0b46c1480a96fd425961ef58b58ccf1c63546a21
-  data.tar.gz: aa648e7dbbbb7f39aaabb88c88eabbe1ebd1baf1f8a075f0f2b5a74bb3169c5b
+  metadata.gz: 52213cc69860a40c5c84fc88b32f585458285d463500c38a608b8684aef576c9
+  data.tar.gz: 12d0053a8a39b0ed6fc83cc5b6b0a5de86b18210ae9ce996a58bd5b416b97698
 SHA512:
-  metadata.gz: 23a59f8b97c874a4e35b01ce08eaa2a09d0874727cdbd775f3aaea369df989bb95d6ce8760470121cad414cc3c7597d2ecd25e74145da47a4fe8a544cbb4ff24
-  data.tar.gz: 43e28a1c3b3a96c191cd3665ad930a6ebe4f2ef8bbad39e4bd3796713f25dffe2a7e80d3a2c3c2b50814f79ecd4c91b6553b7c797cf7e4f9f71c6772263e6c7d
+  metadata.gz: b0dbd124ffe15d87bf11c464bd8b4f5b1641aedfdf6f5581f4ae71f27a3d8f14dd8da43f85ca8a5568904bf36858c35e166e57c02fc5709d6c008cdb37cb773e
+  data.tar.gz: e1c6cd8cf9d832bf1733bd682a65ef0e9a0967a102786334ec9832edef104c297c76eea086a1146a5c9f6d83941cfe2803dee5d29ba47e70f313b289d8ec650f

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release History: opentelemetry-instrumentation-action_view
 
+### v0.2.0 / 2021-12-01
+
+* ADDED: Move activesupport notification subsciber out of action_view gem 
+* FIXED: Instrumentation of Rails 7 
+
+### v0.1.3 / 2021-10-06
+
+* FIXED: Do not replace fanout 
+
+### v0.1.2 / 2021-09-29
+
+* (No significant changes)
+
+### v0.1.1 / 2021-09-09
+
+* FIXED: Keep Active Support subscriptions intact when patching 
+
 ### v0.1.0 / 2021-08-12
 
 * Initial release.

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,8 +28,6 @@ module OpenTelemetry
         private
 
         def require_dependencies
-          require_relative 'fanout'
-          require_relative 'span_subscriber'
           require_relative 'railtie'
         end
       end

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

@@ -15,17 +15,12 @@ module OpenTelemetry
 
       # This Railtie sets up subscriptions to relevant ActionView notifications
       class Railtie < ::Rails::Railtie
-        config.before_initialize do
-          ::ActiveSupport::Notifications.notifier = Fanout.new
-        end
-
         config.after_initialize do
+          ::OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation.instance.install({})
+
           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)
+            config = ActionView::Instrumentation.instance.config
+            ::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(ActionView::Instrumentation.instance.tracer, subscription_name, config[:notification_payload_transform], config[:disallowed_notification_payload_keys])
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionView
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
     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.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +98,16 @@ dependencies:
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -206,19 +220,17 @@ 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
 - lib/opentelemetry/instrumentation/action_view/version.rb
 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.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.2.0/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.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths:

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-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 < ::ActiveSupport::Notifications::Fanout
-        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

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module ActionView
-      # The SpanSubscriber is a special ActiveSupport::Notification subscription
-      # handler which turns notifications into generic spans, taking care to handle
-      # context appropriately.
-      class SpanSubscriber
-        ALWAYS_VALID_PAYLOAD_TYPES = [TrueClass, FalseClass, String, Numeric, Symbol].freeze
-
-        def initialize(name:, tracer:)
-          @span_name = name.split('.')[0..1].reverse.join(' ').freeze
-          @tracer = tracer
-        end
-
-        def start(_name, _id, payload)
-          span = @tracer.start_span(@span_name, kind: :internal)
-          token = OpenTelemetry::Context.attach(
-            OpenTelemetry::Trace.context_with_span(span)
-          )
-
-          [span, token]
-        end
-
-        def finish(_name, _id, payload) # rubocop:disable Metrics/AbcSize
-          span = payload.delete(:__opentelemetry_span)
-          token = payload.delete(:__opentelemetry_ctx_token)
-          return unless span && token
-
-          payload = transform_payload(payload)
-          attrs = payload.map do |k, v|
-            [k.to_s, sanitized_value(v)] if valid_payload_key?(k) && valid_payload_value?(v)
-          end
-          span.add_attributes(attrs.compact.to_h)
-
-          if (e = payload[:exception_object])
-            span.record_exception(e)
-            span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}")
-          end
-
-          span.finish
-          OpenTelemetry::Context.detach(token)
-        end
-
-        private
-
-        def instrumentation_config
-          ActionView::Instrumentation.instance.config
-        end
-
-        def transform_payload(payload)
-          return payload if instrumentation_config[:notification_payload_transform].nil?
-
-          instrumentation_config[:notification_payload_transform].call(payload)
-        end
-
-        def valid_payload_key?(key)
-          %i[exception exception_object].none?(key) && instrumentation_config[:disallowed_notification_payload_keys].none?(key)
-        end
-
-        def valid_payload_value?(value)
-          if value.is_a?(Array)
-            return true if value.empty?
-
-            value.map(&:class).uniq.size == 1 && ALWAYS_VALID_PAYLOAD_TYPES.any? { |t| value.first.is_a?(t) }
-          else
-            ALWAYS_VALID_PAYLOAD_TYPES.any? { |t| value.is_a?(t) }
-          end
-        end
-
-        # We'll accept symbols as values, but stringify them; and we'll stringify symbols within an array.
-        def sanitized_value(value)
-          if value.is_a?(Array)
-            value.map { |v| v.is_a?(Symbol) ? v.to_s : v }
-          elsif value.is_a?(Symbol)
-            value.to_s
-          else
-            value
-          end
-        end
-      end
-    end
-  end
-end