From 05e1548e5b452d4bfe3bc6837a1a1b51a6367f72 Mon Sep 17 00:00:00 2001
From: Siri Hansen
Date: Tue, 24 Apr 2018 14:55:29 +0200
Subject: Remove error_logger process and add logger process
---
lib/sasl/doc/src/sasl_app.xml | 183 ++++++++++++++++++++++++------------------
1 file changed, 107 insertions(+), 76 deletions(-)
(limited to 'lib/sasl/doc')
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 @@
The SASL application provides the following services:
- alarm_handler
- - rb
- release_handler
- systools
- The SASL application also includes error_logger event
- handlers for formatting SASL error and crash reports.
The SASL application in OTP has nothing to do with
"Simple Authentication and Security Layer" (RFC 4422).
@@ -47,51 +44,109 @@
- Error Logger Event Handlers
- The following error logger event handlers are used by
- the SASL application.
+ Configuration
+ The following configuration parameters are defined for the SASL
+ application. For more information about configuration parameters, see
+ app(4) in Kernel.
+ All configuration parameters are optional.
+
+
+ -
+
Specifies the program to be used when restarting the system
+ during release installation. Default is
+ $OTP_ROOT/bin/start.
+
+
+ -
+
Specifies the nodes used by this node to read/write release
+ information. This parameter is ignored if parameter
+ client_directory is not set.
+
+
+ -
+
This parameter specifies the client directory at the master
+ nodes. For details, see
+ Release Handling
+ in OTP Design Principles. This parameter is
+ ignored if parameter masters is not set.
+
+
+ -
+
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 masters
+ and client_directory are not set.
+
+
+ -
+
Indicates where the releases directory is located.
+ The release handler writes all its files to this directory.
+ If this parameter is not set, the OS environment parameter
+ RELDIR is used. By default, this is
+ $OTP_ROOT/releases.
+
+
+ -
+
If set to true, all dates in textual log outputs are
+ displayed in Universal Coordinated Time with the string
+ UTC appended.
+
+
+
+
+
+ Deprecated Error Logger Event Handlers and Configuration
+ In OTP-21, a new API for logging was added to Erlang/OTP. The
+ old error_logger event manager, and event handlers
+ running on this manager, will still work, but they are not used
+ by default.
+ The error logger event handlers sasl_report_tty_h
+ and sasl_report_file_h, were earliger used for printing
+ the so called SASL reports, i.e. supervisor
+ reports, crash reports, and progress
+ reports. 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 logger_log_progress=true.
+ If the old error logger event handlers are still desired, they
+ must be added by
+ calling error_logger:add_report_handler/1,2.
sasl_report_tty_h
-
Formats and writes supervisor reports, crash
reports, and progress reports to stdio.
This error logger event handler uses
- error_logger_format_depth
- in the Kernel application to limit how much detail is
- printed in crash and supervisor reports.
+ logger_format_depth
+ in the Kernel application to limit how much detail is printed
+ in crash and supervisor reports. If logger_format_depth
+ is not set, it uses the old error_logger_format_depth
+ instead.
sasl_report_file_h
-
Formats and writes supervisor reports, crash
report, and progress report to a single file.
This error logger event handler uses
- error_logger_format_depth
- in the Kernel application to limit the details
- printed in crash and supervisor reports.
-
- log_mf_h
- -
-
This error logger writes all 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 the STDLIB Reference
- Manual.
- To activate this event handler, three SASL
- configuration parameters must be set,
- error_logger_mf_dir, error_logger_mf_maxbytes,
- and error_logger_mf_maxfiles. The next section provides
- more information about the configuration parameters.
+ logger_format_depth
+ in the Kernel application to limit the details printed in
+ crash and supervisor reports. If logger_format_depth is
+ not set, it uses the old error_logger_format_depth
+ instead.
-
-
-
- Configuration
- The following configuration parameters are defined for the SASL
- application. For more information about configuration parameters, see
- app(4) in Kernel.
- All configuration parameters are optional.
+ A similar behaviour, but still using the new logger API, can be
+ obtained by setting the Kernel application environment
+ variable logger_sasl_compatible=true. This will add a
+ second instance of the standard logger handler
+ named sasl_h, which will only print the SASL reports. No
+ SASL reports will then be printed by the Kernel logger
+ handler.
+ The sasl_h handler will be configured according to the
+ values of the following SASL application environment
+ variables.
-
@@ -124,6 +179,19 @@
sasl_error_logger to error reports or progress reports,
or both. Default is all.
+
+
+ The error logger event handler log_mf_h can also still
+ be used. This event handler writes all 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 the STDLIB Reference
+ Manual.
+ To activate this event handler, three SASL configuration
+ parameters must be
+ set:
+
-
Specifies in which directory log_mf_h is to store
@@ -142,49 +210,12 @@
this parameter is undefined, the log_mf_h handler is
not installed.
-
- -
-
Specifies the program to be used when restarting the system
- during release installation. Default is
- $OTP_ROOT/bin/start.
-
-
- -
-
Specifies the nodes used by this node to read/write release
- information. This parameter is ignored if parameter
- client_directory is not set.
-
-
- -
-
This parameter specifies the client directory at the master
- nodes. For details, see
- Release Handling
- in OTP Design Principles. This parameter is
- ignored if parameter masters is not set.
-
-
- -
-
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 masters
- and client_directory are not set.
-
-
- -
-
Indicates where the releases directory is located.
- The release handler writes all its files to this directory.
- If this parameter is not set, the OS environment parameter
- RELDIR is used. By default, this is
- $OTP_ROOT/releases.
-
-
- -
-
If set to true, all dates in textual log outputs are
- displayed in Universal Coordinated Time with the string
- UTC appended.
-
+ The new
+ logger_disk_log_h might be an alternative
+ to log_mf_h if log rotation is desired. This does,
+ however, write the log events in clear text and not as binaries.
+