logcraft 2.0.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2256a97ecb30662f543512b9ace85cabe956a49ee4407f0f3575a56ff36055bd
-  data.tar.gz: 89a522ff6b287c903110b9df445f201a65955a52edf371bd3df125691dfa3482
+  metadata.gz: e77bb5b3fd57a71991d2d62ad60b405d3aec4c204e9aca74d5b8aad73938fbce
+  data.tar.gz: ef7f87bcb528b05c9d2a0499a50d00184a949f1d018091fe25e7b5fcacea535d
 SHA512:
-  metadata.gz: 2cefe4bd29be7ccabaedd3503e3d135fa05f95128d939df500d516644d1cb7fab18aaf8a410a1077bf549b345dfa2cf773dee01baba5d941d47e9a95828c14fd
-  data.tar.gz: 915fcd06110d9e200652d5f9bbe62c3d9a3ee49151e7147df68855d4d58639a3ac7788df74b2ca3c037984c4a5026b2e923494849408731c10584fdae0b0054c
+  metadata.gz: eae1d4bfb0b539d0850fb306562244e73da2ff4a1745bdd378b9d10cb00dbedfa87938209327a8188bb9ca775827ba09ba1091f2a7a097417d85378cecabe2d0
+  data.tar.gz: beb08ae116067d4feed050d8049cbbf97579fa00e905e669709ca0eb433ebfd1a13bef5dbdfbbed5ac85937704f5aa0b5671038f818a45165f29b7d51379393a

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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.1] - 2023-06-13
+### Added
+- Added support for custom log formatters.
+
+## [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

