simple_json_log_formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bae50427131ba2bc0fba6d8cbefdfc55079824aa
-  data.tar.gz: 7c14c6b45a817d1340c58178398f36a5a6cbbe9e
+  metadata.gz: 08c34b6646691ead6f6b302670589ad504a4c4cf
+  data.tar.gz: 843a9a6a6982d7b856b3dab5cb509e4dee8834bc
 SHA512:
-  metadata.gz: c7536be431dabf0856966b04ca18fed86bcd828747ceed1b2c0ef0da983621aaada5576f32c1f570a32db800bff7bcc1d206c883eb65a5ea466892a6b22febf6
-  data.tar.gz: c2fbf635daaffdafe520c098e4b6e5b0c4f5faa20f62be8a76547c9abbfa1a2f27ef110cc0cd902501811030527dcce3f7919914bf04843525338f3fcd85d99a
+  metadata.gz: 55801d55d135b6dc21ec4e9f4d33f24ba163bac9324759f0604b4b6c1c1e13c717826b8100a359e8bbac4217c8376a23822b345635c8f03e31a1a189155c410b
+  data.tar.gz: fad61c69945f8739a114f3a2bf1509e95d3b807587ceca81cfba9b5e885001c1747f52831e1b5b41b82b146a551a939fcbe2cbf4822daa2c42beee458fe2235a

data/.gitignore

@@ -1,11 +1,13 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+*.gem
+.bundle/
+.yardoc
+_yardoc/
+coverage/
+doc/
+log/
+pkg/
+spec/reports/
+tmp/
 Gemfile.lock
 
 # rspec failure tracking

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 taogawa
+Copyright (c) 2018 Takeshi Ogawa
+Copyright (c) 2015 Naotoshi Seo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,9 @@
 # SimpleJsonLogFormatter
 
+Json formatter for Ruby logger.
+
+This project is based on [LtsvLogFormatter](https://github.com/sonots/ltsv_log_formatter) and modified for json.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +22,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'logger'
+require 'simple_json_log_formatter'
+logger = Logger.new
+logger.formatter = SimpleJsonLogFormatter.new
+```
+
+### Rails
+
+Configure at `config/application.rb` or `config/environments/*.rb`
+
+```ruby
+# config/application.rb
+# OR
+# config/environments/*.rb
+config.log_formatter = SimpleJsonLogFormatter.new
+```
+
+### Options
+
+- time_key
+    - Change the key name of the time field. Set nil to remove. Default: time
+- severity_key
+    - Change the key name of the severity field. Set nil to remove. Default: severity
+- progname_key
+    - Change the key name of the progname field. Set nil to remove. Default: progname
+- message_key
+    - Change the key name for the message field. Default: message
+- datetime_format
+    - Change date and time format of the time field. Default: `%FT%T%:z`
+
+```ruby
+logger.formatter = SimpleJsonLogFormatter.new(time_key: "log_time", progname_key: nil)
+```
 
 ## Development
 
@@ -28,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_json_log_formatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/taogawa/simple_json_log_formatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/simple_json_log_formatter.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require "simple_json_log_formatter/version"
-require "logger"
 require "json"
 
 class SimpleJsonLogFormatter
@@ -10,6 +9,7 @@ class SimpleJsonLogFormatter
   # @param [Hash] opts
   # @option opts [String] time_key (default: time)
   # @option opts [String] severity_key (default: severity)
+  # @option opts [String] progname_key (default: progname)
   # @option opts [String] message_key (default: message)
   # @option opts [String] datetime_format (default: nil)
   def initialize(opts={})
@@ -18,31 +18,23 @@ class SimpleJsonLogFormatter
     @opts[:severity_key] = :severity unless @opts.has_key?(:severity_key)
     @opts[:progname_key] = :progname unless @opts.has_key?(:progname_key)
     @opts[:message_key] ||= :message
-    @opts[:datetime_format] = @opts.dig(:datetime_format)
+    @opts[:datetime_format] = "%FT%T%:z" unless @opts.has_key?(:datetime_format)
   end
 
   def call(severity, time, progname, msg)
-    log = [*format_time(time), *format_severity(severity), *format_progname(progname), *format_message(msg)].to_h
-    "#{log.to_json}\n"
+    event = {}
+    event[@opts[:time_key]] = time.strftime(@opts[:datetime_format]) if @opts[:time_key]
+    event[@opts[:severity_key]] = severity if @opts[:severity_key]
+    event[@opts[:progname_key]] = progname if @opts[:progname_key]
+    event[@opts[:message_key]] = format_message(msg)
+    "#{event.to_json}\n"
   end
 
   private
-    def format_time(time)
-      { @opts[:time_key] => time.strftime(@opts.dig(:datetime_format) || "%FT%T%:z") } if @opts[:time_key]
-    end
-
-    def format_severity(severity)
-      { @opts[:severity_key] => severity } if @opts[:severity_key]
-    end
-
-    def format_progname(progname)
-      { @opts[:progname_key] => progname } if @opts[:progname_key]
-    end
-
     def format_message(msg)
       if msg.is_a?(String) && msg.start_with?("{") && msg.end_with?("}")
         msg = (JSON.parse(msg) rescue nil) || msg
       end
-      { @opts[:message_key] => msg }
+      msg
     end
 end

data/lib/simple_json_log_formatter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class SimpleJsonLogFormatter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_json_log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - taogawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler