1sasl(7) Erlang Application Definition sasl(7)
2
6 sasl - The SASL application
7
9 The SASL application provides the following services:
10 * alarm_handler
12 * release_handler
14 * systools
16 Note:
18 The SASL application in OTP has nothing to do with "Simple Authentica‐
19 tion and Security Layer" (RFC 4422).
20
23 The following configuration parameters are defined for the SASL appli‐
24 cation. For more information about configuration parameters, see app(4)
25 in Kernel.
26 All configuration parameters are optional.
28 start_prg = string() :
30 Specifies the program to be used when restarting the system during
31 release installation. Default is $OTP_ROOT/bin/start.
32 masters = [atom()] :
34 Specifies the nodes used by this node to read/write release infor‐
35 mation. This parameter is ignored if parameter client_directory is
36 not set.
37 client_directory = string() :
39 This parameter specifies the client directory at the master nodes.
40 For details, see Release Handling in OTP Design Principles. This
41 parameter is ignored if parameter masters is not set.
42 static_emulator = true | false :
44 Indicates if the Erlang emulator is statically installed. A node
45 with a static emulator cannot switch dynamically to a new emulator,
46 as the executable files are written into memory statically. This
47 parameter is ignored if parameters masters and client_directory are
48 not set.
49 releases_dir = string() :
51 Indicates where the releases directory is located. The release han‐
52 dler writes all its files to this directory. If this parameter is
53 not set, the OS environment parameter RELDIR is used. By default,
54 this is $OTP_ROOT/releases.
55
57 In Erlang/OTP 21.0, a new API for logging was added. The old error_log‐
58 ger event manager, and event handlers running on this manager, still
59 work, but they are not used by default.
60 The error logger event handlers sasl_report_tty_h and sasl_re‐
62 port_file_h, were earlier used for printing the so called SASL reports,
63 i.e. supervisor reports, crash reports, and progress reports. These re‐
64 ports are now also printed by the default logger handler started by the
65 Kernel application. Progress reports are by default stopped by the pri‐
66 mary log level, but can be enabled by setting this level to info, for
67 example by using the Kernel configuration parameter logger_level.
68 If the old error logger event handlers are still desired, they must be
70 added by calling error_logger:add_report_handler/1,2.
71 sasl_report_tty_h:
73 Formats and writes supervisor reports, crash reports, and progress
74 reports to stdio. This error logger event handler uses error_log‐
75 ger_format_depth in the Kernel application to limit how much detail
76 is printed in crash and supervisor reports.
77 sasl_report_file_h:
79 Formats and writes supervisor reports, crash report, and progress
80 report to a single file. This error logger event handler uses er‐
81 ror_logger_format_depth in the Kernel application to limit the de‐
82 tails printed in crash and supervisor reports.
83 A similar behaviour, but still using the new logger API, can be ob‐
85 tained by setting the Kernel application environment variable log‐
86 ger_sasl_compatible to true. This adds a second instance of the stan‐
87 dard Logger handler, named sasl, which only prints the SASL reports. No
88 SASL reports are then printed by the Kernel logger handler.
89 The sasl handler is configured according to the values of the following
91 SASL application environment variables.
92 sasl_error_logger = Value :
94 Value is one of the following:
95 tty:
97 Installs sasl_report_tty_h in the error logger. This is the de‐
98 fault option.
99 {file,FileName}:
101 Installs sasl_report_file_h in the error logger. All reports go
102 to file FileName, which is a string. The file is opened in write
103 mode with encoding utf8.
104 {file,FileName,Modes}:
106 Same as {file,FileName}, except that Modes allows you to specify
107 the modes used for opening the FileName given to the file:open/2
108 call. By default, the file is opened in write mode with encoding
109 utf8. Use [append] to have the FileName open in append mode. A
110 different encoding can also be specified. FileName is a string.
111 false:
113 No SASL error logger handler is installed.
114 errlog_type = error | progress | all :
116 Restricts the error logging performed by the specified sasl_er‐
117 ror_logger to error reports or progress reports, or both. Default
118 is all.
119 utc_log = true | false :
121 If set to true, all dates in textual log outputs are displayed in
122 Universal Coordinated Time with the string UTC appended.
123 The error logger event handler log_mf_h can also still be used. This
125 event handler writes all events sent to the error logger to disk. Mul‐
126 tiple files and log rotation are used. For efficiency reasons, each
127 event is written as a binary. For more information about this handler,
128 see the STDLIB Reference Manual.
129 To activate this event handler, three SASL configuration parameters
131 must be set:
132 error_logger_mf_dir = string() | false :
134 Specifies in which directory log_mf_h is to store its files. If
135 this parameter is undefined or false, the log_mf_h handler is not
136 installed.
137 error_logger_mf_maxbytes = integer() :
139 Specifies the maximum size of each individual file written by
140 log_mf_h. If this parameter is undefined, the log_mf_h handler is
141 not installed.
142 error_logger_mf_maxfiles = 0<integer()<256 :
144 Specifies the number of files used by log_mf_h. If this parameter
145 is undefined, the log_mf_h handler is not installed.
146 The new logger_disk_log_h might be an alternative to log_mf_h if log
148 rotation is desired. This does, however, write the log events in clear
149 text and not as binaries.
150
152 alarm_handler(3), error_logger(3), logger(3), log_mf_h(3), rb(3), re‐
153 lease_handler(3), systools(3)
154Ericsson AB sasl 4.2 sasl(7)