ougai 1.7.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02b6fb3d3c2a1bf4d395dcb2d1988230e6ec7d35
+  data.tar.gz: 4b839d8ec5c1a3ff40522532c37da50adb90b67a
+SHA512:
+  metadata.gz: 5b5a2ad7ef4dcf1ce0778b66a788d0c9f21299d8188c0f9c8d6a4818c4b3c7d1d7e241c18aefba27d0c2b5aef3c5edf48ca6db84515c87fc701be2abd0a56fb8
+  data.tar.gz: a1873ff2005aa43c434a5a3563c28b08729e4308faf172b38c1799ea72e3e5cd06ef9aa07745ef6bf702fe86b4112d4bbb8d9e0f7ebac892f8a39c680095e9a7

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ougai.gemspec
+gemspec
+
+group :test do
+  gem 'awesome_print'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    ougai (1.7.1-java)
+      jrjackson (~> 0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    jrjackson (0.4.6-java)
+    json (2.1.0-java)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    timecop (0.9.1)
+    yard (0.9.16)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.11)
+  ougai!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+  timecop
+  yard
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Toshimitsu Takahashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,363 @@
+Ougai
+=====
+
+[![Gem Version](https://badge.fury.io/rb/ougai.svg)](https://badge.fury.io/rb/ougai)
+[![document](https://img.shields.io/badge/document-1.7.0-green.svg)](http://www.rubydoc.info/gems/ougai/)
+[![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 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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ougai'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install ougai
+```
+
+## Usage
+
+**Ougai::Logger** is sub-class of original [Logger](https://ruby-doc.org/stdlib-2.4.1/libdoc/logger/rdoc/Logger.html) in Ruby.
+All arguments of the `initialize` pass through itself to **::Logger**.
+
+```ruby
+require 'rubygems'
+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
+logger.info('Information!')
+```
+
+```json
+{"name":"main","hostname":"mint","pid":14607,"level":30,"time":"2016-10-16T22:26:48.835+09:00","v":0,"msg":"Information!"}
+```
+
+### log only structured data
+
+```ruby
+logger.info({
+  msg: 'Request', method: 'GET', path: '/login',
+  format: 'html', controller: 'LoginController',
+  action: 'new', status: 200
+})
+logger.debug(user: { name: 'Taro', age: 19 })
+```
+
+```json
+{"name":"main","hostname":"mint","pid":9044,"level":30,"time":"2016-10-28T17:58:53.668+09:00","v":0,"msg":"Request","method":"GET","path":"/login","format":"html","controller":"LoginController","action":"new","status":200}
+{"name":"main","hostname":"mint","pid":9044,"level":20,"time":"2016-10-28T17:58:53.668+09:00","v":0,"msg":"No message","user":{"name":"Taro","age":19}}
+```
+
+If a data does not contain `msg` field, msg is set `default_message` attribute value of a Logger. its default is 'No message'.
+
+```ruby
+logger.default_message = 'User dump'
+logger.debug(user: { name: 'Taro', age: 19 })
+```
+
+```json
+{"name":"main","hostname":"mint","pid":9303,"level":20,"time":"2016-10-28T18:03:50.118+09:00","v":0,"msg":"User dump","user":{"name":"Taro","age":19}}
+```
+
+### log only an exception
+
+```ruby
+begin
+  raise StandardError, 'some error'
+rescue => ex
+  logger.error(ex)
+end
+```
+
+```json
+{"name":"main","hostname":"mint","pid":4422,"level":50,"time":"2016-10-22T13:05:02.989+09:00","v":0,"msg":"some error","err":{"name":"StandardError","message":"some error","stack":"main.rb:24:in `<main>'"}}
+```
+
+### log with a message and custom data
+
+```ruby
+logger.debug('Debugging', data_id: 1, data_flag: true)
+logger.debug('Debug!', custom_data: { id: 1, name: 'something' })
+```
+
+```json
+{"name":"main","hostname":"mint","pid":14607,"level":20,"time":"2016-10-16T22:26:48.836+09:00","v":0,"msg":"Debugging","data_id":1,"data_flag":true}
+{"name":"main","hostname":"mint","pid":14607,"level":20,"time":"2016-10-16T22:26:48.836+09:00","v":0,"msg":"Debug!","custom_data":{"id":1,"name":"something"}}
+```
+
+### log with a message and an exception
+
+```ruby
+begin
+  raise StandardError, 'fatal error'
+rescue => ex
+  logger.fatal('Unexpected!', ex)
+end
+```
+
+```json
+{"name":"main","hostname":"mint","pid":14607,"level":60,"time":"2016-10-16T22:26:48.836+09:00","v":0,"msg":"Unexpected!","err":{"name":"StandardError","message":"fatal error","stack":"main.rb:12:in `<main>'"}}
+```
+
+### log with an exception and custom data
+
+```ruby
+begin
+  raise StandardError, 'some error'
+rescue => ex
+  logger.error(ex, error_id: 999)
+end
+```
+
+```json
+{"name":"main","hostname":"mint","pid":13962,"level":50,"time":"2016-10-28T23:44:52.144+09:00","v":0,"error_id":999,"err":{"name":"StandardError","message":"some error","stack":"main.rb:40:in `<main>'"}}
+```
+
+### log with a message, an exception and custom data
+
+```ruby
+begin
+  1 / 0
+rescue => ex
+  logger.error('Caught error', ex, reason: 'zero spec')
+end
+```
+
+```json
+{"name":"main","hostname":"mint","pid":14607,"level":50,"time":"2016-10-16T22:26:48.836+09:00","v":0,"msg":"Caught error","err":{"name":"ZeroDivisionError","message":"divided by 0","stack":"main.rb:18:in `/'\n ...'"},"reason":"zero spec"}
+```
+
+### logs with blocks
+
+```ruby
+logger.info { 'Hello!' }
+
+logger.debug do
+  ['User dump', { name: 'Taro', age: 15 }]
+end
+
+logger.error do
+  ['Failed to fetch info', ex, { id: 10 }]
+end
+
+loggger.fatal { ex }
+
+loggger.fatal do
+  ['Unexpected', ex]
+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.
+But if the field's type is *Array*, both with_field value and logging value are merged with `concat` and `uniq`.
+
+### Create a child logger
+
+`logger.child(with_fields)` creates a child logger of self. Its argument `with_fields` add to all logs the child logger outputs. A child logger can also create its child logger. If you pass a block to this method, the child logger will be yielded to it.
+
+```ruby
+logger = Ougai::Logger.new(STDOUT)
+logger.with_fields = { app: 'yourapp', tags: ['service'], kind: 'main' }
+
+child_logger = logger.child({ tags:['user'], kind: 'logic' })
+logger.info('Created child logger')
+
+child_logger.info('Created a user', name: 'Mike')
+
+gc_logger = child_logger.child({ kind: 'detail' })
+child_logger.info('Created grand child logger')
+
+gc_logger.debug('something detail', age: 34, weight: 72)
+
+gc_logger.child({ mode: 'processed' }) do |gcc_logger|
+  gcc_logger.info('Great-grandchild logger that will be cleaned up on block exit.')
+
+  :some_return_value
+end
+```
+
+```json
+{"name":"main","hostname":"mint2","pid":8342,"level":30,"time":"2017-08-01T22:07:20.400+09:00","v":0,"app":"yourapp","tags":["service"],"kind":"main","msg":"Created child logger"}
+{"name":"Mike","hostname":"mint2","pid":8342,"level":30,"time":"2017-08-01T22:07:20.400+09:00","v":0,"app":"yourapp","tags":["service","user"],"kind":"logic","msg":"Created a user"}
+{"name":"main","hostname":"mint2","pid":8342,"level":30,"time":"2017-08-01T22:07:20.400+09:00","v":0,"app":"yourapp","tags":["service","user"],"kind":"logic","msg":"Created grand child logger"}
+{"name":"main","hostname":"mint2","pid":8342,"level":20,"time":"2017-08-01T22:07:20.400+09:00","v":0,"app":"yourapp","tags":["service","user"],"kind":"detail","age":34,"weight":72,"msg":"something detail"}
+{"name":"main","hostname":"mint2","pid":8342,"level":20,"time":"2017-08-01T22:07:20.400+09:00","v":0,"app":"yourapp","tags":["service","user"],"kind":"detail","mode":"processed","msg":"Great-grandchild logger that will be cleaned up on block exit."}
+```
+
+If any field exists in both parent log and child log, the parent value is overridden or merged by child value.
+
+### Hook before logging
+
+Setting `before_log` of logger or child an *lambda* with `data` field, a process can be run before log each output.
+
+* Adding variable data (like Thread ID) to logging data can be defined in common.
+* Returning `false` in *lambda*, the log is cancelled and does not output.
+* The *before_log* of child logger is run ahead of the parent logger's.
+
+```ruby
+logger.before_log = lambda do |data|
+  data[:thread_id] = Thread.current.object_id.to_s(36)
+end
+
+logger.debug('on main thread')
+Thread.new { logger.debug('on another thread') }
+```
+
+```json
+{"name":"main","hostname":"mint","pid":13975,"level":20,"time":"2017-08-06T15:35:53.435+09:00","v":0,"msg":"on main thread","thread_id":"gqe0ava6c"}
+{"name":"main","hostname":"mint","pid":13975,"level":20,"time":"2017-08-06T15:35:53.435+09:00","v":0,"msg":"on another thread","thread_id":"gqe0cb14g"}
+```
+
+### Using broadcast, log output plural targets
+
+`Ougai::Logger.broadcast` can be used to like `ActiveSupport::Logger.broadcast`.
+
+#### An example
+
+Original `logger` outputs STDOUT and `error_logger` outputs `./error.log`.
+Every calling for `logger` is propagated to `error_logger`.
+
+```ruby
+logger = Ougai::Logger.new(STDOUT)
+
+error_logger = Ougai::Logger.new('./error.log')
+logger.extend Ougai::Logger.broadcast(error_logger)
+
+logger.level = Logger::INFO
+logger.info('Hello!')
+
+error_logger.level = Logger::ERROR
+logger.error('Failed to do something.')
+
+logger.level = Logger::WARN # error_logger level is also set WARN by propagation
+logger.warn('Ignored something.')
+```
+
+##### STDOUT
+
+```json
+{"name":"main","hostname":"mint","pid":24915,"level":30,"time":"2017-08-16T17:23:42.415+09:00","v":0,"msg":"Hello!"}
+{"name":"main","hostname":"mint","pid":24915,"level":50,"time":"2017-08-16T17:23:42.416+09:00","v":0,"msg":"Failed to do something."}
+{"name":"main","hostname":"mint","pid":24915,"level":40,"time":"2017-08-16T17:23:42.416+09:00","v":0,"msg":"Ignored something."}
+```
+
+##### error.log
+
+```json
+{"name":"main","hostname":"mint","pid":24915,"level":50,"time":"2017-08-16T17:23:42.415+09:00","v":0,"msg":"Failed to do something."}
+{"name":"main","hostname":"mint","pid":24915,"level":40,"time":"2017-08-16T17:23:42.416+09:00","v":0,"msg":"Ignored something."}
+```
+
+
+## View pretty logs with node-bunyan or pino
+
+Install [bunyan](https://github.com/trentm/node-bunyan) or [pino](https://github.com/pinojs/pino) via npm
+
+```
+$ npm install -g bunyan
+```
+
+Pipe a log file to command
+
+```
+$ 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!
+    custom_data: {
+      "id": 1,
+      "name": "something"
+    }
+[2016-10-16T22:26:48.836+09:00] FATAL: main/14607 on mint: Unexpected!
+    main.rb:12:in `<main>'
+[2016-10-16T22:26:48.836+09:00] ERROR: main/14607 on mint: Caught error (reason="z
+    main.rb:18:in `/'
+      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
+
+Add awesome_print to Gemfile and `bundle`
+
+```ruby
+gem 'awesome_print'
+```
+
+Set *Ougai::Formatters::Readable* instance to `formatter` accessor
+
+```ruby
+require 'rubygems'
+require 'ougai'
+
+logger = Ougai::Logger.new(STDOUT)
+logger.formatter = Ougai::Formatters::Readable.new
+```
+
+### Screen result example
+
+![Screen Shot](https://github.com/tilfin/ougai/blob/images/ougai_readable_format.png?raw=true)
+
+
+## How to use with famous products, services and libraries
+
+- [Use as Rails logger](https://github.com/tilfin/ougai/wiki/Use-as-Rails-logger) and apply the request with [Lograge](https://github.com/roidrage/lograge)
+- [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)
+- [Forward logs to Loggly](https://github.com/tilfin/ougai/wiki/Forward-logs-to-Loggly)
+- [Use as Rack logger](https://github.com/tilfin/ougai/wiki/Use-as-Rack-logger)
+
+## Custom formatters and integrations
+- [Awesome Ougai](https://github.com/tilfin/ougai/wiki/Awesom-Ougai)
+
+## License
+
+[MIT](LICENSE.txt)