Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nishidayuya/structured_logger
A structured logger with Ruby's Logger interface.
https://github.com/nishidayuya/structured_logger
Last synced: about 1 month ago
JSON representation
A structured logger with Ruby's Logger interface.
- Host: GitHub
- URL: https://github.com/nishidayuya/structured_logger
- Owner: nishidayuya
- License: mit
- Created: 2015-08-26T21:28:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-23T10:45:01.000Z (almost 7 years ago)
- Last Synced: 2024-11-09T10:48:35.603Z (2 months ago)
- Language: Ruby
- Homepage: https://github.com/nishidayuya/structured_logger
- Size: 28.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# StructuredLogger
A structured logger with Ruby's Logger interface.
[](https://raw.githubusercontent.com/nishidayuya/structured_logger/master/LICENSE.txt)
[](http://badge.fury.io/rb/structured_logger)
[](https://gemnasium.com/nishidayuya/structured_logger)
[](https://travis-ci.org/nishidayuya/structured_logger)
[](https://codeclimate.com/github/nishidayuya/structured_logger/coverage)
[](https://codeclimate.com/github/nishidayuya/structured_logger)
## Installation
### General Ruby application
Add this line to your application's Gemfile:
gem 'structured_logger'
And then execute:
$ bundle
Or install it yourself as:
$ gem install structured_logger
### Rails application
Add to `Gemfile` (see previous section) and run `bundle`.
Write `config/initializers/structured_logger.rb`.
```ruby
# Use StructuredLogger instead of Logger.
l = StructuredLogger.new("log/#{Rails.env}.log")
# If you want timestamp and PID with ActiveSupport::TaggedLogging, enable next line.
#l.formatter = ::Logger::Formatter.new
# If you want tagging support, enable next line.
#l = ActiveSupport::TaggedLogging.new(l)
Rails.logger = l
```
Play it!
## Usage
We can write log with parameters.
```ruby
t = Time.now; sleep(0.1)
l = StructuredLogger.new(STDOUT)
l.debug("processed request", started_at: t, elapsed_sec: Time.now - t, status: "ok")
#=> D, [2015-08-21T05:14:37.022621 #8310] DEBUG -- : processed request: started_at=2015-08-21 05:14:36 +0900 elapsed_sec=0.100156444 status="ok"
l.debug { ["processed request", started_at: t, elapsed_sec: Time.now - t, status: "ok"] }
#=> D, [2015-08-21T05:15:00.214480 #8416] DEBUG -- : processed request: started_at=2015-08-21 05:15:00 +0900 elapsed_sec=0.100193648 status="ok"
```
`StructuredLogger` instance methods have Ruby's `Logger` interface. So, we can replace Ruby's `Logger` to `StructuredLogger`.
```ruby
l = Logger.new(STDOUT)
l.error("Something happend")
#=> E, [2015-08-25T06:43:18.244950 #23623] ERROR -- : Something happend
l = StructuredLogger.new(STDOUT)
l.error("Something happend")
#=> E, [2015-08-25T06:43:47.798889 #23623] ERROR -- : Something happend
```
Also we can use it with `ActiveSupport::TaggedLogging`.
```ruby
l = ActiveSupport::TaggedLogging.new(StructuredLogger.new(STDOUT))
l.tagged(:crawler) do
l.tagged(:downloading) do
l.warn("malformed file format", path: downloaded_path.to_s)
end
end
#=> [crawler] [downloading] malformed file format: path="/opt/app/tmp/1234.bin"
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/nishidayuya/structured_logger.