lumberjack_json_device 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b9e1a335053608bb8428db2f6828acd748c02ec0610c0c064e060ab94fe36c
-  data.tar.gz: 9a1bf5cb6cce667cde7837624be8db44826976abb4c07c9568481d89efd38c16
+  metadata.gz: 5056428eb1c260cf68a1742064c824645ef8df0c71164a20fd8f03bb5b3f1bbc
+  data.tar.gz: 69ff5c7d4c88a90b5be63b9d77724b4c36f090a109791c0819bbe0f97934d0f7
 SHA512:
-  metadata.gz: 3226afbeeb3c72a0e60b940e26fa47973882d6f5770dff91d0d859087c0399a033c1dd54982da74a03fddd8e8fc7acc2849773b0a20bf362d1c4551314a5ba4e
-  data.tar.gz: 2068343690c36690deda5c7c6b91d9c9f1ba8663ad375f28f064ab88d9acdb9ffdb8912b04611c4898363c024bcc01d9e6fca8ab8293a58db3a72992234ff4b7
+  metadata.gz: 03f44e6637e5fd9df15ccef421ebafcc035498ff272afae0c3845997bfd63099a11bc2425051fa4a94e8bf20eef7419ee961511b6fcba1a675537fc8ebaf28f3
+  data.tar.gz: a5a0bfdc425825484dd1cd0c95ea788919189c594cf5fb7ed55107e14655b7be55a2826f71758b2b1c93e91695c2506f84eeacc690e88919b579da339abddba0

data/CHANGE_LOG.md

@@ -4,6 +4,15 @@ 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.0
+
+### Changed
+
+- The `as_json` method for custom JSON serialization is now supported. This gives more consistent results when serializing non-primitive objects types. Some JSON parsing libraries and Rails will use this method, but the core `JSON` library does not which can result in unexpected behavior.
+- Keep the order of keys in the payload so that the first keys are always time, severity, message, etc.
+- Key mappings can now be specified using dot notation to nest attributes in the JSON document.
+- Depends on Lumberjack 1.4.
+
 ## 2.1.0
 
 ### Changed

data/README.md

@@ -186,7 +186,7 @@ param_filter = ActiveSupport::ParameterFilter.new(Rails.application.config.filte
 device = Lumberjack::JsonDevice.new(STDOUT, post_processor: ->(data) { param_filter.filter(data) }
 ```
 
-Note that all hash keys will be strings.If the post processor does not return a hash, it will be ignored.
+Note that all hash keys will be strings and the values will be JSON-safe. If the post processor does not return a hash, it will be ignored.
 
 ### Pretty Printing
 

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/lib/lumberjack_json_device.rb

@@ -2,6 +2,7 @@
 
 require "lumberjack"
 require "json"
+require "time"
 
 module Lumberjack
   # This Lumberjack device logs output to another device as JSON formatted text with one document per line.
@@ -160,28 +161,30 @@ module Lumberjack
       data = {}
       set_attribute(data, @time_key, entry.time) if @time_key
       set_attribute(data, @severity_key, entry.severity_label) if @severity_key
-      set_attribute(data, @message_key, entry.message) if @message_key
-      set_attribute(data, @progname_key, entry.progname) if @progname_key
+      set_attribute(data, @message_key, json_safe(entry.message)) if @message_key
+      set_attribute(data, @progname_key, json_safe(entry.progname)) if @progname_key && entry.progname
       set_attribute(data, @pid_key, entry.pid) if @pid_key
 
-      tags = Lumberjack::Utils.expand_tags(entry.tags) if entry.tags
+      tags = entry.tags.transform_values { |value| json_safe(value) } if entry.tags
+
       extracted_tags = nil
       if @custom_keys.size > 0 && !tags&.empty?
         extracted_tags = []
         @custom_keys.each do |name, key|
-          set_attribute(data, key, tag_value(tags, name))
-          extracted_tags << name
-        end
+          name = name.is_a?(Array) ? name.join(".") : name.to_s
+          value = tags.delete(name)
+          next if value.nil?
 
-        extracted_tags.each do |path|
-          tags = deep_remove_tag(tags, path, entry.tags)
+          value = Lumberjack::Utils.expand_tags(value) if value.is_a?(Hash)
+          set_attribute(data, key, value)
+          extracted_tags << name
         end
       end
 
-      if @tags_key
-        tags ||= {}
+      if @tags_key && !tags&.empty?
+        tags = Lumberjack::Utils.expand_tags(tags)
         if @tags_key == "*"
-          data = tags.merge(data) unless tags.empty?
+          tags.each { |k, v| data[k] = v unless data.include?(k) }
         else
           set_attribute(data, @tags_key, tags)
         end
@@ -198,44 +201,6 @@ module Lumberjack
 
     private
 
-    def tag_value(tags, name)
-      return nil if tags.nil?
-      return tags[name] unless name.is_a?(Array)
-
-      val = tags[name.first]
-      return val if name.length == 1
-      return nil unless val.is_a?(Hash)
-
-      tag_value(val, name[1, name.length])
-    end
-
-    def deep_remove_tag(tags, path, original_tags)
-      return nil if tags.nil?
-
-      dup_needed = tags.equal?(original_tags)
-      key = path.first
-      val = tags[key] if path.length > 1
-      unless val.is_a?(Hash)
-        if tags.include?(key)
-          tags = tags.dup if dup_needed
-          tags.delete(key)
-        end
-        return tags
-      end
-
-      new_val = deep_remove_tag(val, path[1, path.length], original_tags[key])
-      if new_val.empty? || !new_val.equal?(val)
-        tags = tags.dup if dup_needed
-        if new_val.empty?
-          tags.delete(key)
-        else
-          tags[key] = new_val
-        end
-      end
-
-      tags
-    end
-
     def set_attribute(data, key, value)
       return if value.nil?
 
@@ -243,6 +208,8 @@ module Lumberjack
         value = @time_formatter.call(value)
       end
 
+      key = key.split(".") if key.is_a?(String) && key.include?(".")
+
       if key.is_a?(Array)
         unless key.empty?
           if key.size == 1
@@ -258,7 +225,7 @@ module Lumberjack
           deep_merge!(data, Lumberjack::Tags.stringify_keys(hash))
         end
       else
-        data[key] = value unless key.nil?
+        data[key.to_s] = value unless key.nil?
       end
     end
 
@@ -295,5 +262,22 @@ module Lumberjack
         end
       end
     end
+
+    def json_safe(value)
+      return nil if value.nil?
+
+      # Check if the as_json method is defined takes no parameters
+      as_json_arity = value.method(:as_json).arity if value.respond_to?(:as_json)
+
+      if as_json_arity == 0 || as_json_arity == -1
+        value.as_json
+      elsif value.is_a?(Hash)
+        value.transform_values { |v| json_safe(v) }
+      elsif value.is_a?(Enumerable)
+        value.collect { |v| json_safe(v) }
+      else
+        value
+      end
+    end
   end
 end

data/lumberjack_json_device.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.5"
 
-  spec.add_dependency "lumberjack", ">=1.3.3"
+  spec.add_dependency "lumberjack", ">=1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_json_device
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '1.4'
 description:
 email:
 - bbdurand@gmail.com