ougai 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60f1f030cbb1eb389906d56f3ecad6d4f0b549f2
-  data.tar.gz: 602afdd55a5473b5a967269cb4b1d1b5b7251a8f
+  metadata.gz: ab744df888b1db18e07decc89a6dfb1666a92d62
+  data.tar.gz: 89a0f4938fd5907d0aa82b9a8fcdfa8016b667b2
 SHA512:
-  metadata.gz: 0e33caabe88d4061539a7ac6b187f5280a78d00fd5eb93f6329f57ecf7eb699670f0c3708f67b56970b5ff6ca6f829b4856e2b42f74ae5e3a2b762ba7e94b1e6
-  data.tar.gz: af162bcc83a5d6464c767c726b4e04af903c821303b151f02ed504cac3205e5b0f6b790e925b37a601e7149a4f37373e243e6db1ad29a352e894999adfd35e50
+  metadata.gz: b3f8f5ebc280851c6df676f27b6de15d7bc55941c612182c885cb5348b26da3c1aa8c5efec861cdbc5f3cba08c46f0b80959adfd1810c388dbfdf28b14a8c0fc
+  data.tar.gz: 61f3eaa68945aff32a34677ab8b28f2ebaf66e6e1a7734b9e66e22c409f11c892799b9ef1a8ccb62dc7a8ef5b6a86f43455957c3ec1369b9be91fbf5ac4a17e8

data/README.md

@@ -145,7 +145,7 @@ end
 ```
 
 
-### View log by node-bunyan
+## View log by node-bunyan
 
 Install [bunyan](https://github.com/trentm/node-bunyan) via NPM
 
@@ -171,6 +171,7 @@ $ bunyan output.log
       main.rb:18:in `<main>'
 ```
 
+
 ## Use human Readable formatter for console
 
 Add awesome_print to Gemfile and `bundle`
@@ -191,7 +192,94 @@ logger.formatter = Ougai::Formatters::Readable.new
 
 ### Screen result example
 
-![Screen Shot](https://github.com/tilfin/ougai/blob/images/ougai_readable_format.png?raw=true))
+![Screen Shot](https://github.com/tilfin/ougai/blob/images/ougai_readable_format.png?raw=true)
+
+
+## Use on Rails
+
+### for Development
+
+Add following code to `config/environments/development.rb`
+
+```ruby
+Rails.application.configure do
+  ...
+
+  logger = Ougai::Logger.new(STDOUT)
+  logger.formatter = Ougai::Formatters::Readable.new
+  config.logger = logger
+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 = Ougai::Logger.new(STDOUT)
+  else
+    config.logger = Ougai::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
+
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  def hello
+    logger.debug 'Call action', somefield: 'somevalue'
+    render plain: 'Hello!'
+  end
+end
+```
+
+logger outputs
+
+```
+[2016-11-03T15:11:24.847+09:00] DEBUG: Call action
+{
+    :somefield => "somevalue"
+}
+[2016-11-03T15:11:24.872+09:00] INFO: Request
+{
+    :request => {
+            :method => "GET",
+              :path => "/",
+            :format => :html,
+        :controller => "ApplicationController",
+            :action => "hello",
+            :status => 200,
+          :duration => 30.14,
+              :view => 3.35,
+                :db => 0.0
+    }
+}
+```
 
 ## License
 

data/lib/ougai/formatters/readable.rb

@@ -3,15 +3,19 @@ require 'ougai/formatters/base'
 module Ougai
   module Formatters
     class Readable < Base
-      def initialize(app_name = nil, hostname = nil)
-        super(app_name, hostname)
-        @trace_indent = 4
+      attr_accessor :plain, :trace_indent
+
+      def initialize(opts = {})
+        super(opts[:app_name], opts[:hostname])
+        @trace_indent = opts[:trace_indent] || 4
+        @plain = opts[:plain] || false
         load_awesome_print
       end
 
       def call(severity, time, progname, data)
         msg = data.delete(:msg)
-        strs = ["[#{time.iso8601(3)}] #{colored_level(severity)}: #{msg}"]
+        level = @plain ? severity : colored_level(severity)
+        strs = ["[#{time.iso8601(3)}] #{level}: #{msg}"]
         if data.key?(:err)
           err = data.delete(:err)
           err_str = "  #{err[:name]} (#{err[:message]}):"
@@ -19,7 +23,7 @@ module Ougai
           strs.push(err_str)
         end
         unless data.empty?
-          strs.push(data.ai)
+          strs.push(data.ai({ plain: @plain }))
         end
         strs.join("\n") + "\n"
       end

data/lib/ougai/version.rb

@@ -1,3 +1,3 @@
 module Ougai
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ougai
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Toshimitsu Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JSON logger compatible with node-bunyan is capable of handling data easily.
 test_files: []
-has_rdoc: