scout_apm_logging 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d85bd807f130a6b0187f898a42d6d703a2c21d21a2aac03a7dcc4d1141e1b8e
-  data.tar.gz: 936a7d718eb3f2d8b05d6694ab15b56dae548996d9dd24c7b4aca5a1eccadbbf
+  metadata.gz: aea114282e91583732d4a4b3246273d0b18ae3b2e5b784366b5a18691889391b
+  data.tar.gz: dd625a2eb6bede54138bb05ef3671ad1a98995d59f1c5de28d033fd617d156b6
 SHA512:
-  metadata.gz: 1c6765bc549891c2156e0d8d31b6d74862541a07685b9d81408ab14d65d5c42b83565c441a8c1520027f73db60bbb65b82778195ef358ec9a95a7b8c7bae60be
-  data.tar.gz: eb22f6ab71fcd15e13f3725b999ae7597161ae5f716b00f0649a8d74535747df3426b09f7a0244521ac9e16c627a0120373a73791bef1cbbfa00914e59d63df5
+  metadata.gz: 4d62832832aa309c9bd66c5cabe2d6c4c23472452bd0f3b9874741febd5f0a5f6716dfea8ff5e929075424ea998a89eb0edb947da9959d0bf03da334a9502158
+  data.tar.gz: 94ab281a893c87b2d1b979b4b8fa7c9c2bd0e467983b302c0f0931b04f582dc6dc2c6b9c3c19b83ad14b79ece26a6b4a5f0c7e6cda492b6b840c133ec9d7d5f2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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.
+
 ## 0.0.10
 * Remove capitalization from action name in the formatter, to match that of the standard format.
 

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

@@ -46,12 +46,18 @@ module ScoutApm
 
           name, action = layer.name.split('/')
 
-          return {} unless name && action
+          return {} unless name
 
           updated_name = name.split('_').map(&:capitalize).join
 
           derived_key = "#{layer.type.downcase}_entrypoint".to_sym
-          derived_value_of_scout_name = "#{updated_name}#{layer.type.capitalize}##{action}"
+
+          # For background jobs, we won't have an action.
+          derived_value_of_scout_name = if action
+                                          "#{updated_name}#{layer.type.capitalize}##{action}"
+                                        else
+                                          name
+                                        end
 
           { derived_key => derived_value_of_scout_name }
         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/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

@@ -4,7 +4,9 @@ module ScoutApm
   module Logging
     module Loggers
       # Holds both the original application logger and the new one. Relays commands to both.
-      class Proxy
+      class Proxy < BasicObject
+        include ::Kernel
+
         def self.create_with_loggers(*loggers)
           new.tap do |proxy_logger|
             loggers.each { |logger| proxy_logger.add_scout_loggers(logger) }
@@ -25,6 +27,25 @@ module ScoutApm
           @loggers
         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 class
+          ::Logger
+        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

@@ -50,11 +50,11 @@ module ScoutApm
               logger.formatter = log_instance.formatter
 
               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/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.10'
+    VERSION = '0.0.12'
   end
 end

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.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scout_apm
@@ -94,6 +94,7 @@ files:
 - 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