Merge branch 'siri/kernel/logger/OTP-13295'

* siri/kernel/logger/OTP-13295:
  Add documentation of the built-in logger handlers
  Catch badarg in logger:get_format_depth/0
  Add chars_limit option to logger_formatter
  Don't kill logger process until all other processes are dead
  Set call timeout for logger_server to infinity
  Update primary bootstrap
  Test cuddle for logger
  Update cth_log_redirect to a logger handler
  Start using logger internally in kernel and stdlib
  Remove error_logger process and add logger process
  Add logger

6 files changed, 193 insertions, 123 deletions

diff --git a/lib/sasl/doc/src/sasl_app.xml b/lib/sasl/doc/src/sasl_app.xml
index e0693fcb60..48b0b8eafb 100644
--- a/lib/sasl/doc/src/sasl_app.xml
+++ b/lib/sasl/doc/src/sasl_app.xml
@@ -34,12 +34,9 @@
     <p>The SASL application provides the following services:</p>
     <list type="bulleted">
       <item><c>alarm_handler</c></item>
-      <item><c>rb</c></item>
       <item><c>release_handler</c></item>
       <item><c>systools</c></item>
     </list>
-    <p>The SASL application also includes <c>error_logger</c> event
-      handlers for formatting SASL error and crash reports.</p>
     <note>
        <p>The SASL application in OTP has nothing to do with
           "Simple Authentication and Security Layer" (RFC 4422).</p>
@@ -47,51 +44,109 @@
   </description>
 
   <section>
-    <title>Error Logger Event Handlers</title>
-    <p>The following error logger event handlers are used by
-      the SASL application.</p>
+    <title>Configuration</title>
+    <p>The following configuration parameters are defined for the SASL
+      application. For more information about configuration parameters, see
+      <seealso marker="kernel:app"><c>app(4)</c></seealso> in Kernel.</p>
+    <p>All configuration parameters are optional.</p>
+    <taglist>
+      <tag><c><![CDATA[start_prg = string() ]]></c></tag>
+      <item>
+        <p>Specifies the program to be used when restarting the system
+          during release installation. Default is
+          <c>$OTP_ROOT/bin/start</c>.</p>
+      </item>
+      <tag><c><![CDATA[masters = [atom()] ]]></c></tag>
+      <item>
+        <p>Specifies the nodes used by this node to read/write release
+          information. This parameter is ignored if parameter
+          <c>client_directory</c> is not set.</p>
+      </item>
+      <tag><c><![CDATA[client_directory = string() ]]></c></tag>
+      <item>
+        <p>This parameter specifies the client directory at the master
+          nodes. For details, see
+          <seealso marker="doc/design_principles:release_handling">Release Handling</seealso>
+          in <em>OTP Design Principles</em>. This parameter is
+          ignored if parameter <c>masters</c> is not set.</p>
+      </item>
+      <tag><c><![CDATA[static_emulator = true | false ]]></c></tag>
+      <item>
+        <p>Indicates if the Erlang emulator is statically installed. A
+          node with a static emulator cannot switch dynamically to a
+          new emulator, as the executable files are written into memory
+          statically. This parameter is ignored if parameters <c>masters</c>
+          and <c>client_directory</c> are not set.</p>
+      </item>
+      <tag><c><![CDATA[releases_dir = string() ]]></c></tag>
+      <item>
+        <p>Indicates where the <c>releases</c> directory is located.
+          The release handler writes all its files to this directory.
+          If this parameter is not set, the OS environment parameter
+          <c>RELDIR</c> is used. By default, this is
+          <c>$OTP_ROOT/releases</c>.</p>
+      </item>
+      <tag><c><![CDATA[utc_log = true | false ]]></c></tag>
+      <item>
+        <p>If set to <c>true</c>, all dates in textual log outputs are
+          displayed in Universal Coordinated Time with the string
+          <c>UTC</c> appended.</p>
+      </item>
+    </taglist>
+  </section>
+
+  <section>
+    <title>Deprecated Error Logger Event Handlers and Configuration</title>
+    <p>In OTP-21, a new API for logging was added to Erlang/OTP. The
+      old <c>error_logger</c> event manager, and event handlers
+      running on this manager, will still work, but they are not used
+      by default.</p>
+    <p>The error logger event handlers <c>sasl_report_tty_h</c>
+      and <c>sasl_report_file_h</c>, were earliger used for printing
+      the so called SASL reports, i.e. <em>supervisor
+      reports</em>, <em>crash reports</em>, and <em>progress
+      reports</em>. These reports are now also printed by the standard
+      logger handler started by the Kernel application. Progress
+      reports are by default stopped by a filter, but can easily be
+      added by setting the Kernel configuration
+      parameter <seealso marker="kernel:kernel_app#logger_log_progress"><c>logger_log_progress=true</c></seealso>.</p>
+    <p>If the old error logger event handlers are still desired, they
+      must be added by
+      calling <c>error_logger:add_report_handler/1,2</c>.</p>
     <taglist>
       <tag><c>sasl_report_tty_h</c></tag>
       <item>
         <p>Formats and writes <em>supervisor reports</em>, <em>crash
         reports</em>, and <em>progress reports</em> to <c>stdio</c>.
         This error logger event handler uses
