opentelemetry-instrumentation-active_record 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1131d4989281075576fd33667b2dfe783c5da679192b254f0ac8bd11490075
-  data.tar.gz: 719137b4fb014c01449240d61bb12ee0e76671e43bf6fd0b5259461904c28154
+  metadata.gz: a1ddaea29d71120e402d121369f632b92fc9a48dfb33c5d60bdc38e3becadeec
+  data.tar.gz: 5bb2301384011e58bab8c96b96bbacb3c61f6f34c35a7222031d784858bda89e
 SHA512:
-  metadata.gz: 4ee27b5a907c5b08dcf34c96ef61fed9b13a3ebe7f38c9d0a4999d9945f91a77079aca4e9e6fc8b04ce349a8bbf311d16eb9d20288613eaebcc59c270fbc7eb8
-  data.tar.gz: a7b2dcce676d412fe490d3177bd36c2c2bb9786f5f8791a1042ccbabff6dd5e2a083087679e2f455731094f58755f78861fb40c1b92dafeb837ec229904aa73b
+  metadata.gz: 62c14304ace8d9730b7c12fc67a8a7aa99c052172ea71d8cd4499e39f0a37ee6e87678804f55453d734798c6ad2032a6b0c32c211e091f2050d6c03970da1595
+  data.tar.gz: 8f119bd04db09a6477487c14945ecb8c201dcab6a487b39f6344b734c9068a3741cac1bd6034ba249dfcae81e9a94c0fffaa58e1024484ecb57802ca25c53ee6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-active_record
 
+### v0.7.3 / 2024-08-15
+
+* FIXED: Use Active Support Lazy Load Hooks to avoid prematurely initializing ActiveRecord::Base and ActiveJob::Base
+
 ### v0.7.2 / 2024-04-30
 
 * FIXED: Resolve active_record testing issue

data/README.md

@@ -6,7 +6,7 @@ The Active Record instrumentation is a community-maintained instrumentation for
 
 Install the gem using:
 
-```
+```console
 gem install opentelemetry-instrumentation-active_record
 ```
 
@@ -38,7 +38,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here](
 
 The `opentelemetry-instrumentation-active_record` 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 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].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] 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
 
@@ -49,4 +49,6 @@ The `opentelemetry-instrumentation-active_record` gem is distributed under the A
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+[rails-home]: https://rubyonrails.org/

data/lib/opentelemetry/instrumentation/active_record/instrumentation.rb

@@ -13,7 +13,7 @@ module OpenTelemetry
 
         install do |_config|
           require_dependencies
-          patch
+          patch_activerecord
         end
 
         present do
@@ -30,27 +30,8 @@ module OpenTelemetry
           ::ActiveRecord.version
         end
 
-        def patch
-          # The original approach taken here was to patch each individual module of interest.
-          # However the patches are applied too late in some applications and as a result the
-          # Active Record models will not have the instrumentation patches applied.
-          # Prepending the ActiveRecord::Base class is more consistent in applying
-          # the patches regardless of initialization order.
-          #
-          # Modules to prepend to ActiveRecord::Base are still grouped by the source
-          # module that they are defined in.
-          # Example: Patches::PersistenceClassMethods refers to https://github.com/rails/rails/blob/v6.1.0/activerecord/lib/active_record/persistence.rb#L10
-          ::ActiveRecord::Base.prepend(Patches::Querying)
-          ::ActiveRecord::Base.prepend(Patches::Persistence)
-          ::ActiveRecord::Base.prepend(Patches::PersistenceClassMethods)
-          ::ActiveRecord::Base.prepend(Patches::PersistenceInsertClassMethods)
-          ::ActiveRecord::Base.prepend(Patches::TransactionsClassMethods)
-          ::ActiveRecord::Base.prepend(Patches::Validations)
-
-          ::ActiveRecord::Relation.prepend(Patches::RelationPersistence)
-        end
-
         def require_dependencies
+          require 'active_support/lazy_load_hooks'
           require_relative 'patches/querying'
           require_relative 'patches/persistence'
           require_relative 'patches/persistence_class_methods'
@@ -59,6 +40,23 @@ module OpenTelemetry
           require_relative 'patches/validations'
           require_relative 'patches/relation_persistence'
         end
+
+        def patch_activerecord
+          ActiveSupport.on_load(:active_record) do
+            # Modules to prepend to ActiveRecord::Base are grouped by the source
+            # module that they are defined in as they are included into ActiveRecord::Base
+            # Example: Patches::PersistenceClassMethods refers to https://github.com/rails/rails/blob/v6.1.0/activerecord/lib/active_record/persistence.rb#L10
+            #   which is included into ActiveRecord::Base in https://github.com/rails/rails/blob/914caca2d31bd753f47f9168f2a375921d9e91cc/activerecord/lib/active_record/base.rb#L283
+            ::ActiveRecord::Base.prepend(Patches::Querying)
+            ::ActiveRecord::Base.prepend(Patches::Persistence)
+            ::ActiveRecord::Base.prepend(Patches::PersistenceClassMethods)
+            ::ActiveRecord::Base.prepend(Patches::PersistenceInsertClassMethods)
+            ::ActiveRecord::Base.prepend(Patches::TransactionsClassMethods)
+            ::ActiveRecord::Base.prepend(Patches::Validations)
+
+            ::ActiveRecord::Relation.prepend(Patches::RelationPersistence)
+          end
+        end
       end
     end
   end

data/lib/opentelemetry/instrumentation/active_record/patches/persistence_insert_class_methods.rb

@@ -20,37 +20,37 @@ module OpenTelemetry
           module ClassMethods
             ruby2_keywords def insert(*args)
               tracer.in_span("#{self}.insert") do
-                super(*args)
+                super
               end
             end
 
             ruby2_keywords def insert_all(*args)
               tracer.in_span("#{self}.insert_all") do
-                super(*args)
+                super
               end
             end
 
             ruby2_keywords def insert!(*args)
               tracer.in_span("#{self}.insert!") do
-                super(*args)
+                super
               end
             end
 
             ruby2_keywords def insert_all!(*args)
               tracer.in_span("#{self}.insert_all!") do
-                super(*args)
+                super
               end
             end
 
             ruby2_keywords def upsert(*args)
               tracer.in_span("#{self}.upsert") do
-                super(*args)
+                super
               end
             end
 
             ruby2_keywords def upsert_all(*args)
               tracer.in_span("#{self}.upsert_all") do
-                super(*args)
+                super
               end
             end
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveRecord
-      VERSION = '0.7.2'
+      VERSION = '0.7.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_record
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: 1.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: 1.65.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -233,10 +233,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_record/0.7.2/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_record/0.7.3/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_record
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_record/0.7.2
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_record/0.7.3
 post_install_message: 
 rdoc_options: []
 require_paths: