Lug

A small Ruby logger for debugging libraries and applications. Pretty much a clone of debug for Node.js

Features

• Smaller and faster than Ruby's logger
• Colorized output for tty output devices (like stderr)
• Filter log messages by namespace
• Standard logger interface (responds to #debug, #warn, #error, etc.)

Installation

Add this line to your application's Gemfile:

gem 'lug'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lug

Usage

TODO: Write usage instructions here

Benchmark

Performance comparison between Ruby's Logger class and Lug logger classes. TtyLogger colorizes output and calculates elapsed time between lines.

                                    user     system      total        real
Logger#debug                    2.720000   0.430000   3.150000 (  3.144094)
Lug::Logger#log                 1.470000   0.050000   1.520000 (  1.521829)
Lug::Logger#log + TtyDevice     1.480000   0.040000   1.520000 (  1.522490)
Lug::Logger#debug               1.740000   0.050000   1.790000 (  1.785965)
Lug::Logger#debug + TtyDevice   1.740000   0.040000   1.780000 (  1.781318)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake 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, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/munshkr/lug. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.