ougai 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07b9c78b3ba77163b4181b653717cde507c558c4
-  data.tar.gz: 24908f54426f4695ec3f3db02869de55bf239618
+  metadata.gz: 207074987e412815fd6fbb4acb718da9b4451c95
+  data.tar.gz: 1e0d8320ba60fcd41c87c0dfb575cabc6cd77683
 SHA512:
-  metadata.gz: 123c9b422abdacaff15127779c162b211726e048d8b6f93840b31152a257865b550cfa8025131633553189544d66bf5b1072dbbb8f8fa97594d994cbfc160339
-  data.tar.gz: 57f93dda462f828a0130da70ca20b2f900680c74797e63670f71b294b43a1ae580b31a438b71cd122b02f46155f2ca7319cd8ba0e0b912abbd26d036d0d6371f
+  metadata.gz: 5ebf1a15410b890788c3ff9ea531d05286ec447c479bd348491a08a1735fa46d64783f805c84eedb31e73c074fa02b449c5deb2eb7a78321f493cb181696b092
+  data.tar.gz: 2c3e322ba81f980a55572b31aebbdc753636db5cd394fadbf1a107e160e8c9e6c74a228c64aa3d5820455744f2d37bdbccb1e4decda40daa2e9bb46c44e0b8c9

data/README.md

@@ -42,6 +42,14 @@ require 'ougai'
 logger = Ougai::Logger.new(STDOUT)
 ```
 
+### TRACE level
+
+The `level` of logger supports **TRACE** level lower than **DEBUG**.
+
+```ruby
+logger.level = Ougai::Logger::TRACE # , :trace or 'trace'
+```
+
 ### log only a message
 
 ```ruby
