root
/
grape-middleware-logger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

reorganize the readme

This commit is contained in:
Ryan Buckley 2015-12-12 01:04:19 -08:00
parent ea4503558d
commit 558030b6dc
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -23,7 +23,36 @@ end
Server requests will be logged to STDOUT by default.
#### Rails
## Custom setup
Customize the logging by passing the `logger` option. Example using a CustomLogger and parameter sanitization:
```ruby
use Grape::Middleware::Logger, {
logger: CustomLogger.new,
filter: CustomFilter.new
}
```
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
Processing by ReportsAPI#reports/:id
Parameters: {"id"=>"101"}
Completed 200 in 6.29ms
```
Error
```
Started POST "/v1/reports" at 2015-12-11 15:42:33 -0800
Processing by ReportsAPI#reports
Parameters: {"name"=>"foo", "password"=>"[FILTERED]"}
Error: {:error=>"undefined something something bad", :detail=>"Whoops"}
Completed 422 in 6.29ms
```
## Using Rails?
`Rails.logger` and `Rails.application.config.filter_parameters` will be used automatically as the default logger and
param filterer, respectively.
@ -51,35 +80,6 @@ class SelectiveLogger
end
```
#### Custom setup
Customize the logging by passing the `logger` option. Example using a CustomLogger and parameter sanitization:
```ruby
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
Processing by ReportsAPI#reports/:id
Parameters: {"id"=>"101"}
Completed 200 in 6.29ms
```
Error
```
Started POST "/v1/reports" at 2015-12-11 15:42:33 -0800
Processing by ReportsAPI#reports
Parameters: {"name"=>"foo", "password"=>"[FILTERED]"}
Error: {:error=>"undefined something something bad", :detail=>"Whoops"}
Completed 422 in 6.29ms
```
## Rack
If you're using the `rackup` command to run your server in development, pass the `-q` flag to silence the default rack logger.