scout_apm_logging 0.0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 198bf309d17f0abfcf2c33f820a2d44e1e92ef5af9e321ee9fbaacfec256f032
-  data.tar.gz: 2a09b14a45e702fe1e4f4caee6ff89475e14971ba9edad41ae5cf3c72ab97850
+  metadata.gz: bbe47505a0defc4e795ece37c30380707600c95708954f2aa99b86e2eff5aefb
+  data.tar.gz: 7aa1c9af19eb96358fbc5ceb037b901cc2dd4a01ab87cc6d737f9b0205fa77cf
 SHA512:
-  metadata.gz: ebd30ceac50e2f14f3693946e8dd883112cc502513678b3a9963e253f2622d1ea488c2a66bce01f3e20726d7c6f08f61392cde6f22f1d9d0412987780f6399fa
-  data.tar.gz: c0cfeb3cfbed2628772550b18b1a2f7965a144fafea14846ed65936043ae283b48cef6ba0109a05dfe9df3b826080d0f24676c0957b3909311cae12098b1e2de
+  metadata.gz: a1d8ee77dd245e14a26a40298c5c77d61af4b1869aa4bc8d53ae1856ae336456148a7a3d2ad865b1e920ef4184fe14120cb07dc453e7b6a8e25738495123a7f1
+  data.tar.gz: 25380fc37e48a7a6a6f901246faf3fec03884c4665a853d6decb3646a566a8b637aaf1851e86f76865429838fb631aaa5d0c245dd9ff7d453824f80a854f2ce3

data/Rakefile

@@ -1,3 +1,5 @@
+require "bundler/gem_tasks"
+
 task :default => :test
 
 task :test do

data/lib/scout_apm/logging/config.rb

@@ -227,7 +227,7 @@ module ScoutApm
           'log_level' => 'info',
           'logs_monitored' => [],
           'logs_capture_level' => 'debug',
-          'logs_reporting_endpoint' => 'https://otlp.telemetryhub.com:4317',
+          'logs_reporting_endpoint' => 'https://otlp.scoutotel.com:4317',
           'logs_proxy_log_dir' => '/tmp/scout_apm/logs/',
           'manager_lock_file' => '/tmp/scout_apm/monitor_lock_file.lock',
           'monitor_pid_file' => '/tmp/scout_apm/scout_apm_log_monitor.pid',

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

@@ -2,8 +2,12 @@
 
 require 'logger'
 
-require_relative './swap'
+require_relative './formatter'
+require_relative './logger'
 require_relative './proxy'
+require_relative './swaps/rails'
+require_relative './swaps/sidekiq'
+require_relative './swaps/scout'
 
 module ScoutApm
   module Logging
@@ -12,33 +16,34 @@ module ScoutApm
       class Capture
         attr_reader :context
 
+        KNOWN_LOGGERS = [
+          Swaps::Rails,
+          Swaps::Sidekiq,
+          Swaps::Scout
+        ].freeze
+
         def initialize(context)
           @context = context
         end
 
-        def capture_log_locations! # rubocop:disable Metrics/AbcSize
-          logger_instances << Rails.logger if defined?(Rails)
-          logger_instances << Sidekiq.logger if defined?(Sidekiq)
-          logger_instances << ObjectSpace.each_object(::ScoutTestLogger).to_a if defined?(::ScoutTestLogger)
+        def capture_and_swap_log_locations!
+          return unless context.config.value('logs_monitor')
+
+          create_proxy_log_dir!
 
-          # Swap in our logger for each logger instance, in conjunction with the original class.
-          updated_log_locations = logger_instances.compact.flatten.map do |logger|
-            swapped_in_location(logger)
+          # We can move this to filter_map when our lagging version is Ruby 2.7
+          updated_log_locations = KNOWN_LOGGERS.map do |logger|
+            logger.new(context).update_logger! if logger.present?
           end
+          updated_log_locations.compact!
 
           context.config.state.add_log_locations!(updated_log_locations)
         end
 
         private
 
-        def logger_instances
-          @logger_instances ||= []
-        end
-
-        def swapped_in_location(log_instance)
-          swap = Swap.new(context, log_instance)
-          swap.update_logger!
-          swap.log_location
+        def create_proxy_log_dir!
+          Utils.ensure_directory_exists(context.config.value('logs_proxy_log_dir'))
         end
       end
     end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module ScoutApm
   module Logging
     module Loggers
@@ -29,6 +27,8 @@ module ScoutApm
           new_logger = FileLogger.new(determine_file_path, LOG_AGE, LOG_SIZE)
           # Ruby's Logger handles a lot of the coercion itself.
           new_logger.level = context.config.value('logs_capture_level')
+          # Add our custom formatter to the logger.
+          new_logger.formatter = Formatter.new
           new_logger
         end
 

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

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module ScoutApm
   module Logging
     module Loggers
       # Holds both the original application logger and the new one. Relays commands to both.
       class Proxy
+        def self.create_with_loggers(original_logger, new_file_logger)
+          new.tap do |proxy_logger|
+            proxy_logger.add(original_logger)
+            proxy_logger.add(new_file_logger)
+          end
+        end
+
         def initialize
           @loggers = []
         end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ScoutApm
+  module Logging
+    module Loggers
+      module Swaps
+        # Swaps in our logger for the Rails logger.
+        class Rails
+          attr_reader :context
+
+          def self.present?
+            defined?(::Rails) && ::Rails.logger
+          end
+
+          def initialize(context)
+            @context = context
+          end
+
+          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)
+              add_logger_to_broadcast!
+            else
+              swap_in_proxy_logger!
+            end
+
+            new_log_location
+          end
+
+          private
+
+          def log_instance
+            ::Rails.logger
+          end
+
+          def new_file_logger
+            @new_file_logger ||= Loggers::Logger.new(context, log_instance).create_logger!
+          end
+
+          # 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.formatter = log_instance.formatter
+            end
+          end
+
+          def new_log_location
+            new_file_logger.instance_variable_get(:@logdev).filename
+          end
+
+          def add_logger_to_broadcast!
+            log_instance.broadcast_to(new_file_logger)
+          end
+
+          def swap_in_proxy_logger!
+            # First logger needs to be the original logger for the return value of relayed calls.
+            proxy_logger = Proxy.create_with_loggers(original_logger, new_file_logger)
+
+            ::Rails.logger = proxy_logger
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ScoutApm
+  module Logging
+    module Loggers
+      module Swaps
+        # Swaps in our logger for the test Scout logger.
+        class Scout
+          attr_reader :context
+
+          def self.present?
+            defined?(::TestLoggerWrapper) && ::TestLoggerWrapper.logger
+          end
+
+          def initialize(context)
+            @context = context
+          end
+
+          def update_logger!
+            swap_in_proxy_logger!
+
+            new_log_location
+          end
+
+          private
+
+          def log_instance
+            ::TestLoggerWrapper.logger
+          end
+
+          def new_file_logger
+            @new_file_logger ||= Loggers::Logger.new(context, log_instance).create_logger!
+          end
+
+          # 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.formatter = log_instance.formatter
+            end
+          end
+
+          def new_log_location
+            new_file_logger.instance_variable_get(:@logdev).filename
+          end
+
+          def swap_in_proxy_logger!
+            # First logger needs to be the original logger for the return value of relayed calls.
+            proxy_logger = Proxy.create_with_loggers(original_logger, new_file_logger)
+
+            ::TestLoggerWrapper.logger = proxy_logger
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ScoutApm
+  module Logging
+    module Loggers
+      module Swaps
+        # Swaps in our logger for the Sidekiq logger.
+        class Sidekiq
+          attr_reader :context
+
+          def self.present?
+            defined?(::Sidekiq) && ::Sidekiq.logger
+          end
+
+          def initialize(context)
+            @context = context
+          end
+
+          def update_logger!
+            swap_in_proxy_logger!
+
+            new_log_location
+          end
+
+          private
+
+          def log_instance
+            ::Sidekiq.logger
+          end
+
+          def new_file_logger
+            @new_file_logger ||= Loggers::Logger.new(context, log_instance).create_logger!
+          end
+
+          # 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.formatter = log_instance.formatter
+            end
+          end
+
+          def new_log_location
+            new_file_logger.instance_variable_get(:@logdev).filename
+          end
+
+          def swap_in_proxy_logger!
+            # First logger needs to be the original logger for the return value of relayed calls.
+            proxy_logger = Proxy.create_with_loggers(original_logger, new_file_logger)
+
+            ::Sidekiq.configure_server do |config|
+              config.logger = proxy_logger
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/logging/monitor_manager/manager.rb

