buffering_logger 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f49590098cb33d87ab8d0114a978908743fe30357604b07dad8e11f5ec999fc2
-  data.tar.gz: fab5895b8c82b7b08f7b50229eb6f6672afe07ea0ee832982e2637230c7f2b5c
+  metadata.gz: dc9b82663dc5ffc6178d13c3083c561de7586ce1c6e3d33e97265a1d29704ab4
+  data.tar.gz: ee87cca077521602967459410da53d0e067391ba6ee9d3f7e47179e0f2fe0208
 SHA512:
-  metadata.gz: 2e6e3304cacc56982a8c1348f8d6911013c6192230ed1e2b8fda53f668bdf76d526b206102877f1b33daa3e369a734f3d413d802f074f05e6e2a6e76f011c6fb
-  data.tar.gz: 3ab02da9c65ff13366f77f1b5935d5d4249357cc0110a71480c3041715f3b7d57454ac0de0009d4b49d1662445bc70bc18711a3e145901c4c1cdca5df12f8529
+  metadata.gz: bbc41e536016932cc8c5b1e5e2c814eb6089d0605d1843335ce63e403250b3a09c49168d7e2e52570db41766c079284f4b5fa961924a161df9c3e4a521fcd52d
+  data.tar.gz: 4cbddf5dce7fe3d1413c9487f3a3b6f56d6de8d578dab6dd8aca79a591a0018586987cd100202967179b41eaab962b54c0838c5b7ddd519820c350b39a5702bf

data/lib/buffering_logger/rails_rack_log_request_id.rb

@@ -0,0 +1,20 @@
+#
+# With buffered logs we don't need to log the request_id on every line.
+# Instead we log it once near the start of the request.
+# We do this via a Rack middleware to ensure that it's logged even for things
+# like a `RoutingError` or other exceptional cases.
+#
+class BufferingLogger::RailsRackLogRequestId
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    request = ActionDispatch::Request.new(env)
+    Rails.logger.info("request_id=#{request.request_id.inspect}")
+
+    @app.call(env)
+  end
+
+end

data/lib/buffering_logger/railtie.rb

@@ -1,10 +1,14 @@
 require 'buffering_logger'
 require 'buffering_logger/rack_buffer'
+require 'buffering_logger/rails_rack_log_request_id'
 require 'rails/railtie'
 
 class BufferingLogger::Railtie < Rails::Railtie
 
-  def self.install(transform: nil, device: nil, sync: true)
+  def self.install(
+    transform: nil, device: nil, sync: true, request_id: true,
+    warn_log_tags: true, simple_formatter: true
+  )
     initializer :buffering_logger, :before => :initialize_logger do |app|
       device ||= begin
         # Does mostly the same things that Rails does. See http://git.io/2v9FxQ
@@ -23,17 +27,39 @@ class BufferingLogger::Railtie < Rails::Railtie
       device.sync = true if sync && device.respond_to?(:sync=)
 
       logger = BufferingLogger::Logger.new(device)
-      logger.formatter = app.config.log_formatter
+      logger.formatter = if simple_formatter
+        ActiveSupport::Logger::SimpleFormatter.new
+      else
+        app.config.log_formatter
+      end
       logger = ActiveSupport::TaggedLogging.new(logger)
 
       app.config.logger = logger
 
-      # Inserts at the very beginning so that all logs, even from other
+      # We insert this at the very beginning so that all logs, even from other
       # middleware, get buffered together.
       app.config.middleware.insert(
         0,
-        BufferingLogger::RackBuffer, logger, transform: transform,
+        BufferingLogger::RackBuffer,
+        logger,
+        transform: transform,
       )
+
+      # Log the request_id
+      if request_id
+        app.config.middleware.insert_after(
+          Rails::Rack::Logger,
+          BufferingLogger::RailsRackLogRequestId,
+        )
+      end
+
+      if warn_log_tags && app.config.log_tags.present?
+        puts(<<~TEXT.squish)
+          NOTE: You're using `Rails.application.config.log_tags` with
+          BufferingLogger. We recommend disabling these when using
+          BufferingLogger. See the README for more info.
+        TEXT
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buffering_logger
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jordan Brough
@@ -22,6 +22,7 @@ files:
 - lib/buffering_logger/logger.rb
 - lib/buffering_logger/rack_buffer.rb
 - lib/buffering_logger/rails.rb
+- lib/buffering_logger/rails_rack_log_request_id.rb
 - lib/buffering_logger/railtie.rb
 - lib/buffering_logger/single_line_transform.rb
 homepage: https://github.com/jordan-brough/buffering_logger