scout_apm_logging 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820ef17ae470e00a8860d6cb25ba09fb908c5c1c2396a564144e8336be787c0f
-  data.tar.gz: 3338d6fbdc74aa519db27e0017b23af3ede6f6bf7a1e3df4c10ca798e6bc6331
+  metadata.gz: 55f7d2c11024d2dba505a31f9a95face612da9befd41e70cce442655e5647711
+  data.tar.gz: 0d4b6f542d73fd0b435296e465f814b1593d7d52ae5dd31d7b07965c3e52e2a6
 SHA512:
-  metadata.gz: 2e2e011988efb53ed021f0003efab939181af9df79f5ac7b90eea773c0cbf87641f410ea34b4904022bce5ab37f310287e4a04293bee53c66d9d16d988b0aa20
-  data.tar.gz: '086fd228d639e53c693e05d9cd43f6200cd38f3df7dfa087e1f609fc51dec9b1621e51f06bf1c68eddaed19188c0772250b7249fa550e7a3f5d96a45519cd8f6'
+  metadata.gz: 35c113e4c84c336657d4a312385f7b23328518112be3f7a0a234eca56fd66422d264121dd0dbd19bf206ef309904ab9b3a4d40a4b50741185966979a8cb4c1a3
+  data.tar.gz: 6e196f2c3625af8ecc6d898a653be40f1e61511e9e20a4b7a30f5a9efa93c3eba6fda5f6bbcb3d43546800ae64b5b1fdd879d697a57f9e4e740e82b4ee350a3e

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.0.9
+* Add Scout Transaction ID to log attributes.
+
+## 0.0.8
+* Fix internal method names for proxy logger to prevent accidental overriding.
+* Re-broadcast to console in development for the proxy logger.
+* Fix tags not being removed when yielded contents throw an exception.
+* Fix missing return statement, where tagged logging patches were being added to unintended loggers.
+
 ## 0.0.7
 * Fix determined logger level comparison
 

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

@@ -12,7 +12,7 @@ module ScoutApm
       class Formatter < ::Logger::Formatter
         DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%LZ'
 
-        def call(severity, time, progname, msg)
+        def call(severity, time, progname, msg) # rubocop:disable Metrics/AbcSize
           attributes_to_log = {
             severity: severity,
             time: format_datetime(time),
@@ -23,6 +23,7 @@ module ScoutApm
           attributes_to_log[:progname] = progname if progname
           attributes_to_log['service.name'] = service_name
 
+          attributes_to_log.merge!(scout_transaction_id)
           attributes_to_log.merge!(scout_layer)
           attributes_to_log.merge!(scout_context)
           # Naive local benchmarks show this takes around 200 microseconds. As such, we only apply it to WARN and above.
@@ -66,6 +67,10 @@ module ScoutApm
           user_context.transform_keys { |key| "user.#{key}" }.merge(extra_context)
         end
 
+        def scout_transaction_id
+          { "scout_transaction_id": ScoutApm::RequestManager.lookup.transaction_id }
+        end
+
         def local_log_location
           # Should give us the last local stack which called the log within just the last couple frames.
           last_local_location = caller[0..15].find { |path| path.include?(Rails.root.to_s) }

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

@@ -3,7 +3,9 @@
 module ScoutApm
   module Logging
     module Loggers
+      # The actual instance of the logger.
       class FileLogger < ::Logger
+        include ::ActiveSupport::LoggerSilence if const_defined?('::ActiveSupport::LoggerSilence')
       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,8 +11,8 @@ module ScoutApm
         # Patches TaggedLogging to work with our loggers.
         module TaggedLogging
           def tagged(*tags) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-            super(*tags) unless (self == ::Rails.logger && is_a?(ScoutApm::Logging::Loggers::Proxy)) ||
-                                (::Rails.logger.respond_to?(:broadcasts) && ::Rails.logger.broadcasts.include?(self))
+            return super(*tags) unless (self == ::Rails.logger && is_a?(ScoutApm::Logging::Loggers::Proxy)) ||
+                                       (::Rails.logger.respond_to?(:broadcasts) && ::Rails.logger.broadcasts.include?(self))
 
             if is_a?(ScoutApm::Logging::Loggers::Proxy)
               if block_given?
@@ -20,8 +20,13 @@ module ScoutApm
                 loggers = @loggers[1..]
                 pushed_counts = extend_and_push_tags(loggers, *tags)
 
-                formatter.tagged(*tags) { yield self }.tap do
+                begin
+                  formatter.tagged(*tags) { yield self }.tap do
+                    logger_pop_tags(loggers, pushed_counts)
+                  end
+                rescue StandardError => e
                   logger_pop_tags(loggers, pushed_counts)
+                  raise e
                 end
               else
                 loggers = instance_variable_get(:@loggers)
@@ -36,9 +41,13 @@ module ScoutApm
               # We skip the first logger to prevent double tagging when calling formatter.tagged
               loggers = ::Rails.logger.broadcasts[1..]
               pushed_counts = extend_and_push_tags(loggers, *tags)
-
-              formatter.tagged(*tags) { yield self }.tap do
+              begin
+                formatter.tagged(*tags) { yield self }.tap do
+                  logger_pop_tags(loggers, pushed_counts)
+                end
+              rescue StandardError => e
                 logger_pop_tags(loggers, pushed_counts)
+                raise e
               end
             else
               broadcasts = ::Rails.logger.broadcasts

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

@@ -7,7 +7,7 @@ module ScoutApm
       class Proxy
         def self.create_with_loggers(*loggers)
           new.tap do |proxy_logger|
-            loggers.each { |logger| proxy_logger.add(logger) }
+            loggers.each { |logger| proxy_logger.add_scout_loggers(logger) }
           end
         end
 
@@ -15,11 +15,11 @@ module ScoutApm
           @loggers = []
         end
 
-        def add(logger)
+        def add_scout_loggers(logger)
           @loggers << logger
         end
 
-        def remove(logger)
+        def remove_scout_loggers(logger)
           @loggers.reject! { |inst_log| inst_log == logger }
 
           @loggers

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

@@ -38,7 +38,7 @@ module ScoutApm
           end
 
           # Eseentially creates the original logger.
-          def 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
@@ -48,6 +48,14 @@ module ScoutApm
             ::Logger.new(original_logdevice).tap do |logger|
               logger.level = log_instance.level
               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?(
+                  logger, $stdout, $stderr
+                )
+
+                logger.extend(ActiveSupport::Logger.broadcast(ActiveSupport::Logger.new($stdout)))
+              end
             end
           end
 

data/lib/scout_apm/logging/version.rb

@@ -2,6 +2,6 @@
 
 module ScoutApm
   module Logging
-    VERSION = '0.0.7'
+    VERSION = '0.0.9'
   end
 end

metadata

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