opentelemetry-instrumentation-rails 0.13.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfbd1df327dfb01a1e969dc1282231650d00d3eb00313834c7c49b5c3381ea3
-  data.tar.gz: 83b8a23d8fd0bb426a533cc2ea8c3928e96b4bab27033fcdead5fb132ca219aa
+  metadata.gz: ce9c51efe3309c265a51f9779f89fafbfcb7ee7c89e8491892736f80aa8c473d
+  data.tar.gz: cee3ae8c0b9165a3c40532b1114dde2d6f33a3a2527fad94ac28cd0bb17c5544
 SHA512:
-  metadata.gz: c678fe7128282df1aa601be0dbd43bf293a7a2ed78c057e98c957772885dbb83de42aa4f2baae4e093e3abf000613a75eafa7e6a5bed9744c2bad7f71e6a92ac
-  data.tar.gz: 6626077ce2cf87a2e9acae3df98ea0dce99e730007729f3e7002f6cbbc022cf0a96966c8f928ec7b092fe2a50063f9a16d4d0e2ca676d50c7b19118b5bff48d2
+  metadata.gz: 24a1491adf9c2aaf800a89a3141fc331b142d8db8ba04f5ad0ba01707b7a155d65a20495c698baae766ce06c5acf908ac6c585e368931351f78adc3603b2a2db
+  data.tar.gz: cb6b640fcdba28eca82caa3b3cd2232c93dbd43e00b5cf3cdbdefd8d7bba9e98819e692f7a1ee6d8878f0d27a0b96cec483638e8df1c397b1baff6bca31cd17a

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History: opentelemetry-instrumentation-rails
 
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+
+### 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)
@@ -10,12 +33,12 @@
 
 ### v0.11.0 / 2020-12-11
 
-* FIXED: Rails tests 
-* FIXED: Copyright comments to not reference year 
+* FIXED: Rails tests
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.0 / 2020-12-03
 
-* FIXED: Otel-instrumentation-all not installing all 
+* FIXED: Otel-instrumentation-all not installing all
 
 ### v0.9.0 / 2020-11-27
 

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)
@@ -38,7 +50,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here](
 
 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
 
@@ -50,4 +62,4 @@ The `opentelemetry-instrumentation-rails` gem is distributed under the Apache 2.
 [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.13.0'
+      VERSION = '0.18.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rails
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.18.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-05-21 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.13.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rack-test
   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