scout_apm_logging 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4dc1a11fe63b4c983636958676d8ca7e76bb04c5281bdabd272373deaf83e5
-  data.tar.gz: 70809502cbbfb93a9cc73e26329f4e52b57008f51f9e34b3769fdfb17b2d46f4
+  metadata.gz: a74ddd478e8429ef76315b9bdb23557583719b0ed241f0fecb1c0a6658b4efe7
+  data.tar.gz: 72bc063672bff254e893c196662c69cc06934297379e21ee3482e15974b4f465
 SHA512:
-  metadata.gz: b3a17d497a14d952294dd23ce5eac8605f7cee5da807ba53cc312acafbe314c33a303d75d97ac828f3ea1aba40e733da1104aa655866121e7f3c149afc9935cb
-  data.tar.gz: 3515ffc8593bc564318859e0fb7340f82c2c066509a82411091b8e5e21bb4abcb223e1318d83b76a12ac11986db22bf4abaec5f511d6c07bdcaa5cc32742b7fd
+  metadata.gz: 4f5ba120cff4d9087ce213736477eebb687159b126f415bf7e6ea2c3ddbf7b6058aa48b605f91031d4883af1b20019010a4f01ee6871b1fda79b5ff02cf29111
+  data.tar.gz: f029117cdc4d4b83d26dd5cbb67a9ac7f64fac72c67763d97bb6a712b3f566a0d9661a463c6f563b86aa18369e69188f6251e3c791035e6c737bc6155e5c2ae8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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.
+
 ## 0.0.3
 * **Feature**: Add support for TaggedLogging.
 * Add ability to customize file logger size. Increase default size to 10MiB.

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

@@ -12,12 +12,15 @@ module ScoutApm
       class Formatter < ::Logger::Formatter
         DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%LZ'
 
-        def call(severity, time, progname, msg) # rubocop:disable Metrics/AbcSize
-          attributes_to_log[:severity] = severity
-          attributes_to_log[:time] = format_datetime(time)
+        def call(severity, time, progname, msg)
+          attributes_to_log = {
+            severity: severity,
+            time: format_datetime(time),
+            pid: Process.pid.to_s,
+            msg: msg2str(msg)
+          }
+
           attributes_to_log[:progname] = progname if progname
-          attributes_to_log[:pid] = Process.pid.to_s
-          attributes_to_log[:msg] = msg2str(msg)
           attributes_to_log['service.name'] = service_name
 
           attributes_to_log.merge!(scout_layer)
@@ -30,10 +33,6 @@ module ScoutApm
 
         private
 
-        def attributes_to_log
-          @attributes_to_log ||= {}
-        end
-
         def format_datetime(time)
           time.utc.strftime(DATETIME_FORMAT)
         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.3'
+    VERSION = '0.0.5'
   end
 end

data/spec/integration/rails/lifecycle_spec.rb

@@ -48,6 +48,11 @@ describe ScoutApm::Logging do
     expect(messages.count('[YIELD] Yield Test')).to eq(1)
     expect(messages.count('Another Log')).to eq(1)
 
+    log_locations = lines.map { |item| item['log_location'] }.compact
+
+    # Verify that log attributes aren't persisted
+    expect(log_locations.size).to eq(1)
+
     # Kill the rails process. We use kill as using any other signal throws a long log line.
     Process.kill('KILL', rails_pid)
     # Kill the process and ensure PID file clean up

data/spec/rails/app.rb

@@ -20,6 +20,7 @@ end
 
 class RootController < ActionController::Base
   def index
+    Rails.logger.warn('Add location log attributes')
     Rails.logger.tagged('TEST').info('Some log')
     Rails.logger.tagged('YIELD') { logger.info('Yield Test') }
     Rails.logger.info('Another Log')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm_logging
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Scout APM
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scout_apm
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby Logging Support