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         * release_handler
14
15         * systools
16
17   Note:
18       The  SASL application in OTP has nothing to do with "Simple Authentica‐
19       tion and Security Layer" (RFC 4422).
20
21

CONFIGURATION

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
27       All configuration parameters are optional.
28
29         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
33         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
38         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
43         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
50         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

DEPRECATED ERROR LOGGER EVENT HANDLERS AND CONFIGURATION

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
61       The    error    logger    event    handlers    sasl_report_tty_h    and
62       sasl_report_file_h,  were  earlier used for printing the so called SASL
63       reports, i.e. supervisor reports, crash reports, and progress  reports.
64       These  reports  are  now  also  printed  by  the default logger handler
65       started by the Kernel application.  Progress  reports  are  by  default
66       stopped  by  the  primary log level, but can be enabled by setting this
67       level to info, for example by using the Kernel configuration  parameter
68       logger_level.
69
70       If  the old error logger event handlers are still desired, they must be
71       added by calling error_logger:add_report_handler/1,2.
72
73         sasl_report_tty_h:
74           Formats and writes supervisor reports, crash reports, and  progress
75           reports  to  stdio. This error logger event handler uses error_log‐
76           ger_format_depth in the Kernel application to limit how much detail
77           is printed in crash and supervisor reports.
78
79         sasl_report_file_h:
80           Formats  and  writes supervisor reports, crash report, and progress
81           report to a single file.  This  error  logger  event  handler  uses
82           error_logger_format_depth  in  the  Kernel application to limit the
83           details printed in crash and supervisor reports.
84
85       A similar behaviour, but  still  using  the  new  logger  API,  can  be
86       obtained  by  setting  the Kernel application environment variable log‐
87       ger_sasl_compatible to true. This adds a second instance of  the  stan‐
88       dard Logger handler, named sasl, which only prints the SASL reports. No
89       SASL reports are then printed by the Kernel logger handler.
90
91       The sasl handler is configured according to the values of the following
92       SASL application environment variables.
93
94         sasl_error_logger = Value :
95           Value is one of the following:
96
97           tty:
98             Installs  sasl_report_tty_h  in  the  error  logger.  This is the
99             default option.
100
101           {file,FileName}:
102             Installs sasl_report_file_h in the error logger. All  reports  go
103             to  file FileName, which is a string. The file is opened in write
104             mode with encoding utf8.
105
106           {file,FileName,Modes}:
107             Same as {file,FileName}, except that Modes allows you to  specify
108             the  modes used for opening the FileName given to the file:open/2
109             call. By default, the file is opened in write mode with  encoding
110             utf8.  Use  [append]  to have the FileName open in append mode. A
111             different encoding can also be specified. FileName is a string.
112
113           false:
114             No SASL error logger handler is installed.
115
116         errlog_type = error | progress | all :
117           Restricts  the   error   logging   performed   by   the   specified
118           sasl_error_logger  to  error  reports or progress reports, or both.
119           Default is all.
120
121         utc_log = true | false :
122           If set to true, all dates in textual log outputs are  displayed  in
123           Universal Coordinated Time with the string UTC appended.
124
125       The  error  logger  event handler log_mf_h can also still be used. This
126       event handler writes all events sent to the error logger to disk.  Mul‐
127       tiple  files  and  log  rotation are used. For efficiency reasons, each
128       event is written as a binary. For more information about this  handler,
129       see the STDLIB Reference Manual.
130
131       To  activate  this  event  handler, three SASL configuration parameters
132       must be set:
133
134         error_logger_mf_dir = string() | false :
135           Specifies in which directory log_mf_h is to  store  its  files.  If
136           this  parameter  is undefined or false, the log_mf_h handler is not
137           installed.
138
139         error_logger_mf_maxbytes = integer() :
140           Specifies the maximum size  of  each  individual  file  written  by
141           log_mf_h.  If  this parameter is undefined, the log_mf_h handler is
142           not installed.
143
144         error_logger_mf_maxfiles = 0<integer()<256 :
145           Specifies the number of files used by log_mf_h. If  this  parameter
146           is undefined, the log_mf_h handler is not installed.
147
148       The  new  logger_disk_log_h  might be an alternative to log_mf_h if log
149       rotation is desired. This does, however, write the log events in  clear
150       text and not as binaries.
151

SEE ALSO

153       alarm_handler(3),   error_logger(3),   logger(3),  log_mf_h(3),  rb(3),
154       release_handler(3), systools(3)
155
156
157
158Ericsson AB                       sasl 4.0.2                           sasl(7)
Impressum