ougai 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b0465e90dbafc2f753aa9913eaf7e7b3201af61
-  data.tar.gz: c1a31078a887b752c8a345b205dae87524457e0a
+  metadata.gz: 60ba5446b81c3f2211ccdaf9d4e9e3fb4a5eccf3
+  data.tar.gz: e2ec9ab27c885466024b65920c324d4bb53cce3d
 SHA512:
-  metadata.gz: d8714ecf3b6a701a498ef18d1c224b2897a98513b9d4ff59921c845ec2040dccee448af9b2579d32446577d02f26b41bb21fb29ab7f90f834733cd88cd522d2b
-  data.tar.gz: 36dfd041ba4a4485b049d67babb112f90f5383e25ac6bb3f114681d2beb14e696fafdad6f9e67c272477f8bafc9ba7a3fea617036fbfea0ee08f90ce9b88da22
+  metadata.gz: 5247253014f31ab80f35f6cba271c5ae9e9aa85050262a7e9da66c7c7c0e778c970278bfa9dd0d533ab7e9b9170a0f7e8097eb0cacbc93befe589d0bcb3bed89
+  data.tar.gz: 6b9bc32d51eaa2dd33ca74c7c851bf0cec3e594983de5896b0a515914f78e25e161fc9576d4b23b1627c5afb50e98acaa3cb8f4e59a60de8a893eb1315b7df0e

data/README.md

@@ -114,6 +114,20 @@ end
 {"name":"main","hostname":"mint","pid":14607,"level":60,"time":"2016-10-16T22:26:48.836+09:00","v":0,"msg":"Unexpected!","err":{"name":"StandardError","message":"fatal error","stack":"main.rb:12:in `<main>'"}}
 ```
 
+### log with an exception and custom data
+
+```ruby
+begin
+  raise StandardError, 'some error'
+rescue => ex
+  logger.error(ex, error_id: 999)
+end
+```
+
+```json
+{"name":"main","hostname":"mint","pid":13962,"level":50,"time":"2016-10-28T23:44:52.144+09:00","v":0,"error_id":999,"err":{"name":"StandardError","message":"some error","stack":"main.rb:40:in `<main>'"}}
+```
+
 ### log with a message, an exception and custom data
 
 ```ruby

data/lib/ougai.rb

@@ -7,32 +7,35 @@ require 'json'
 module Ougai
   class Logger < Logger
     attr_accessor :default_message, :app_name
+    attr_accessor :ex_key, :ex_trace_indent
 
     def initialize(*args)
       super(*args)
       @default_message = 'No message'
       @app_name = File.basename($0, ".rb")
       @hostname = Socket.gethostname
+      @ex_key = :err
+      @ex_trace_indent = 2
       @formatter = create_formatter
     end
 
-    def debug(message, ex = nil, data = {})
+    def debug(message, ex = nil, data = nil)
       super(to_item(message, ex, data))
     end
 
-    def info(message, ex = nil, data = {})
+    def info(message, ex = nil, data = nil)
       super(to_item(message, ex, data))
     end
 
-    def warn(message, ex = nil, data = {})
+    def warn(message, ex = nil, data = nil)
       super(to_item(message, ex, data))
     end
 
-    def error(message, ex = nil, data = {})
+    def error(message, ex = nil, data = nil)
       super(to_item(message, ex, data))
     end
 
-    def fatal(message, ex = nil, data = {})
+    def fatal(message, ex = nil, data = nil)
       super(to_item(message, ex, data))
     end
 
@@ -55,23 +58,34 @@ module Ougai
 
     def to_item(msg, ex, data)
       item = {}
-      if ex.nil? && msg.is_a?(Exception)
-        item[:msg] = msg.to_s
-        item[:err] = serialize_ex(msg)
-      elsif ex
-        item[:msg] = msg
-        if ex.is_a?(Hash)
+      if ex.nil?       # 1 arg
+        if msg.is_a?(Exception)
+          item[:msg] = msg.to_s
+          item[@ex_key] = serialize_ex(msg)
+        elsif msg.is_a?(Hash)
+          item[:msg] = @default_message unless msg.key?(:msg)
+          item.merge!(msg)
+        else
+          item[:msg] = msg.to_s
+        end
+      elsif data.nil?  # 2 args
+        if ex.is_a?(Exception)
+          item[:msg] = msg.to_s
+          item[@ex_key] = serialize_ex(ex)
+        elsif ex.is_a?(Hash)
           item.merge!(ex)
-        elsif ex.is_a?(Exception)
-          item[:err] = serialize_ex(ex)
-          item.merge!(data)
+          if msg.is_a?(Exception)
+            item[@ex_key] = serialize_ex(msg)
+          else
+            item[:msg] = msg.to_s
+          end
         end
-      elsif msg.is_a?(Hash)
-        item[:msg] = @default_message unless msg.key?(:msg)
-        item.merge!(msg)
-      else
-        item[:msg] = msg
-        item.merge!(data)
+      elsif msg        # 3 args
+        item[@ex_key] = serialize_ex(ex) if ex.is_a?(Exception)
+        item.merge!(data) if data.is_a?(Hash)
+        item[:msg] = msg.to_s
+      else             # No args
+        item[:msg] = @default_message
       end
       item
     end
@@ -82,7 +96,8 @@ module Ougai
         message: ex.to_s
       }
       if ex.backtrace
-        err[:stack] = ex.backtrace.join("\n  ")
+        sp = "\n" + ' ' * @ex_trace_indent
+        err[:stack] = ex.backtrace.join(sp)
       end
       err
     end

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi