log_formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eb86ba92366fe1b7bd2ce2e1ee8710f5291f6ac
-  data.tar.gz: aa7049e97734f880b43cf7602af22f745300faeb
+  metadata.gz: 90f99a541ff581ec9e24cbd0581175ebb8452706
+  data.tar.gz: 32d2812b82a6aadd54a92efd2e0afb1dedec60fe
 SHA512:
-  metadata.gz: a3f61442413c1996da8b32952d04647e9de7a892810d579728196dce62e804288a1f63bae32d400fdf25d07be4d13d700b075c966ca2f139c0ae8b516eebbeeb
-  data.tar.gz: 6340c09cd30f77bc15e0730858d9fea09d7b7751b9088d04ee8652536d8caa21d8cd4822591932a46a9dae4990ed1a09e6eee235437ed71e3951a06379aa6c29
+  metadata.gz: a92a60ba028c177da4f07cf7f0768d43ab1bb864af4ae00f200ea37ffdc2896a0675ede8934b2c84e7b374ffdb26f0b76eca9d373cefff7f2b8d89716ae4469c
+  data.tar.gz: 8b6918a822261bd8e0709893ff740c27edf3a80530e5ae4e75d8c20bfe09f47874e9be9d405ff82407c46478c32cd4eb4bdd0016848d927857844ab464ecd731

data/README.md

@@ -5,6 +5,7 @@ Log Formatter for Ruby and other logger.
 Details as following:
 
 - `log_formatter/ruby_json_formatter'` : ruby logger json formatter
+- `log_formatter/log4r_json_formatter'` : log4r logger json formatter
 
 ## Installation
 
@@ -32,7 +33,10 @@ Or install it yourself as:
 require 'logger_formatter.rb'
 require 'log_formatter/ruby_json_formatter'
 
-logger.formatter = RubyJSONFormatter::Base.new
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+
+logger.formatter = Ruby::JSONFormatter::Base.new
 
 logger.info 'test data'
 ```
@@ -52,7 +56,7 @@ result:
 ### set app and common ext info
 
 ```
-logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'})
 logger.info 'test data'
 ```
 
@@ -72,7 +76,7 @@ result:
 ### log with hash
 
 ```
-logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'})
 
 logger.debug({data: "test data", author: 'chad'})
 ```
@@ -96,7 +100,7 @@ result:
 json formatter will add `log_type`,`log_level`,`log_timestamp`，`log_app` as default key, but you can change them if needed.
 
 ```
-logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
   config[:level] = :cus_level
   config[:type] = :cus_type
   config[:app] = :cus_app
@@ -122,6 +126,26 @@ result:
 
 full code to see [examples/ruby_logger](https://github.com/chadlwm/log_formatter/blob/master/examples/ruby_logger.rb)
 
+
+## Log4r JSON Formatter
+
+### Get Start
+
+```
+logger = Log4r::Logger.new('Log4RTest')
+outputter = Log4r::StdoutOutputter.new(
+  "console",
+  :formatter => Log4r::JSONFormatter::Base.new
+)
+logger.add(outputter)
+
+logger.debug("Created logger")
+```
+
+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/log4r_logger.rb

@@ -0,0 +1,71 @@
+require 'log4r'
+require 'log_formatter'
+require 'log_formatter/log4r_json_formatter'
+include Log4r
+
+logger = Log4r::Logger.new('Log4RTest')
+# logger.outputters = Outputter.stdout
+outputter = Log4r::StdoutOutputter.new(
+  "console",
+  :formatter => Log4r::JSONFormatter::Base.new
+)
+logger.add(outputter)
+
+# plain initialize
+
+logger.debug("Created logger")
+logger.info("Program started")
+logger.warn("Nothing to do!")
+# {"message":"Created logger","log_level":"DEBUG","log_type":"Log4RTest","log_app":null,"log_timestamp":"2016-08-25T16:48:13+08:00"}
+# {"message":"Program started","log_level":"INFO","log_type":"Log4RTest","log_app":null,"log_timestamp":"2016-08-25T16:48:13+08:00"}
+# {"message":"Nothing to do!","log_level":"WARN","log_type":"Log4RTest","log_app":null,"log_timestamp":"2016-08-25T16:48:13+08:00"}
+
+# initialize with app and ext info
+logger2 = Log4r::Logger.new('Log4RTest')
+outputter2 = Log4r::StdoutOutputter.new(
+  "console",
+  :formatter => Log4r::JSONFormatter::Base.new('app', {'source': 'examples'})
+)
+logger2.add(outputter2)
+
+logger2.debug("Created logger")
+logger2.info("Program started")
+logger2.warn("Nothing to do!")
+# {"source":"examples","message":"Created logger","log_level":"DEBUG","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:02:37+08:00"}
+# {"source":"examples","message":"Program started","log_level":"INFO","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:02:37+08:00"}
+# {"source":"examples","message":"Nothing to do!","log_level":"WARN","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:02:37+08:00"}
+
+logger3 = Log4r::Logger.new('Log4RTest')
+outputter3 = Log4r::StdoutOutputter.new(
+  "console",
+  :formatter => Log4r::JSONFormatter::Base.new('app', {'source': 'examples'})
+)
+logger3.add(outputter3)
+
+logger3.debug({data: "Created logger"})
+logger3.info({data: "Program started"})
+logger3.warn({data: "Nothing to do!"})
+# {"source":"examples","data":"Created logger","log_level":"DEBUG","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:03:48+08:00"}
+# {"source":"examples","data":"Program started","log_level":"INFO","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:03:48+08:00"}
+# {"source":"examples","data":"Nothing to do!","log_level":"WARN","log_type":"Log4RTest","log_app":"app","log_timestamp":"2016-08-25T17:03:48+08:00"}
+
+
+logger4 = Log4r::Logger.new('Log4RTest')
+json_formatter4 = Log4r::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+  config[:level] = :cus_level
+  config[:type] = :cus_type
+  config[:app] = :cus_app
+  config[:timestamp] = :cus_timestamp
+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","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"}

data/examples/ruby_logger.rb

@@ -6,7 +6,7 @@ logger = Logger.new(STDOUT)
 logger.level = Logger::DEBUG
 
 # plain initialize
-logger.formatter =  RubyJSONFormatter::Base.new
+logger.formatter =  Ruby::JSONFormatter::Base.new
 
 logger.debug("Created logger")
 logger.info("Program started")
@@ -16,7 +16,7 @@ logger.warn("Nothing to do!")
 # {"message":"Nothing to do!","log_level":"WARN","log_type":null,"log_app":null,"log_timestamp":"2016-08-25T15:34:25+08:00"}
 
 # initialize with app and ext info
-logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'})
 
 logger.debug("Created logger")
 logger.info("Program started")
@@ -26,7 +26,7 @@ logger.warn("Nothing to do!")
 # {"source":"examples","message":"Nothing to do!","log_level":"WARN","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
 
 # log hash
-logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'})
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'})
 
 logger.debug({data: "Created logger"})
 logger.info({data: "Program started"})
@@ -36,7 +36,7 @@ logger.warn({data: "Nothing to do!"})
 # {"source":"examples","data":"Nothing to do!","log_level":"WARN","log_type":null,"log_app":"app","log_timestamp":"2016-08-25T15:34:25+08:00"}
 
 # log with custome key instead of default keys
-logger.formatter =  RubyJSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
+logger.formatter =  Ruby::JSONFormatter::Base.new('app', {'source': 'examples'}) do |config|
   config[:level] = :cus_level
   config[:type] = :cus_type
   config[:app] = :cus_app

data/lib/log_formatter/common.rb

@@ -0,0 +1,38 @@
+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
+    event[@config[:type].freeze] = progname
+    event[@config[:app].freeze] = @app
+    event[@config[:timestamp].freeze] = current_time(time).iso8601
+    "#{@ext.merge(event).to_json}\n"
+  end
+
+  def msg2str(msg)
+    case msg
+    when ::String
+      msg.gsub("\n", "\t")
+    when ::Exception
+      "#{ msg.message } (#{ msg.class })\t" <<
+        (msg.backtrace || []).join("\t")
+    else
+      msg.inspect
+    end
+  end
+
+  def current_time(time)
+    return time if time
+    Time.respond_to?(:current) ? Time.current : Time.now
+  end
+end

data/lib/log_formatter/log4r_json_formatter.rb

@@ -0,0 +1,29 @@
+require 'log4r'
+require 'json'
+require 'time'
+require File.expand_path('../common', __FILE__)
+
+module Log4r::JSONFormatter
+  class Base < Log4r::BasicFormatter
+    include LogFormatter::Common
+
+    def initialize(app = nil, ext = {})
+      @app = app
+      @ext = ext.is_a?(Hash) ? ext : {}
+      @config = {
+        level: :log_level,
+        type: :log_type,
+        app: :log_app,
+        timestamp: :log_timestamp
+      }
+
+      yield @config if block_given?
+
+      super()
+    end
+
+    def format(event)
+      @event = build_event(event.data, Log4r::LNAMES[event.level], nil, event.name)
+    end
+  end
+end

data/lib/log_formatter/ruby_json_formatter.rb

@@ -1,63 +1,29 @@
 require 'logger'
 require 'json'
 require 'time'
-
-module RubyJSONFormatter
-  class Base < ::Logger::Formatter
-    def initialize(app = nil, ext = {})
-      @app = app
-      @ext = ext.is_a?(Hash) ? ext : {}
-      @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
-
-    protected
-
-    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
+require File.expand_path('../common', __FILE__)
+
+module Ruby
+  module JSONFormatter
+    class Base < ::Logger::Formatter
+      include LogFormatter::Common
+
+      def initialize(app = nil, ext = {})
+        @app = app
+        @ext = ext.is_a?(Hash) ? ext : {}
+        @config = {
+          level: :log_level,
+          type: :log_type,
+          app: :log_app,
+          timestamp: :log_timestamp
+        }
+
+        yield @config if block_given?
       end
 
-      event = case data
-                when Hash
-                  data
-                else
-                  {"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
-      "#{@ext.merge(event).to_json}\n"
-    end
-
-    def msg2str(msg)
-      case msg
-      when ::String
-        msg.gsub("\n", "\t")
-      when ::Exception
-        "#{ msg.message } (#{ msg.class })\t" <<
-          (msg.backtrace || []).join("\t")
-      else
-        msg.inspect
+      def call(severity, time, progname, message)
+        @event = build_event(message, severity, time, progname)
       end
     end
-
-    def current_time(time)
-      return time if time
-      Time.respond_to?(:current) ? Time.current : Time.now
-    end
   end
 end

data/lib/log_formatter/version.rb

@@ -1,3 +1,3 @@
 module LogFormatter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/log_formatter.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "log4r", "~> 1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - chad_lwm
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: log formatter for json. For Plain Ruby Logger, and for log4r and so on,
   details to read the REAME.md file.
 email:
@@ -70,8 +84,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/log4r_logger.rb
 - examples/ruby_logger.rb
 - lib/log_formatter.rb
+- lib/log_formatter/common.rb
+- lib/log_formatter/log4r_json_formatter.rb
 - lib/log_formatter/ruby_json_formatter.rb
 - lib/log_formatter/version.rb
 - log_formatter.gemspec