README.md

ContextualLogger

This gem adds the ability to your ruby logger, to accept conditional context, and utilize it when formatting your log entry.

Installation

To use an unreleased version, add it to your Gemfile for Bundler:

gem 'contextual_logger', git: 'git://github.com/Invoca/contextual_logger.git'

Usage

Initialization

To use the contextual logger, all you need to do is initailize the object with your existing logger

require 'logger'
require 'contextual_logger'

logger = Logger.new(STDOUT)
contextual_logger = ContextualLogger.new(logger)

Logging

All base logging methods are available for use with or without added context

contextual_logger.info('Something might have just happened', file: __FILE__, current_object: inspect)

If there is a base set of context you'd like to apply to a block of code, simply wrap it in #with_context

contextual_logger.with_context(file: __FILE__, current_object: inspect) do
  contextual_logger.info('Something might have just happened')
  try.doing_something()
rescue => ex
  contextual_logger.error('Something definitely just happened', error: ex.message)
end

If you'd like to set a global context for your process, you can do the following

contextual_logger.global_context = { service_name: 'test_service' }

Contributions

Contributions to this project are always welcome. Please thoroughly read our Contribution Guidelines before starting any work.