opentelemetry-instrumentation-active_record 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b0625bdb64f872d8a0c7f4e6437020b1b8810a4db298bcfba37d7ea46c1b605
-  data.tar.gz: e1f2e726af346b7f1b9d86e0699abd4b5f4f38eba29b2d7674cb944369b3ff68
+  metadata.gz: 5f45fc126930cb5135a9ab42d14cf285050c7e9b207c8d584c098848100dfd68
+  data.tar.gz: cb43858ecd8428af9ebc579298047087e1987c7d5d86ffa87027739732a0ef64
 SHA512:
-  metadata.gz: d8e98756506d65c582dd19690a964df0230ac5d29d02c13e879c74593b1da7756885ff11519e281d34571bf8fb8b9629e28fd343b73b772e027d667a7be621b4
-  data.tar.gz: 0c6213df64daffb64c7a0f05714b6359302407877ba1b6e9f764a62de593ca913d3d4106148e93ccd71280925db0969ec12f1b5494b9996c25e30abbdcd7af82
+  metadata.gz: 350d5b0dd98032a79ba02784e5f670d75944a6ee5f715220929c4bb06f176e1a3e8cf2c39493917814a4156b95acb055e333a19120e87dba0b3d8ca35b0a0a7a
+  data.tar.gz: 8e575d88192b7e9399bf194cd0e2b4cc3463e9302dfa1195c218a928ee1149ef47db99d8738e8a993703955bdeea5bab372d66d91c8949448f29da98bd9a42dc

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release History: opentelemetry-instrumentation-active_record
 
+### v0.2.2 / 2021-12-01
+
+* FIXED: Add max supported version for active record 
+
+### v0.2.1 / 2021-09-29
+
+* (No significant changes)
+
+### v0.2.0 / 2021-09-29
+
+* ADDED: Trace update_all and delete_all calls in ActiveRecord 
+* FIXED: Remove Active Record instantiation patch 
+
+### v0.1.1 / 2021-08-12
+
+* (No significant changes)
+
 ### v0.1.0 / 2021-07-08
 
 * Initial release, adds instrumentation patches to querying and persistence methods.

data/README.md

@@ -1,6 +1,6 @@
 # OpenTelemetry ActiveRecord Instrumentation
 
-Todo: Add a description.
+The Active Record instrumentation is a community-maintained instrumentation for the Active Record portion of the [Ruby on Rails][rails-home] web-application framework.
 
 ## How do I get started?
 

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

@@ -10,6 +10,7 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the ActiveRecord instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('5.2.0')
+        MAX_MAJOR_VERSION = 6
 
         install do |_config|
           require_dependencies
@@ -21,7 +22,11 @@ module OpenTelemetry
         end
 
         compatible do
-          gem_version >= MINIMUM_VERSION
+          # We know that releases after MAX_MAJOR_VERSION are unstable so we
+          # check the major version number of the gem installed to make sure we
+          # do not install on a pre-release or full release of the latest
+          # if it exceeds the MAX_MAJOR_VERSION version.
+          gem_version >= MINIMUM_VERSION && gem_version.segments[0] <= MAX_MAJOR_VERSION
         end
 
         private
@@ -50,6 +55,8 @@ module OpenTelemetry
           ::ActiveRecord::Base.prepend(Patches::PersistenceInsertClassMethods) if insert_class_methods_supported?
           ::ActiveRecord::Base.prepend(Patches::TransactionsClassMethods)
           ::ActiveRecord::Base.prepend(Patches::Validations)
+
+          ::ActiveRecord::Relation.prepend(Patches::RelationPersistence)
         end
 
         def require_dependencies
@@ -59,6 +66,7 @@ module OpenTelemetry
           require_relative 'patches/persistence_insert_class_methods' if insert_class_methods_supported?
           require_relative 'patches/transactions_class_methods'
           require_relative 'patches/validations'
+          require_relative 'patches/relation_persistence'
         end
       end
     end

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

@@ -30,12 +30,6 @@ module OpenTelemetry
               end
             end
 
-            def instantiate(attributes, column_types = {}, &block)
-              tracer.in_span("#{self}.instantiate") do
-                super
-              end
-            end
-
             def update(id = :all, attributes) # rubocop:disable Style/OptionalArguments
               tracer.in_span("#{self}.update") do
                 super

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module ActiveRecord
+      module Patches
+        # Module to prepend to ActiveRecord::Relation for instrumentation
+        module RelationPersistence
+          def update_all(*)
+            tracer.in_span("#{model.name}.update_all") do
+              super
+            end
+          end
+
+          def delete_all(*)
+            tracer.in_span("#{model.name}.delete_all") do
+              super
+            end
+          end
+
+          private
+
+          def tracer
+            ActiveRecord::Instrumentation.instance.tracer
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveRecord
-      VERSION = '0.1.0'
+      VERSION = '0.2.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +211,7 @@ files:
 - lib/opentelemetry/instrumentation/active_record/patches/persistence_class_methods.rb
 - lib/opentelemetry/instrumentation/active_record/patches/persistence_insert_class_methods.rb
 - lib/opentelemetry/instrumentation/active_record/patches/querying.rb
+- lib/opentelemetry/instrumentation/active_record/patches/relation_persistence.rb
 - lib/opentelemetry/instrumentation/active_record/patches/transactions_class_methods.rb
 - lib/opentelemetry/instrumentation/active_record/patches/validations.rb
 - lib/opentelemetry/instrumentation/active_record/version.rb
@@ -218,10 +219,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_record/v0.1.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_record/v0.2.2/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/active_record
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_record/v0.1.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_record/v0.2.2
 post_install_message: 
 rdoc_options: []
 require_paths: