ougai 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7662273f5608fda137ffbfb6286a7361cef52dc5
-  data.tar.gz: f500797dfdcd3b6c75b58c17c7644df8fb786430
+  metadata.gz: d30c9475aab949b8119bbb1bb5b921b82cab591f
+  data.tar.gz: 1a60805fd8a9602104c4f45180b54f1db48c5a81
 SHA512:
-  metadata.gz: 4d7247de5ed99e0a7cfb45bd99e4da264262ea237e0ab0c4e1720396bd8acd973d0f93f2880841f62f0ffcfaf7f9b089bf966b349d59434823b871bfaa4a49f9
-  data.tar.gz: af91ab240776919d8a17262f7a3cc5dee143041c04fb2cbb303f9515b2b06abdb50bf224928f210e1864ffae6f9ed7f6a8cd541b58e236da849386af1ee4d788
+  metadata.gz: abb0ce860369b3ff1bf6f3f853e965dae781fd73cf341c954f2fd5f1d9316027850fe6c29eb339cf3b4d9e4abc870af1f39e27a9eb11845ac3532905ab89ed25
+  data.tar.gz: 31bd2e3c9795548c6b47c4a874b0dee68fd98242037040601fc81f8806c2cdff5b3b005cbb708e83ddbe72c168551b67ad437f1dafa855d2f5db63b00942c502

data/README.md

@@ -168,6 +168,22 @@ end
 
 To specify more than one of a message, an exception and custom data, the block returns them as an array.
 
+### Adding custom fields to all logs
+
+The fields of `with_fields` add to all logs as is.
+
+```ruby
+logger.with_fields = { version: '1.1.0' }
+logger.debug(user: { name: 'Taro', age: 19 })
+logger.info('Hello!', user: { name: 'Jiro' }, version: '2.3')
+```
+
+```json
+{"name":"test","hostname":"mint","pid":30182,"level":20,"time":"2017-07-22T20:52:12.332+09:00","v":0,"version":"1.1.0","msg":"No message","user":{"name":"Taro","age":19}}
+{"name":"test","hostname":"mint","pid":30308,"level":30,"time":"2017-07-22T20:53:54.314+09:00","v":0,"version":"2.3","user":{"name":"Jiro"},"msg":"Hello!"}
+```
+
+If any field of with_fields is specified in each log, the field is overridden.
 
 ## View log by node-bunyan
 

data/lib/ougai/logger.rb

@@ -3,48 +3,49 @@ require 'logger'
 
 module Ougai
   class Logger < ::Logger
-    attr_accessor :default_message, :exc_key
+    attr_accessor :default_message, :exc_key, :with_fields
 
     def initialize(*args)
       super(*args)
       @default_message = 'No message'
       @exc_key = :err
       @formatter = create_formatter
+      @with_fields = {}
     end
 
     def debug(message = nil, ex = nil, data = nil, &block)
       return true if level > DEBUG
       args = block ? yield : [message, ex, data]
-      add(DEBUG, to_item(args))
+      add(DEBUG, build_log(args))
     end
 
     def info(message = nil, ex = nil, data = nil, &block)
       return true if level > INFO
       args = block ? yield : [message, ex, data]
-      add(INFO, to_item(args))
+      add(INFO, build_log(args))
     end
 
     def warn(message = nil, ex = nil, data = nil, &block)
       return true if level > WARN
       args = block ? yield : [message, ex, data]
-      add(WARN, to_item(args))
+      add(WARN, build_log(args))
     end
 
     def error(message = nil, ex = nil, data = nil, &block)
       return true if level > ERROR
       args = block ? yield : [message, ex, data]
-      add(ERROR, to_item(args))
+      add(ERROR, build_log(args))
     end
 
     def fatal(message = nil, ex = nil, data = nil, &block)
       return true if level > FATAL
       args = block ? yield : [message, ex, data]
-      add(FATAL, to_item(args))
+      add(FATAL, build_log(args))
     end
 
     def unknown(message = nil, ex = nil, data = nil, &block)
       args = block ? yield : [message, ex, data]
-      add(UNKNOWN, to_item(args))
+      add(UNKNOWN, build_log(args))
     end
 
     def self.broadcast(logger)
@@ -68,6 +69,10 @@ module Ougai
 
     private
 
+    def build_log(args)
+      @with_fields.merge(to_item(args))
+    end
+
     def to_item(args)
       msg, ex, data = args
 

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/spec/logger_spec.rb

@@ -96,6 +96,20 @@ describe Ougai::Logger do
         expect(item).to be_log_message(log_msg, log_level)
         expect(item).to include_data(data_id: 108, action: 'dump')
       end
+
+      it 'outputs valid with fields' do
+        logger.with_fields = { coreField1: 123, core_field2: 'core', 'core_field3' => 456  }
+        logger.send(method, { msg: log_msg, data_id: 109, action: 'do' })
+        expect(item).to be_log_message(log_msg, log_level)
+        expect(item).to include_data(data_id: 109, action: 'do', coreField1: 123, core_field2: 'core', core_field3: 456)
+      end
+
+      it 'outputs valid with fields overridden' do
+        logger.with_fields = { core_field1: 'original', core_field2: 'original', err: 'original' }
+        logger.send(method, { msg: log_msg, data_id: 110, action: 'do', core_field1: 'override' })
+        expect(item).to be_log_message(log_msg, log_level)
+        expect(item).to include_data(data_id: 110, action: 'do', core_field1: 'override', core_field2: 'original', err: 'original')
+      end
     end
 
     context 'with data that does not contain msg' do
@@ -150,6 +164,17 @@ describe Ougai::Logger do
         expect(item).to be_log_message(log_msg, log_level)
         expect(item).to include_error('errmsg')
       end
+
+      it 'outputs valid overridden err field' do
+        logger.with_fields = { err: 'original' }
+        begin
+          raise StandardError, 'errmsg2'
+        rescue => ex
+          logger.send(method, log_msg, ex)
+        end
+
+        expect(item).to include_error('errmsg2')
+      end
     end
 
     context 'with exception and data' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-01 00:00:00.000000000 Z
+date: 2017-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler