Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonots/ltsv_log_formatter
A ruby logger formatter to output log in LTSV format
https://github.com/sonots/ltsv_log_formatter
Last synced: 2 months ago
JSON representation
A ruby logger formatter to output log in LTSV format
- Host: GitHub
- URL: https://github.com/sonots/ltsv_log_formatter
- Owner: sonots
- License: mit
- Created: 2015-04-24T01:59:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-06T16:11:59.000Z (almost 8 years ago)
- Last Synced: 2024-10-13T08:08:23.980Z (3 months ago)
- Language: Ruby
- Size: 8.79 KB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# LtsvLogFormatter
A ruby logger formatter to output log in LTSV format
## Installation
Add this line to your application's Gemfile:
gem 'ltsv_log_formatter'
And then execute:
$ bundle
## How to use
```ruby
require 'logger'
require 'ltsv_log_formatter'
logger = Logger.new(STDOUT)
logger.formatter = LtsvLogFormatter.new
```
## Rails
Configure at `config/application.rb`
```ruby
config.logger.formatter = LtsvLogFormatter.new
```
## Example
Passing a hash parameter:
```
irb> logger.info({foo: "foo", bar: "bar"})
time:20150423T00:00:00+09:00\tlevel:INFO\tfoo:foo\tbar:bar
```
Passing a string parameter: `message` key is used as default
```ruby
irb> logger.info("foo")
time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo
```
NOTE1: Notice that the line feed character `\n` is converted into `\\n` because LTSV format does not allow to break lines
```ruby
irb> logger.info("foo\nbar")
time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo\\nbar
```
NOTE2: Notice that the tab character `\t` is converted into `\\t` because message might have a string as "\t:"
```ruby
irb> logger.info("foo\tbar:baz")
time:20150423T00:00:00+09:00\tlevel:INFO\tmessage:foo\\tbar:baz
```
## Options
* time_key
* Change the key name of the time field. Set `nil` to remove. Default: time
* level_key
* Change the kay name of the level field. Set `nil` to remove. Default: level
* message_key
* Change the kay name for the string (not hash) message. Default: message
Example)
```ruby
logger.formatter = LtsvLogFormatter.new(time_key: "log_time", level_key: nil)
```
## ChangeLog
See [CHANGELOG.md](CHANGELOG.md) for details.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new [Pull Request](../../pull/new/master)
## Copyright
See [LICENSE.txt](LICENSE.txt) for details.