-	<seealso marker="kernel:kernel_app#error_logger_format_depth">error_logger_format_depth</seealso>
-	in the Kernel application to limit how much detail is
-        printed in crash and supervisor reports.</p>
+	<seealso marker="kernel:kernel_app#logger_format_depth"><c>logger_format_depth</c></seealso>
+	in the Kernel application to limit how much detail is printed
+	in crash and supervisor reports. If <c>logger_format_depth</c>
+	is not set, it uses the old <c>error_logger_format_depth</c>
+	instead.</p>
       </item>
       <tag><c>sasl_report_file_h</c></tag>
       <item>
         <p>Formats and writes <em>supervisor reports</em>, <em>crash
         report</em>, and <em>progress report</em> to a single file.
         This error logger event handler uses
-	<seealso marker="kernel:kernel_app#error_logger_format_depth">error_logger_format_depth</seealso>
-	in the Kernel application to limit the details
-        printed in crash and supervisor reports.</p>
-      </item>
-      <tag><c>log_mf_h</c></tag>
-      <item>
-        <p>This error logger writes <em>all</em> events sent to the
-          error logger to disk. Multiple files and log rotation are
-          used. For efficiency reasons, each event is written as a
-          binary. For more information about this handler,
-          see <seealso marker="stdlib:log_mf_h">the STDLIB Reference
-          Manual</seealso>.</p>
-        <p>To activate this event handler, three SASL
-          configuration parameters must be set,
-          <c>error_logger_mf_dir</c>, <c>error_logger_mf_maxbytes</c>,
-          and <c>error_logger_mf_maxfiles</c>. The next section provides
-          more information about the configuration parameters.</p>
+	<seealso marker="kernel:kernel_app#logger_format_depth"><c>logger_format_depth</c></seealso>
+	in the Kernel application to limit the details printed in
+	crash and supervisor reports. If <c>logger_format_depth</c> is
+	not set, it uses the old <c>error_logger_format_depth</c>
+	instead.</p>
       </item>
     </taglist>
-  </section>
-
-  <section>
-    <title>Configuration</title>
-    <p>The following configuration parameters are defined for the SASL
-      application. For more information about configuration parameters, see
-      <seealso marker="kernel:app"><c>app(4)</c></seealso> in Kernel.</p>
-    <p>All configuration parameters are optional.</p>
+    <p>A similar behaviour, but still using the new logger API, can be
+      obtained by setting the Kernel application environment
+      variable <seealso marker="kernel:kernel_app#logger_sasl_compatible"><c>logger_sasl_compatible=true</c></seealso>. This will add a
+      second instance of the standard logger handler
+      named <c>sasl_h</c>, which will only print the SASL reports. No
+      SASL reports will then be printed by the Kernel logger
+      handler.</p>
+    <p>The <c>sasl_h</c> handler will be configured according to the
+      values of the following SASL application environment
+      variables.</p>
     <taglist>
       <tag><c><![CDATA[sasl_error_logger = Value ]]></c></tag>
       <item>
@@ -124,6 +179,19 @@
           <c>sasl_error_logger</c> to error reports or progress reports,
           or both. Default is <c>all</c>.</p>
       </item>
+    </taglist>
+
+    <p>The error logger event handler <c>log_mf_h</c> can also still
+      be used. This event handler writes <em>all</em> events sent to
+      the error logger to disk. Multiple files and log rotation are
+      used. For efficiency reasons, each event is written as a
+      binary. For more information about this handler,
+      see <seealso marker="stdlib:log_mf_h">the STDLIB Reference
+      Manual</seealso>.</p>
+    <p>To activate this event handler, three SASL configuration
+      parameters must be
+      set:</p>
+    <taglist>
       <tag><c><![CDATA[error_logger_mf_dir = string() | false ]]></c></tag>
       <item>
         <p>Specifies in which directory <c>log_mf_h</c> is to store
@@ -142,49 +210,12 @@
           this parameter is undefined, the <c>log_mf_h</c> handler is
           not installed.</p>
       </item>
-      <tag><c><![CDATA[start_prg = string() ]]></c></tag>
-      <item>
-        <p>Specifies the program to be used when restarting the system
-          during release installation. Default is
-          <c>$OTP_ROOT/bin/start</c>.</p>
-      </item>
-      <tag><c><![CDATA[masters = [atom()] ]]></c></tag>
-      <item>
-        <p>Specifies the nodes used by this node to read/write release
-          information. This parameter is ignored if parameter
-          <c>client_directory</c> is not set.</p>
-      </item>
-      <tag><c><![CDATA[client_directory = string() ]]></c></tag>
-      <item>
-        <p>This parameter specifies the client directory at the master
-          nodes. For details, see
-          <seealso marker="doc/design_principles:release_handling">Release Handling</seealso>
-          in <em>OTP Design Principles</em>. This parameter is
-          ignored if parameter <c>masters</c> is not set.</p>
-      </item>
-      <tag><c><![CDATA[static_emulator = true | false ]]></c></tag>
-      <item>
-        <p>Indicates if the Erlang emulator is statically installed. A
-          node with a static emulator cannot switch dynamically to a
-          new emulator, as the executable files are written into memory
-          statically. This parameter is ignored if parameters <c>masters</c>
-          and <c>client_directory</c> are not set.</p>
-      </item>
-      <tag><c><![CDATA[releases_dir = string() ]]></c></tag>
-      <item>
-        <p>Indicates where the <c>releases</c> directory is located.
-          The release handler writes all its files to this directory.
-          If this parameter is not set, the OS environment parameter
-          <c>RELDIR</c> is used. By default, this is
-          <c>$OTP_ROOT/releases</c>.</p>
-      </item>
-      <tag><c><![CDATA[utc_log = true | false ]]></c></tag>
-      <item>
-        <p>If set to <c>true</c>, all dates in textual log outputs are
-          displayed in Universal Coordinated Time with the string
-          <c>UTC</c> appended.</p>
-      </item>
     </taglist>
+    <p>The new <seealso marker="kernel:logger_disk_log_h">
+	<c>logger_disk_log_h</c></seealso> might be an alternative
+      to <c>log_mf_h</c> if log rotation is desired. This does,
+      however, write the log events in clear text and not as binaries.</p>
+
   </section>
 
   <section>
diff --git a/lib/sasl/src/sasl.app.src b/lib/sasl/src/sasl.app.src
index 1e8e58a978..60d08ffa54 100644
--- a/lib/sasl/src/sasl.app.src
+++ b/lib/sasl/src/sasl.app.src
@@ -40,8 +40,7 @@
 	      ]},
     {registered, [sasl_sup, alarm_handler, release_handler]},
     {applications, [kernel, stdlib]},
-    {env, [{sasl_error_logger, tty},
-           {errlog_type, all}]},
+    {env, []},
     {mod, {sasl, []}},
     {runtime_dependencies, ["tools-2.6.14","stdlib-3.4","kernel-5.3",
 			    "erts-9.0"]}]}.
diff --git a/lib/sasl/src/sasl.erl b/lib/sasl/src/sasl.erl
index 24afaee183..657eb6688a 100644
--- a/lib/sasl/src/sasl.erl
+++ b/lib/sasl/src/sasl.erl
@@ -31,45 +31,52 @@
 %%%-----------------------------------------------------------------
 -behaviour(application).
 
--record(state, {sasl_error_logger, error_logger_mf}).
+-record(state, {sasl_logger, error_logger_mf}).
 
 start(_, []) ->
-    Handler = get_sasl_error_logger(),
-    Type = get_sasl_error_logger_type(),
+    {Dest,Level} = get_logger_info(),
     Mf = get_error_logger_mf(),
-    add_sasl_error_logger(Handler, Type),
+    add_sasl_logger(Dest, Level),
     add_error_logger_mf(Mf),
-    State = #state{sasl_error_logger = Handler, error_logger_mf = Mf}, 
+    State = #state{sasl_logger = Dest, error_logger_mf = Mf},
     case supervisor:start_link({local, sasl_sup}, sasl, []) of
 	{ok, Pid} -> {ok, Pid, State};
 	Error -> Error
     end.
 
 stop(State) ->
-    delete_sasl_error_logger(State#state.sasl_error_logger),
+    delete_sasl_logger(State#state.sasl_logger),
     delete_error_logger_mf(State#state.error_logger_mf).
 
 %%-----------------------------------------------------------------
 %% Internal functions
 %%-----------------------------------------------------------------
-get_sasl_error_logger() ->
+get_logger_info() ->
+    case application:get_env(kernel, logger_sasl_compatible) of
+        {ok,true} ->
+            {get_logger_dest(),get_logger_level()};
+        _ ->
+            {std,undefined}
+    end.
+
+get_logger_dest() ->
     case application:get_env(sasl, sasl_error_logger) of
-	{ok, false} -> undefined;
-	{ok, tty} -> tty;
-	{ok, {file, File}} when is_list(File) -> {file, File, [write]};
-	{ok, {file, File, Modes}} when is_list(File), is_list(Modes) ->
-        {file, File, Modes};
-	{ok, Bad} -> exit({bad_config, {sasl, {sasl_error_logger, Bad}}});
-	_ -> undefined
+        {ok, false} -> undefined;
+        {ok, tty} -> standard_io;
+        {ok, {file, File}} when is_list(File) -> {file, File};
+        {ok, {file, File, Modes}} when is_list(File), is_list(Modes) ->
+            {file, File, Modes};
+        {ok, Bad} -> exit({bad_config, {sasl, {sasl_logger_dest, Bad}}});
+        undefined -> standard_io
     end.
 
-get_sasl_error_logger_type() ->
+get_logger_level() ->
     case application:get_env(sasl, errlog_type) of
-	{ok, error} -> error;
-	{ok, progress} -> progress;
-	{ok, all} -> all;
-	{ok, Bad} -> exit({bad_config, {sasl, {errlog_type, Bad}}});
-	_ -> all
+        {ok, error} -> error;
+        {ok, progress} -> info;
+        {ok, all} -> info;
+        {ok, Bad} -> exit({bad_config, {sasl, {errlog_type, Bad}}});
+        _ -> info
     end.
 
 get_error_logger_mf() ->
@@ -119,23 +126,32 @@ get_mf_maxf() ->
 	{ok, Bad} -> exit({bad_config, {sasl, {error_logger_mf_maxfiles, Bad}}})
     end.
 
-add_sasl_error_logger(undefined, _Type) -> ok;
-add_sasl_error_logger(Handler, Type) ->
-    error_logger:add_report_handler(mod(Handler), args(Handler, Type)).
-
-delete_sasl_error_logger(undefined) -> ok;
-delete_sasl_error_logger(Type) ->
-    error_logger:delete_report_handler(mod(Type)).
-
-mod(tty) -> sasl_report_tty_h;
-mod({file, _File, _Modes}) -> sasl_report_file_h.
-
-args({file, File, Modes}, Type) -> {File, Modes, type(Type)};
-args(_, Type) -> type(Type).
-
-type(error) -> error;
-type(progress) -> progress;
-type(_) -> all.
+add_sasl_logger(undefined, _Level) -> ok;
+add_sasl_logger(std, undefined) -> ok;
+add_sasl_logger(Dest, Level) ->
+    FC0 = #{legacy_header=>true,
+            template=>[{logger_formatter,header},"\n",msg,"\n"]},
+    FC = case application:get_env(sasl,utc_log) of
+             {ok,Bool} when is_boolean(Bool) ->
+                 FC0#{utc=>Bool};
+             _ ->
+                 FC0
+         end,
+    ok = logger:add_handler(sasl_h,logger_std_h,
+                            #{level=>Level,
+                              filter_default=>stop,
+                              filters=>
+                                  [{sasl_domain,
+                                    {fun logger_filters:domain/2,
+                                     {log,equals,[beam,erlang,otp,sasl]}}}],
+                              logger_std_h=>#{type=>Dest},
+                              formatter=>{logger_formatter,FC}}).
+
+delete_sasl_logger(undefined) -> ok;
+delete_sasl_logger(std) -> ok;
+delete_sasl_logger(_Type) ->
+    _ = logger:remove_handler(sasl_h),
+    ok.
 
 add_error_logger_mf(undefined) -> ok;
 add_error_logger_mf({Dir, MaxB, MaxF}) ->
diff --git a/lib/sasl/src/systools_make.erl b/lib/sasl/src/systools_make.erl
index a9e8bcecfa..f4b1b54fd1 100644
--- a/lib/sasl/src/systools_make.erl
+++ b/lib/sasl/src/systools_make.erl
@@ -1546,6 +1546,12 @@ mandatory_modules() ->
      gen_server,
      heart,
      kernel,
+     logger,
+     logger_filters,
+     logger_server,
+     logger_backend,
+     logger_config,
+     logger_simple,
      lists,
      proc_lib,
      supervisor
@@ -1570,7 +1576,7 @@ preloaded() ->
 
 kernel_processes() ->
     [{heart, heart, start, []},
-     {error_logger, error_logger, start_link, []},
+     {logger, logger_server, start_link, []},
      {application_controller, application_controller, start,
       fun(Appls) ->
               [{_,App}] = filter(fun({{kernel,_},_App}) -> true;
diff --git a/lib/sasl/test/sasl_SUITE.erl b/lib/sasl/test/sasl_SUITE.erl
index f12bde9b3d..7b63684c53 100644
--- a/lib/sasl/test/sasl_SUITE.erl
+++ b/lib/sasl/test/sasl_SUITE.erl
@@ -21,6 +21,7 @@
 -include_lib("common_test/include/ct.hrl").
 
 %% Test server specific exports
+-export([init_per_suite/1,end_per_suite/1]).
 -export([all/0,groups/0,init_per_group/2,end_per_group/2]).
 -export([init_per_testcase/2, end_per_testcase/2]).
 
@@ -37,6 +38,19 @@ all() ->
 groups() -> 
     [].
 
+init_per_suite(Config) ->
+    S = application:get_env(kernel,logger_sasl_compatible),
+    application:set_env(kernel,logger_sasl_compatible,true),
+    [{sasl_compatible,S}|Config].
+
+end_per_suite(Config) ->
+    case ?config(sasl_compatible,Config) of
+        {ok,X} ->
+            application:set_env(kernel,logger_sasl_compatible,X);
+        undefined ->
+            application:unset_env(kernel,logger_sasl_compatible)
+    end.
+
 init_per_group(_GroupName, Config) ->
     Config.
 
diff --git a/lib/sasl/test/sasl_report_SUITE.erl b/lib/sasl/test/sasl_report_SUITE.erl
index 92df5e6e40..96975aaf69 100644
--- a/lib/sasl/test/sasl_report_SUITE.erl
+++ b/lib/sasl/test/sasl_report_SUITE.erl
@@ -53,13 +53,17 @@ gen_server_crash_unicode(Config) ->
     gen_server_crash(Config, unicode).
 
 gen_server_crash(Config, Encoding) ->
+    StopFilter = {fun(_,_) -> stop end, ok},
+    logger:add_handler_filter(logger_std_h,stop_all,StopFilter),
+    logger:add_handler_filter(cth_log_redirect,stop_all,StopFilter),
     try
 	do_gen_server_crash(Config, Encoding)
     after
-	error_logger:tty(true),
+        ok = application:unset_env(kernel, logger_sasl_compatible),
 	ok = application:unset_env(sasl, sasl_error_logger),
 	ok = application:unset_env(kernel, error_logger_format_depth),
-	error_logger:add_report_handler(cth_log_redirect)
+        logger:remove_handler_filter(logger_std_h,stop_all),
+        logger:remove_handler_filter(cth_log_redirect,stop_all)
     end,
     ok.
 
@@ -70,26 +74,26 @@ do_gen_server_crash(Config, Encoding) ->
     SaslLog = filename:join(LogDir, "sasl.log"),
     ok = filelib:ensure_dir(SaslLog),
 
-    error_logger:delete_report_handler(cth_log_redirect),
-    error_logger:tty(false),
     application:stop(sasl),
     Modes = [write, {encoding, Encoding}],
+    ok = application:set_env(kernel, logger_sasl_compatible, true),
     ok = application:set_env(sasl, sasl_error_logger, {file,SaslLog,Modes},
 			     [{persistent,true}]),
     application:set_env(kernel, error_logger_format_depth, 30),
     error_logger:logfile({open,KernelLog}),
     application:start(sasl),
-    io:format("~p\n", [gen_event:which_handlers(error_logger)]),
+    logger:i(print),
 
     crash_me(),
 
     error_logger:logfile(close),
+    application:stop(sasl),
 
     check_file(KernelLog, utf8, 70000, 150000),
     check_file(SaslLog, Encoding, 70000, 150000),
 
-    %% ok = file:delete(KernelLog),
-    %% ok = file:delete(SaslLog),
+    ok = file:delete(KernelLog),
+    ok = file:delete(SaslLog),
     ok.
 
 check_file(File, Encoding, Min, Max) ->