logcraft 2.0.1 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1553a9ab5e60ffb3beab51543cefcca10632c655fafa559ed18fe123dad9243a
-  data.tar.gz: 673ea0771ff8846f9b191f1ab745233cc6002dc2b454b92b97a4e5a8088dea33
+  metadata.gz: f83b1cb57e7d3a8072d8fc2d7b5b7d952cd9f96eb72edecb88244179384d4f61
+  data.tar.gz: 2f679955495954defc5ba217f0ef36318f0fae6e8d050c48b834c582b8742ff8
 SHA512:
-  metadata.gz: d440d1fb9a136f36e30911912ec79fff375ad4086b87697399e6530422d92e8749307ac043acdec270a04d507281e009d5f2bf86f5c01ab00192e40de34149d8
-  data.tar.gz: 5a207a0a5ed398a1ecd95db4252cd0455c265f8a93b4b3b22ab7a60f852d2b8b072ee59366117665476fd35730c134aac958b16d2f1c3670bcf538f08773ea97
+  metadata.gz: ad933459ec43e29bcf9c13627d591ded635601e1a2df160c7178c98abadb5f103bacdd3b160d5ab7900b83fa0b254d701be6eaeb7e1277dfc211a76303f4b376
+  data.tar.gz: a1693794447ab3fc3180c9aa905d397fd4ae7f4e23fe7474d7c7817cfef8acecf41935db8f4a1589ee691133af7186d486d60a7df432ff02230a089483010fcf

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.2] - 2023-10-23
+### Added
+- Added support for Rails 7.1.
+
+## [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

data/Gemfile

@@ -6,8 +6,8 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'rails', '~> 7.0.0'
-  gem 'rspec-rails', '~> 4.0'
+  gem 'rails', '~> 7.1.0'
+  gem 'rspec-rails', '~> 6.0'
   gem 'sqlite3', '~> 1.4'
   gem 'net-smtp', require: false
 end

data/README.md

@@ -17,6 +17,7 @@ Logcraft's purpose is threefold:
 Logcraft supports:
 
 * [Ruby](https://www.ruby-lang.org) 2.6 and up (tested with 2.6, 2.7, 3.0 and 3.1)
+* [Rails](https://rubyonrails.org/) 5 and up (tested with 5.2, 6.0, 6.1, 7.0 and 7.1)
 * [Rails](https://rubyonrails.org/) 5 and up (tested with 5.2, 6.0, 6.1 and 7.0)
 * [Sidekiq](https://github.com/mperham/sidekiq) integration is provided via
   the [Logcraft::Sidekiq](https://github.com/zormandi/logcraft-sidekiq) gem
@@ -27,17 +28,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 +191,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 +216,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 +236,8 @@ Formatted for readability:
     "action": "welcome"
   }, 
   "response_status_code": 200, 
-  "duration": 13, 
-  "duration_sec": 0.013
+  "duration": 31, 
+  "duration_sec": 0.031
 }
 ```
 
@@ -275,6 +276,7 @@ I highly recommend using the [Oj](https://github.com/ohler55/oj) gem which - if
 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'
@@ -293,8 +295,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.                                                                                                  |
@@ -305,7 +308,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
@@ -315,10 +318,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!"}
 
@@ -356,7 +362,7 @@ config.logcraft.global_context = -> do
       service: correlation.service.to_s,
       version: correlation.version.to_s
     },
-    ddsource: ['ruby']
+    ddsource: 'ruby'
   }
 end
 ```

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logcraft.gemspec
+gemspec path: '..'
+
+group :test do
+  gem 'rails', '~> 7.1.0'
+  gem 'rspec-rails', '~> 6.0'
+  gem 'sqlite3', '~> 1.4'
+  gem 'net-smtp', require: false
+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/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'
@@ -45,7 +45,11 @@ module Logcraft
     end
 
     config.before_configuration do |app|
-      app.config.logger = Logcraft.logger 'Application'
+      app.config.logger = if defined? ActiveSupport::BroadcastLogger
+                            ActiveSupport::BroadcastLogger.new Logcraft.logger('Application')
+                          else
+                            Logcraft.logger 'Application'
+                          end
       app.config.log_level = ENV['LOG_LEVEL'] || :info
     end
   end

data/lib/logcraft/rspec/helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Ezlog
+module Logcraft
   module RSpec
     module Helpers
       def log_output_is_expected

data/lib/logcraft/rspec.rb

@@ -7,7 +7,7 @@ require_relative 'rspec/matchers'
 require_relative 'log_layout'
 
 RSpec.configure do |config|
-  config.include Ezlog::RSpec::Helpers
+  config.include Logcraft::RSpec::Helpers
   config.before(:suite) do
     Logging.appenders.string_io('__logcraft_stringio__', layout: Logging.logger.root.appenders.first&.layout || Logcraft::LogLayout.new)
     config.capture_log_messages to: '__logcraft_stringio__'

data/lib/logcraft/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logcraft
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: '2.2'
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -97,6 +97,7 @@ files:
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
 - lib/logcraft.rb
 - lib/logcraft/log_context_helper.rb
 - lib/logcraft/log_layout.rb
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A zero-configuration structured logging solution for pure Ruby or Ruby on