2.4 KiB

Raw Blame History

Grape::Middleware::Logger

Simple logger for Grape apps. Logs request path, parameters, status and time taken. Also logs exceptions and error responses (thrown by error!).

Installation

Add this line to your application's Gemfile:

gem 'grape', '>= 0.12.0'
gem 'grape-middleware-logger'

Usage

class API < Grape::API
  # @note Make sure this above you're first +mount+
  use Grape::Middleware::Logger
end

Server requests will be logged to STDOUT by default.

Rails

Using Grape with Rails? The Rails.logger will be used by default.

Custom setup

Customize the logging by passing the logger option. Example using a CustomLogger and parameter sanitization:

use Grape::Middleware::Logger, {
  logger: CustomLogger.new,
  filter: ActionDispatch::Http::ParameterFilter.new(Rails.application.config.filter_parameters)
}

The logger option can be any object that responds to .info(msg)

The filter option can be any object that responds to .filter(params_hash)

Example output

Get

Started GET "/v1/reports/101" at 2015-12-11 15:40:51 -0800
  Parameters: {"id"=>"101"}
Completed 200 in 6.29ms

Error

Started POST "/v1/reports" at 2015-12-11 15:42:33 -0800
  Parameters: {"name"=>"foo", "password"=>"[FILTERED]"}
  Error: {:error=>"undefined something something bad", :detail=>"Whoops"}
Completed 422 in 6.29ms

Credits

Big thanks to jadent's question/answer on stackoverflow for easily logging error responses. Borrowed some motivation from the grape_logging gem and would love to see these two consolidated at some point.

Contributing

Fork it ( https://github.com/ridiculous/grape-middleware-logger/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

2.4 KiB Raw Blame History