@@ -24,9 +24,6 @@ module ScoutApm
         add_exit_handler!
 
         determine_configuration_state
-
-        # Continue to hold the lock until we have written the PID file.
-        ensure_monitor_pid_file_exists
       end
 
       def determine_configuration_state
@@ -35,6 +32,9 @@ module ScoutApm
         if monitoring_enabled
           context.logger.info('Log monitoring enabled')
           create_process
+
+          # Continue to hold the lock until we have written the PID file.
+          ensure_monitor_pid_file_exists
         else
           context.logger.info('Log monitoring disabled')
           remove_processes
@@ -50,7 +50,10 @@ module ScoutApm
         at_exit do
           # Only remove/restart the monitor and collector if we are exiting from an app_server process.
           # We need to wait on this check, as the process command line changes at some point.
-          remove_processes if Utils.current_process_is_app_server?
+          if Utils.current_process_is_app_server?
+            context.logger.debug('Exiting from app server process. Removing monitor and collector processes.')
+            remove_processes
+          end
         end
       end
 
@@ -64,12 +67,15 @@ module ScoutApm
         gem_directory = File.expand_path('../../../..', __dir__)
 
         # As we daemonize the process, we will write to the pid file within the process.
-        Process.spawn("ruby #{gem_directory}/bin/scout_apm_logging_monitor", in: reader)
+        pid = Process.spawn("ruby #{gem_directory}/bin/scout_apm_logging_monitor", in: reader)
 
         reader.close
         # TODO: Add support for Sinatra.
         writer.puts Rails.root if defined?(Rails)
         writer.close
+        # Block until we have spawned the process and forked. This is to ensure
+        # we keep the exclusive lock until the process has written the PID file.
+        Process.wait(pid)
       end
 
       private

data/lib/scout_apm/logging/version.rb

@@ -2,6 +2,6 @@
 
 module ScoutApm
   module Logging
-    VERSION = '0.0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/scout_apm_logging.rb

@@ -21,7 +21,7 @@ module ScoutApm
         initializer 'scout_apm_logging.monitor' do
           context = ScoutApm::Logging::MonitorManager.instance.context
 
-          Loggers::Capture.new(context).capture_log_locations!
+          Loggers::Capture.new(context).capture_and_swap_log_locations!
 
           unless Utils.skip_setup?
             Utils.attempt_exclusive_lock(context) do

data/scout_apm_logging.gemspec

@@ -1,5 +1,3 @@
-require "bundler/gem_tasks"
-
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'scout_apm/logging/version'
 

data/spec/integration/loggers/capture_spec.rb

@@ -2,6 +2,8 @@ require 'logger'
 
 require 'spec_helper'
 
+require_relative '../../../lib/scout_apm/logging/loggers/capture'
+
 describe ScoutApm::Logging::Loggers::Capture do
   it 'should find the logger, capture the log destination, and rotate collector configs' do
     ENV['SCOUT_MONITOR_INTERVAL'] = '10'
@@ -17,9 +19,7 @@ describe ScoutApm::Logging::Loggers::Capture do
     first_logger = ScoutTestLogger.new('/tmp/first_file.log')
     first_logger_basename = File.basename(first_logger.instance_variable_get(:@logdev).filename.to_s)
     first_logger_updated_path = File.join(context.config.value('logs_proxy_log_dir'), first_logger_basename)
