scout_apm_logging 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a99a84cd9f8dd023b8717c81e5d80b17c99f5afb8c7e7edb6152193ef7fecdf
-  data.tar.gz: b9d2e44b40adcb5f9acc13f6ef6d2176e79ed6b056f6e6d1e8f9f0359857ebf6
+  metadata.gz: a55380380a6a30ccfe38b8a7b117e02e2aa8c3ffc09a679f194c0b93ed1f4062
+  data.tar.gz: 0131aa6a8d6ed072553996fe58b5a4e3d1f1170e656dda3b8283bbad301f56e8
 SHA512:
-  metadata.gz: 1f73329ada6fde049cf1ffe18ad2d43c0fa09158cffcc10e51c58f897d9cd40f1aa2636ee645e2b26d7a36204e082ca318c5281e8e32759aaac2b685a4ff5f32
-  data.tar.gz: 664471524c4802ad23cfeee6299a56259d07e7a9a9d2fb241393202b4116946052f695982ada22c3060a39fca25f351ce6a90487e329283bc264749e6ee56738
+  metadata.gz: ddada293aa30a8c806e6ca1e7d318b5a2f412f990d2bd5e2eeb81e5ddd10d661a7362571c105d776f7c5adbeecd4d6adf788ba505c6d6b811f8824f30485550e
+  data.tar.gz: 825aba7b09c6075bcb0230b18b582eb37daa08d0c2eff45c781c73efa8a058dbae4498e1702e14438320a3bf618aae52d738b81aabfa7e87b825a1efed827da8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.6
+* Ensure logger level is set back to the original.
+
+## 0.0.5
+* Remove `msg` attribute after it has been moved to the log body to prevent duplication.
+
 ## 0.0.4
 * Fix memoizing of log attributes, which could lead to persistent attributes.
 

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

@@ -25,7 +25,7 @@ module ScoutApm
 
           FileLogger.new(determine_file_path, LOG_AGE, log_size).tap do |logger|
             # Ruby's Logger handles a lot of the coercion itself.
-            logger.level = context.config.value('logs_capture_level')
+            logger.level = determined_log_level
             # Add our custom formatter to the logger.
             logger.formatter = Formatter.new
           end
@@ -55,6 +55,16 @@ module ScoutApm
 
         private
 
+        # This makes the assumption that the logs we capture should be
+        # at least that of the original logger level, and not lower, but can be
+        # configured to be a higher cutoff.
+        def determined_log_level
+          capture_level = context.config.value('logs_capture_level')
+          capture_value = ::Logger::Severity.const_get(capture_level.upcase)
+
+          [capture_value, log_instance.level].max
+        end
+
         def find_log_destination(logdev)
           dev = try(logdev, :filename) || try(logdev, :dev)
           if dev.is_a?(String)

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

@@ -46,6 +46,7 @@ module ScoutApm
             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
           end

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

@@ -41,6 +41,7 @@ module ScoutApm
             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
           end

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

@@ -41,6 +41,7 @@ module ScoutApm
             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
           end

data/lib/scout_apm/logging/monitor/collector/configuration.rb

@@ -95,6 +95,8 @@ module ScoutApm
                     - 'set(attributes["raw_bytes"], body)'
                     # Replace the body with the log message.
                     - 'set(body, attributes["msg"])'
+                    # Remove the msg attribute.
+                    - 'delete_key(attributes, "msg")'
                     # Move service.name attribute to resource attribute.
                     - 'set(resource.attributes["service.name"], attributes["service.name"])'
               batch:

data/lib/scout_apm/logging/version.rb

@@ -2,6 +2,6 @@
 
 module ScoutApm
   module Logging
-    VERSION = '0.0.4'
+    VERSION = '0.0.6'
   end
 end

data/spec/integration/rails/lifecycle_spec.rb

@@ -47,6 +47,7 @@ describe ScoutApm::Logging do
     expect(messages.count('[TEST] Some log')).to eq(1)
     expect(messages.count('[YIELD] Yield Test')).to eq(1)
     expect(messages.count('Another Log')).to eq(1)
+    expect(messages.count('Should not be captured')).to eq(0)
 
     log_locations = lines.map { |item| item['log_location'] }.compact
 

data/spec/rails/app.rb

@@ -12,6 +12,7 @@ Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
 
 class App < ::Rails::Application
   config.eager_load = false
+  config.log_level = :info
 
   routes.append do
     root to: 'root#index'
@@ -24,6 +25,8 @@ class RootController < ActionController::Base
     Rails.logger.tagged('TEST').info('Some log')
     Rails.logger.tagged('YIELD') { logger.info('Yield Test') }
     Rails.logger.info('Another Log')
+    Rails.logger.debug('Should not be captured')
+
     render plain: Rails.version
   end
 end

data/spec/unit/loggers/capture_spec.rb

@@ -19,6 +19,7 @@ describe ScoutApm::Logging::Loggers::Capture do
     ENV['SCOUT_MONITOR_INTERVAL'] = '10'
     ENV['SCOUT_MONITOR_INTERVAL_DELAY'] = '10'
     ENV['SCOUT_LOGS_MONITOR'] = 'true'
+    ENV['SCOUT_LOGS_CAPTURE_LEVEL'] = 'debug'
 
     output_from_log = capture_stdout do
       context = ScoutApm::Logging::Context.new
@@ -26,7 +27,10 @@ describe ScoutApm::Logging::Loggers::Capture do
       conf = ScoutApm::Logging::Config.with_file(context, conf_file)
       context.config = conf
 
-      TestLoggerWrapper.logger = ScoutTestLogger.new($stdout)
+      test_logger = ScoutTestLogger.new($stdout)
+      test_logger.level = 'INFO'
+
+      TestLoggerWrapper.logger = test_logger
 
       capture = ScoutApm::Logging::Loggers::Capture.new(context)
       capture.setup!
@@ -34,16 +38,22 @@ describe ScoutApm::Logging::Loggers::Capture do
       expect(TestLoggerWrapper.logger.class).to eq(ScoutApm::Logging::Loggers::Proxy)
 
       TestLoggerWrapper.logger.info('TEST')
+      TestLoggerWrapper.logger.debug('SHOULD NOT CAPTURE')
 
       log_path = File.join(context.config.value('logs_proxy_log_dir'), 'test.log')
       content = File.read(log_path)
       expect(content).to include('TEST')
 
+      # Shouldn't capture. While the log_capture_level was set to debug,
+      # the original logger instance had a higher log level of info.
+      expect(content).not_to include('SHOULD NOT CAPTURE')
+
       state_file = File.read(context.config.value('monitor_state_file'))
       state_data = JSON.parse(state_file)
       expect(state_data['logs_monitored']).to eq([log_path])
     end
 
     expect(output_from_log).to include('TEST')
+    expect(output_from_log).not_to include('SHOULD NOT CAPTURE')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm_logging
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scout_apm