logist 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52997b31f4c651b9349bf9427a4844956269c5f58973db7094231652b99ad7e6
-  data.tar.gz: f8e631686dd4d2511aad0153d718031a8d3455c0bf31cde2f25a63c72fd0c687
+  metadata.gz: 6e6ad3e32e005fb5cd93ab69c54a65cda28d6c39339084d0d85ab0d506478cb8
+  data.tar.gz: fba3d6f1f25d24836fbe8bc63d0e45f7061001144b4b9b472898cda2dfc3e4ca
 SHA512:
-  metadata.gz: 696cc510043ead76af46528791e5db536527bd978ddf005e1051ab062eabd84b85235655a43fffacff728a871e7386bda1f240fa8bb22d26e922f1298bbae5b0
-  data.tar.gz: ef66a241b788823ebca6b6a0e5efc807fcd5c57dbda8c3e43d138a5ce3e23f2fe451de67684e52d5c063278f305e57195df79731e2ae16afadf33da72a9b76a9
+  metadata.gz: 1d9c68a45b69f8a44f3416359582d60a3ad3b7cc6c2e801f76d9f3b5712a2afa40440d9220da527abfe8fa9582fcf810e4b2f6a01ee96bdf48925007e219b299
+  data.tar.gz: fbb266f39ea4f7175e1a55a683092944885a15152ad13bc790dfd3572140cb068f149fefee7814859547dbf93382347d0be660eb0321bb8e077cf7e6deb972e6

data/README.md

@@ -66,6 +66,25 @@ Rails.application.configure do
 end
 ```
 
+### flat_json option
+
+If you want to log Hash object, but you don't want to have nested JSON, you can set `flat_json=true`:
+
+```ruby
+config.logger.formatter.flat_json = true
+```
+
+When `flat_json=false` (default):
+
+```json
+{"level":"INFO","message":{"foo":"bar"}}
+```
+
+When `flat_json=true`:
+
+```json
+{"level":"INFO","foo":"bar"}
+```
 
 
 ## Development

data/lib/logist/formatter/json.rb

@@ -5,23 +5,29 @@ require 'rails'
 module Logist
   module Formatter
     class Json < ::Logger::Formatter
-      def call(severity, timestamp, progname, msg)
-        { level: severity, timestamp: format_datetime(timestamp), environment: ::Rails.env, message: format_message(msg) }.to_json + "\n"
-      end
+      attr_accessor :flat_json
+
+      def call(severity, timestamp, progname, raw_msg)
+        msg = normalize_message(raw_msg)
+        payload = { level: severity, timestamp: format_datetime(timestamp), environment: ::Rails.env }
 
-      def format_message(msg)
-        case msg.class.name
-          when "Hash"
-            msg
-          when "Array"
-            msg
-          else
-            begin
-              JSON.parse(msg)
-            rescue JSON::ParserError
-              "#{msg}"
-            end
+        if flat_json && msg.is_a?(Hash)
+          payload.merge!(msg)
+        else
+          payload.merge!(message: msg)
         end
+
+        payload.to_json << "\n"
+      end
+
+      private
+
+      def normalize_message(raw_msg)
+        return raw_msg unless raw_msg.is_a?(String)
+
+        JSON.parse(raw_msg)
+      rescue JSON::ParserError
+        raw_msg
       end
     end
   end

data/lib/logist/logger.rb

@@ -14,17 +14,25 @@ module Logist
     end
 
     def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
-                   progname: nil, formatter: nil, datetime_format: nil,
+                   progname: nil, formatter: nil, datetime_format: nil, flat_json: false,
                    shift_period_suffix: '%Y%m%d')
       # I think that Logist should support other formats in the future.
       # But, as it is now, Logist only support json format.
       # So this line force json format all environments.
       @formatter = Logist::Formatter::Json.new
       @formatter.datetime_format = datetime_format
+      @formatter.flat_json = flat_json
       super(logdev, shift_age, shift_size, level: level,
             progname: progname, formatter: @formatter, datetime_format: datetime_format,
             shift_period_suffix: shift_period_suffix)
-      after_initialize if respond_to? :after_initialize
+
+      # https://github.com/rails/rails/pull/34055
+      # even with ^ respond_to?(:after_initialize) is still true
+      # but we know not to run it if ActiveSupport::LoggerSilence is defined, since that was added in the same rails version
+      # via https://github.com/rails/rails/pull/34045
+      if !defined?(ActiveSupport::LoggerSilence) && respond_to?(:after_initialize)
+        after_initialize
+      end
     end
   end
 end

data/lib/logist/version.rb

@@ -1,3 +1,3 @@
 module Logist
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logist
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - AkiraFukushima
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,7 +128,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Change log format to json in Rails.
 test_files: []