log_formatter 0.4.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7650cd6a12ef1c0e615e67317578693bfab7f994
-  data.tar.gz: 2ce529cbb4a652a195238d48ae48e11bbb549c83
+  metadata.gz: c8fce49cc4dc2f320cbe2f591453422cf7f0e315
+  data.tar.gz: 966bbb62c55642ee918290df161591db121a6a07
 SHA512:
-  metadata.gz: bf93c45bce92117e79477600c66ce44cb0248b10291ee00d0273fd516bad8d7d240be5b75285e153162e218e5da99413f4b90e89b69c74f7dea233cc7583d361
-  data.tar.gz: 7d2e4dac17e60d3e7e5a98e49df0d60e37e970ad2b3bbf2525733a85014e0b6fcabb24a9ef2430a5b1ef7142784e555fb460d9fb64c73357a1050eb99df47f7d
+  metadata.gz: 678d72c6135557fb6e962ce6fb21d1afb18ee398fd57e89047a9f619a0f91389b2a95724e89233456917f36b488beb307bf6afc2e45553d2e1d0f3830332c44f
+  data.tar.gz: d24682ed71aa86ed5b522714f012491bb118e50cfaef2a90f96549b6bcbb60fde92a679c682756bb255a46d87b941df9d6104ef310a2c97378703c97ada3adaf

data/README.md

@@ -27,9 +27,9 @@ Or install it yourself as:
 
 ## Usage
 
-## Ruby Logger Json Formatter
+### Ruby Logger Json Formatter
 
-### quick start
+#### quick start
 
 ```
 require 'log_formatter'
@@ -55,7 +55,7 @@ result:
 }
 ```
 
-### set app and common ext info
+#### set app and common ext info
 
 ```
 logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'})
@@ -75,7 +75,7 @@ result:
 }
 ```
 
-### log with hash
+#### log with hash
 
 ```
 logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'})
@@ -97,7 +97,7 @@ result:
 }
 ```
 
-### reset the defaut key
+#### reset the defaut key
 
 json formatter will add `log_type`,`log_level`,`log_timestamp`，`log_app` as default key, but you can change them if needed.
 
@@ -126,7 +126,7 @@ result:
 }
 ```
 
-### disable auto generate keys
+#### 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.
 
@@ -155,9 +155,30 @@ result:
 full code to see [examples/ruby_logger](https://github.com/chadlwm/log_formatter/blob/master/examples/ruby_logger.rb)
 
 
-## Log4r JSON Formatter
+### Ruby Logger Text Formatter
 
-### Get Start
+#### Get Start
+
+```
+require 'log_formatter'
+require 'log_formatter/ruby_json_formatter'
+
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+
+logger.formatter = Ruby::JSONFormatter::Base.new
+
+logger.debug("Created logger")
+```
+
+other cases just same as ruby json formatter.
+
+full code to see [examples/ruby_text_logger](https://github.com/chadlwm/log_formatter/blob/master/examples/ruby_text_logger.rb)
+
+
+### Log4r JSON Formatter
+
+#### Get Start
 
 ```
 require 'log4r'
