sasl(6) - f29

1sasl(7)                  Erlang Application Definition                 sasl(7)
2
3
4

NAME

6       sasl - The SASL application
7

DESCRIPTION

9       The SASL application provides the following services:
10
11         * alarm_handler
12
13         * rb
14
15         * release_handler
16
17         * systools
18
19       The SASL application also includes error_logger event handlers for for‐
20       matting SASL error and crash reports.
21
22   Note:
23       The SASL application in OTP has nothing to do with "Simple  Authentica‐
24       tion and Security Layer" (RFC 4422).
25
26

ERROR LOGGER EVENT HANDLERS

28       The following error logger event handlers are used by the SASL applica‐
29       tion.
30
31         sasl_report_tty_h:
32           Formats and writes supervisor reports, crash reports, and  progress
33           reports  to  stdio. This error logger event handler uses error_log‐
34           ger_format_depth in the Kernel application to limit how much detail
35           is printed in crash and supervisor reports.
36
37         sasl_report_file_h:
38           Formats  and  writes supervisor reports, crash report, and progress
39           report to a single file.  This  error  logger  event  handler  uses
40           error_logger_format_depth  in  the  Kernel application to limit the
41           details printed in crash and supervisor reports.
42
43         log_mf_h:
44           This error logger writes all events sent to  the  error  logger  to
45           disk. Multiple files and log rotation are used. For efficiency rea‐
46           sons, each event is written as a binary. For more information about
47           this handler, see the STDLIB Reference Manual.
48
49           To activate this event handler, three SASL configuration parameters
50           must be  set,  error_logger_mf_dir,  error_logger_mf_maxbytes,  and
51           error_logger_mf_maxfiles.  The  next section provides more informa‐
52           tion about the configuration parameters.
53

CONFIGURATION

55       The following configuration parameters are defined for the SASL  appli‐
56       cation. For more information about configuration parameters, see app(4)
57       in Kernel.
58
59       All configuration parameters are optional.
60
61         sasl_error_logger = Value :
62           Value is one of the following:
63
64           tty:
65             Installs sasl_report_tty_h in  the  error  logger.  This  is  the
66             default option.
67
68           {file,FileName}:
69             Installs  sasl_report_file_h  in the error logger. All reports go
70             to file FileName, which is a string. The file is opened in  write
71             mode with encoding utf8.
72
73           {file,FileName,Modes}:
74             Same  as {file,FileName}, except that Modes allows you to specify
75             the modes used for opening the FileName given to the  file:open/2
76             call.  By default, the file is opened in write mode with encoding
77             utf8. Use [append] to have the FileName open in  append  mode.  A
78             different encoding can also be specified. FileName is a string.
79
80           false:
81             No SASL error logger handler is installed.
82
83         errlog_type = error | progress | all :
84           Restricts   the   error   logging   performed   by   the  specified
85           sasl_error_logger to error reports or progress  reports,  or  both.
86           Default is all.
87
88         error_logger_mf_dir = string() | false :
89           Specifies  in  which  directory  log_mf_h is to store its files. If
90           this parameter is undefined or false, the log_mf_h handler  is  not
91           installed.
92
93         error_logger_mf_maxbytes = integer() :
94           Specifies  the  maximum  size  of  each  individual file written by
95           log_mf_h. If this parameter is undefined, the log_mf_h  handler  is
96           not installed.
97
98         error_logger_mf_maxfiles = 0<integer()<256 :
99           Specifies  the  number of files used by log_mf_h. If this parameter
100           is undefined, the log_mf_h handler is not installed.
101
102         start_prg = string() :
103           Specifies the program to be used when restarting the system  during
104           release installation. Default is $OTP_ROOT/bin/start.
105
106         masters = [atom()] :
107           Specifies  the nodes used by this node to read/write release infor‐
108           mation. This parameter is ignored if parameter client_directory  is
109           not set.
110
111         client_directory = string() :
112           This  parameter specifies the client directory at the master nodes.
113           For details, see Release Handling in OTP  Design  Principles.  This
114           parameter is ignored if parameter masters is not set.
115
116         static_emulator = true | false :
117           Indicates  if  the  Erlang emulator is statically installed. A node
118           with a static emulator cannot switch dynamically to a new emulator,
119           as  the  executable  files are written into memory statically. This
120           parameter is ignored if parameters masters and client_directory are
121           not set.
122
123         releases_dir = string() :
124           Indicates where the releases directory is located. The release han‐
125           dler writes all its files to this directory. If this  parameter  is
126           not  set,  the OS environment parameter RELDIR is used. By default,
127           this is $OTP_ROOT/releases.
128
129         utc_log = true | false :
130           If set to true, all dates in textual log outputs are  displayed  in
131           Universal Coordinated Time with the string UTC appended.
132

NAME

DESCRIPTION

ERROR LOGGER EVENT HANDLERS

CONFIGURATION

SEE ALSO