opentelemetry-instrumentation-action_pack 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2fe93205bd6919c07ee1c8bcffcc4da51ef45c44ae35e43e5d9706d8bc5ec69
-  data.tar.gz: 434bb0a50a54867c3d125736763678660ed36155b208c2daba71866d36f12cbb
+  metadata.gz: 99be35d64f5fd7d823eb70e181f5632085271225dfa5bbc10adb997f287581a8
+  data.tar.gz: b4df430eb2003fa5e5863ae9203bf77d4c8f34234579c7fbd11267d51f4e8b01
 SHA512:
-  metadata.gz: 61254f1ee327721f3acd8da527f9f3d43f844c68fcb818a864f2f1df71d66201059f5248f2c1b70c8a3895fb1877be2de6d7466bfb31fb50422963cda21b3185
-  data.tar.gz: bdfb5be311c901208a38228673db73c1500b7f687705e3bee6e6db6fffa09c34742211af6883cae375a793a6e2e6d30d52b5f560b6ad268c93662eb4a4cafed2
+  metadata.gz: d13b693131f8b6e64fead4308d30c67ad5b2a13320083a68abfba66c2d9cb235ac9e411eb9678df14616e4706e6920b6c55fcb706c7aae6487da66a55ab509a8
+  data.tar.gz: 8f6f5faf8b5466e2e745461636bdfb800f1adb134d9174790d94e2ef1ec8d832bf500c4699782de0e869de3be98d50b5f4fd0a1af485e128ae04d0b645b52ce5

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History: opentelemetry-instrumentation-action_pack
 
+### v0.3.2 / 2022-11-16
+
+* * FIXED: Loosen dependency on Rack
+
+### v0.3.1 / 2022-10-27
+
+* FIXED: Declare span_naming option in action_pack instrumentation
+
+### v0.3.0 / 2022-10-14
+
+* ADDED: Name ActionPack spans with the HTTP method and route 
+
 ### v0.2.1 / 2022-10-04
 
 * FIXED: Ensures the correct route is add to http.route span attribute 

data/README.md

@@ -32,11 +32,18 @@ end
 
 ### Configuration options
 
-The `http.route` attribute is disabled by default because we use [.recognize](https://github.com/rails/rails/blob/v6.1.3/actionpack/lib/action_dispatch/journey/router.rb#L65)
+| Name  | Default | Description |
+| ----- | ------- | ----------- |
+| `span_naming`  | `:rails_route`  | Configures the name for the Rack span. `:rails_route` is in the format of `HTTP_METHOD /rails/route(.:format)`, for example `GET /users/:id(.:format)`. `:controller_action` is in the format of `Controller#action`, for example `UsersController#show` |
+| `enable_recognize_route`  | `true`  | Enables or disables adding the `http.route` attribute. |
+
+The default configuration uses a [method from Rails to obtain the route for the request](https://github.com/rails/rails/blob/v6.1.3/actionpack/lib/action_dispatch/journey/router.rb#L65). The options above allow this behaviour to be opted out of if you have performance issues. If you wish to avoid using this method then set `span_naming: :controller_action, enable_recognize_route: false`.
+
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::ActionPack', {
-    enable_recognize_route: true
+    span_naming: :controller_action,
+    enable_recognize_route: false
   }
 end
 ```

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

@@ -25,7 +25,8 @@ module OpenTelemetry
           gem_version >= MINIMUM_VERSION
         end
 
-        option :enable_recognize_route, default: false, validate: :boolean
+        option :enable_recognize_route, default: true, validate: :boolean
+        option :span_naming, default: :rails_route, validate: %i[controller_action rails_route]
 
         private
 

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

@@ -14,11 +14,20 @@ module OpenTelemetry
             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']
-
-                add_rails_route(rack_span, request) if instrumentation_config[:enable_recognize_route]
-
-                rack_span.set_attribute('http.target', request.filtered_path) if request.filtered_path != request.fullpath
+                unless request.env['action_dispatch.exception']
+                  rack_span.name = case instrumentation_config[:span_naming]
+                                   when :controller_action then "#{self.class.name}##{name}"
+                                   else "#{request.method} #{rails_route(request)}"
+                                   end
+                end
+
+                attributes_to_append = {
+                  OpenTelemetry::SemanticConventions::Trace::CODE_NAMESPACE => self.class.name,
+                  OpenTelemetry::SemanticConventions::Trace::CODE_FUNCTION => name
+                }
+                attributes_to_append[OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE] = rails_route(request) if instrumentation_config[:enable_recognize_route]
+                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)
@@ -26,11 +35,10 @@ module OpenTelemetry
 
             private
 
-            def add_rails_route(rack_span, request)
-              ::Rails.application.routes.router.recognize(request) do |route, _params|
-                rack_span.set_attribute('http.route', route.path.spec.to_s)
+            def rails_route(request)
+              @rails_route ||= ::Rails.application.routes.router.recognize(request) do |route, _params|
+                return route.path.spec.to_s
                 # Rails will match on the first route - see https://guides.rubyonrails.org/routing.html#crud-verbs-and-actions
-                break
               end
             end
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActionPack
-      VERSION = '0.2.1'
+      VERSION = '0.3.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-action_pack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -242,10 +242,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-action_pack/v0.2.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-action_pack/v0.3.2/file.CHANGELOG.html
   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://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-action_pack/v0.2.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-action_pack/v0.3.2
 post_install_message: 
 rdoc_options: []
 require_paths: