File 1881-Document-the-log-messages-emitted-when-the-handler-f.patch of Package erlang
From abe053fce424854c2e6c6c06e62e39a1a9ba832c Mon Sep 17 00:00:00 2001 From: Tobias Pfeiffer <pragtob@gmail.com> Date: Thu, 14 Nov 2024 11:57:02 +0100 Subject: [PATCH] Document the log messages emitted when the handler flushes Was lucky enough to encounter it right now, and thought it'd be a nice addition to the docs just like the drop message #8849 Also adjusted the wording and example around both: * "something" felt to unsure for logs upon revision * my example included `[notice]` which I learned the other day is the elixir default formtting, not erlang :sweat-smile:, so moved that to the text so that it applies for both without "falsifying" the example. --- lib/kernel/doc/guides/logger_chapter.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/kernel/doc/guides/logger_chapter.md b/lib/kernel/doc/guides/logger_chapter.md index c5b28e01e4..e684c380d5 100644 --- a/lib/kernel/doc/guides/logger_chapter.md +++ b/lib/kernel/doc/guides/logger_chapter.md @@ -1025,8 +1025,8 @@ actions, exist: message queue is reduced to a level below the threshold, synchronous or asynchronous mode is resumed. Notice that when the handler activates or deactivates drop mode, information about it is printed in the log. - The emitted log message looks something like this: - `[notice] Handler :default switched from :sync to :drop mode` + The emitted log message is on the `:notice` level and looks like this: + `Handler :default switched from :sync to :drop mode` Defaults to `200` messages. @@ -1039,6 +1039,8 @@ actions, exist: make sure that no new events are received during the operation. Notice that after the flush operation is performed, the handler prints information in the log about how many events have been deleted. + The emitted log message is on the `:notice` level and looks like this: + `Handler :default flushed 1070 log events` Defaults to `1000` messages. -- 2.43.0
