json_tagged_logger 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde9c968aab725f59b4d0002b2e318b286edb8e8b7790222d1002e51ce631e6e
-  data.tar.gz: 97e23c6b02ec7faa8869659c59ef8ba1f2bc200cd607b4e248d2e8a7e74cab5f
+  metadata.gz: 3c914a43a81cb199406223b8d4ab2cdf00a059139bda4eb75b4d8781fa6cff24
+  data.tar.gz: 3b1a1b1071facc268b4b5267863f8e3167fde5f6df7dd609db09c0124761ec90
 SHA512:
-  metadata.gz: 2c21e9f1e126a80a8160587f04d30ca7ccd83433471e78c017320734d570f3cb43935e78bf8bd0a858d114c98fd2fc2115b45363f9e0e283d4c3d6ba182dd94e
-  data.tar.gz: be70dcda430a3341613c09c85eebcc66f98c9361658192808ab6fb9b0bd63b498713e8ff907fad6c6ce116dead29c302acb11c8bb51bf91edd5e8a6b3df880ab
+  metadata.gz: 5b5016dc1565e4d02cc98187fd7a59c70fba7125770f01aa638bf23fc51f7d0a07d3677465296f0e4bd1d599fa3c102b6c55d2ae7ebfeaf9cb939836c0429dc4
+  data.tar.gz: 5a4bfce86d924b53577fc6be3111b1bcd76466a0c4a38f5aa9979f31b56a09c1509911b243294bcba25b34b8eb4f416e239c5ad8cbf03f4091538789d9645419

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

@@ -2,20 +2,24 @@ require 'action_dispatch'
 
 module JsonTaggedLogger
   module TagFromSession
-    def self.get(log_label, session_key = log_label)
+    def self.get(*simple_tags, **labeled_tags)
+      labels = simple_tags + labeled_tags.keys
+      session_keys = simple_tags + labeled_tags.values
+
       lambda do |request|
-        { log_label => get_value_from_session(request, session_key) }.to_json
+        values = get_values_from_session(request, session_keys)
+        labels.zip(values).to_h.to_json
       end
     end
 
     private
 
-    def self.get_value_from_session(request, key)
+    def self.get_values_from_session(request, keys)
       session_options = Rails.application.config.session_options
       session_store = Rails.application.config.session_store.new(Rails.application, session_options)
       session = ActionDispatch::Request::Session.create(session_store, request, session_options)
 
-      session[key]
+      keys.map { |k| session[k] }
     ensure
       # Clean up side effects from loading the session so it can be loaded as
       # usual during the normal request cycle. Leaving these headers in place

data/lib/json_tagged_logger/version.rb

@@ -1,3 +1,3 @@
 module JsonTaggedLogger
-  VERSION = "0.3.0"
+  VERSION = "0.5.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.5.0
 platform: ruby
 authors:
 - Sean Santry