opentelemetry-instrumentation-active_model_serializers 0.20.1 → 0.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b949c58c29ef0c04a05e08869eef507222a9a42cf3026016604472de3ab538f
-  data.tar.gz: df0259ac2556ed56fe8bb24c11af3f073052201c63636a17bab48e3815020bb7
+  metadata.gz: 79b4ebdf892853ac5b800c445abba347e9a985e1cba611493aff3ef4bc322092
+  data.tar.gz: 62430d20906a9614ddae4fea5015e6e2e171268c048e852c33a531c609bb1635
 SHA512:
-  metadata.gz: a7f80dbfdca4acb78dd6803e6c90d9f0e5caab468acf0593a8bb87a357bb9f0709a8264ed22507fcf298fc49b693783ceeeb7931fb3a475787fc83ac9a80f8a0
-  data.tar.gz: 8d4e4e58832adead91fc2cd57eacfe3a0efe7bd32619d8620eccdc74710e5e8a83d0a35e93c11ada3b9f70bcff005755408398bfb5722b74a5458259e4a886bc
+  metadata.gz: 9626d66b283b78643c2bde5b7a975f1802ad726a4a178386bf2743762f3fe30fb98ef779c36dc2dbd592abe4b9a19c0a118d26fbbe1a31775a92abdc7f638286
+  data.tar.gz: 390d8337a2f50566fcea3a9ff61561a504b26f8acac8ee6f9c31f07ac0ce58fc5be84027efe75dcd885a022d1b193cda28355a0d900a8c06a4bbba6cc06c40de

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-active_model_serializers
 
+### v0.20.3 / 2024-12-04
+
+* FIXED: Use ActiveSupport::Notifications subscriber to serialize events.
+
+### v0.20.2 / 2024-07-23
+
+* DOCS: Add cspell to CI
+
 ### v0.20.1 / 2023-06-05
 
 * FIXED: Base config options 
@@ -43,7 +51,7 @@
 
 ### v0.18.0 / 2021-05-21
 
-* ADDED: Updated API depedency for 1.0.0.rc1
+* ADDED: Updated API dependency for 1.0.0.rc1
 
 ### v0.17.0 / 2021-04-22
 

data/README.md

@@ -6,7 +6,7 @@ The OpenTelemetry Active Model Serializers gem is a community maintained instrum
 
 Install the gem using:
 
-```
+```console
 gem install opentelemetry-instrumentation-active_model_serializers
 ```
 
@@ -38,7 +38,7 @@ Example usage of active_model_serializers can be seen in the `./example/active_m
 
 The `opentelemetry-instrumentation-active_model_serializers` 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
 