@@ -178,6 +199,7 @@ other cases just same as ruby json formatter.
 
 full code to see [examples/log4r_logger](https://github.com/chadlwm/log_formatter/blob/master/examples/log4r_logger.rb)
 
+
 ## Test with Rspec
 
 ```

data/examples/ruby_text_logger.rb

@@ -0,0 +1,66 @@
+require 'logger'
+require 'log_formatter'
+require 'log_formatter/ruby_text_formatter'
+
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+
+# plain initialize
+logger.formatter =  Ruby::TextFormatter::Base.new
+
+logger.debug("Created logger")
+logger.info("Program started")
+logger.warn("Nothing to do!")
+# message:Created logger	log_level:DEBUG	log_type:	log_app:	log_timestamp:2017-12-07T17:25:18+08:00
+# message:Program started	log_level:INFO	log_type:	log_app:	log_timestamp:2017-12-07T17:25:18+08:00
+# message:Nothing to do!	log_level:WARN	log_type:	log_app:	log_timestamp:2017-12-07T17:25:18+08:00
+
+# initialize with app and ext info
+logger.formatter =  Ruby::TextFormatter::Base.new('app', {'source': 'examples'})
+
+logger.debug("Created logger")
+logger.info("Program started")
+logger.warn("Nothing to do!")
+# source:examples	message:Created logger	log_level:DEBUG	log_type:	log_app:app	log_timestamp:2017-12-07T17:25:56+08:00
+# source:examples	message:Program started	log_level:INFO	log_type:	log_app:app	log_timestamp:2017-12-07T17:25:56+08:00
+# source:examples	message:Nothing to do!	log_level:WARN	log_type:	log_app:app	log_timestamp:2017-12-07T17:25:56+08:00
+
+# log hash
+logger.formatter =  Ruby::TextFormatter::Base.new('app', {'source': 'examples'})
+
+logger.debug({data: "Created logger"})
+logger.info({data: "Program started"})
+logger.warn({data: "Nothing to do!"})
+# source:examples	data:Created logger	log_level:DEBUG	log_type:	log_app:app	log_timestamp:2017-12-07T17:25:56+08:00
+# source:examples	data:Program started	log_level:INFO	log_type:	log_app:app	log_timestamp:2017-12-07T17:25:56+08:00
+# source:examples	data:Nothing to do!	log_level:WARN	log_type:	log_app:app	log_timestamp:2017-12-07T17:25:56+08:00
+
+# log with custome key instead of default keys
+logger.formatter =  Ruby::TextFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = :cus_level
+  config[:type] = :cus_type
+  config[:app] = :cus_app
+  config[:timestamp] = :cus_timestamp
+end
+
+logger.debug({data: "Created logger"})
+logger.info({data: "Program started"})
+logger.warn({data: "Nothing to do!"})
+# source:examples	data:Created logger	cus_level:DEBUG	cus_type:	cus_app:app	cus_timestamp:2017-12-07T17:25:56+08:00
+# source:examples	data:Program started	cus_level:INFO	cus_type:	cus_app:app	cus_timestamp:2017-12-07T17:25:56+08:00
+# source:examples	data:Nothing to do!	cus_level:WARN	cus_type:	cus_app:app	cus_timestamp:2017-12-07T17:25:56+08:00
+
+# log to disable some auto generate keys by setting to fasle
+logger.formatter =  Ruby::TextFormatter::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	cus_app:app
+# source:examples	data:Program started	cus_app:app
+# source:examples	data:Nothing to do!	cus_app:ap

data/lib/log_formatter/common.rb

@@ -1,24 +1,4 @@
 module LogFormatter::Common
-  def build_event(message, severity, time, progname)
-    data = message
-    if data.is_a?(String) && data.start_with?('{'.freeze)
-      data = (JSON.parse(message) rescue nil) || message
-    end
-
-    event = case data
-              when Hash
-                data
-              else
-                {"message".freeze => msg2str(data)}
-            end
-
-    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
-
   def msg2str(msg)
     case msg
     when ::String

data/lib/log_formatter/common_json.rb

@@ -0,0 +1,21 @@
+module LogFormatter::Common::JSON
+  def build_event(message, severity, time, progname)
+    data = message
+    if data.is_a?(String) && data.start_with?('{'.freeze)
+      data = (JSON.parse(message) rescue nil) || message
+    end
+
+    event = case data
+            when Hash
+              data
+            else
+              {"message".freeze => msg2str(data)}
+            end
+
+    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
+end

data/lib/log_formatter/common_text.rb

@@ -0,0 +1,25 @@
+module LogFormatter::Common::Text
+  def build_event(message, severity, time, progname)
+    data = message
+    if data.is_a?(String) && data.start_with?('{'.freeze)
+      data = (JSON.parse(message) rescue nil) || message
+    end
+
+    event = case data
+            when Hash
+              data
+            else
+              {"message".freeze => msg2str(data)}
+            end
+
+    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]
+    log_msg = []
+    @ext.merge(event).each do |k, v|
+      log_msg << "#{k}:#{v}"
+    end
+    log_msg.join("\t")+"\n"
+  end
+end

data/lib/log_formatter/log4r_json_formatter.rb

@@ -2,10 +2,12 @@ require 'log4r'
 require 'json'
 require 'time'
 require File.expand_path('../common', __FILE__)
+require File.expand_path('../common_json', __FILE__)
 
 module Log4r::JSONFormatter
   class Base < Log4r::BasicFormatter
     include LogFormatter::Common
+    include LogFormatter::Common::JSON
 
     def initialize(app = nil, ext = {})
       @app = app

data/lib/log_formatter/ruby_json_formatter.rb

@@ -2,15 +2,17 @@ require 'logger'
 require 'json'
 require 'time'
 require File.expand_path('../common', __FILE__)
+require File.expand_path('../common_json', __FILE__)
 
 module Ruby
   module JSONFormatter
     class Base < ::Logger::Formatter
       include LogFormatter::Common
+      include LogFormatter::Common::JSON
 
       def initialize(app = nil, ext = {})
         @app = app
-        @ext = ext.is_a?(Hash) ? ext : {}
+        @ext = ext.is_a?(Hash) ? ext : {ext_info: ext.inspect}
         @config = {
           level: :log_level,
           type: :log_type,

data/lib/log_formatter/ruby_text_formatter.rb

@@ -0,0 +1,31 @@
+require 'logger'
+require 'json'
+require 'time'
+require File.expand_path('../common', __FILE__)
+require File.expand_path('../common_text', __FILE__)
+
+module Ruby
+  module TextFormatter
+    class Base < ::Logger::Formatter
+      include LogFormatter::Common
+      include LogFormatter::Common::Text
+
+      def initialize(app = nil, ext = {})
+        @app = app
+        @ext = ext.is_a?(Hash) ? ext : {ext_info: ext.inspect}
+        @config = {
+          level: :log_level,
+          type: :log_type,
+          app: :log_app,
+          timestamp: :log_timestamp
+        }
+
+        yield @config if block_given?
+      end
+
+      def call(severity, time, progname, message)
+        @event = build_event(message, severity, time, progname)
+      end
+    end
+  end
+end

data/lib/log_formatter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.2
 platform: ruby
 authors:
 - chad_lwm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,10 +86,14 @@ files:
 - bin/setup
 - examples/log4r_logger.rb
 - examples/ruby_logger.rb
+- examples/ruby_text_logger.rb
 - lib/log_formatter.rb
 - lib/log_formatter/common.rb
+- lib/log_formatter/common_json.rb
+- lib/log_formatter/common_text.rb
 - lib/log_formatter/log4r_json_formatter.rb
 - lib/log_formatter/ruby_json_formatter.rb
+- lib/log_formatter/ruby_text_formatter.rb
 - lib/log_formatter/version.rb
 - log_formatter.gemspec
 homepage: https://github.com/chadlwm/log_formatter
@@ -112,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: log formatter