opentelemetry-instrumentation-action_pack 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99be35d64f5fd7d823eb70e181f5632085271225dfa5bbc10adb997f287581a8
-  data.tar.gz: b4df430eb2003fa5e5863ae9203bf77d4c8f34234579c7fbd11267d51f4e8b01
+  metadata.gz: 388f9fbed50d78d291eaa2bf05dab31f56186c9590e5da9c16a7d0822ccfabbf
+  data.tar.gz: 0fb1375a95d864a463745be2938b9e13d1b98068b62a6c21b0c7d22b0df6b33f
 SHA512:
-  metadata.gz: d13b693131f8b6e64fead4308d30c67ad5b2a13320083a68abfba66c2d9cb235ac9e411eb9678df14616e4706e6920b6c55fcb706c7aae6487da66a55ab509a8
-  data.tar.gz: 8f6f5faf8b5466e2e745461636bdfb800f1adb134d9174790d94e2ef1ec8d832bf500c4699782de0e869de3be98d50b5f4fd0a1af485e128ae04d0b645b52ce5
+  metadata.gz: 9194a51cf36b8324d9b8d867b55d9f0c37f1ab464cf106e61abfb9c0150ef4e7c6edf2de54b265b124e15db41c34ae0afb131d259140b63a29ed90f35ac288b6
+  data.tar.gz: 2c46ae0869e6ae29f46e1e0c7cec0b14adfbc89e6728d7996d54729965f2872a657b78a6de2a535dd3a0c10b6fe056781127c0889f112d61838999a455ec35ac

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-instrumentation-action_pack
 
+### v0.4.1 / 2023-01-14
+
+* DOCS: Fix gem homepage 
+* DOCS: More gem documentation fixes 
+
+### v0.4.0 / 2022-12-06
+
+* BREAKING CHANGE: Remove enable_recognize_route and span_naming options 
+
+* FIXED: Remove enable_recognize_route and span_naming options 
+
 ### v0.3.2 / 2022-11-16
 
 * * FIXED: Loosen dependency on Rack

data/README.md

@@ -30,24 +30,6 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
-### Configuration options
-
-| 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', {
-    span_naming: :controller_action,
-    enable_recognize_route: false
-  }
-end
-```
-
 ## 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/instrumentation.rb

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

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

@@ -14,18 +14,12 @@ module OpenTelemetry
             def dispatch(name, request, response)
               rack_span = OpenTelemetry::Instrumentation::Rack.current_span
               if rack_span.recording?
-                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
+                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 => name
+                  OpenTelemetry::SemanticConventions::Trace::CODE_FUNCTION => String(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
@@ -35,13 +29,6 @@ module OpenTelemetry
 
             private
 
-            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
-              end
-            end
-
             def instrumentation_config
               ActionPack::Instrumentation.instance.config
             end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-action_pack
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -70,16 +70,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.41.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -238,14 +238,14 @@ files:
 - 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-contrib
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-action_pack/v0.3.2/file.CHANGELOG.html
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_pack/0.4.1/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://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-action_pack/v0.3.2
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-action_pack/0.4.1
 post_install_message: 
 rdoc_options: []
 require_paths: