scout_apm_logging 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bbd257d9d08bbe578c328b108c2ce42e488ae5f7f0577a2ce7a692bbf208ac0
-  data.tar.gz: f274d28b0e8485077d460cc5f00d259211a135e580fc5591cb84a04713650476
+  metadata.gz: dd453a461cde33d8b0dd69cf25180bd88aa1c29d7576001ac2605fd6e2eab95b
+  data.tar.gz: 86fcb8e29e7506ba5abc0a0961c0260c8a3c5695a04761c4f33bda002efaa201
 SHA512:
-  metadata.gz: 120b0718b958634f0ba0b04ab122e4d8b6b2a743962b9089fbf309b0d97616107ebfcbab61dca6684d79079094d46f50cee1d4d27dfe2f4b945b4f6bdb9541da
-  data.tar.gz: b9fa5e1dcfbe6d005c17a4719c9f8c93750639915d81ba946f597662c101fe4edd2b732dd176a180e6f1043d3f8eda0b9c8f0c6f7cd6a51ff24c7e61203adfaf
+  metadata.gz: 43ce974c35e2544f4870bebfdaa580dcb535f96d9905954df47be5afb75d3471ab12ef6bbda4c79605e83daa777fe15e8604d763ac99db616841b0acc82ab244
+  data.tar.gz: '09f7492dc86c28b91e38f340b2aad44b3fbe0cb1689f0e50bc814aa4dee78257f96417377c59b884ad147035576ed80dcaea73d9ee3a97e7429d5d94b114ed10'

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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
+to held loggers.
+* Fix ERB evaluation in scout_apm.yml config file to allow for usage of Rails.env.
+
 ## 0.0.11
 * Fix Scout layer capturing in log attributes for background jobs.
 

data/bin/scout_apm_logging_monitor

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require_relative '../lib/scout_apm/logging/monitor/_rails.rb'
 require_relative "../lib/scout_apm/logging/monitor/monitor.rb"
 
 ScoutApm::Logging::Monitor.instance.setup!

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/logger.rb

@@ -6,6 +6,21 @@ module ScoutApm
       # The actual instance of the logger.
       class FileLogger < ::Logger
         include ::ActiveSupport::LoggerSilence if const_defined?('::ActiveSupport::LoggerSilence')
+
+        # Other loggers may be extended with additional methods that have not been applied to this file logger.
+        # Most likely, these methods will still utilize the exiting logging methods to write to the IO device,
+        # however, if this is not the case we may miss logs. With that being said, we shouldn't impact the original
+        # applications intended behavior and let the user know we don't support it and no-op.
+        def method_missing(name, *_args)
+          return unless defined?(::Rails)
+
+          ::Rails.logger.warn("Method #{name} called on ScoutApm::Logging::Loggers::FileLogger, but it is not defined.")
+        end
+
+        # More impactful for the broadcast logger.
+        def respond_to_missing?(name, *_args)
+          super
+        end
       end
 
       # The newly created logger which we can configure, and will log to a filepath.

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/patches/tagged_logging.rb

@@ -11,10 +11,10 @@ module ScoutApm
         # Patches TaggedLogging to work with our loggers.
         module TaggedLogging
           def tagged(*tags) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-            return super(*tags) unless (self == ::Rails.logger && is_a?(ScoutApm::Logging::Loggers::Proxy)) ||
+            return super(*tags) unless (self == ::Rails.logger && respond_to?(:is_scout_proxy_logger?)) ||
                                        (::Rails.logger.respond_to?(:broadcasts) && ::Rails.logger.broadcasts.include?(self))
 
-            if is_a?(ScoutApm::Logging::Loggers::Proxy)
+            if respond_to?(:is_scout_proxy_logger?)
               if block_given?
                 # We skip the first logger to prevent double tagging when calling formatter.tagged
                 loggers = @loggers[1..]

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

@@ -19,12 +19,50 @@ 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
+        end
+
+        # We don't want other libraries to change the level of the logger we create, as this
+        # is dictated by the logs_capture_level configuration.
+        def level=(level)
+          @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
+          @loggers.first.class
+        end
+
+        def is_scout_proxy_logger?
+          true
+        end
+
         def method_missing(name, *args, &block)
           # Some libraries will do stuff like Library.logger.formatter = Rails.logger.formatter
           # As such, we should return the first logger's (the original logger) return value.

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,24 +39,14 @@ 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?(
+                next if ::ActiveSupport::Logger.respond_to?(:logger_outputs_to?) && ::ActiveSupport::Logger.logger_outputs_to?(
                   logger, $stdout, $stderr
                 )
 
-                logger.extend(ActiveSupport::Logger.broadcast(ActiveSupport::Logger.new($stdout)))
+                logger.extend(ActiveSupport::Logger.broadcast(::ActiveSupport::Logger.new($stdout)))
               end
             end
           end

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/monitor/_rails.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# We start the monitor process outside the context of Rails, and ultimately don't use
+# it for anything related to starting the collector. However, when we load the config/scout_apm.yml file,
+# we support ERB, and users may be using Rails.env methods for naming the app, or configuring whether
+# monitor should be enabled for a specific environment.
+
+require 'active_support'
+
+# https://github.com/rails/rails/blob/v7.2.1/railties/lib/rails.rb#L76
+module Rails
+  class << self
+    def env
+      # EnvironmentInquirer was added in Rails 6.1
+      @env ||= if const_defined?('::ActiveSupport::EnvironmentInquirer')
+                 ::ActiveSupport::EnvironmentInquirer.new(ENV['RAILS_ENV'].presence || ENV['RACK_ENV'].presence || 'development')
+               else
+                 ::ActiveSupport::StringInquirer.new(ENV['RAILS_ENV'].presence || ENV['RACK_ENV'].presence || 'development')
+               end
+    end
+  end
+end

data/lib/scout_apm/logging/version.rb

@@ -2,6 +2,6 @@
 
 module ScoutApm
   module Logging
-    VERSION = '0.0.11'
+    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!

data/spec/unit/loggers/capture_spec.rb

@@ -35,7 +35,7 @@ describe ScoutApm::Logging::Loggers::Capture do
       capture = ScoutApm::Logging::Loggers::Capture.new(context)
       capture.setup!
 
-      expect(TestLoggerWrapper.logger.class).to eq(ScoutApm::Logging::Loggers::Proxy)
+      expect(TestLoggerWrapper.logger.respond_to?(:is_scout_proxy_logger?)).to eq(true)
 
       TestLoggerWrapper.logger.info('TEST')
       TestLoggerWrapper.logger.debug('SHOULD NOT CAPTURE')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm_logging
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scout_apm
@@ -89,11 +89,13 @@ 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
 - lib/scout_apm/logging/loggers/swaps/scout.rb
 - lib/scout_apm/logging/loggers/swaps/sidekiq.rb
+- lib/scout_apm/logging/monitor/_rails.rb
 - lib/scout_apm/logging/monitor/collector/checksum.rb
 - lib/scout_apm/logging/monitor/collector/configuration.rb
 - lib/scout_apm/logging/monitor/collector/downloader.rb