1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
.TH sasl 6 "sasl 2.1.5.3" "Ericsson AB" "ERLANG APPLICATION DEFINITION"
.SH APPLICATION
sasl \- The SASL Application
.SH DESCRIPTION
.LP
This section describes the SASL (System Architecture Support Libraries) application which provides the following services:
.RS 2
.TP 2
*
\fIalarm_handler\fR
.TP 2
*
\fIoverload\fR
.TP 2
*
\fIrb\fR
.TP 2
*
\fIrelease_handler\fR
.TP 2
*
\fIsystools\fR
.RE
.LP
The SASL application also includes \fIerror_logger\fR event handlers for formatting SASL error and crash reports\&.
.SS Note:
.LP
The SASL application in OTP has nothing to do with "Simple Authentication and Security Layer" (RFC 4422)\&.
.SH ERROR LOGGER EVENT HANDLERS
.LP
The following error logger event handlers are defined in the SASL application\&.
.RS 2
.TP 4
.B
\fIsasl_report_tty_h\fR:
Formats and writes \fIsupervisor reports\fR, \fIcrash reports\fR and \fIprogress reports\fR to \fIstdio\fR\&.
.TP 4
.B
\fIsasl_report_file_h\fR:
Formats and writes \fIsupervisor reports\fR, \fIcrash report\fR and \fIprogress report\fR to a single file\&.
.TP 4
.B
\fIerror_logger_mf_h\fR:
This error logger writes \fIall\fR events sent to the error logger to disk\&. It installs the \fIlog_mf_h\fR event handler in the \fIerror_logger\fR process\&.
.RE
.SH CONFIGURATION
.LP
The following configuration parameters are defined for the SASL application\&. See \fIapp(4)\fR for more information about configuration parameters:
.RS 2
.TP 4
.B
\fIsasl_error_logger = Value <optional>\fR:
\fIValue\fR is one of:
.RS 4
.LP
.RS 2
.TP 4
.B
\fItty\fR:
Installs \fIsasl_report_tty_h\fR in the error logger\&. This is the default option\&.
.TP 4
.B
\fI{file, FileName}\fR:
Installs \fIsasl_report_file_h\fR in the error logger\&. This makes all reports go to the file \fIFileName\fR\&. \fIFileName\fR is a string\&.
.TP 4
.B
\fIfalse\fR:
No SASL error logger handler is installed\&.
.RE
.RE
.TP 4
.B
\fIerrlog_type = error | progress | all <optional>\fR:
Restricts the error logging performed by the specified \fIsasl_error_logger\fR to error reports, progress reports, or both\&. Default is \fIall\fR\&.
.TP 4
.B
\fIerror_logger_mf_dir = string() | false<optional>\fR:
Specifies in which directory the files are stored\&. If this parameter is undefined or \fIfalse\fR, the \fIerror_logger_mf_h\fR is not installed\&.
.TP 4
.B
\fIerror_logger_mf_maxbytes = integer() <optional>\fR:
Specifies how large each individual file can be\&. If this parameter is undefined, the \fIerror_logger_mf_h\fR is not installed\&.
.TP 4
.B
\fIerror_logger_mf_maxfiles = 0<integer()<256 <optional>\fR:
Specifies how many files are used\&. If this parameter is undefined, the \fIerror_logger_mf_h\fR is not installed\&.
.TP 4
.B
\fIoverload_max_intensity = float() > 0 <optional>\fR:
Specifies the maximum intensity for \fIoverload\fR\&. Default is \fI0\&.8\fR\&.
.TP 4
.B
\fIoverload_weight = float() > 0 <optional>\fR:
Specifies the \fIoverload\fR weight\&. Default is \fI0\&.1\fR\&.
.TP 4
.B
\fIstart_prg = string() <optional>\fR:
Specifies which program should be used when restarting the system\&. Default is \fI$OTP_ROOT/bin/start\fR\&.
.TP 4
.B
\fImasters = [atom()] <optional>\fR:
Specifies which nodes this node uses to read/write release information\&. This parameter is ignored if the \fIclient_directory\fR parameter is not set\&.
.TP 4
.B
\fIclient_directory = string() <optional>\fR:
This parameter specifies the client directory at the master nodes\&. Refer to Release Handling in \fIOTP Design Principles\fR for more information\&. This parameter is ignored if the \fImasters\fR parameter is not set\&.
.TP 4
.B
\fIstatic_emulator = true | false <optional>\fR:
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 the \fImasters\fR and \fIclient_directory\fR parameters are not set\&.
.TP 4
.B
\fIreleases_dir = string() <optional>\fR:
Indicates where the \fIreleases\fR directory is located\&. The release handler writes all its files to this directory\&. If this parameter is not set, the OS environment parameter \fIRELDIR\fR is used\&. By default, this is \fI$OTP_ROOT/releases\fR\&.
.TP 4
.B
\fIutc_log = true | false <optional>\fR:
If set to \fItrue\fR, all dates in textual log outputs are displayed in Universal Coordinated Time with the string \fIUTC\fR appended\&.
.RE
.SH SEE ALSO
.LP
alarm_handler(3), error_logger(3), log_mf_h(3), overload(3), rb(3), release_handler(3), systools(3)
|
