opentelemetry-instrumentation-rails 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34571f27de616ba58694c8237c0aa261d2fb4bd0fffdc233a2c6aadb57a9db6
-  data.tar.gz: eb6d54e06b7e8b4e25d863ce342130de2c41c41ebdf23c287c8dda0b9d286462
+  metadata.gz: 83e599f0c6dd74b03a1ba2351634df27b41830de3d5c7a98d7978e937736cf04
+  data.tar.gz: b4f033ba3bf54a043dc592c95377678c630b08bd5b1a62598fc3e04f41139fdd
 SHA512:
-  metadata.gz: d9a6b78d0b3aba5bc89f0b4c7a5cc6f4af50509958d65f789356fe5823688682cea61e8167b317e82f9c25427d5b80f4cffba7032784d7c5213d3a107153d53d
-  data.tar.gz: 1948237271395861da709a3ec93f0cccc6ddfce8ccf3bea1f3065ee48df1ead58f1dfcb657d23c834bd854dcf5ced63ff66adf8501fba8c9d86fe6ae9513a512
+  metadata.gz: 327efc6f764d24ab8d239e494344b4c85d7e1376fafa378a90e8171ccb104e821a4b0400c5a13de542e25a858357829dfad9a812e1965e2ba8c5b6f1ebfbb020
+  data.tar.gz: b9d58fb62cc0adb707dd3477af5dba12051dab2bc83cf43deeb1eee5ff29f8037fd1e963873a4d6a142c12ce5f45a06a465c6f7dbd86eeb9465500f633294a67

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-instrumentation-rails
 
+### v0.19.0 / 2021-08-12
+
+* ADDED: Instrument active record
+* ADDED: Add ActionView instrumentation via ActiveSupport::Notifications
+* FIXED: Rails instrumentation to not explicitly install sub gems
+* DOCS: Update docs to rely more on environment variable configuration
+
+* This release adds support for Active Record and Action View.
+* The `enable_recognize_route` configuration option has been moved to the ActionPack gem.
+* See readme for details on how to configure the sub instrumentation gems.
+
 ### v0.18.1 / 2021-06-23
 
 * FIXED: Updated rack middleware position to zero 

data/README.md

@@ -14,15 +14,7 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-r
 
 ## Usage
 
-To use the instrumentation, call `use` with the name of the instrumentation:
-
-```ruby
-OpenTelemetry::SDK.configure do |c|
-  c.use 'OpenTelemetry::Instrumentation::Rails'
-end
-```
-
-Alternatively, you can also call `use_all` to install all the available instrumentation.
+To use the Rails instrumentation, call `use_all` so it installs all the instrumentation gems.
 
 ```ruby
 OpenTelemetry::SDK.configure do |c|
@@ -30,15 +22,14 @@ 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)
+The Rails instrumentation attempts to mirror the structure of the Ruby on Rails.  It is a collection of instrumentation gems for components of Rails such as Action View, Active Record, Action Pack, etc...
+
+You may want to include all of the Rails instrumentation but disable a single instrumentation gem that it includes.  Here is an example of how you can disable Active Record when using this instrumentation gem.
 ```ruby
 OpenTelemetry::SDK.configure do |c|
-  c.use 'OpenTelemetry::Instrumentation::Rails', {
-    enable_recognize_route: true
-  }
+  c.use_all({ 'OpenTelemetry::Instrumentation::ActiveRecord' => { enabled: false } })
 end
 ```
 

data/lib/opentelemetry/instrumentation/rails.rb

@@ -15,6 +15,8 @@ module OpenTelemetry
   end
 end
 
-require 'opentelemetry-instrumentation-rack'
+require 'opentelemetry-instrumentation-action_pack'
+require 'opentelemetry-instrumentation-action_view'
+require 'opentelemetry-instrumentation-active_record'
 require_relative './rails/instrumentation'
 require_relative './rails/version'

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

@@ -12,30 +12,19 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the Rails
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        install do |_config|
-          require_dependencies
-          require_railtie
-          patch_metal
-        end
-
-        present do
-          defined?(::Rails)
-        end
+        MINIMUM_VERSION = Gem::Version.new('5.2.0')
 
-        option :enable_recognize_route, default: false, validate: :boolean
+        # This gem requires the instrumentantion gems for the different
+        # components of Rails, as a result it does not have any explicit
+        # work to do in the install step.
+        install { true }
+        present { defined?(::Rails) }
+        compatible { gem_version >= MINIMUM_VERSION }
 
         private
 
-        def require_dependencies
-          require_relative 'patches/action_controller/metal'
-        end
-
-        def require_railtie
-          require_relative 'railtie'
-        end
-
-        def patch_metal
-          ::ActionController::Metal.prepend(Patches::ActionController::Metal)
+        def gem_version
+          Gem.loaded_specs['actionpack'].version
         end
       end
     end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rails
-      VERSION = '0.18.1'
+      VERSION = '0.19.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rails
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,42 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-instrumentation-base
+  name: opentelemetry-instrumentation-action_pack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-action_view
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-instrumentation-rack
+  name: opentelemetry-instrumentation-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -235,8 +263,6 @@ files:
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/rails.rb
 - lib/opentelemetry/instrumentation/rails/instrumentation.rb
-- lib/opentelemetry/instrumentation/rails/patches/action_controller/metal.rb
-- lib/opentelemetry/instrumentation/rails/railtie.rb
 - lib/opentelemetry/instrumentation/rails/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module Rails
-      module Patches
-        module ActionController
-          # Module to prepend to ActionController::Metal for instrumentation
-          module Metal
-            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
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module Rails
-      # The Instrumentation class contains logic to detect and install the Rails
-      # instrumentation, while this Railtie is used to conventionally instrument
-      # the Rails application through its initialization hooks
-      class Railtie < ::Rails::Railtie
-        config.before_initialize do |app|
-          OpenTelemetry::Instrumentation::Rack::Instrumentation.instance.install({})
-
-          app.middleware.insert_before(
-            0,
-            OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware
-          )
-        end
-      end
-    end
-  end
-end