Merge branch 'logger-instrumentation' of github.com:kaylareopelle/ope…

…ntelemetry-ruby-contrib into logger-instrumentation

POST_INSTALL_MESSAGE

@@ -0,0 +1,3 @@
+Ruby 3.0 has reached EoL 2024-04-23. OTel Ruby Contrib gems will no longer accept new features or bug fixes for Ruby 3.0 after 2025-01-15. Please upgrade to Ruby 3.1 or higher to continue receiving updates.
+
+Rails 6.1 has reached EoL 2024-10-01. OTel Ruby Contrib gems will no longer accept new features or bug fixes for Rails 6.1 after 2025-01-15. Please upgrade to Rails 7.0 or higher to continue receiving updates.

helpers/mysql/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-helpers-mysql
 
+### v0.1.2 / 2024-11-26
+
+* (No significant changes)
+
 ### v0.1.1 / 2024-06-18
 
 * FIXED: Relax otel common gem constraints

helpers/mysql/lib/opentelemetry/helpers/mysql/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Helpers
     module MySQL
-      VERSION = '0.1.1'
+      VERSION = '0.1.2'
     end
   end
 end

helpers/mysql/opentelemetry-helpers-mysql.gemspec

@@ -44,4 +44,6 @@ Gem::Specification.new do |spec|
     spec.metadata['bug_tracker_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues'
     spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
   end
+
+  spec.post_install_message = File.read(File.expand_path('../../POST_INSTALL_MESSAGE', __dir__))
 end

helpers/sql-obfuscation/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-helpers-sql-obfuscation
 
+### v0.2.1 / 2024-11-26
+
+* (No significant changes)
+
 ### v0.2.0 / 2024-09-12
 
 - BREAKING CHANGE: Return message when sql is over the obfuscation limit. Fixes a bug where sql statements with prepended comments that hit the obfuscation limit would be sent raw.

helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Helpers
     module SqlObfuscation
-      VERSION = '0.2.0'
+      VERSION = '0.2.1'
     end
   end
 end

helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec

@@ -42,4 +42,6 @@ Gem::Specification.new do |spec|
     spec.metadata['bug_tracker_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues'
     spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
   end
+
+  spec.post_install_message = File.read(File.expand_path('../../POST_INSTALL_MESSAGE', __dir__))
 end

instrumentation/action_mailer/Gemfile

@@ -11,4 +11,7 @@ gemspec
 group :test do
   gem 'opentelemetry-instrumentation-base', path: '../base'
   gem 'opentelemetry-instrumentation-active_support', path: '../active_support'
+  # Add jar-dependencies gem only if the Ruby runtime is JRuby
+  # https://github.com/jruby/jruby/issues/7262
+  gem 'jar-dependencies', '0.4.1', platforms: :jruby
 end

instrumentation/active_model_serializers/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

instrumentation/active_model_serializers/example/rails_app.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  gem 'rails'
+  gem 'active_model_serializers'
+  gem 'opentelemetry-api'
+  gem 'opentelemetry-common'
+  gem 'opentelemetry-instrumentation-active_model_serializers', path: '../'
+  gem 'opentelemetry-sdk'
+  gem 'opentelemetry-exporter-otlp'
+end
+
+ENV['OTEL_TRACES_EXPORTER'] ||= 'console'
+OpenTelemetry::SDK.configure do |c|
+  c.service_name = 'active_model_serializers_example'
+  c.use 'OpenTelemetry::Instrumentation::ActiveModelSerializers'
+end
+
+# no manual subscription trigger
+
+at_exit do
+  OpenTelemetry.tracer_provider.shutdown
+end
+
+# TraceRequestApp is a minimal Rails application inspired by the Rails
+# bug report template for Action Controller.
+# The configuration is compatible with Rails 6.0
+class TraceRequestApp < Rails::Application
+  config.root = __dir__
+  config.hosts << 'example.org'
+  credentials.secret_key_base = 'secret_key_base'
+
+  config.eager_load = false
+
+  config.logger = Logger.new($stdout)
+  Rails.logger  = config.logger
+end
+
+# Rails app initialization will pick up the instrumentation Railtie
+# and subscribe to Active Support notifications
+TraceRequestApp.initialize!
+
+ExampleAppTracer = OpenTelemetry.tracer_provider.tracer('example_app')
+
+class TestModel
+  include ActiveModel::API
+  include ActiveModel::Serialization
+
+  attr_accessor :name
+
+  def attributes
+    { 'name' => nil,
+      'screaming_name' => nil }
+  end
+
+  def screaming_name
+    ExampleAppTracer.in_span('screaming_name transform') do |span|
+      name.upcase
+    end
+  end
+end
+
+model = TestModel.new(name: 'test object')
+serialized_model = ActiveModelSerializers::SerializableResource.new(model).serializable_hash
+
+puts "\n*** The serialized object: #{serialized_model}"

instrumentation/active_model_serializers/example/standalone.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  gem 'active_model_serializers'
+  gem 'opentelemetry-api'
+  gem 'opentelemetry-common'
+  gem 'opentelemetry-instrumentation-active_model_serializers', path: '../'
+  gem 'opentelemetry-sdk'
+  gem 'opentelemetry-exporter-otlp'
+end
+
+ENV['OTEL_TRACES_EXPORTER'] ||= 'console'
+OpenTelemetry::SDK.configure do |c|
+  c.service_name = 'active_model_serializers_example'
+  c.use_all
+end
+
+# without Rails and the Railtie automation, must manually trigger
+# instrumentation subscription after SDK is configured
+OpenTelemetry::Instrumentation::ActiveModelSerializers.subscribe
+
+at_exit do
+  OpenTelemetry.tracer_provider.shutdown
+end
+
+ExampleAppTracer = OpenTelemetry.tracer_provider.tracer('example_app')
+
+class TestModel
+  include ActiveModel::API
+  include ActiveModel::Serialization
+
+  attr_accessor :name
+
+  def attributes
+    { 'name' => nil,
+      'screaming_name' => nil }
+  end
+
+  def screaming_name
+    ExampleAppTracer.in_span('screaming_name transform') do |span|
+      name.upcase
+    end
+  end
+end
+
+model = TestModel.new(name: 'test object')
+serialized_model = ActiveModelSerializers::SerializableResource.new(model).serializable_hash
+
+puts "\n*** The serialized object: #{serialized_model}"

instrumentation/active_model_serializers/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 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
           !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

instrumentation/active_model_serializers/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