scout_apm_logging 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aea114282e91583732d4a4b3246273d0b18ae3b2e5b784366b5a18691889391b
-  data.tar.gz: dd625a2eb6bede54138bb05ef3671ad1a98995d59f1c5de28d033fd617d156b6
+  metadata.gz: dd453a461cde33d8b0dd69cf25180bd88aa1c29d7576001ac2605fd6e2eab95b
+  data.tar.gz: 86fcb8e29e7506ba5abc0a0961c0260c8a3c5695a04761c4f33bda002efaa201
 SHA512:
-  metadata.gz: 4d62832832aa309c9bd66c5cabe2d6c4c23472452bd0f3b9874741febd5f0a5f6716dfea8ff5e929075424ea998a89eb0edb947da9959d0bf03da334a9502158
-  data.tar.gz: 94ab281a893c87b2d1b979b4b8fa7c9c2bd0e467983b302c0f0931b04f582dc6dc2c6b9c3c19b83ad14b79ece26a6b4a5f0c7e6cda492b6b840c133ec9d7d5f2
+  metadata.gz: 43ce974c35e2544f4870bebfdaa580dcb535f96d9905954df47be5afb75d3471ab12ef6bbda4c79605e83daa777fe15e8604d763ac99db616841b0acc82ab244
+  data.tar.gz: '09f7492dc86c28b91e38f340b2aad44b3fbe0cb1689f0e50bc814aa4dee78257f96417377c59b884ad147035576ed80dcaea73d9ee3a97e7429d5d94b114ed10'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.0.13
+* Add ability to handle other libraries setting the Rails logger.
+* Overwrite comparability methods on the proxy class. Have proxy class inherit from Object again.
+* Clone original log instances.
+
 ## 0.0.12
 * Prevent certain attributes from being changed on created FileLogger.
 * Update proxy class to inherit from BasicObject to relay class comparison methods

data/lib/scout_apm/logging/loggers/capture.rb

@@ -42,10 +42,11 @@ module ScoutApm
           Utils.ensure_directory_exists(context.config.value('logs_proxy_log_dir'))
         end
 
-        def add_logging_patches!
+        def add_logging_patches! # rubocop:disable Metrics/AbcSize
+          require_relative './patches/rails_logger' unless ::Rails.logger.respond_to?(:broadcasts)
           # We can't swap out the logger similar to that of Rails and Sidekiq, as
           # the TaggedLogging logger is dynamically generated.
-          return unless Rails.logger.respond_to?(:tagged)
+          return unless ::Rails.logger.respond_to?(:tagged)
 
           ::ActiveSupport::TaggedLogging.prepend(Patches::TaggedLogging)
 
@@ -53,9 +54,9 @@ module ScoutApm
           # This appears to be an issue in Ruby 2.7 with the broadcast logger.
           ruby_version = Gem::Version.new(RUBY_VERSION)
           isruby27 = (ruby_version >= Gem::Version.new('2.7') && ruby_version < Gem::Version.new('3.0'))
-          return unless isruby27 && Rails.logger.respond_to?(:broadcasts)
+          return unless isruby27 && ::Rails.logger.respond_to?(:broadcasts)
 
-          Rails.logger.broadcasts.each do |logger|
+          ::Rails.logger.broadcasts.each do |logger|
             logger.extend ::ActiveSupport::TaggedLogging
           end
         end

data/lib/scout_apm/logging/loggers/patches/rails_logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# A patch to Rails to allow swapping out the logger for the held logger in the proxy.
+module Rails
+  class << self
+    def logger=(new_logger)
+      @logger.tap do |rails_logger|
+        if rails_logger.respond_to?(:is_scout_proxy_logger?)
+          old_logger = rails_logger.instance_variable_get(:@loggers).first
+          rails_logger.swap_scout_loggers!(old_logger, new_logger)
+        else
+          @logger = new_logger
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/logging/loggers/proxy.rb

@@ -4,9 +4,7 @@ module ScoutApm
   module Logging
     module Loggers
       # Holds both the original application logger and the new one. Relays commands to both.
-      class Proxy < BasicObject
-        include ::Kernel
-
+      class Proxy
         def self.create_with_loggers(*loggers)
           new.tap do |proxy_logger|
             loggers.each { |logger| proxy_logger.add_scout_loggers(logger) }
@@ -21,12 +19,19 @@ module ScoutApm
           @loggers << logger
         end
 
-        def remove_scout_loggers(logger)
+        def remove_scout_loggers!(logger)
           @loggers.reject! { |inst_log| inst_log == logger }
 
           @loggers
         end
 
+        def swap_scout_loggers!(old_logger, new_logger)
+          logger_index = @loggers.index(old_logger)
+          return unless logger_index
+
+          @loggers[logger_index] = new_logger
+        end
+
         # We don't want other libraries to change the formatter of the logger we create.
         def formatter=(formatter)
           @loggers.first.formatter = formatter
@@ -38,8 +43,20 @@ module ScoutApm
           @loggers.first.level = level
         end
 
+        def is_a?(klass)
+          @loggers.first.is_a?(klass)
+        end
+
+        def kind_of?(klass)
+          @loggers.first.is_a?(klass)
+        end
+
+        def instance_of?(klass)
+          @loggers.first.instance_of?(klass)
+        end
+
         def class
-          ::Logger
+          @loggers.first.class
         end
 
         def is_scout_proxy_logger?

data/lib/scout_apm/logging/loggers/swaps/rails.rb

@@ -19,8 +19,10 @@ module ScoutApm
           def update_logger!
             # In Rails 7.1, broadcast logger was added which allows sinking to multiple IO devices.
             if defined?(::ActiveSupport::BroadcastLogger) && log_instance.is_a?(::ActiveSupport::BroadcastLogger)
+              context.logger.debug('Rails Broadcast logger detected. Adding new logger to broadcast.')
               add_logger_to_broadcast!
             else
+              context.logger.debug("Swapping in Proxy for current Rails logger: #{log_instance.class}.")
               swap_in_proxy_logger!
             end
 
@@ -37,18 +39,8 @@ module ScoutApm
             @new_file_logger ||= Loggers::Logger.new(context, log_instance).create_logger!
           end
 
-          # Eseentially creates the original logger.
-          def original_logger # rubocop:disable Metrics/AbcSize
-            # We can use the previous logdev. log_device will continuously call write
-            # through the devices until the logdev (@dev) is an IO device other than logdev:
-            # https://github.com/ruby/ruby/blob/master/lib/logger/log_device.rb#L42
-            # Log device holds the configurations around shifting too.
-            original_logdevice = log_instance.instance_variable_get(:@logdev)
-
-            ::Logger.new(original_logdevice).tap do |logger|
-              logger.level = log_instance.level
-              logger.formatter = log_instance.formatter
-
+          def original_logger
+            @original_logger = log_instance.clone.tap do |logger|
               if ::Rails.env.development? && $stdout.tty? && $stderr.tty?
                 next if ::ActiveSupport::Logger.respond_to?(:logger_outputs_to?) && ::ActiveSupport::Logger.logger_outputs_to?(
                   logger, $stdout, $stderr

data/lib/scout_apm/logging/loggers/swaps/scout.rb

@@ -17,6 +17,7 @@ module ScoutApm
           end
 
           def update_logger!
+            context.logger.debug('Swapping in Proxy for Test logger.')
             swap_in_proxy_logger!
 
             new_log_location
@@ -34,16 +35,7 @@ module ScoutApm
 
           # Eseentially creates the original logger.
           def original_logger
-            # We can use the previous logdev. log_device will continuously call write
-            # through the devices until the logdev (@dev) is an IO device other than logdev:
-            # https://github.com/ruby/ruby/blob/master/lib/logger/log_device.rb#L42
-            # Log device holds the configurations around shifting too.
-            original_logdevice = log_instance.instance_variable_get(:@logdev)
-
-            ::Logger.new(original_logdevice).tap do |logger|
-              logger.level = log_instance.level
-              logger.formatter = log_instance.formatter
-            end
+            @original_logger = log_instance.clone
           end
 
           def new_log_location

data/lib/scout_apm/logging/loggers/swaps/sidekiq.rb

@@ -17,6 +17,7 @@ module ScoutApm
           end
 
           def update_logger!
+            context.logger.debug("Swapping in Proxy for current Sidekiq logger: #{log_instance.class}.")
             swap_in_proxy_logger!
 
             new_log_location
@@ -38,12 +39,7 @@ module ScoutApm
             # through the devices until the logdev (@dev) is an IO device other than logdev:
             # https://github.com/ruby/ruby/blob/master/lib/logger/log_device.rb#L42
             # Log device holds the configurations around shifting too.
-            original_logdevice = log_instance.instance_variable_get(:@logdev)
-
-            ::Logger.new(original_logdevice).tap do |logger|
-              logger.level = log_instance.level
-              logger.formatter = log_instance.formatter
-            end
+            @original_logger = log_instance.clone
           end
 
           def new_log_location

data/lib/scout_apm/logging/version.rb

@@ -2,6 +2,6 @@
 
 module ScoutApm
   module Logging
-    VERSION = '0.0.12'
+    VERSION = '0.0.13'
   end
 end

data/lib/scout_apm_logging.rb

@@ -18,7 +18,7 @@ module ScoutApm
     if defined?(Rails) && defined?(Rails::Railtie)
       # If we are in a Rails environment, setup the monitor daemon manager.
       class RailTie < ::Rails::Railtie
-        initializer 'scout_apm_logging.monitor' do
+        initializer 'scout_apm_logging.monitor', after: :initialize_logger, before: :initialize_cache do
           context = ScoutApm::Logging::MonitorManager.instance.context
 
           Loggers::Capture.new(context).setup!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm_logging
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scout_apm
@@ -89,6 +89,7 @@ files:
 - lib/scout_apm/logging/loggers/capture.rb
 - lib/scout_apm/logging/loggers/formatter.rb
 - lib/scout_apm/logging/loggers/logger.rb
+- lib/scout_apm/logging/loggers/patches/rails_logger.rb
 - lib/scout_apm/logging/loggers/patches/tagged_logging.rb
 - lib/scout_apm/logging/loggers/proxy.rb
 - lib/scout_apm/logging/loggers/swaps/rails.rb