json_tagged_logger 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d6a91dae71312da17de8ad46580f46a3a5d7c6c20d8e1444107734cb7775c49
-  data.tar.gz: 159b9a61bf557b8324c2d1c1f3dd03e4fc2f37625996046e7de29fd2b2f05a0f
+  metadata.gz: f290019420ad4691086787da1f7c2982383eaae9812bc2eb1874778ce5d00718
+  data.tar.gz: 9a52e70773163bd3428612d56b1f723bd50550763f84710eda06aec1a02cd9a7
 SHA512:
-  metadata.gz: 43d1c8b1d1905f04271bdb538618e4b24d6b1eefc1d2864d01c38949ae5b1f6dcfccc0af60254136667cef7dd345becf52cf65169030818f911d4d56c7abdf4f
-  data.tar.gz: 06fd82f28251e33f49a31273d415f76d4d9a5b1fc085b05a707722b3be9046f96148731f64324c9a44f6cbc86c2a3769d44652c893713f7fd4553173e35df1d9
+  metadata.gz: 902135acc6779b5d4a5f63313a8f0ced0125d08998d61ebf77064dd4159764cb14bac9353a11f0efc70a02cc99bed628eaea25dbbd95169dc79c3ef5b782d786
+  data.tar.gz: 3ad70d7851f82976ac866d1ad3553670f3122c8476429de4064d71333214cadbebcfb7e9af1d013151c04f83ff5d8038ce52cc7fd88fb453c7bf8529074aae50

data/README.md

@@ -1,5 +1,7 @@
 # JsonTaggedLogger
 
+[![Build Status](https://github.com/santry/json_tagged_logger/actions/workflows/ci.yml/badge.svg)](https://github.com/santry/json_tagged_logger/actions/workflows/ci.yml)
+
 `JsonTaggedLogger` works in conjunction with [`ActiveSupport::TaggedLogging`](https://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html) and (optionally) [Lograge](https://github.com/roidrage/lograge) to produce JSON-formatted log output. By itself, `ActiveSupport::TaggedLogging` supports simple tagging. With `JsonTaggedLogger`, you can compose key/value pairs, simple tags, and the log message itself into a single JSON document for easy consumption and parsing in log aggregators.
 
 ## Usage
@@ -60,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

@@ -1,5 +1,14 @@
+require 'active_support/core_ext/hash/keys'
+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,
@@ -10,7 +19,7 @@ module JsonTaggedLogger
       json_tags.each { |t| log.merge!(t) }
 
       if text_tags.present?
-        log[:tags] = text_tags
+        log[:tags] = text_tags.to_a
       end
 
       bare_message = message_without_tags(message)
@@ -21,13 +30,19 @@ module JsonTaggedLogger
         parsed_message = bare_message
       ensure
         if parsed_message.is_a?(Hash)
-          log.merge!(parsed_message.symbolize_keys)
+          parsed_message.symbolize_keys!
+          if log.has_key?(:tags) && parsed_message.has_key?(:tags)
+            parsed_message[:tags] = parsed_message[:tags] + log[:tags]
+          end
+
+          log.merge!(parsed_message)
         else
+          #binding.irb
           log.merge!(msg: parsed_message.strip)
         end
       end
 
-      log.compact.to_json + "\n"
+      format_for_output(log)
     end
 
     private
@@ -60,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/log_tags_config.rb

@@ -1,13 +1,17 @@
+require 'action_dispatch'
+
 module JsonTaggedLogger
   class LogTagsConfig
     def self.generate(*tags)
       tags.map do |tag|
-        if tag.is_a?(Proc) && tag.arity == 1
+        if tag.is_a?(String)
+          tag
+        elsif tag.is_a?(Proc) && tag.arity == 1
           tag
         elsif tag.is_a?(Symbol) && ActionDispatch::Request.method_defined?(tag)
           -> (request) { { tag => request.send(tag) }.to_json }
         else
-          raise ArgumentError, "Only symbols that ActionDispatch::Request responds to or single-argument Procs allowed. You provided '#{tag.inspect}'."
+          raise ArgumentError, "Only strings, symbols that ActionDispatch::Request responds to or single-argument Procs allowed. You provided '#{tag.inspect}'."
         end
       end
     end

data/lib/json_tagged_logger/logger.rb

@@ -1,3 +1,6 @@
+require 'active_support'
+require 'active_support/tagged_logging'
+
 module JsonTaggedLogger
   module Logger
     def self.new(logger)

data/lib/json_tagged_logger/tag_from_session.rb

@@ -1,3 +1,5 @@
+require 'action_dispatch'
+
 module JsonTaggedLogger
   module TagFromSession
     def self.get(log_label, session_key = log_label)

data/lib/json_tagged_logger/version.rb

@@ -1,3 +1,3 @@
 module JsonTaggedLogger
-  VERSION = "0.2.1"
+  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.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Sean Santry
@@ -9,7 +9,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: Formatter for logging with ActiveSupport::TaggedLogging as JSON
 email:
 - sean@santry.us
@@ -38,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="