Improve docs for Logger overload protection (#13855)

The previous docs didn't mention that logger may drop messages entirely. This should give a fair overview of the built-in overload protections, similar to erlang/otp#8855. --- Co-authored-by: Andrea Leopardi <[email protected]>
elixir-lang · Sep 24, 2024 · 6cd46d7 · 6cd46d7
1 parent b8b7947
commit 6cd46d7
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/lib/logger/lib/logger.ex b/lib/logger/lib/logger.ex
@@ -19,9 +19,12 @@ defmodule Logger do
     * Formats and truncates messages on the client
       to avoid clogging `Logger` handlers.
 
-    * Alternates between sync and async modes to remain
-      performant when required but also apply back-pressure
-      when under stress.
+    * Provides multiple forms of [overload protection](https://www.erlang.org/doc/apps/kernel/logger_chapter.html#protecting-the-handler-from-overload):
+      * keeps track of its message queue and switches to sync mode to apply
+        back pressure or even drop messages
+      * limits the number of logs emitted defaulting to 500 per second
+      * optionally allows to terminate and restart it if the message queue length
+        or memory thresholds are exceeded
 
     * Allows overriding the logging level for a specific module,
       application or process.