opentelemetry-instrumentation-rails 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a83b6b54690f4740106e4fbb6a1d6eeb0f6e392adeaae14360e1f4b1ca260a6
-  data.tar.gz: 8c0782fce816758e3ac2bdf162b11f61f9b31fe44992622e4333fee0d136c49e
+  metadata.gz: 689a1c682f6de7f70663955bdc99a1de4f758ff9d54cc14f9d18d1b5c3896b54
+  data.tar.gz: 43387df2aea22327d040971a3c500db575fcf100114835e8f2707f89e5289230
 SHA512:
-  metadata.gz: e2df0ba03c759f251b870d9365928ce24584095eb0f9d467a8fa11f8227e38bcfbfc0b242c82af23af00b73227f69ac237d047615df0b1f2b92689a058d624e2
-  data.tar.gz: 850eb20a873d9c9df90dbfab9775e45a710836ea58c6cf8525bbe3cb6b0456f47e1ed87c334142d0681ecc7b69e6331a73b544ef41eb92900ca072f615beffee
+  metadata.gz: 9491e565317e410bfbb0c1dbab9b2b95a0320b68d5018b7aaf4d852f8dcf90a8a3e07e60c36d9fb83378673f14701e644b74456a7b4a0a866335eb1d7424cfd4
+  data.tar.gz: eba631a571aea18efa7aab46a4f39e06466be945ea3e28040fa0961f14265ab4aa80772b49a6cce75d38ec1414b83ede2d70b893fd4d9f545415bcb9b3edce1c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-instrumentation-rails
 
+### v0.17.0 / 2021-04-22
+
+* ADDED: Added http.route in rails instrumentation to match the spec 
+* FIXED: Rails example by not using `rails` from git 
+* FIXED: Updated rack middleware position to zero 
+
 ### v0.16.0 / 2021-03-17
 
 * FIXED: Example scripts now reference local common lib 

data/README.md

@@ -30,6 +30,18 @@ OpenTelemetry::SDK.configure do |c|
 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)
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Rails', {
+    enable_recognize_route: true
+  }
+end
+```
+
 ## Examples
 
 Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/rails/example/trace_request_demonstration.ru)

data/lib/opentelemetry/instrumentation/rails.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation

data/lib/opentelemetry/instrumentation/rails/instrumentation.rb

@@ -22,6 +22,8 @@ module OpenTelemetry
           defined?(::Rails)
         end
 
+        option :enable_recognize_route, default: false, validate: :boolean
+
         private
 
         def require_dependencies

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

@@ -14,8 +14,22 @@ module OpenTelemetry
             def dispatch(name, request, response)
               rack_span = OpenTelemetry::Instrumentation::Rack.current_span
               rack_span.name = "#{self.class.name}##{name}" if rack_span.context.valid? && !request.env['action_dispatch.exception']
+
+              add_rails_route(rack_span, request) if instrumentation_config[:enable_recognize_route]
               super(name, request, response)
             end
+
+            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)
+              end
+            end
+
+            def instrumentation_config
+              Rails::Instrumentation.instance.config
+            end
           end
         end
       end

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

@@ -15,7 +15,7 @@ module OpenTelemetry
           OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({})
 
           app.middleware.insert_after(
-            ActionDispatch::RequestId,
+            0,
             OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware
           )
         end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rails
-      VERSION = '0.16.0'
+      VERSION = '0.17.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rails
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Rails instrumentation for the OpenTelemetry framework