https://github.com/steveklabnik/mono_logger

A lock-free logger for Ruby 2.0
https://github.com/steveklabnik/mono_logger

Last synced: 3 days ago
JSON representation

A lock-free logger for Ruby 2.0

• Host: GitHub
• URL: https://github.com/steveklabnik/mono_logger
• Owner: steveklabnik
• License: mit
• Created: 2013-03-20T04:56:11.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-04-06T17:19:11.000Z (over 1 year ago)
• Last Synced: 2024-12-06T06:50:23.186Z (17 days ago)
• Language: Ruby
• Homepage: https://github.com/steveklabnik/mono_logger
• Size: 28.3 KB
• Stars: 106
• Watchers: 6
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# MonoLogger

[![Build Status](https://travis-ci.org/steveklabnik/mono_logger.png?branch=master)](https://travis-ci.org/steveklabnik/mono_logger) [![Code Climate](https://codeclimate.com/github/steveklabnik/mono_logger.png)](https://codeclimate.com/github/steveklabnik/mono_logger)

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`:

```ruby

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

```ruby

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.