opentelemetry-instrumentation-action_pack 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01fdccf711bd55c9f8e6df0d15bc871698058ba9500523696dbb22d2f3a28a4a
-  data.tar.gz: 55ecb33d2d56eec21b2cedee82df3189cb1c056a44464c34a2feadba6c327c76
+  metadata.gz: e06ad2752b2424da0f9118ec0cf639d7a71f8eeb125dc09c7b6382a71fa1adee
+  data.tar.gz: 4df567444bc1fff28bcc26f28229aa5023d2eacaf240f3ee1bbb9869b96bd8f3
 SHA512:
-  metadata.gz: d403b045b944b7062988e5e4a3a2e0a6c17d4a1e50409e1a920d36c27bcb19cd95b9de3aa8422dbcaa5b05443919165611478283ee2cc2477d0faf5a69d5f151
-  data.tar.gz: 2bc7459a91c2331288aebb7076c0f3e834aa966d7e8f751b79c14efcbc23eb5386147a4ce1acb65de750b6587f030a2cc4960f68e3296193773e92f0b13a4bd1
+  metadata.gz: a3524725aa834c10dea18cdde35cc860e4d5b5b3fe5c4f2e4b3e7235af15f9c6d53111a3b59699631c4f76eb67c323ff6d0c8a3a37645ca885ee14f52d686b8e
+  data.tar.gz: 516886964fa80632bc3b237ada0b85ff60d4b9193d685414aa7dc069ced6f04acd42f06b2586a00db5cbb57645902c7309af38f786932b8a88a7d77c335c167c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-action_pack
 
+### v0.9.0 / 2024-01-09
+
+* BREAKING CHANGE: Use ActiveSupport instead of patches #703 
+
 ### v0.8.0 / 2023-11-22
 
 * BREAKING CHANGE: Drop Rails 6.0 EOL

data/README.md

@@ -30,6 +30,25 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
+## Active Support Instrumentation
+
+Earlier versions of this instrumentation relied on patching custom `dispatch` hooks from Rails's [Action Controller](https://github.com/rails/rails/blob/main/actionpack/lib/action_controller/metal.rb#L224) to extract request information.
+
+This instrumentation now relies on `ActiveSupport::Notifications` and registers a custom Subscriber that listens to relevant events to modify the Rack span.
+
+See the table below for details of what [Rails Framework Hook Events](https://guides.rubyonrails.org/active_support_instrumentation.html#action-controller) are recorded by this instrumentation:
+
+| Event Name | Subscribe? | Creates Span? |  Notes |
+| - | - | - | - |
+| `process_action.action_controller` | :white_check_mark: | :x: | It modifies the existing Rack span |
+
+
+### Error Handling for Action Controller
+
+If an error is triggered by Action Controller (such as a 500 internal server error), Action Pack will typically employ the default `ActionDispatch::PublicExceptions.new(Rails.public_path)` as the `exceptions_app`, as detailed in the [documentation](https://guides.rubyonrails.org/configuring.html#config-exceptions-app).
+
+The error object will be retained within `payload[:exception_object]`. Additionally, its storage in `request.env['action_dispatch.exception']` is contingent upon the configuration of `action_dispatch.show_exceptions` in Rails.
+
 ## Examples
 
 Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_pack/example/trace_demonstration.ru)

data/lib/opentelemetry/instrumentation/action_pack/handlers/action_controller.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module ActionPack
+      module Handlers
+        # Action Controller handler to handle the notification from Active Support
+        class ActionController
+          # @param config [Hash] of instrumentation options
+          def initialize(config)
+            @config = config
+          end
+
+          # Invoked by ActiveSupport::Notifications at the start of the instrumentation block
+          #
+          # @param _name [String] of the event (unused)
+          # @param _id [String] of the event (unused)
+          # @param payload [Hash] the payload passed as a method argument
+          # @return [Hash] the payload passed as a method argument
+          def start(_name, _id, payload)
+            rack_span = OpenTelemetry::Instrumentation::Rack.current_span
+
+            request = payload[:request]
+
+            rack_span.name = "#{payload[:controller]}##{payload[:action]}" unless request.env['action_dispatch.exception']
+
+            attributes_to_append = {
+              OpenTelemetry::SemanticConventions::Trace::CODE_NAMESPACE => String(payload[:controller]),
+              OpenTelemetry::SemanticConventions::Trace::CODE_FUNCTION => String(payload[:action])
+            }
+
+            attributes_to_append[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] = request.filtered_path if request.filtered_path != request.fullpath
+
+            rack_span.add_attributes(attributes_to_append)
+          rescue StandardError => e
+            OpenTelemetry.handle_error(exception: e)
+          end
+
+          # Invoked by ActiveSupport::Notifications at the end of the instrumentation block
+          #
+          # @param _name [String] of the event (unused)
+          # @param _id [String] of the event (unused)
+          # @param payload [Hash] the payload passed as a method argument
+          # @return [Hash] the payload passed as a method argument
+          def finish(_name, _id, payload)
+            rack_span = OpenTelemetry::Instrumentation::Rack.current_span
+            rack_span.record_exception(payload[:exception_object]) if payload[:exception_object]
+          rescue StandardError => e
+            OpenTelemetry.handle_error(exception: e)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/action_pack/handlers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'handlers/action_controller'
+
+module OpenTelemetry
+  module Instrumentation
+    module ActionPack
+      # Module that contains custom event handlers, which are used to generate spans per event
+      module Handlers
+        module_function
+
+        def subscribe
+          return unless Array(@subscriptions).empty?
+
+          config = ActionPack::Instrumentation.instance.config
+          handlers_by_pattern = {
+            'process_action.action_controller' => Handlers::ActionController.new(config)
+          }
+
+          @subscriptions = handlers_by_pattern.map do |key, handler|
+            ::ActiveSupport::Notifications.subscribe(key, handler)
+          end
+        end
+
+        # Removes Event Handler Subscriptions for Action Controller notifications
+        # @note this method is not thread-safe and should not be used in a multi-threaded context
+        def unsubscribe
+          @subscriptions&.each { |subscriber| ::ActiveSupport::Notifications.unsubscribe(subscriber) }
+          @subscriptions = nil
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/action_pack/instrumentation.rb

@@ -32,11 +32,11 @@ module OpenTelemetry
         end
 
         def patch
-          ::ActionController::Metal.prepend(Patches::ActionController::Metal)
+          Handlers.subscribe
         end
 
         def require_dependencies
-          require_relative 'patches/action_controller/metal'
+          require_relative 'handlers'
         end
 
         def require_railtie

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionPack
-      VERSION = '0.8.0'
+      VERSION = '0.9.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-action_pack
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -156,14 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.59.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.56.1
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -220,18 +234,19 @@ files:
 - lib/opentelemetry-instrumentation-action_pack.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/action_pack.rb
+- lib/opentelemetry/instrumentation/action_pack/handlers.rb
+- lib/opentelemetry/instrumentation/action_pack/handlers/action_controller.rb
 - lib/opentelemetry/instrumentation/action_pack/instrumentation.rb
-- lib/opentelemetry/instrumentation/action_pack/patches/action_controller/metal.rb
 - lib/opentelemetry/instrumentation/action_pack/railtie.rb
 - lib/opentelemetry/instrumentation/action_pack/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_pack/0.8.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_pack/0.9.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/action_pack
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_pack/0.8.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_pack/0.9.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/instrumentation/action_pack/patches/action_controller/metal.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module ActionPack
-      module Patches
-        module ActionController
-          # Module to prepend to ActionController::Metal for instrumentation
-          module Metal
-            def dispatch(name, request, response)
-              rack_span = OpenTelemetry::Instrumentation::Rack.current_span
-              if rack_span.recording?
-                rack_span.name = "#{self.class.name}##{name}" unless request.env['action_dispatch.exception']
-
-                attributes_to_append = {
-                  OpenTelemetry::SemanticConventions::Trace::CODE_NAMESPACE => self.class.name,
-                  OpenTelemetry::SemanticConventions::Trace::CODE_FUNCTION => String(name)
-                }
-                attributes_to_append[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] = request.filtered_path if request.filtered_path != request.fullpath
-                rack_span.add_attributes(attributes_to_append)
-              end
-
-              super(name, request, response)
-            end
-
-            private
-
-            def instrumentation_config
-              ActionPack::Instrumentation.instance.config
-            end
-          end
-        end
-      end
-    end
-  end
-end