logcraft 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2256a97ecb30662f543512b9ace85cabe956a49ee4407f0f3575a56ff36055bd
-  data.tar.gz: 89a522ff6b287c903110b9df445f201a65955a52edf371bd3df125691dfa3482
+  metadata.gz: 1553a9ab5e60ffb3beab51543cefcca10632c655fafa559ed18fe123dad9243a
+  data.tar.gz: 673ea0771ff8846f9b191f1ab745233cc6002dc2b454b92b97a4e5a8088dea33
 SHA512:
-  metadata.gz: 2cefe4bd29be7ccabaedd3503e3d135fa05f95128d939df500d516644d1cb7fab18aaf8a410a1077bf549b345dfa2cf773dee01baba5d941d47e9a95828c14fd
-  data.tar.gz: 915fcd06110d9e200652d5f9bbe62c3d9a3ee49151e7147df68855d4d58639a3ac7788df74b2ca3c037984c4a5026b2e923494849408731c10584fdae0b0054c
+  metadata.gz: d440d1fb9a136f36e30911912ec79fff375ad4086b87697399e6530422d92e8749307ac043acdec270a04d507281e009d5f2bf86f5c01ab00192e40de34149d8
+  data.tar.gz: 5a207a0a5ed398a1ecd95db4252cd0455c265f8a93b4b3b22ab7a60f852d2b8b072ee59366117665476fd35730c134aac958b16d2f1c3670bcf538f08773ea97

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.1] - 2022-10-07
+### Fixed
+- Fixed a bug where request log tracing didn't work with the DataDog integration. Had to move up logging
+  the request to the point where the middleware is done processing instead of where we originally had it;
+  at the time when the response body was closed. We lost some precision in terms of measuring request duration
+  but some context (e.g. DataDog active trace) would not be available otherwise.
+
 ## [2.0.0] - 2022-07-31
 ### Added
 - Added the option to change the log level or suppress logging of unhandled errors which are, in fact,

data/README.md

@@ -274,6 +274,17 @@ ActiveSupport::JSON.encode test: 'foo > bar'
 I highly recommend using the [Oj](https://github.com/ohler55/oj) gem which - if present - will be automatically
 picked up by Logcraft, as it is significantly faster and will serialize your messages as you would expect.
 
+In a nutshell:
+```ruby
+# With default ActiveSupport serialization
+Rails.logger.info 'foo > bar'
+#=> {...,"message":"foo \u003e bar"}
+
+# With Oj
+Rails.logger.info 'foo > bar'
+#=> {...,"message":"foo > bar"}
+```
+
 ## Configuration options
 
 ### Rails configuration

data/lib/logcraft/rails/request_logger.rb

@@ -14,13 +14,9 @@ module Logcraft
         request = ActionDispatch::Request.new env
 
         instrumentation_start request
-
         status, headers, body = @app.call env
-        request_id = Logging.mdc[:request_id]
-        body = ::Rack::BodyProxy.new(body) do
-          instrumentation_finish request
-          log_request request, status, start_time, request_id
-        end
+        body = ::Rack::BodyProxy.new(body) { instrumentation_finish request }
+        log_request request, status, start_time
 
         [status, headers, body]
       rescue Exception => ex
@@ -47,22 +43,18 @@ module Logcraft
         instrumenter.finish 'request.action_dispatch', request: request
       end
 
-      def log_request(request, status, start_time, request_id = nil)
+      def log_request(request, status, start_time)
         return if path_ignored? request
 
         end_time = current_time_in_milliseconds
-        message = {
-          message: '%s %s - %i (%s)' % [request.method, request.filtered_path, status, Rack::Utils::HTTP_STATUS_CODES[status]],
-          remote_ip: request.remote_ip,
-          method: request.method,
-          path: request.filtered_path,
-          params: params_to_log(request),
-          response_status_code: status,
-          duration: end_time - start_time,
-          duration_sec: (end_time - start_time) / 1000.0
-        }
-        message[:request_id] = request_id if request_id
-        @logger.info message
+        @logger.info message: '%s %s - %i (%s)' % [request.method, request.filtered_path, status, Rack::Utils::HTTP_STATUS_CODES[status]],
+                     remote_ip: request.remote_ip,
+                     method: request.method,
+                     path: request.filtered_path,
+                     params: params_to_log(request),
+                     response_status_code: status,
+                     duration: end_time - start_time,
+                     duration_sec: (end_time - start_time) / 1000.0
       end
 
       def path_ignored?(request)

data/lib/logcraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logcraft
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logcraft
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Zoltan Ormandi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-31 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - zoltan.ormandi@gmail.com
 executables: []
@@ -120,7 +120,7 @@ metadata:
   homepage_uri: https://github.com/zormandi/logcraft
   source_code_uri: https://github.com/zormandi/logcraft
   changelog_uri: https://github.com/zormandi/logcraft/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A zero-configuration structured logging solution for pure Ruby or Ruby on
   Rails projects.