opentelemetry-instrumentation-active_support 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47686e87960341ed5a9f5f98b578d6c416a64690ec5825fdab6dbbb5efd89ff4
-  data.tar.gz: a4792ec81a86f327fbf4df0787aa4b75717969e449c98d5d81c598ab967e233d
+  metadata.gz: 1852a8b123120f16f182d8c90a618c1fa26199e55bd7cbec455131f43f69b4f6
+  data.tar.gz: 2f6e719ac8a31dc081020cec7dadfc4dc79077bd567d0dc7e67eb4d8ffda0c3c
 SHA512:
-  metadata.gz: 924253c76e30b09ef28941b9dad449f663d5d7331355189d025dae683eef5bfd67cc9b1fd5710e53a66f3e82510274f66a05366f9fb4fb7857b287a19855e0ff
-  data.tar.gz: 6dfaa83d2515adf4a7efd9e753af26ec7c6177a3bbcdf2a6bf6cce60204a160ca2f3c9720811c3dda40d9537e806d20bf7c9e49ce5979e06d15295435c4c65c6
+  metadata.gz: 5bbe103450f24ceb73320c6703a4c560c0140919f0dc4a970b405c758b97fdc7638f84f7a05d348d80423717f6a0864f351a3efd5da4ca7875b0ae775440cbab
+  data.tar.gz: e26a15ede4719613f77efc98c00d4fc1e1dc38948e2dd77262dbbcfa5faea59e5d5cf870f13c5446d93250eaecbbb9a802f00e8ba462cd88c694cb7310964df0

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History: opentelemetry-instrumentation-active_support
 
+### v0.2.2 / 2023-01-14
+
+* FIXED: Drop Rails dependency for ActiveSupport Instrumentation 
+
+### v0.2.1 / 2023-01-14
+
+* DOCS: Fix gem homepage 
+* DOCS: More gem documentation fixes 
+
 ### v0.2.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -36,7 +36,7 @@ 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/active_support/example/trace_demonstration.rb)
+Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_support/example/trace_demonstration.rb)
 
 ## How can I get involved?
 
@@ -51,7 +51,7 @@ The `opentelemetry-instrumentation-active_support` gem is distributed under the
 [rails-home]: https://rubyonrails.org
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[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
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/active_support/span_subscriber.rb

@@ -8,14 +8,17 @@ module OpenTelemetry
   module Instrumentation
     # rubocop:disable Style/Documentation
     module ActiveSupport
+      NOTIFIER_MAJOR_VERSION_6 = 6
+
       # The SpanSubscriber is a special ActiveSupport::Notification subscription
       # handler which turns notifications into generic spans, taking care to handle
       # context appropriately.
 
       # A very hacky way to make sure that OpenTelemetry::Instrumentation::ActiveSupport::SpanSubscriber
       # gets invoked first
-      #
-      def self.subscribe( # rubocop:disable Metrics/AbcSize
+      # Rails 6+ https://github.com/rails/rails/blob/0f0ec9908e25af36df2d937dc431f626a4102b3d/activesupport/lib/active_support/notifications/fanout.rb#L51
+      # Rails 5 https://github.com/rails/rails/blob/8030cff808657faa44828de001cd3b80364597de/activesupport/lib/active_support/notifications/fanout.rb#L16
+      def self.subscribe(
         tracer,
         pattern,
         notification_payload_transform = nil,
@@ -29,18 +32,36 @@ module OpenTelemetry
         )
 
         subscriber_object = ::ActiveSupport::Notifications.subscribe(pattern, subscriber)
+
         ::ActiveSupport::Notifications.notifier.synchronize do
-          if ::Rails::VERSION::MAJOR >= 6
-            s = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern].pop
-            ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern].unshift(s)
+          subscribers = find_subscribers(pattern)
+
+          if subscribers.nil?
+            OpenTelemetry.handle_error(
+              message: 'Unable to move OTEL ActiveSupport Notifications subscriber to the front of the notifications list which may cause incomplete traces.' \
+                       'Please report an issue here: ' \
+                       'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/new?labels=bug&template=bug_report.md&title=ActiveSupport%20Notifications%20subscribers%20list%20is%20nil'
+            )
           else
-            s = ::ActiveSupport::Notifications.notifier.instance_variable_get(:@subscribers).pop
-            ::ActiveSupport::Notifications.notifier.instance_variable_get(:@subscribers).unshift(s)
+            subscribers.unshift(
+              subscribers.delete(subscriber_object)
+            )
           end
         end
         subscriber_object
       end
 
+      def self.find_subscribers(pattern)
+        active_support_major_version = ::ActiveSupport.version.canonical_segments.first
+
+        # TODO: Drop support for Rails 5 since it is EOL since 2022-06-01
+        if active_support_major_version >= NOTIFIER_MAJOR_VERSION_6
+          ::ActiveSupport::Notifications.notifier.instance_variable_get(:@string_subscribers)[pattern]
+        else
+          ::ActiveSupport::Notifications.notifier.instance_variable_get(:@subscribers)
+        end
+      end
+
       class SpanSubscriber
         ALWAYS_VALID_PAYLOAD_TYPES = [TrueClass, FalseClass, String, Numeric, Symbol].freeze
 
@@ -64,7 +85,7 @@ module OpenTelemetry
           [span, token]
         end
 
-        def finish(name, id, payload) # rubocop:disable Metrics/AbcSize
+        def finish(name, id, payload)
           span = payload.delete(:__opentelemetry_span)
           token = payload.delete(:__opentelemetry_ctx_token)
           return unless span && token

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveSupport
-      VERSION = '0.2.0'
+      VERSION = '0.2.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_support
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +70,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -156,28 +170,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.41.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -251,14 +265,14 @@ files:
 - lib/opentelemetry/instrumentation/active_support/instrumentation.rb
 - lib/opentelemetry/instrumentation/active_support/span_subscriber.rb
 - lib/opentelemetry/instrumentation/active_support/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_support/v0.2.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/active_support
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-active_support/v0.2.0
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_support/0.2.2/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_support
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_support/0.2.2
 post_install_message: 
 rdoc_options: []
 require_paths: