ougai 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8386aa7b0737156ca211cfdb4cc7c4030751dc2a
-  data.tar.gz: 9fde65ba8e677511d6ad7061e65dc5816c52bced
+  metadata.gz: fd24ccdad4b3e8fa0a273e6bc4d4a7633b8a2099
+  data.tar.gz: b4ac8f5e868affc6c44e5592651f68ca634ae3ba
 SHA512:
-  metadata.gz: b75ed0bd57138091a7990179072355120bd81fd4f22314154c0c86878ad9372937550c1a2e3dede39858bc8f0c564a8ad13589dcb3284aa67f205625ad7df82d
-  data.tar.gz: dcd961d585d741efd7134bb94ccfca3e981429073b03eac0e6ccfad8e9bdd5c906c2e1f27a68f9467abcdf8407a4d91f20cabaccb0305e0963ef227c0e41ebc3
+  metadata.gz: bf27f89b20a9bd241fd329b756be6d1d5cd163bae87dd0c7f51dc8e3b95f6c58dc857fb6e4765c16a1162279465fe2d21378af45323f56acf1e8d02f01028799
+  data.tar.gz: def31d8b2f563ab7e12e9fea200796177f417b9e3523ee9890c5edb60a647826e477e9c2db412a06b285921e457ddc81cedf516fe86ea500758e53900411a357

data/README.md

@@ -6,7 +6,7 @@ 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 JSON logging system is capable of handling a message, data or an exception easily.
+A structured JSON logging system is capable of handling a message, structured data or an exception easily.
 It is compatible with [Bunyan](https://github.com/trentm/node-bunyan) for Node.js.
 It can also output human readable format for the console.
 
@@ -327,79 +327,6 @@ logger.formatter = Ougai::Formatters::Readable.new
 ![Screen Shot](https://github.com/tilfin/ougai/blob/images/ougai_readable_format.png?raw=true)
 
 
-## Use on Rails
-
-### Define a custom logger
-
-Add following code to `lib/your_app/logger.rb`
-A custom logger includes LoggerSilence because Rails logger must support `silence` feature.
-
-```ruby
-module YourApp
-  class Logger < Ougai::Logger
-    include ActiveSupport::LoggerThreadSafeLevel
-    include LoggerSilence
-
-    def initialize(*args)
-      super
-      after_initialize if respond_to? :after_initialize
-    end
-
-    def create_formatter
-      if Rails.env.development? || Rails.env.test?
-        Ougai::Formatters::Readable.new
-      else
-        Ougai::Formatters::Bunyan.new
-      end
-    end
-  end
-end
-```
-
-### for Development
-
-Add following code to `config/environments/development.rb`
-
-```ruby
-Rails.application.configure do
-  ...
-
-  config.logger = YourApp::Logger.new(STDOUT)
-end
-```
-
-### for Production
-
-Add following code to the end block of `config/environments/production.rb`
-
-```ruby
-Rails.application.configure do
-  ...
-
-  if ENV["RAILS_LOG_TO_STDOUT"].present?
-    config.logger = YourApp::Logger.new(STDOUT)
-  else
-    config.logger = YourApp::Logger.new(config.paths['log'].first)
-  end
-end
-```
-
-### With Lograge
-
-You must modify [lograge](https://github.com/roidrage/lograge) formatter like *Raw*.
-The following code set request data to `request` field of JSON.
-
-```ruby
-Rails.application.configure do
-  config.lograge.enabled = true
-  config.lograge.formatter = Class.new do |fmt|
-    def fmt.call(data)
-      { msg: 'Request', request: data }
-    end
-  end
-end
-```
-
 ### Output example on development
 
 If you modify `application_controller.rb` as
@@ -438,6 +365,11 @@ logger outputs
 }
 ```
 
+## How to use with famous products and libraries
+
+- [Use as Rails logger](https://github.com/tilfin/ougai/wiki/Use-as-Rails-logger)
+- [Customize Sidekiq logger](https://github.com/tilfin/ougai/wiki/Customize-Sidekiq-logger)
+
 ## License
 
 [MIT](LICENSE.txt)

data/lib/ougai/formatters/bunyan.rb

@@ -4,15 +4,22 @@ require 'json'
 module Ougai
   module Formatters
     class Bunyan < Base
+      attr_accessor :jsonize
+
+      def initialize
+        super
+        @jsonize = true
+      end
+
       def call(severity, time, progname, data)
-        JSON.generate({
+        dump({
           name: progname || @app_name,
           hostname: @hostname,
           pid: $$,
           level: to_level(severity),
-          time: time.iso8601(3),
+          time: time,
           v: 0
-        }.merge(data)) + "\n"
+        }.merge(data))
       end
 
       def to_level(severity)
@@ -31,6 +38,14 @@ module Ougai
           20
         end
       end
+
+      private
+
+      def dump(data)
+        return data unless @jsonize
+        data[:time] = data[:time].iso8601(3)
+        JSON.generate(data) + "\n"
+      end
     end
   end
 end

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/spec/formatters/bunyan_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Ougai::Formatters::Bunyan 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 'when severity is DEBUG' do
+    subject { JSON.parse(formatter.call('DEBUG', Time.now, nil, data).chomp, symbolize_names: true) }
+
+    it 'includes valid strings' do
+      expect(subject).to include(data.merge(level: 20))
+      expect(subject[:time]).to match(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/)
+    end
+  end
+
+  context 'jsonize is falsey' do
+    before do
+      formatter.jsonize = false
+    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 { formatter.call('ERROR', Time.now, nil, data.merge({ err: err })) }
+
+      it 'includes valid hash' do
+        expect(subject).to include(level: 50, err: err)
+        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, err: err)
+        expect(subject[:time]).to be_an_instance_of(Time)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - lib/ougai/version.rb
 - spec/child_logger_spec.rb
 - spec/formatters/base_spec.rb
+- spec/formatters/bunyan_spec.rb
 - spec/formatters/readable_spec.rb
 - spec/logger_spec.rb
 - spec/logging_spec.rb
@@ -109,6 +110,7 @@ summary: JSON logger compatible with node-bunyan is capable of handling data eas
 test_files:
 - spec/child_logger_spec.rb
 - spec/formatters/base_spec.rb
+- spec/formatters/bunyan_spec.rb
 - spec/formatters/readable_spec.rb
 - spec/logger_spec.rb
 - spec/logging_spec.rb