A lock-free logger for Ruby 2.0
Ruby
Switch branches/tags
Clone or download
Latest commit 0cbc317 Sep 3, 2014

README.md

MonoLogger

Build Status Code Climate Coverage Status

Ruby's stdlib Logger wraps all IO in mutexes. Ruby 2.0 doesn't allow you to request a lock in a trap handler because that could deadlock. This gem fixes this issue by giving you a lock-free logger class.

If you've ever seen log writing failed. can't be called from trap context, you're in the right place!

Installation

Add this line to your application's Gemfile:

gem 'mono_logger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mono_logger

Usage

It's simple, just use MonoLogger anywhere you'd use Logger:

require 'logger'


logger = Logger.new(STDOUT)
logger.level = Logger::WARN

logger.debug("Created logger")
logger.info("Program started")
logger.warn("Nothing to do!")

Turns into

require 'mono_logger'


logger = MonoLogger.new(STDOUT)
logger.level = MonoLogger::WARN

logger.debug("Created logger")
logger.info("Program started")
logger.warn("Nothing to do!")

That's it! No more errors!

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

License

MIT. See LICENSE.txt for more details.