ougai 1.6.1 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f97b8ee5e0ea8a1a8447617bc897d7f4d74374ef
-  data.tar.gz: 6378c1a5f851471e1e57fd61595a9108d1cdfda9
+  metadata.gz: 3a3a13441e1374f9f227801a4fa3b01992e05c7f
+  data.tar.gz: 0e2a39093027b4a0ad7c82b2626460ae07225e1a
 SHA512:
-  metadata.gz: 7ef907639cb3aed26f0a363e6728e7a893c767d05a5e31dddb042c10c43996ef5ed1b5b1763843924ab10b2895e59db03e306bbdbd4881833c18689e4a7e0d88
-  data.tar.gz: b547e81ff137f3c877f1a789a22318b1172fa5743f24741f3ea2470309c9e8d0cc5f5d0f0257af74da5c5dd2a3451b223feec2296148db7bf3ce3eb2e705dd85
+  metadata.gz: 62426a676338318a26d1c37e72bd9f5221d8f980fc810bb939ac6a19631b77c9a44193f43dc21e31f362e62194f3ee99e4f2fc15e54c9781336beaea571f7802
+  data.tar.gz: 2b027dbbc7bbeff72e7069e0cdf899609a3ca45ec0e0c241349af5025c7b6f2e4e34b93a1401a3edd1677bfcd6c69f1aadc63bfca78c8e4a87090e6f2ab6137f

data/Gemfile

@@ -6,4 +6,5 @@ gemspec
 group :test do
   gem 'awesome_print'
   gem 'simplecov', require: false
+  gem 'yard'
 end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    ougai (1.6.3)