@@ -50,4 +50,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [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

data/lib/opentelemetry/instrumentation/active_model_serializers/instrumentation.rb

@@ -4,16 +4,24 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'opentelemetry-instrumentation-active_support'
+
 module OpenTelemetry
   module Instrumentation
     module ActiveModelSerializers
       # Instrumentation class that detects and installs the ActiveModelSerializers instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
+        # Minimum supported version of the `active_model_serializers` gem
         MINIMUM_VERSION = Gem::Version.new('0.10.0')
 
+        # ActiveSupport::Notification topics to which the instrumentation subscribes
+        SUBSCRIPTIONS = %w[
+          render.active_model_serializers
+        ].freeze
+
         install do |_config|
+          install_active_support_instrumenation
           require_dependencies
-          register_event_handler
         end
 
         present do
@@ -24,24 +32,39 @@ module OpenTelemetry
           !defined?(::ActiveSupport::Notifications).nil? && gem_version >= MINIMUM_VERSION
         end
 
+        def subscribe
+          SUBSCRIPTIONS.each do |subscription_name|
+            OpenTelemetry.logger.debug("Subscribing to #{subscription_name} notifications with #{_tracer}")
+            OpenTelemetry::Instrumentation::ActiveSupport.subscribe(_tracer, subscription_name, default_attribute_transformer)
+          end
+        end
+
         private
 
+        def _tracer
+          self.class.instance.tracer
+        end
+
         def gem_version
           Gem::Version.new(::ActiveModel::Serializer::VERSION)
         end
 
-        def require_dependencies
-          require_relative 'event_handler'
+        def install_active_support_instrumenation
+          OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation.instance.install({})
         end
 
-        def register_event_handler
-          ::ActiveSupport::Notifications.subscribe(event_name) do |_name, start, finish, _id, payload|
-            EventHandler.handle(start, finish, payload)
-          end
+        def require_dependencies
+          require_relative 'railtie'
         end
 
-        def event_name
-          'render.active_model_serializers'
+        def default_attribute_transformer
+          lambda { |payload|
+            {
+              'serializer.name' => payload[:serializer].name,
+              'serializer.renderer' => 'active_model_serializers',
+              'serializer.format' => payload[:adapter]&.class&.name || 'default'
+            }
+          }
         end
       end
     end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module ActiveModelSerializers # :nodoc:
+      def self.subscribe
+        Instrumentation.instance.subscribe
+      end
+
+      if defined?(::Rails::Railtie)
+        # This Railtie sets up subscriptions to relevant ActiveModelSerializers notifications
+        class Railtie < ::Rails::Railtie
+          config.after_initialize do
+            ::OpenTelemetry::Instrumentation::ActiveModelSerializers.subscribe
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module ActiveModelSerializers
-      VERSION = '0.20.1'
+      VERSION = '0.20.3'
     end
   end
 end

data/lib/opentelemetry/instrumentation/active_model_serializers.rb

@@ -15,5 +15,5 @@ module OpenTelemetry
   end
 end
 
-require_relative './active_model_serializers/instrumentation'
-require_relative './active_model_serializers/version'
+require_relative 'active_model_serializers/instrumentation'
+require_relative 'active_model_serializers/version'

data/lib/opentelemetry/instrumentation.rb

@@ -19,4 +19,4 @@ module OpenTelemetry
   end
 end
 
-require_relative './instrumentation/active_model_serializers'
+require_relative 'instrumentation/active_model_serializers'

data/lib/opentelemetry-instrumentation-active_model_serializers.rb

@@ -4,4 +4,4 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-require_relative './opentelemetry/instrumentation'
+require_relative 'opentelemetry/instrumentation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.20.3
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -142,70 +156,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: 1.68.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: 1.68.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 3.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 3.24.0
 - !ruby/object:Gem::Dependency
-  name: yard-doctest
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
 description: Active Model Serializers instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -220,17 +234,17 @@ files:
 - lib/opentelemetry-instrumentation-active_model_serializers.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/active_model_serializers.rb
-- lib/opentelemetry/instrumentation/active_model_serializers/event_handler.rb
 - lib/opentelemetry/instrumentation/active_model_serializers/instrumentation.rb
+- lib/opentelemetry/instrumentation/active_model_serializers/railtie.rb
 - lib/opentelemetry/instrumentation/active_model_serializers/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_model_serializers/0.20.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_model_serializers/0.20.3/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_model_serializers
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_model_serializers/0.20.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-active_model_serializers/0.20.3
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/instrumentation/active_model_serializers/event_handler.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module ActiveModelSerializers
-      # Event handler singleton for ActiveModelSerializers
-      module EventHandler
-        extend self
-
-        def handle(start_timestamp, end_timestamp, payload)
-          tracer.start_span(span_name(payload),
-                            start_timestamp: start_timestamp,
-                            attributes: build_attributes(payload),
-                            kind: :internal)
-                .finish(end_timestamp: end_timestamp)
-        end
-
-        protected
-
-        def span_name(payload)
-          "#{demodulize(payload[:serializer].name)} render"
-        end
-
-        def build_attributes(payload)
-          {
-            'serializer.name' => payload[:serializer].name,
-            'serializer.renderer' => 'active_model_serializers',
-            'serializer.format' => payload[:adapter]&.class&.name || 'default'
-          }
-        end
-
-        def tracer
-          ActiveModelSerializers::Instrumentation.instance.tracer
-        end
-
-        def demodulize(string)
-          string = string.to_s
-          i = string.rindex('::')
-          i ? string[(i + 2)..-1] : string
-        end
-      end
-    end
-  end
-end