sjs/grape_logging
1
0
Fork 0
mirror of https://github.com/samsonjs/grape_logging.git synced 2026-03-25 08:55:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Replaced all 'use' examples in README.md with 'insert_before'

Browse source
This commit is contained in:
thedarkside 2021-10-08 22:04:12 +02:00 committed by GitHub
parent 6e562a2788
commit 01846a40ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -114,7 +114,7 @@ end
You can change the formatter like so You can change the formatter like so
```ruby ```ruby
class MyAPI < Grape::API class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger, logger: logger, formatter: MyFormatter.new insert_before Grape::Middleware::Error, GrapeLogging::Middleware::RequestLogger, logger: logger, formatter: MyFormatter.new
end end
``` ```
@ -125,7 +125,8 @@ If you prefer some other format I strongly encourage you to do pull request with
You can include logging of other parts of the request / response cycle by including subclasses of `GrapeLogging::Loggers::Base` You can include logging of other parts of the request / response cycle by including subclasses of `GrapeLogging::Loggers::Base`
```ruby ```ruby
class MyAPI < Grape::API class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger, insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
logger: logger, logger: logger,
include: [ GrapeLogging::Loggers::Response.new, include: [ GrapeLogging::Loggers::Response.new,
GrapeLogging::Loggers::FilterParameters.new, GrapeLogging::Loggers::FilterParameters.new,
@ -158,7 +159,8 @@ You can control the level used to log. The default is `info`.
```ruby ```ruby
class MyAPI < Grape::API class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger, insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
logger: logger, logger: logger,
log_level: 'debug' log_level: 'debug'
end end
@ -170,7 +172,8 @@ You can choose to not pass the logger to ```grape_logging``` but instead send lo
First, config ```grape_logging```, like that: First, config ```grape_logging```, like that:
```ruby ```ruby
class MyAPI < Grape::API class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger, insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
instrumentation_key: 'grape_key', instrumentation_key: 'grape_key',
include: [ GrapeLogging::Loggers::Response.new, include: [ GrapeLogging::Loggers::Response.new,
GrapeLogging::Loggers::FilterParameters.new ] GrapeLogging::Loggers::FilterParameters.new ]