From 56cacefda4f18c8fdc45839b6bec1d07d0d2d78e Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Thu, 28 Feb 2019 20:49:08 +0100
Subject: [logger] Add log file rotation by options to logger_std_h

OTP-15479
OTP-15662

New configuration map for logger_std_h:

 #{type => file,
   file => file:filename(),
   modes => [file:mode()],
   max_no_bytes => pos_integer() | infinity,
   max_no_files => non_neg_integer(),
   compress_on_rotate => boolean()}

For backwards compatibility, the old variant for specifying the file
name via the 'type' parameter is still supported, i.e. {file,FileName}
and {file,FileName,Modes}, but it is no longer documented.

Rotation scheme:
The current log file always has the same name, and the archived files
get extensions ".0", ".1", ... The newest archive has extension ".0",
and the oldest archive has the highest number.

If 'compress_on_rotate' is set to true, the archived files are gzipped
and get the additional extension ".gz", e.g. error.log.0.gz.

Rotation is turned off by setting 'max_no_bytes' to infinity. Setting
'max_no_files' to 0 does not turn off rotation, but only specifies
that no archives are to be saved.
---
 lib/kernel/doc/src/logger_chapter.xml | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'lib/kernel/doc/src/logger_chapter.xml')

diff --git a/lib/kernel/doc/src/logger_chapter.xml b/lib/kernel/doc/src/logger_chapter.xml
index 5ed7397135..bfd0acf634 100644
--- a/lib/kernel/doc/src/logger_chapter.xml
+++ b/lib/kernel/doc/src/logger_chapter.xml
@@ -801,7 +801,7 @@ logger:debug(#{got => connection_request, id => Id, state => State},
 [{kernel,
   [{logger,
     [{handler, default, logger_std_h,  % {handler, HandlerId, Module,
-      #{config => #{type => {file,"log/erlang.log"}}}}  % Config}
+      #{config => #{file => "log/erlang.log"}}}  % Config}
     ]}]}].
       </code>
       <p>Modify the default handler to print each log event as a
@@ -831,10 +831,10 @@ logger:debug(#{got => connection_request, id => Id, state => State},
   [{logger,
     [{handler, default, logger_std_h,
       #{level => error,
-        config => #{type => {file, "log/erlang.log"}}}},
+        config => #{file => "log/erlang.log"}}},
      {handler, info, logger_std_h,
       #{level => debug,
-        config => #{type => {file, "log/debug.log"}}}}
+        config => #{file => "log/debug.log"}}}
     ]}]}].
       </code>
     </section>
@@ -1004,10 +1004,10 @@ ok</pre>
     <p>Then, add a new handler which prints to file. You can use the
       handler
       module <seealso marker="logger_std_h"><c>logger_std_h</c></seealso>,
-      and specify type <c>{file,File}</c>.:</p>
+      and configure it to log to file:</p>
     <pre>
-4> <input>Config = #{config => #{type => {file,"./info.log"}}, level => info}.</input>
-#{config => #{type => {file,"./info.log"}},level => info}
+4> <input>Config = #{config => #{file => "./info.log"}, level => info}.</input>
+#{config => #{file => "./info.log"},level => info}
 5> <input>logger:add_handler(myhandler, logger_std_h, Config).</input>
 ok</pre>
     <p>Since <c>filter_default</c> defaults to <c>log</c>, this
@@ -1246,7 +1246,7 @@ do_log(Fd, LogEvent, #{formatter := {FModule, FConfig}}) ->
       <p>A configuration example:</p>
       <code type="none">
 logger:add_handler(my_standard_h, logger_std_h,
-                   #{config => #{type => {file,"./system_info.log"},
+                   #{config => #{file => "./system_info.log",
                                  sync_mode_qlen => 100,
                                  drop_mode_qlen => 1000,
                                  flush_qlen => 2000}}).
-- 
cgit v1.2.3