opentelemetry-instrumentation-rails 0.12.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f171f3fd0e28ec5717ccd5360426c80acca215ce31399c2a93765aa36399249
-  data.tar.gz: 7b846c7029587b3516f66d62cdd8fce92f45e0ffb9cb3efac7978953c35f5084
+  metadata.gz: 689a1c682f6de7f70663955bdc99a1de4f758ff9d54cc14f9d18d1b5c3896b54
+  data.tar.gz: 43387df2aea22327d040971a3c500db575fcf100114835e8f2707f89e5289230
 SHA512:
-  metadata.gz: 7bff4494bd9a5b7adc6e35b25ee99e701a3462cc7069f18a0f7beebee25be1f73d861732910713eb7585c02c64d38210a947330f655b38b95ea72c8a0b6c7775
-  data.tar.gz: 2cde9e70d25f2cf2e43a7baedc05297eb395d18f518409f04d51960e1f3568d98f7d37e85b7897820fb0507ec58eae693319edeb1d661f4d2c231ca841818ea4
+  metadata.gz: 9491e565317e410bfbb0c1dbab9b2b95a0320b68d5018b7aaf4d852f8dcf90a8a3e07e60c36d9fb83378673f14701e644b74456a7b4a0a866335eb1d7424cfd4
+  data.tar.gz: eba631a571aea18efa7aab46a4f39e06466be945ea3e28040fa0961f14265ab4aa80772b49a6cce75d38ec1414b83ede2d70b893fd4d9f545415bcb9b3edce1c

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # 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 
+* DOCS: Replace Gitter with GitHub Discussions 
+
+### v0.15.0 / 2021-02-18
+
+* (No significant changes)
+
+### v0.14.0 / 2021-02-03
+
+* (No significant changes)
+
+### v0.13.0 / 2021-01-29
+
+* (No significant changes)
+
 ### v0.12.0 / 2020-12-24
 
 * (No significant changes)

data/README.md

@@ -30,15 +30,27 @@ 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/master/instrumentation/rails/example/trace_request_demonstration.ru)
+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)
 
 ## How can I get involved?
 
 The `opentelemetry-instrumentation-rails` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -47,7 +59,7 @@ The `opentelemetry-instrumentation-rails` gem is distributed under the Apache 2.
 [rails-home]: https://github.com/rails/rails
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

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.12.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.12.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-24 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.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.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.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -227,7 +241,8 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -243,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