@@ -334,6 +342,7 @@ logger.formatter = Ougai::Formatters::Readable.new
 - [Customize Sidekiq logger](https://github.com/tilfin/ougai/wiki/Customize-Sidekiq-logger)
 - [Forward logs to Fluentd](https://github.com/tilfin/ougai/wiki/Forward-logs-to-Fluentd)
 - [Forward logs to Logentries](https://github.com/tilfin/ougai/wiki/Forward-logs-to-Logentries)
+- [Use as ServerEngine logger](https://github.com/tilfin/ougai/wiki/Use-as-ServerEngine-logger)
 
 ## License
 

data/lib/ougai.rb

@@ -1,8 +1,8 @@
 require 'logger'
 require 'ougai/version'
+require 'ougai/logging'
 require 'ougai/formatters/base'
 require 'ougai/formatters/bunyan'
 require 'ougai/formatters/readable'
-require 'ougai/logging'
 require 'ougai/child_logger'
 require 'ougai/logger'

data/lib/ougai/child_logger.rb

@@ -13,6 +13,36 @@ module Ougai
       @parent.level
     end
 
+    # Whether the current severity level allows for logging DEBUG.
+    # @return [Boolean] true if allows
+    def debug?
+      @parent.debug?
+    end
+
+    # Whether the current severity level allows for logging INFO.
+    # @return [Boolean] true if allows
+    def info?
+      @parent.info?
+    end
+
+    # Whether the current severity level allows for logging WARN.
+    # @return [Boolean] true if allows
+    def warn?
+      @parent.warn?
+    end
+
+    # Whether the current severity level allows for logging ERROR.
+    # @return [Boolean] true if allows
+    def error?
+      @parent.error?
+    end
+
+    # Whether the current severity level allows for logging FATAL.
+    # @return [Boolean] true if allows
+    def fatal?
+      @parent.fatal?
+    end
+
     # @private
     def chain(severity, args, fields, hooks)
       hooks.push(@before_log) if @before_log

data/lib/ougai/formatters/bunyan.rb

@@ -28,6 +28,10 @@ module Ougai
 
       def to_level(severity)
         case severity
+        when 'TRACE'
+          10
+        when 'DEBUG'
+          20
         when 'INFO'
           30
         when 'WARN'
@@ -36,10 +40,8 @@ module Ougai
           50
         when 'FATAL'
           60
-        when 'ANY'
+        else
           70
-        else # DEBUG
-          20
         end
       end
 

data/lib/ougai/formatters/readable.rb

@@ -33,6 +33,10 @@ module Ougai
 
       def colored_level(severity)
         case severity
+        when 'TRACE'
+          color = '0;34'
+        when 'DEBUG'
+          color = '0;37'
         when 'INFO'
           color = '0;36'
         when 'WARN'
@@ -41,8 +45,8 @@ module Ougai
           color = '0;31'
         when 'FATAL'
           color = '0;35'
-        else # DEBUG
-          color = '0;37'
+        else
+          color = '0;32'
         end
         "\e[#{color}m#{severity}\e[0m"
       end

data/lib/ougai/logger.rb

@@ -42,6 +42,20 @@ module Ougai
       end
     end
 
+    def level=(severity)
+      if severity.is_a?(Integer)
+        @level = severity
+        return
+      end
+
+      if severity.to_s.downcase == 'trace'
+        @level = TRACE
+        return
+      end
+
+      super
+    end
+
     # @private
     def chain(severity, args, fields, hooks)
       hooks.push(@before_log) if @before_log
@@ -62,6 +76,10 @@ module Ougai
 
     private
 
+    def format_severity(severity)
+      to_label(severity)
+    end
+
     def write(severity, args, fields, hooks)
       data = merge_fields(fields, to_item(args))
       hooks.each do |hook|

data/lib/ougai/logging.rb

@@ -4,6 +4,25 @@ module Ougai
     attr_accessor :with_fields
     attr_writer :before_log
 
+    module Severity
+      include ::Logger::Severity
+      TRACE = -1
+
+      SEV_LABEL = %w(TRACE DEBUG INFO WARN ERROR FATAL ANY).each(&:freeze).freeze
+
+      def to_label(severity)
+        SEV_LABEL[severity + 1] || 'ANY'
+      end
+    end
+    include Severity
+
+    # Log any one or more of a message, an exception and structured data as TRACE.
+    # @return [Boolean] true
+    # @see Logging#debug
+    def trace(message = nil, ex = nil, data = nil, &block)
+      log(TRACE, message, ex, data, block)
+    end
+
     # Log any one or more of a message, an exception and structured data as DEBUG.
     # If the block is given for delay evaluation, it returns them as an array or the one of them as a value.
     # @param message [String] The message to log. Use default_message if not specified.
@@ -12,35 +31,35 @@ module Ougai
     # @yieldreturn [String|Exception|Object|Array] Any one or more of former parameters
     # @return [Boolean] true
     def debug(message = nil, ex = nil, data = nil, &block)
-      log(Logger::DEBUG, message, ex, data, block)
+      log(DEBUG, message, ex, data, block)
     end
 
     # Log any one or more of a message, an exception and structured data as INFO.
     # @return [Boolean] true
     # @see Logging#debug
     def info(message = nil, ex = nil, data = nil, &block)
-      log(Logger::INFO, message, ex, data, block)
+      log(INFO, message, ex, data, block)
     end
 
     # Log any one or more of a message, an exception and structured data as WARN.
     # @return [Boolean] true
     # @see Logging#debug
     def warn(message = nil, ex = nil, data = nil, &block)
-      log(Logger::WARN, message, ex, data, block)
+      log(WARN, message, ex, data, block)
     end
 
     # Log any one or more of a message, an exception and structured data as ERROR.
     # @return [Boolean] true
     # @see Logging#debug
     def error(message = nil, ex = nil, data = nil, &block)
-      log(Logger::ERROR, message, ex, data, block)
+      log(ERROR, message, ex, data, block)
     end
 
     # Log any one or more of a message, an exception and structured data as FATAL.
     # @return [Boolean] true
     # @see Logging#debug
     def fatal(message = nil, ex = nil, data = nil, &block)
-      log(Logger::FATAL, message, ex, data, block)
+      log(FATAL, message, ex, data, block)
     end
 
     # Log any one or more of a message, an exception and structured data as UNKNOWN.
@@ -48,7 +67,13 @@ module Ougai
     # @see Logging#debug
     def unknown(message = nil, ex = nil, data = nil, &block)
       args = block ? yield : [message, ex, data]
-      append(Logger::UNKNOWN, args)
+      append(UNKNOWN, args)
+    end
+
+    # Whether the current severity level allows for logging TRACE.
+    # @return [Boolean] true if allows
+    def trace?
+      level <= TRACE
     end
 
     # Creates a child logger and returns it.

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "1.4.4"
+  VERSION = "1.5.0"
 end

data/spec/child_logger_spec.rb

@@ -32,10 +32,39 @@ describe Ougai::ChildLogger do
   describe '#level propagated from parent one' do
     let(:logger) { parent_logger.child }
 
+    context 'TRACE' do
+      let(:log_msg) { 'log message' }
+      before { parent_logger.level = Ougai::Logger::TRACE }
+
+      it 'outputs trace message' do
+        logger.trace(log_msg)
+        expect(item).to be_log_message(log_msg, 10)
+      end
+
+      it 'outputs debug message' do
+        logger.debug(log_msg)
+        expect(item).to be_log_message(log_msg, 20)
+      end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_truthy
+        expect(logger.debug?).to be_truthy
+        expect(logger.info?).to be_truthy
+        expect(logger.warn?).to be_truthy
+        expect(logger.error?).to be_truthy
+        expect(logger.fatal?).to be_truthy
+      end
+    end
+
     context 'DEBUG' do
       let(:log_msg) { 'log message' }
       before { parent_logger.level = Logger::DEBUG }
 
+      it 'does not output trace message' do
+        logger.trace(log_msg)
+        expect(item).to be_nil
+      end
+
       it 'outputs debug message' do
         logger.debug(log_msg)
         expect(item).to be_log_message(log_msg, 20)
@@ -45,6 +74,15 @@ describe Ougai::ChildLogger do
         logger.info(log_msg)
         expect(item).to be_log_message(log_msg, 30)
       end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_falsey
+        expect(logger.debug?).to be_truthy
+        expect(logger.info?).to be_truthy
+        expect(logger.warn?).to be_truthy
+        expect(logger.error?).to be_truthy
+        expect(logger.fatal?).to be_truthy
+      end
     end
 
     context 'INFO' do
@@ -65,6 +103,15 @@ describe Ougai::ChildLogger do
         logger.warn(log_msg)
         expect(item).to be_log_message(log_msg, 40)
       end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_falsey
+        expect(logger.debug?).to be_falsey
+        expect(logger.info?).to be_truthy
+        expect(logger.warn?).to be_truthy
+        expect(logger.error?).to be_truthy
+        expect(logger.fatal?).to be_truthy
+      end
     end
 
     context 'WARN' do
@@ -85,6 +132,15 @@ describe Ougai::ChildLogger do
         logger.error(log_msg)
         expect(item).to be_log_message(log_msg, 50)
       end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_falsey
+        expect(logger.debug?).to be_falsey
+        expect(logger.info?).to be_falsey
+        expect(logger.warn?).to be_truthy
+        expect(logger.error?).to be_truthy
+        expect(logger.fatal?).to be_truthy
+      end
     end
 
     context 'ERROR' do
@@ -105,6 +161,15 @@ describe Ougai::ChildLogger do
         logger.fatal(log_msg)
         expect(item).to be_log_message(log_msg, 60)
       end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_falsey
+        expect(logger.debug?).to be_falsey
+        expect(logger.info?).to be_falsey
+        expect(logger.warn?).to be_falsey
+        expect(logger.error?).to be_truthy
+        expect(logger.fatal?).to be_truthy
+      end
     end
 
     context 'FATAL' do
@@ -125,6 +190,15 @@ describe Ougai::ChildLogger do
         logger.unknown(log_msg)
         expect(item).to be_log_message(log_msg, 70)
       end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_falsey
+        expect(logger.debug?).to be_falsey
+        expect(logger.info?).to be_falsey
+        expect(logger.warn?).to be_falsey
+        expect(logger.error?).to be_falsey
+        expect(logger.fatal?).to be_truthy
+      end
     end
 
     context 'UNKNOWN' do
@@ -140,6 +214,15 @@ describe Ougai::ChildLogger do
         logger.unknown(log_msg)
         expect(item).to be_log_message(log_msg, 70)
       end
+
+      it 'is consistent with the methods severity allows' do
+        expect(logger.trace?).to be_falsey
+        expect(logger.debug?).to be_falsey
+        expect(logger.info?).to be_falsey
+        expect(logger.warn?).to be_falsey
+        expect(logger.error?).to be_falsey
+        expect(logger.fatal?).to be_falsey
+      end
     end
   end
 

data/spec/formatters/bunyan_spec.rb

@@ -36,6 +36,15 @@ describe Ougai::Formatters::Bunyan do
       formatter.jsonize = false
     end
 
+    context 'when severity is TRACE' do
+      subject { formatter.call('TRACE', Time.now, nil, data) }
+
+      it 'includes valid hash' do
+        expect(subject).to include(data.merge(level: 10))
+        expect(subject[:time]).to be_an_instance_of(Time)
+      end
+    end
+
     context 'when severity is DEBUG' do
       subject { formatter.call('DEBUG', Time.now, nil, data) }
 
@@ -80,6 +89,14 @@ describe Ougai::Formatters::Bunyan do
         expect(subject[:time]).to be_an_instance_of(Time)
       end
     end
+
+    context 'when severity is UNKNOWN' do
+      subject { formatter.call('ANY', Time.now, nil, { msg: 'unknown msg' }) }
+
+      it 'includes valid hash' do
+        expect(subject).to include(level: 70, msg: 'unknown msg')
+      end
+    end
   end
 
   context 'with_newline is false' do

data/spec/formatters/readable_spec.rb

@@ -18,6 +18,15 @@ describe Ougai::Formatters::Readable do
     }
   end
 
+  context 'when severity is TRACE' do
+    subject { described_class.new.call('TRACE', Time.now, nil, data) }
+
+    it 'includes valid strings' do
+      expect(subject).to include("\e[0;34mTRACE\e[0m: Log Message!")
+      expect(subject.gsub(/\e\[([;\d]+)?m/, '')).to include(':status => 200')
+    end
+  end
+
   context 'when severity is DEBUG' do
     subject { described_class.new.call('DEBUG', Time.now, nil, data) }
 
@@ -62,6 +71,13 @@ describe Ougai::Formatters::Readable do
     end
   end
 
+  context 'when severity is UNKNOWN' do
+    subject { described_class.new.call('ANY', Time.now, nil, { msg: 'unknown msg' }) }
+    it 'includes valid strings' do
+      expect(subject).to include("\e[0;32mANY\e[0m: unknown msg")
+    end
+  end
+
   context 'when logger has excluded_fields' do
     subject do
       described_class.new(excluded_fields: [:status, :method]).call('DEBUG', Time.now, nil, data)

data/spec/logger_spec.rb

@@ -232,12 +232,36 @@ describe Ougai::Logger do
     end
   end
 
+  describe '#trace' do
+    let(:log_level) { 10 }
+    let(:log_msg) { 'trace message' }
+    let(:method) { 'trace' }
+
+    before { logger.level = :trace }
+
+    it_behaves_like 'log'
+
+    it 'is consistent with the methods severity allows' do
+      expect(logger.trace?).to be_truthy
+      expect(logger.debug?).to be_truthy
+      expect(logger.info?).to be_truthy
+      expect(logger.warn?).to be_truthy
+      expect(logger.error?).to be_truthy
+      expect(logger.fatal?).to be_truthy
+    end
+  end
+
   describe '#debug' do
     let(:log_level) { 20 }
     let(:log_msg) { 'debug message' }
     let(:method) { 'debug' }
 
     it_behaves_like 'log'
+
+    it 'is consistent with the methods severity allows' do
+      expect(logger.trace?).to be_falsey
+      expect(logger.debug?).to be_truthy
+    end
   end
 
   describe '#info' do
@@ -538,7 +562,7 @@ describe Ougai::Logger do
 
     context 'another logger level is the same as original one' do
       before do
-        logger.level = Logger::INFO # propagate serverity to another one
+        logger.level = Logger::INFO # propagate severity to another one
       end
 
       it 'does not output debug log on both loggers' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: JSON logger compatible with node-bunyan is capable of handling structured