json_tagged_logger 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde9c968aab725f59b4d0002b2e318b286edb8e8b7790222d1002e51ce631e6e
-  data.tar.gz: 97e23c6b02ec7faa8869659c59ef8ba1f2bc200cd607b4e248d2e8a7e74cab5f
+  metadata.gz: f290019420ad4691086787da1f7c2982383eaae9812bc2eb1874778ce5d00718
+  data.tar.gz: 9a52e70773163bd3428612d56b1f723bd50550763f84710eda06aec1a02cd9a7
 SHA512:
-  metadata.gz: 2c21e9f1e126a80a8160587f04d30ca7ccd83433471e78c017320734d570f3cb43935e78bf8bd0a858d114c98fd2fc2115b45363f9e0e283d4c3d6ba182dd94e
-  data.tar.gz: be70dcda430a3341613c09c85eebcc66f98c9361658192808ab6fb9b0bd63b498713e8ff907fad6c6ce116dead29c302acb11c8bb51bf91edd5e8a6b3df880ab
+  metadata.gz: 902135acc6779b5d4a5f63313a8f0ced0125d08998d61ebf77064dd4159764cb14bac9353a11f0efc70a02cc99bed628eaea25dbbd95169dc79c3ef5b782d786
+  data.tar.gz: 3ad70d7851f82976ac866d1ad3553670f3122c8476429de4064d71333214cadbebcfb7e9af1d013151c04f83ff5d8038ce52cc7fd88fb453c7bf8529074aae50

data/README.md

@@ -62,7 +62,7 @@ will get you something like
 }
 ```
 
-[Note: I've pretty-printed the output in these examples for easier reading. The actual log output will be on a single line without extra whitespace.]
+[_Note_: By default, `JsonTaggedLogger::Formatter` outputs logs as single lines without extra whitespace. Setting `JsonTaggedLogger::Formatter#pretty_print` to `true` will pretty print the logs, as I've done in these examples.]
 
 Importantly, if the controller action (or any code it calls along the way) has an explicit call to `Rails.logger.tagged("TAG").info("tagged log message")`, you'll get the same key/value tags (`request_id`, `host`, `my_param`, &c.) in the JSON document along with a `tags` key:
 

data/lib/json_tagged_logger/formatter.rb

@@ -3,6 +3,12 @@ require 'json'
 
 module JsonTaggedLogger
   class Formatter
+    attr_accessor :pretty_print
+
+    def initialize(pretty_print: false)
+      @pretty_pretty = pretty_print
+    end
+
     def call(severity, _time, _progname, message)
       log = {
         level: severity,
@@ -36,7 +42,7 @@ module JsonTaggedLogger
         end
       end
 
-      log.compact.to_json + "\n"
+      format_for_output(log)
     end
 
     private
@@ -69,5 +75,17 @@ module JsonTaggedLogger
         message
       end
     end
+
+    def format_for_output(log_hash)
+      compacted_log = log_hash.compact
+
+      output_json = if pretty_print
+                      JSON.pretty_generate(compacted_log)
+                    else
+                      JSON.generate(compacted_log)
+                    end
+
+      output_json + "\n"
+    end
   end
 end

data/lib/json_tagged_logger/version.rb

@@ -1,3 +1,3 @@
 module JsonTaggedLogger
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_tagged_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sean Santry