Faraday::Logging::ColorFormatter

Add some color to your Faraday logging output.

Before...

After...

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add faraday-logging-color_formatter

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install faraday-logging-color_formatter

Usage

Add the following to your ruby program.

require 'faraday/logging/color_formatter'

And then add the Faraday::Logging::ColorFormatter formatter to your logger middleware config.

connection = Faraday.new(url: 'http://httpbingo.org') do |conn|
  conn.response :logger, ActiveSupport::Logger.new($stdout), formatter: Faraday::Logging::ColorFormatter
end

If you want to replace the default HTTP Request and HTTP Response prefixes or adjust the indentation, pass in a prefix hash with your own values.

connection = Faraday.new(url: 'http://httpbingo.org') do |conn|
  conn.response :logger, ActiveSupport::Logger.new($stdout), formatter: Faraday::Logging::ColorFormatter, prefix: { request: 'request', response: 'response', indent: 2 }
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests and rake rubocop to run the linters. 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kobusjoubert/faraday-logging-color_formatter.

License

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