@@ -27,17 +27,17 @@ structured logging solution.
 ## Table of contents
 
 * [Installation](#installation)
-  * [Rails](#rails)
-  * [Non-Rails applications](#non-rails-applications)
+    * [Rails](#rails)
+    * [Non-Rails applications](#non-rails-applications)
 * [Usage](#usage)
-  * [Structured logging](#structured-logging)
-    * [Adding context information to log messages](#adding-context-information-to-log-messages)
-  * [Rails logging](#rails-logging)
-    * [The log level](#the-log-level)
-    * [JSON serialization](#json-serialization)
+    * [Structured logging](#structured-logging)
+        * [Adding context information to log messages](#adding-context-information-to-log-messages)
+    * [Rails logging](#rails-logging)
+        * [The log level](#the-log-level)
+        * [JSON serialization](#json-serialization)
 * [Configuration options](#configuration-options)
-  * [Rails configuration](#rails-configuration)
-  * [Non-Rails configuration](#non-rails-configuration)
+    * [Rails configuration](#rails-configuration)
+    * [Non-Rails configuration](#non-rails-configuration)
 * [Integration with DataDog](#integration-with-datadog)
 * [RSpec support](#rspec-support)
 * [Development](#development)
@@ -190,7 +190,7 @@ In more detail:
 
 * The `Rails.logger` is set up to be a Logcraft logger with the name `Application`.
 * Rails's default logging of uncaught errors is modified and instead of spreading the error message across several
-  lines, Logcraft log every uncaught error in 1 line (per error), including the error's name and context (stack trace,
+  lines, Logcraft logs every uncaught error in 1 line (per error), including the error's name and context (stack trace,
   etc.).
 * Most importantly, Rails's default request logging - which logs several lines per event during the processing of an
   action - is replaced by Logcraft's own access log middleware. The end result is an access log that
@@ -215,7 +215,7 @@ Processing by PagesController#welcome as HTML
 Completed 200 OK in 31ms (Views: 27.3ms | ActiveRecord: 0.0ms)
 
 With Logcraft:
-{"timestamp":"2022-06-26T18:07:08.103+02:00","level":"INFO","logger":"AccessLog","hostname":"MacbookPro.local","pid":80908,"request_id":"9a43631b-284c-4677-9d08-9c1cc5c7d3a7","message":"GET /welcome?subsession_id=34ea8596f9764f475f81158667bc2654 - 200 (OK)","remote_ip":"127.0.0.1","method":"GET","path":"/welcome?subsession_id=34ea8596f9764f475f81158667bc2654","params":{"subsession_id":"34ea8596f9764f475f81158667bc2654","controller":"pages","action":"welcome"},"response_status_code":200,"duration":13,"duration_sec":0.013}
+{"timestamp":"2022-06-26T18:07:08.103+02:00","level":"INFO","logger":"AccessLog","hostname":"MacbookPro.local","pid":80908,"request_id":"9a43631b-284c-4677-9d08-9c1cc5c7d3a7","message":"GET /welcome?subsession_id=34ea8596f9764f475f81158667bc2654 - 200 (OK)","remote_ip":"127.0.0.1","method":"GET","path":"/welcome?subsession_id=34ea8596f9764f475f81158667bc2654","params":{"subsession_id":"34ea8596f9764f475f81158667bc2654","controller":"pages","action":"welcome"},"response_status_code":200,"duration":31,"duration_sec":0.031}
 
 Formatted for readability:
 {
@@ -235,8 +235,8 @@ Formatted for readability:
     "action": "welcome"
   }, 
   "response_status_code": 200, 
-  "duration": 13, 
-  "duration_sec": 0.013
+  "duration": 31, 
+  "duration_sec": 0.031
 }
 ```
 
@@ -274,6 +274,18 @@ 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
@@ -282,8 +294,9 @@ Logcraft provides the following configuration options for Rails:
 
 | Option                                                | Default value            | Description                                                                                                                                                          |
 |-------------------------------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| logcraft.global_context                               | `{}`                     | A global log context that will be included in every log message. Must be either a Hash or a lambda/Proc returning a Hash.                                            |
-| logcraft.layout_options                               | `{}`                     | Custom options for the log layout. Currently only the `level_formatter` option is supported (see examples).                                                          |
+| logcraft.global_context                               | `{} \| lambda \| proc`   | A global log context that will be included in every log message. Must be either a Hash or a lambda/proc returning a Hash.                                            |
+| logcraft.layout_options.formatter                     | `lambda \| proc`         | A custom formatter for the entire log event. Must return a single string (see examples for usage).                                                                   |
+| logcraft.layout_options.level_formatter               | `lambda \| proc`         | A custom formatter for the log level specifically (see examples for usage).                                                                                          |
 | logcraft.access_log.logger_name                       | `'AccessLog'`            | The name of the logger emitting access log messages.                                                                                                                 |
 | logcraft.access_log.exclude_paths                     | `[]`                     | A list of paths (array of strings or RegExps) not to include in the access log.                                                                                      |
 | logcraft.access_log.log_only_whitelisted_params       | `false`                  | If `true`, the access log will only contain whitelisted parameters.                                                                                                  |
@@ -294,7 +307,7 @@ Logcraft provides the following configuration options for Rails:
 Examples:
 
 ```ruby
-# Use these options in your Rails configuration files (e.g. application.rb)
+# Use these options in your Rails configuration files (e.g. config/application.rb or config/environments/*.rb)
 
 # Set up a global context you want to see in every log message
 config.logcraft.global_context = -> do
@@ -304,10 +317,13 @@ config.logcraft.global_context = -> do
   }
 end
 
+# Set up a custom log formatter (e.g. output logs in YAML format in the development environment - config/environments/development.rb)
+config.logcraft.layout_options.formatter = ->(event) { YAML.dump event } 
+# or just make the JSON more readable
+config.logcraft.layout_options.formatter = ->(event) { JSON.pretty_generate(event) + "\n----------------\n" }
+
 # Set up a custom log level formatter (e.g. Ougai-like numbers)
-config.logcraft.layout_options = {
-  level_formatter: ->(level_number) { (level_number + 2) * 10 }
-}
+config.logcraft.layout_options.level_formatter = ->(level_number) { (level_number + 2) * 10 }
 Rails.logger.error('Boom!')
 # => {...,"level":50,"message":"Boom!"}
 
@@ -345,7 +361,7 @@ config.logcraft.global_context = -> do
       service: correlation.service.to_s,
       version: correlation.version.to_s
     },
-    ddsource: ['ruby']
+    ddsource: 'ruby'
   }
 end
 ```

data/lib/logcraft/log_layout.rb

@@ -4,16 +4,20 @@ require 'time'
 
 module Logcraft
   class LogLayout < Logging::Layout
+    JSON_FORMATTER = ->(event) { MultiJson.dump(event) + "\n" }.freeze
+    LOGGING_LEVEL_FORMATTER = ->(level) { Logging::LNAMES[level] }.freeze
+
     def initialize(global_context = {}, options = {})
       @global_context = global_context
-      @level_formatter = options.fetch :level_formatter, ->(level) { Logging::LNAMES[level] }
+      @formatter = options.fetch :formatter, JSON_FORMATTER
+      @level_formatter = options.fetch :level_formatter, LOGGING_LEVEL_FORMATTER
     end
 
     def format(event)
       log_entry = background_of(event).merge evaluated_global_context,
                                              dynamic_log_context,
                                              message_from(event.data)
-      MultiJson.dump(log_entry) + "\n"
+      @formatter.call log_entry
     end
 
     private

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/railtie.rb

@@ -6,7 +6,7 @@ module Logcraft
   class Railtie < ::Rails::Railtie
     config.logcraft = ActiveSupport::OrderedOptions.new
     config.logcraft.global_context = {}
-    config.logcraft.layout_options = {}
+    config.logcraft.layout_options = ActiveSupport::OrderedOptions.new
 
     config.logcraft.access_log = ActiveSupport::OrderedOptions.new
     config.logcraft.access_log.logger_name = 'AccessLog'

data/lib/logcraft/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logcraft
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: '2.1'
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-31 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging