Logger Facade Ruby

Simple class library to work as logger facade.

This simple logger facade allows you to hook plugins to execute logging.

Installation

Add this line to your application's Gemfile:

gem ' logger_facade'

And then execute:

$ bundle

Or install it yourself as:

$ gem install logger_facade

How to use it

Install it:

gem install logger_facade

Set up plugins

require 'logger_facade'

# this is default config for Console plugin
config = {
  level: :info,
  time_format: '%y-%M-%d %H:%M:%S',
  message_format: '%time | %level | %logger - %msg'
}

# configuration is optional in console plugin
plugin = LoggerFacade::Plugins::Console.new(config);

# hook plugin/s
LoggerFacade::Manager.use(plugin)

# obtain class logger
log = LoggerFacade::Manager.get_logger("Log Name")

# log
log.debug("something to log")
log.info("something to log in info")

# log exception directly
log.error(Exception.new("some caught exception"))

NOTE: Console plugin uses check strftime formats.

Available plugins

• Console
• Airbrake (Will be developed soon)
• Elasticsearch (Will be developed soon)

** Do you need some other plugin?**

Feel free to create one and get in touch with me, that i will add it to this list.

LoggerFacade::Manager Contract

# register a plugin on logger
LoggerFacade::Manager.use(plugin)
# retrieve the list of plugin names
LoggerFacade::Manager.plugins()
# clean  up the list of registered plugins
LoggerFacade::Manager.clearPlugins()
# retrieve a logger with the specified name
log = LoggerFacade::Manager.getLogger("Log Name")

LoggerFacade::Log Contract

log.isDebug() # return if in debug or trace level
log.trace("trace something")
log.debug("debug something")
log.info("info something")
log.warn("warn something")
log.error("error something")
log.error(Exception.new('some caught exception'))

LoggerFacade::Plugins

The plugins must follow this contract:

# plugin name
#name

#isDebug
#trace
#debug
#info
#warn
#error

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

Bump versioning

We use bump gem to control gem versioning.

Bump Patch version

$ bump patch

Bump Minor version

$ bump minor

Bump Major version

$ bump major

Running Specs

$ rspec

Coverage Report

$ open ./coverage/index.html

Credits

Shout out to @pjanuario.