-
-    # While we only use the ObjectSpace for the test logger, we need to wait for it to be captured.
-    wait_for_logger
+    TestLoggerWrapper.logger = first_logger
 
     similuate_railtie
 
@@ -36,6 +36,7 @@ describe ScoutApm::Logging::Loggers::Capture do
     second_logger = ScoutTestLogger.new('/tmp/second_file.log')
     second_logger_basename = File.basename(second_logger.instance_variable_get(:@logdev).filename.to_s)
     second_logger_updated_path = File.join(context.config.value('logs_proxy_log_dir'), second_logger_basename)
+    TestLoggerWrapper.logger = second_logger
 
     similuate_railtie
 
@@ -61,18 +62,7 @@ describe ScoutApm::Logging::Loggers::Capture do
   def similuate_railtie
     context = ScoutApm::Logging::MonitorManager.instance.context
 
-    ScoutApm::Logging::Loggers::Capture.new(context).capture_log_locations!
+    ScoutApm::Logging::Loggers::Capture.new(context).capture_and_swap_log_locations!
     ScoutApm::Logging::MonitorManager.new.setup!
   end
-
-  def wait_for_logger
-    start_time = Time.now
-    loop do
-      break if ObjectSpace.each_object(ScoutTestLogger).count.positive?
-
-      raise 'Timed out while waiting for logger in ObjectSpace' if Time.now - start_time > 10
-
-      sleep 0.1
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ end
 
 RSpec.configure do |config|
   ENV["SCOUT_LOG_LEVEL"] = "debug"
-  ENV["SCOUT_COLLECTOR_LOG_LEVEL"] = "debug"
+  ENV["SCOUT_COLLECTOR_LOG_LEVEL"] = "info"
 
   config.after(:each) do
     RSpec::Mocks.space.reset_all

data/spec/unit/loggers/capture_spec.rb

@@ -4,7 +4,6 @@ require 'stringio'
 require 'spec_helper'
 
 require_relative '../../../lib/scout_apm/logging/loggers/capture'
-require_relative '../../../lib/scout_apm/logging/loggers/proxy'
 
 def capture_stdout
   old_stdout = $stdout
@@ -29,11 +28,8 @@ describe ScoutApm::Logging::Loggers::Capture do
 
       TestLoggerWrapper.logger = ScoutTestLogger.new($stdout)
 
-      # While we only use the ObjectSpace for the test logger, we need to wait for it to be captured.
-      wait_for_logger
-
       capture = ScoutApm::Logging::Loggers::Capture.new(context)
-      capture.capture_log_locations!
+      capture.capture_and_swap_log_locations!
 
       expect(TestLoggerWrapper.logger.class).to eq(ScoutApm::Logging::Loggers::Proxy)
 
@@ -50,15 +46,4 @@ describe ScoutApm::Logging::Loggers::Capture do
 
     expect(output_from_log).to include('TEST')
   end
-
-  def wait_for_logger
-    start_time = Time.now
-    loop do
-      break if ObjectSpace.each_object(::ScoutTestLogger).count.positive?
-
-      raise 'Timed out while waiting for logger in ObjectSpace' if Time.now - start_time > 10
-
-      sleep 0.1
-    end
-  end
 end

data/spec/unit/monitor/collector/configuration_spec.rb

@@ -12,7 +12,7 @@ describe ScoutApm::Logging::Collector::Configuration do
     expect(File.exist?(context.config.value('collector_config_file'))).to be_truthy
     config = YAML.load_file(context.config.value('collector_config_file'))
 
-    expect(config['exporters']['otlp']['endpoint']).to eq('https://otlp.telemetryhub.com:4317')
+    expect(config['exporters']['otlp']['endpoint']).to eq('https://otlp.scoutotel.com:4317')
     expect(config['exporters']['otlp']['headers']['x-telemetryhub-key']).to eq('00001000010000abc')
     expect(config['receivers']['filelog']['include']).to eq(['/tmp/fake_log_file.log'])
   end
@@ -26,7 +26,7 @@ describe ScoutApm::Logging::Collector::Configuration do
     expect(File.exist?(context.config.value('collector_config_file'))).to be_truthy
     config = YAML.load_file(context.config.value('collector_config_file'))
 
