Skip to content

Commit 1fca7c3

Browse files
committed
chore: improve logger docs
fixes elixir-tesla#671 Signed-off-by: Yordis Prieto <[email protected]>
1 parent 6f0f2c0 commit 1fca7c3

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

lib/tesla/middleware/logger.ex

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ defmodule Tesla.Middleware.Logger do
6161
@moduledoc ~S"""
6262
Log requests using Elixir's Logger.
6363
64-
With the default settings it logs request method, URL, response status, and time taken in milliseconds.
64+
With the default settings it logs request method, URL, response status, and
65+
time taken in milliseconds.
6566
6667
## Examples
6768
@@ -77,7 +78,7 @@ defmodule Tesla.Middleware.Logger do
7778
7879
- `:log_level` - custom function for calculating log level (see below)
7980
- `:filter_headers` - sanitizes sensitive headers before logging in debug mode (see below)
80-
- `:debug` - show detailed request/response logging
81+
- `:debug` - use `Logger.debug/2` to log request/response details
8182
- `:format` - custom string template or function for log message (see below)
8283
8384
## Custom log format
@@ -140,12 +141,18 @@ defmodule Tesla.Middleware.Logger do
140141
141142
## Logger Debug output
142143
143-
When the Elixir Logger log level is set to `:debug`
144-
Tesla Logger will show full request & response.
144+
`Tesla` will use `Logger.debug/2` to log request & response details using
145+
the `:debug` option. It will require to set the `Logger` log level to `:debug`
146+
in your configuration, example:
145147
146-
If you want to disable detailed request/response logging
147-
but keep the `:debug` log level (i.e. in development)
148-
you can set `debug: false` in your config:
148+
```elixir
149+
# config/dev.exs
150+
config :logger, level: :debug
151+
```
152+
153+
If you want to disable detailed request/response logging but keep the
154+
`:debug` log level (i.e. in development) you can set `debug: false` in your
155+
config:
149156
150157
```elixir
151158
# config/dev.local.exs

0 commit comments

Comments
 (0)