opentelemetry-instrumentation-action_view 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c7bcecc2f3949e79523c0406503212f2bc54477aaf4dd677314e164a09067c
-  data.tar.gz: 042d4e54e62d8650079a50066e6a9b739524f5fa47f68cf9980e41c0babdaa92
+  metadata.gz: 1d0354ffa37debf3799aa0f4ae55c5e88b258df843379c78cd0bfa48ed42fdd8
+  data.tar.gz: 63428a658d4053054980ac4912f41a0e56d451e2577d4d10e1cc9ba1bd4ec648
 SHA512:
-  metadata.gz: 165bcf906fd27e99c35acbd3421375544a9fc7531eef8939f75713fa6b2f94b557c5d6e929981928cf1fcca71683f9c2120535ce30ff6bab0ea36569a51fd9b5
-  data.tar.gz: f2ee6bfee8771aae53d7301ad9c0eb56df55996fde55a4b5a38b2c9d2d9cf3ea7e06be7621d6dbdbf83f4d802bbc026455b65389cc601e6e8a40310c22432911
+  metadata.gz: 4f5170a008ee10e0af8766dd67b6bcca388ad6529799ab04bdcd542c91bbee4b406434287354084d8f9760dcb3507e68db8f164d54abe106c570364eb3d38209
+  data.tar.gz: 5ff0b8c8a9f0a43419e3cd31162c4aab1ec3bccf17eb03ec017da5206b7fea0e561cd227d30fa2600cc48d7fdb27c5bd7b729e0d3e8641308cb83bf50ebd45db

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History: opentelemetry-instrumentation-action_view
 
+### v0.2.1 / 2022-05-02
+
+* FIXED: RubyGems Fallback 
+
+### 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)

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

@@ -19,7 +19,7 @@ module OpenTelemetry
         end
 
         compatible do
-          Gem.loaded_specs['actionview'].version >= MINIMUM_VERSION
+          gem_version >= MINIMUM_VERSION
         end
 
         option :disallowed_notification_payload_keys, default: [],  validate: :array
@@ -27,9 +27,11 @@ module OpenTelemetry
 
         private
 
+        def gem_version
+          ::ActionView.version
+        end
+
         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(::ActiveSupport::Notifications.notifier)
-        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.2'
+      VERSION = '0.2.1'
     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.2.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   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.2/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-action_view/v0.2.1/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.2.1
 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

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