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

Merge pull request #75 from thedarkside/master

Browse source 
Replaced all 'use' examples in README.md with 'insert_before'
This commit is contained in:
Sami Samhuri 2025-06-27 08:45:59 -04:00 committed by GitHub
commit f7341032d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
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

@ -113,7 +113,7 @@ end
You can change the formatter like so
```ruby
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
```
@ -124,7 +124,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`
```ruby
class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger,
insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
logger: logger,
include: [ GrapeLogging::Loggers::Response.new,
GrapeLogging::Loggers::FilterParameters.new,
@ -157,7 +158,8 @@ You can control the level used to log. The default is `info`.
```ruby
class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger,
insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
logger: logger,
log_level: 'debug'
end
@ -169,7 +171,8 @@ You can choose to not pass the logger to ```grape_logging``` but instead send lo
First, config ```grape_logging```, like that:
```ruby
class MyAPI < Grape::API
use GrapeLogging::Middleware::RequestLogger,
insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
instrumentation_key: 'grape_key',
include: [ GrapeLogging::Loggers::Response.new,
GrapeLogging::Loggers::FilterParameters.new ]