Skip to content

Commit

Permalink
Add notes about logging to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
danielmorrison committed Jan 14, 2025
1 parent e068abb commit 2b071e5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,15 @@ As an Engine, we avoid all the standard Rails middleware. That's nice for simpli
Rails.application.config.twirp.middleware = [Rack::Deflater]
```

### Logging

Our built-in logging outputs the result of each request. Additionally, you can output the Twirp object to help with debugging:

```ruby
# Defaults to true if your log_level is :debug
Rails.application.config.twirp.verbose_logging = true
```

## Bonus Features

Outside the [Twirp spec](https://twitchtv.github.io/twirp/docs/spec_v7.html), we have some (optional) extra magic. They might be useful to you, but you can easily ignore them too.
Expand Down

0 comments on commit 2b071e5

Please sign in to comment.