-    expect(config['exporters']['otlp']['endpoint']).to eq('https://otlp.telemetryhub.com:4317')
+    expect(config['exporters']['otlp']['endpoint']).to eq('https://otlp.scoutotel.com:4317')
     expect(config['exporters']['otlp']['headers']['x-telemetryhub-key']).to eq('00001000010000abc')
     expect(config['receivers']['filelog']['include']).to eq(['/tmp/fake_log_file.log'])
 
@@ -44,7 +44,7 @@ describe ScoutApm::Logging::Collector::Configuration do
     expect(File.exist?(context.config.value('collector_config_file'))).to be_truthy
     config = YAML.load_file(context.config.value('collector_config_file'))
 
-    expect(config['exporters']['otlp']['endpoint']).to eq('https://otlp.telemetryhub.com:4317')
+    expect(config['exporters']['otlp']['endpoint']).to eq('https://otlp.scoutotel.com:4317')
     expect(config['exporters']['otlp']['headers']['x-telemetryhub-key']).to eq('00001000010000abc')
     expect(config['receivers']['filelog']['include']).to eq(['/tmp/fake_log_file.log'])
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm_logging
 version: !ruby/object:Gem::Version
-  version: 0.0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scout_apm
@@ -89,7 +89,9 @@ files:
 - lib/scout_apm/logging/loggers/formatter.rb
 - lib/scout_apm/logging/loggers/logger.rb
 - lib/scout_apm/logging/loggers/proxy.rb
-- lib/scout_apm/logging/loggers/swap.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/collector/checksum.rb
 - lib/scout_apm/logging/monitor/collector/configuration.rb
 - lib/scout_apm/logging/monitor/collector/downloader.rb

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

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-require_relative './formatter'
-require_relative './logger'
-
-module ScoutApm
-  module Logging
-    module Loggers
-      # Swaps in our logger for the application's logger.
-      class Swap
-        attr_reader :context, :log_instance, :new_file_logger
-
-        def initialize(context, log_instance)
-          @context = context
-          @log_instance = log_instance
-        end
-
-        def update_logger!
-          create_proxy_log_dir!
-
-          # 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)
-            add_logger_to_broadcast!
-          else
-            swap_in_proxy_logger!
-          end
-        end
-
-        def log_location
-          new_file_logger.instance_variable_get(:@logdev).filename
-        end
-
-        private
-
-        def add_logger_to_broadcast!
-          @new_file_logger = create_file_logger
-          @new_file_logger.formatter = Loggers::Formatter.new
-
-          log_instance.broadcast_to(new_file_logger)
-        end
-
-        def swap_in_proxy_logger! # rubocop:disable Metrics/AbcSize
-          proxy_logger = Proxy.new
-          # 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)
-          updated_original_logger = ::Logger.new(original_logdevice)
-          updated_original_logger.formatter = log_instance.formatter
-
-          @new_file_logger = create_file_logger
-          @new_file_logger.formatter = Loggers::Formatter.new
-
-          # First logger needs to be the original logger for the return value of relayed calls.
-          proxy_logger.add(updated_original_logger)
-          proxy_logger.add(new_file_logger)
-
-          if defined?(::ActiveSupport::Logger) && log_instance.is_a?(::ActiveSupport::Logger)
-            Rails.logger = proxy_logger
-          elsif defined?(::Sidekiq::Logger) && log_instance.is_a?(::Sidekiq::Logger)
-            Sidekiq.configure_server do |config|
-              config.logger = proxy_logger
-            end
-          elsif defined?(::ScoutTestLogger) && log_instance.is_a?(::ScoutTestLogger)
-            TestLoggerWrapper.logger = proxy_logger
-          end
-        end
-
-        def create_file_logger
-          Loggers::Logger.new(context, log_instance).create_logger!
-        end
-
-        def create_proxy_log_dir!
-          Utils.ensure_directory_exists(context.config.value('logs_proxy_log_dir'))
-        end
-      end
-    end
-  end
-end