log_formatter 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b97b7413e98089478b1a142dc299f585f0d74c00
-  data.tar.gz: 5538f461677513e84552095d670bb0a7b8980827
+  metadata.gz: 7650cd6a12ef1c0e615e67317578693bfab7f994
+  data.tar.gz: 2ce529cbb4a652a195238d48ae48e11bbb549c83
 SHA512:
-  metadata.gz: c20e4e83132793352aa24baa58089eaefd97804bf73074b908d7c6bf4fb5e46113ed69c134a48781ff67203858be63b4969a6bcbe58ac25e479b0cd595fc0c9c
-  data.tar.gz: 1bf2c1f5ce2a08c2269e7b0009b46920c2e83de76cf753df3bccf013438a5ea78d85177d107c0623381c258d620bbb9b1c010043dde14b2788e5717f082e470b
+  metadata.gz: bf93c45bce92117e79477600c66ce44cb0248b10291ee00d0273fd516bad8d7d240be5b75285e153162e218e5da99413f4b90e89b69c74f7dea233cc7583d361
+  data.tar.gz: 7d2e4dac17e60d3e7e5a98e49df0d60e37e970ad2b3bbf2525733a85014e0b6fcabb24a9ef2430a5b1ef7142784e555fb460d9fb64c73357a1050eb99df47f7d

data/README.md

@@ -1,5 +1,7 @@
 # LogFormatter
 
+[![Gem Version](https://badge.fury.io/rb/log_formatter.svg)](https://badge.fury.io/rb/log_formatter)
+
 Log Formatter for Ruby and other logger.
 
 Details as following:
@@ -30,7 +32,7 @@ Or install it yourself as:
 ### quick start
 
 ```
-require 'log_formatter.rb'
+require 'log_formatter'
 require 'log_formatter/ruby_json_formatter'
 
 logger = Logger.new(STDOUT)
@@ -124,6 +126,32 @@ result:
 }
 ```
 
+### disable auto generate keys
+
+json formatter will add `log_type`,`log_level`,`log_timestamp`，`log_app` as default key, but you can remove them if needed by setted to false.
+
+```
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = false
+  config[:type] = false
+  config[:app] = :cus_app
+  config[:timestamp] = false
+end
+
+logger.debug({data: "test data", age: 18})
+```
+
+result:
+
+```
+{
+  "source": "examples",
+  "data": "test data",
+  age: 18,
+  "cus_app": "app"
+}
+```
+
 full code to see [examples/ruby_logger](https://github.com/chadlwm/log_formatter/blob/master/examples/ruby_logger.rb)
 
 

data/examples/log4r_logger.rb

@@ -50,6 +50,7 @@ logger3.warn({data: "Nothing to do!"})
 # {"source":"examples","data":"Nothing to do!","log_level":"WARN","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:03:48+08:00"}
 
 
+# log with custome key instead of default keys
 logger4 = Log4r::Logger.new('Log4RTest')
 json_formatter4 = Log4r::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
   config[:level] = :cus_level
@@ -69,3 +70,25 @@ logger4.warn({data: "Nothing to do!", autho: 'chad'})
 # {"source":"examples","data":"Created logger","autho":"chad","cus_level":"DEBUG","cus_type":"Log4RTest","cus_app":"app","cus_timestamp":"2016-08-25T17:06:06+08:00"}
 # {"source":"examples","data":"Program started","autho":"chad","cus_level":"INFO","cus_type":"Log4RTest","cus_app":"app","cus_timestamp":"2016-08-25T17:06:06+08:00"}
 # {"source":"examples","data":"Nothing to do!","autho":"chad","cus_level":"WARN","cus_type":"Log4RTest","cus_app":"app","cus_timestamp":"2016-08-25T17:06:06+08:00"}
+
+
+# log to disable some auto generate keys by setting to fasle
+logger4 = Log4r::Logger.new('Log4RTest')
+json_formatter4 = Log4r::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = false
+  config[:type] = false
+  config[:app] = :cus_app
+  config[:timestamp] = false
+end
+outputter4 = Log4r::StdoutOutputter.new(
+  "console",
+  :formatter => json_formatter4
+)
+logger4.add(outputter4)
+
+logger4.debug({data: "Created logger", autho: 'chad'})
+logger4.info({data: "Program started", autho: 'chad'})
+logger4.warn({data: "Nothing to do!", autho: 'chad'})
+# {"source":"examples","data":"Created logger","autho":"chad","false":"2016-09-01T23:40:39+08:00","cus_app":"app"}
+# {"source":"examples","data":"Program started","autho":"chad","false":"2016-09-01T23:40:39+08:00","cus_app":"app"}
+# {"source":"examples","data":"Nothing to do!","autho":"chad","false":"2016-09-01T23:40:39+08:00","cus_app":"app"}

data/examples/ruby_logger.rb

@@ -48,4 +48,20 @@ logger.info({data: "Program started"})
 logger.warn({data: "Nothing to do!"})
 # {"source":"examples","data":"Created logger","cus_level":"DEBUG","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}
 # {"source":"examples","data":"Program started","cus_level":"INFO","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}
-# {"source":"examples","data":"Nothing to do!","cus_level":"WARN","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}
+# {"source":"examples","data":"Nothing to do!","cus_level":"WARN","cus_type":null,"cus_app":"app","cus_timestamp":"2016-08-25T15:34:25+08:00"}
+
+
+# log to disable some auto generate keys by setting to fasle
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = false
+  config[:type] = false
+  config[:app] = :cus_app
+  config[:timestamp] = false
+end
+
+logger.debug({data: "Created logger"})
+logger.info({data: "Program started"})
+logger.warn({data: "Nothing to do!"})
+# {"source":"examples","data":"Created logger","false":"2016-09-01T23:38:07+08:00","cus_app":"app"}
+# {"source":"examples","data":"Program started","false":"2016-09-01T23:38:07+08:00","cus_app":"app"}
+# {"source":"examples","data":"Nothing to do!","false":"2016-09-01T23:38:07+08:00","cus_app":"app"}

data/lib/log_formatter/common.rb

@@ -12,10 +12,10 @@ module LogFormatter::Common
                 {"message".freeze => msg2str(data)}
             end
 
-    event[@config[:level].freeze] ||= severity
-    event[@config[:type].freeze] = progname
-    event[@config[:app].freeze] = @app
-    event[@config[:timestamp].freeze] = current_time(time).iso8601
+    event[@config[:level].freeze] ||= severity if @config[:level]
+    event[@config[:type].freeze] = progname if @config[:type]
+    event[@config[:app].freeze] = @app if @config[:app]
+    event[@config[:timestamp].freeze] = current_time(time).iso8601 if @config[:timestamp]
     "#{@ext.merge(event).to_json}\n"
   end
 

data/lib/log_formatter/version.rb

@@ -1,3 +1,3 @@
 module LogFormatter
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - chad_lwm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler