@@ -16,8 +16,8 @@ defmodule Logger do
16
16
performant when required but also apply backpressure
17
17
when under stress.
18
18
19
- * Wraps OTP's ` error_logger` to prevent it from
20
- overflowing.
19
+ * Wraps OTP's [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
20
+ to prevent it from overflowing.
21
21
22
22
Logging is useful for tracking when an event of interest happens in your
23
23
system. For example, it may be helpful to log whenever a user is deleted.
@@ -63,7 +63,7 @@ defmodule Logger do
63
63
application is started, but may be changed during runtime
64
64
65
65
* Error logger configuration - configuration for the
66
- wrapper around OTP's ` error_logger`
66
+ wrapper around OTP's [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
67
67
68
68
### Application configuration
69
69
@@ -145,11 +145,11 @@ defmodule Logger do
145
145
### Error logger configuration
146
146
147
147
The following configuration applies to `Logger`'s wrapper around
148
- Erlang 's ` error_logger`. All the configurations below must be set
149
- before the `:logger` application starts.
148
+ OTP 's [`: error_logger`](http://erlang.org/doc/man/error_logger.html).
149
+ All the configurations below must be set before the `:logger` application starts.
150
150
151
151
* `:handle_otp_reports` - redirects OTP reports to `Logger` so
152
- they are formatted in Elixir terms. This uninstalls Erlang 's
152
+ they are formatted in Elixir terms. This uninstalls OTP 's
153
153
logger that prints terms to terminal. Defaults to `true`.
154
154
155
155
* `:handle_sasl_reports` - redirects supervisor, crash and
@@ -163,17 +163,17 @@ defmodule Logger do
163
163
reached, triggers the error logger to discard messages. This
164
164
value must be a positive number that represents the maximum
165
165
number of messages accepted per second. Once above this
166
- threshold, the ` error_logger` enters discard mode for the
167
- remainder of that second. Defaults to 500 messages.
166
+ threshold, the [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
167
+ enters discard mode for the remainder of that second. Defaults to 500 messages.
168
168
169
- For example, to configure `Logger` to redirect all ` error_logger` messages
170
- using a `config/config.exs` file:
169
+ For example, to configure `Logger` to redirect all [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
170
+ messages using a `config/config.exs` file:
171
171
172
172
config :logger,
173
173
handle_otp_reports: true,
174
174
handle_sasl_reports: true
175
175
176
- Furthermore, `Logger` allows messages sent by Erlang 's ` error_logger`
176
+ Furthermore, `Logger` allows messages sent by OTP 's [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
177
177
to be translated into an Elixir format via translators. Translators
178
178
can be dynamically added at any time with the `add_translator/1`
179
179
and `remove_translator/1` APIs. Check `Logger.Translator` for more
@@ -521,8 +521,8 @@ defmodule Logger do
521
521
## Options
522
522
523
523
* `:flush` - when `true`, guarantees all messages currently sent
524
- to both Logger and Erlang 's ` error_logger` are processed before
525
- the backend is added
524
+ to both Logger and OTP 's [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
525
+ are processed before the backend is added
526
526
527
527
"""
528
528
@ spec add_backend ( atom , keyword ) :: Supervisor . on_start_child ( )
@@ -548,8 +548,8 @@ defmodule Logger do
548
548
## Options
549
549
550
550
* `:flush` - when `true`, guarantees all messages currently sent
551
- to both Logger and Erlang 's ` error_logger` are processed before
552
- the backend is removed
551
+ to both Logger and OTP 's [`: error_logger`](http://erlang.org/doc/man/error_logger.html)
552
+ are processed before the backend is removed
553
553
554
554
"""
555
555
@ spec remove_backend ( atom , keyword ) :: :ok | { :error , term }
0 commit comments