+      oj (~> 3.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.1.0)
+    oj (3.4.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.11)
+  ougai!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+  yard
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -2,12 +2,13 @@ Ougai
 =====
 
 [![Gem Version](https://badge.fury.io/rb/ougai.svg)](https://badge.fury.io/rb/ougai)
+[![document](https://img.shields.io/badge/document-1.6.3-green.svg)](http://www.rubydoc.info/gems/ougai/1.6.3/)
 [![Build Status](https://travis-ci.org/tilfin/ougai.svg?branch=master)](https://travis-ci.org/tilfin/ougai)
 [![Code Climate](https://codeclimate.com/github/tilfin/ougai/badges/gpa.svg)](https://codeclimate.com/github/tilfin/ougai)
 [![Test Coverage](https://codeclimate.com/github/tilfin/ougai/badges/coverage.svg)](https://codeclimate.com/github/tilfin/ougai/coverage)
 
 A structured logging system is capable of handling a message, structured data or an exception easily.
-It has JSON formatter compatible with [Bunyan](https://github.com/trentm/node-bunyan) for Node.js and
+It has JSON formatters compatible with [Bunyan](https://github.com/trentm/node-bunyan) or [pino](https://github.com/pinojs/pino) for Node.js and
 human readable formatter with [Awesome Print](https://github.com/awesome-print/awesome_print) for console.
 
 ## Installation
@@ -293,18 +294,18 @@ logger.warn('Ignored something.')
 ```
 
 
-## View logs with node-bunyan
+## View pretty logs with node-bunyan or pino
 
-Install [bunyan](https://github.com/trentm/node-bunyan) via npm
+Install [bunyan](https://github.com/trentm/node-bunyan) or [pino](https://github.com/pinojs/pino) via npm
 
 ```
 $ npm install -g bunyan
 ```
 
-Pass a log file to command `bunyan`
+Pipe a log file to command
 
 ```
-$ bunyan output.log
+$ cat output.log | bunyan
 [2016-10-16T22:26:48.835+09:00]  INFO: main/14607 on mint: Info message!
 [2016-10-16T22:26:48.836+09:00] DEBUG: main/14607 on mint: Debugging (data_id=1, data_flag=true)
 [2016-10-16T22:26:48.836+09:00] DEBUG: main/14607 on mint: Debug!
@@ -319,6 +320,7 @@ $ bunyan output.log
       main.rb:18:in `<main>'
 ```
 
+If you use *Ougai::Formatters::Pino*, you can use command [pino](https://github.com/pinojs/pino) as well as [bunyan](https://github.com/trentm/node-bunyan).
 
 ## Use human Readable formatter for console
 

data/Rakefile

@@ -1,6 +1,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'yard'
+require 'yard/rake/yardoc_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+FILES = ['lib/**/*.rb']
+OPTIONS = ['--debug', '--verbose']
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = FILES
+  t.options = []
+  t.options << OPTIONS if $trace
+end

data/lib/ougai.rb

@@ -2,7 +2,9 @@ require 'logger'
 require 'ougai/version'
 require 'ougai/logging'
 require 'ougai/formatters/base'
+require 'ougai/formatters/for_json'
 require 'ougai/formatters/bunyan'
 require 'ougai/formatters/readable'
+require 'ougai/formatters/pino'
 require 'ougai/child_logger'
 require 'ougai/logger'

data/lib/ougai/formatters/base.rb

@@ -13,12 +13,19 @@ module Ougai
       attr_accessor :serialize_backtrace
       attr_reader :app_name, :hostname
 
-      def initialize(app_name = nil, hostname = nil)
+      # Intialize a formatter
+      # @param [String] app_name application name
+      # @param [String] hostname hostname
+      # @param [Hash] opts the initial values of attributes
+      # @option opts [String] :trace_indent (2) the value of trace_indent attribute
+      # @option opts [String] :trace_max_lines (100) the value of trace_max_lines attribute
+      # @option opts [String] :serialize_backtrace (true) the value of serialize_backtrace attribute
+      def initialize(app_name = nil, hostname = nil, opts = {})
         @app_name = app_name || File.basename($0, ".rb")
         @hostname = hostname || Socket.gethostname.force_encoding('UTF-8')
-        @trace_indent = 2
-        @trace_max_lines = 100
-        @serialize_backtrace = true
+        @trace_indent = opts.fetch(:trace_indent, 2)
+        @trace_max_lines = opts.fetch(:trace_max_lines, 100)
+        @serialize_backtrace = opts.fetch(:serialize_backtrace, true)
         self.datetime_format = nil
       end
 
@@ -63,6 +70,16 @@ module Ougai
         f << (t.utc? ? 'Z' : '%:z')
         f.freeze
       end
+
+      def self.parse_new_params(args)
+        idx = args.index {|i| i.is_a?(Hash) }
+        return args if idx == 2
+        opts = args[idx]
+        app_name = opts.delete(:app_name)
+        hostname = opts.delete(:hostname)
+        app_name ||= args[0] if idx > 0
+        [app_name, hostname, opts]
+      end
     end
   end
 end

data/lib/ougai/formatters/bunyan.rb

@@ -4,15 +4,27 @@ require 'oj'
 module Ougai
   module Formatters
     # A JSON formatter compatible with node-bunyan
-    # @attr [Boolean] jsonize Whether log should converts JSON (by default this is on).
-    # @attr [Boolean] with_newline Whether tailing NL should be appended (by default this is on).
+    # @attr [Boolean] jsonize Whether log should converts JSON
+    # @attr [Boolean] with_newline Whether tailing NL should be appended
     class Bunyan < Base
+      include ForJson
+
       attr_accessor :jsonize, :with_newline
 
-      def initialize(*args)
-        super(*args)
-        @jsonize = true
-        @with_newline = true
+      # Intialize a formatter
+      # @param [String] app_name application name (execution program name if nil)
+      # @param [String] hostname hostname (hostname if nil)
+      # @param [Hash] opts the initial values of attributes
+      # @option opts [String] :trace_indent (2) the value of trace_indent attribute
+      # @option opts [String] :trace_max_lines (100) the value of trace_max_lines attribute
+      # @option opts [String] :serialize_backtrace (true) the value of serialize_backtrace attribute
+      # @option opts [String] :jsonize (true) the value of jsonize attribute
+      # @option opts [String] :with_newline (true) the value of with_newline attribute
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+        @jsonize = opts.fetch(:jsonize, true)
+        @with_newline = opts.fetch(:with_newline, true)
       end
 
       def _call(severity, time, progname, data)
@@ -26,25 +38,6 @@ module Ougai
         }.merge(data))
       end
 
-      def to_level(severity)
-        case severity
-        when 'TRACE'
-          10
-        when 'DEBUG'
-          20
-        when 'INFO'
-          30
-        when 'WARN'
-          40
-        when 'ERROR'
-          50
-        when 'FATAL'
-          60
-        else
-          70
-        end
-      end
-
       private
 
       OJ_OPTIONS = { mode: :custom, time_format: :xmlschema,

data/lib/ougai/formatters/for_json.rb

@@ -0,0 +1,23 @@
+module Ougai
+  # The features for JSON
+  module Formatters::ForJson
+    def to_level(severity)
+      case severity
+      when 'TRACE'
+        10
+      when 'DEBUG'
+        20
+      when 'INFO'
+        30
+      when 'WARN'
+        40
+      when 'ERROR'
+        50
+      when 'FATAL'
+        60
+      else
+        70
+      end
+    end
+  end
+end

data/lib/ougai/formatters/pino.rb

@@ -0,0 +1,73 @@
+require 'ougai/formatters/base'
+require 'oj'
+
+module Ougai
+  module Formatters
+    # A JSON formatter compatible with pino
+    # @attr [Boolean] jsonize Whether log should converts JSON
+    # @attr [Boolean] with_newline Whether tailing NL should be appended
+    class Pino < Base
+      include ForJson
+
+      attr_accessor :jsonize, :with_newline
+
+      # Intialize a formatter
+      # @param [String] app_name application name (execution program name if nil)
+      # @param [String] hostname hostname (hostname if nil)
+      # @param [Hash] opts the initial values of attributes
+      # @option opts [String] :trace_indent (4) the value of trace_indent attribute
+      # @option opts [String] :trace_max_lines (100) the value of trace_max_lines attribute
+      # @option opts [String] :serialize_backtrace (true) the value of serialize_backtrace attribute
+      # @option opts [String] :jsonize (true) the value of jsonize attribute
+      # @option opts [String] :with_newline (true) the value of with_newline attribute
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+        @jsonize = opts.fetch(:jsonize, true)
+        @with_newline = opts.fetch(:with_newline, true)
+        @trace_indent = opts.fetch(:trace_indent, 4)
+        @serialize_backtrace = true
+      end
+
+      def datetime_format=(val)
+        raise NotImplementedError, 'Not support datetime_format attribute' unless val.nil?
+      end
+
+      def _call(severity, time, progname, data)
+        flat_err(data)
+        dump({
+          name: progname || @app_name,
+          hostname: @hostname,
+          pid: $$,
+          level: to_level(severity),
+          time: time,
+          v: 1
+        }.merge(data))
+      end
+
+      private
+
+      def flat_err(data)
+        return unless data.key?(:err)
+        err = data.delete(:err)
+        msg = err[:message]
+        data[:type] ||= 'Error'
+        data[:msg] ||= msg
+        stack = "#{err[:name]}: #{msg}"
+        stack += "\n" + (" " * @trace_indent) + err[:stack] if err.key?(:stack)
+        data[:stack] ||= stack
+      end
+
+      OJ_OPTIONS = { mode: :custom, time_format: :xmlschema,
+                     use_as_json: true, use_to_hash: true, use_to_json: true }
+
+      def dump(data)
+        return data unless @jsonize
+        data[:time] = data[:time].to_i * 1000
+        str = Oj.dump(data, OJ_OPTIONS)
+        str << "\n" if @with_newline
+        str
+      end
+    end
+  end
+end

data/lib/ougai/formatters/readable.rb

@@ -3,16 +3,25 @@ require 'ougai/formatters/base'
 module Ougai
   module Formatters
     # A human readble formatter with awesome_print
-    # @attr [Boolean] plain Whether log should be plain not colorized (by default this is off).
-    # @attr [Fixnum] trace_indent The indent space size (by default this is 4).
-    # @attr [Array<String, Symbol>] excluded_fields The fields excluded from all logs.
+    # @attr [Boolean] plain Whether log should be plain not colorized.
+    # @attr [Array<String, Symbol>] excluded_fields The fields excluded from all logs
     class Readable < Base
-      attr_accessor :plain, :trace_indent, :excluded_fields
+      attr_accessor :plain, :excluded_fields
 
-      def initialize(opts = {})
-        super(opts[:app_name], opts[:hostname])
-        @trace_indent = opts[:trace_indent] || 4
-        @plain = opts[:plain] || false
+      # Intialize a formatter
+      # @param [String] app_name application name (execution program name if nil)
+      # @param [String] hostname hostname (hostname if nil)
+      # @param [Hash] opts the initial values of attributes
+      # @option opts [String] :trace_indent (4) the value of trace_indent attribute
+      # @option opts [String] :trace_max_lines (100) the value of trace_max_lines attribute
+      # @option opts [String] :serialize_backtrace (true) the value of serialize_backtrace attribute
+      # @option opts [String] :plain (false) the value of plain attribute
+      # @option opts [String] :excluded_fields ([]) the value of excluded_fields attribute
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+        @trace_indent = opts.fetch(:trace_indent, 4)
+        @plain = opts.fetch(:plain, false)
         @excluded_fields = opts[:excluded_fields] || []
         @serialize_backtrace = true
         load_dependent

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = '1.6.1'
+  VERSION = '1.6.3'
 end

data/spec/formatters/pino_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Ougai::Formatters::Pino do
+  let(:data) do
+    {
+      msg: 'Log Message!',
+      status: 200,
+      method: 'GET',
+      path: '/'
+    }
+  end
+
+  let(:err) do
+    {
+      name: 'DummyError',
+      message: 'it is dummy.',
+      stack: "error1.rb\n    error2.rb"
+    }
+  end
+
+  let(:formatter) { described_class.new }
+
+  context '#initialize' do
+    let(:appname) { 'dummy app name' }
+
+    it 'suceeds with arguments' do
+      fmt = described_class.new(appname)
+      expect(fmt.app_name).to eq(appname)
+    end
+  end
+
+  context 'jsonize is true and with_newline is true' do
+    subject { formatter.call('DEBUG', Time.now, nil, data) }
+
+    it 'includes valid strings' do
+      expect(subject).to end_with("\n")
+      result = JSON.parse(subject.chomp, symbolize_names: true)
+      expect(result).to include(data.merge(level: 20))
+      expect(result[:time]).to be > 1518710101026
+    end
+  end
+
+  context 'jsonize is false' do
+    before 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) }
+
+      it 'includes valid hash' do
+        expect(subject).to include(data.merge(level: 20))
+        expect(subject[:time]).to be_an_instance_of(Time)
+      end
+    end
+
+    context 'when severity is INFO' do
+      subject { formatter.call('INFO', Time.now, nil, data) }
+
+      it 'includes valid hash' do
+        expect(subject).to include(data.merge(level: 30))
+        expect(subject[:time]).to be_an_instance_of(Time)
+      end
+    end
+
+    context 'when severity is WARN' do
+      subject { formatter.call('WARN', Time.now, nil, data) }
+
+      it 'includes valid hash' do
+        expect(subject).to include(data.merge(level: 40))
+        expect(subject[:time]).to be_an_instance_of(Time)
+      end
+    end
+
+    context 'when severity is ERROR' do
+      subject {
+        data.delete(:msg)
+        formatter.call('ERROR', Time.now, nil, data.merge({ err: err }))
+      }
+
+      it 'includes valid hash' do
+        expect(subject).to include({
+          level: 50, type: 'Error',
+          msg: 'it is dummy.',
+          stack: "DummyError: it is dummy.\n    error1.rb\n    error2.rb"
+        })
+        expect(subject[:time]).to be_an_instance_of(Time)
+      end
+    end
+
+    context 'when severity is FATAL' do
+      subject { formatter.call('FATAL', Time.now, nil, { msg: 'TheEnd', err: err }) }
+
+      it 'includes valid hash' do
+        expect(subject).to include({
+          level: 60, type: 'Error',
+          msg: 'TheEnd',
+          stack: "DummyError: it is dummy.\n    error1.rb\n    error2.rb"
+        })
+        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
+    before do
+      formatter.with_newline = false
+    end
+
+    subject { formatter.call('INFO', Time.now, nil, data) }
+
+    it 'includes valid strings' do
+      expect(subject).not_to end_with("\n")
+      result = JSON.parse(subject, symbolize_names: true)
+      expect(result).to include(data.merge(level: 30))
+      expect(result[:time]).to be > 1518710101026
+    end
+  end
+
+  describe '#datetime_format' do
+    it 'is not supported' do
+      expect{ formatter.datetime_format = '%I:%M:%S %p' }.to raise_error(NotImplementedError)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.3
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -68,14 +68,13 @@ dependencies:
         version: '3.0'
 description: |2
       A structured logging system is capable of handling a message, custom data or an exception easily.
-      It has JSON formatter compatible with Bunyan for Node.js and human readable formatter with Awesome Print for console.
+      It has JSON formatters compatible with Bunyan or pino for Node.js and human readable formatter with Awesome Print for console.
 email:
 - toshi@tilfin.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -85,6 +84,8 @@ files:
 - lib/ougai/child_logger.rb
 - lib/ougai/formatters/base.rb
 - lib/ougai/formatters/bunyan.rb
+- lib/ougai/formatters/for_json.rb
+- lib/ougai/formatters/pino.rb
 - lib/ougai/formatters/readable.rb
 - lib/ougai/logger.rb
 - lib/ougai/logging.rb
@@ -92,6 +93,7 @@ files:
 - spec/child_logger_spec.rb
 - spec/formatters/base_spec.rb
 - spec/formatters/bunyan_spec.rb
+- spec/formatters/pino_spec.rb
 - spec/formatters/readable_spec.rb
 - spec/logger_spec.rb
 - spec/logging_spec.rb
@@ -120,9 +122,10 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: JSON logger compatible with node-bunyan is capable of handling structured
+summary: JSON logger compatible with node-bunyan or pino is capable of handling structured
   data easily.
 test_files:
+- spec/formatters/pino_spec.rb
 - spec/formatters/base_spec.rb
 - spec/formatters/bunyan_spec.rb
 - spec/formatters/readable_spec.rb

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/coverage/