-spec add_report_handler(Handler) -> any() when Handler :: module().

等效于 add_report_handler(Handler, [])。

-spec add_report_handler(Handler, Args) -> Result
                            when
                                Handler :: module(),
                                Args :: gen_event:handler_args(),
                                Result :: gen_event:add_handler_ret().

向错误记录器添加新的事件处理程序。事件处理程序必须实现为 gen_event 回调模块。

Handler 通常是回调模块的名称，而 Args 是传递给初始化回调函数 gen_event:init/1 的可选项（默认为 []）。如果成功，该函数返回 ok。

事件处理程序必须能够处理此模块中的事件，请参阅事件部分。

第一次调用此函数时，error_logger 将被添加为 Logger 处理程序，并且 error_logger 进程将被启动。

-spec delete_report_handler(Handler) -> Result
                               when Handler :: module(), Result :: gen_event:del_handler_ret().

通过调用 gen_event:delete_handler(error_logger, Handler, []) 从错误记录器中删除一个事件处理程序。

如果在删除后不再有事件处理程序，则 error_logger 将被从 Logger 处理程序中删除，并且 error_logger 进程将被停止。

-spec error_msg(Format) -> ok when Format :: string().

等效于 error_msg(Format, [])。

-spec error_msg(Format, Data) -> ok when Format :: string(), Data :: list().

记录一个标准错误事件。Format 和 Data 参数与 STDLIB 中 io:format/2 的参数相同。

错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

该事件由默认的 Logger 处理程序处理。

保留此函数是为了向后兼容，新代码不得使用它。请改用 ?LOG_ERROR 宏或 logger:error/1,2,3。

示例

1> error_logger:error_msg("An error occurred in ~p", [a_module]).
=ERROR REPORT==== 22-May-2018::11:18:43.376917 ===
An error occurred in a_module
ok

警告

如果在格式字符串中使用 Unicode 转换修饰符 (t)，则所有事件处理程序都必须确保格式化的输出已为 I/O 设备正确编码。

-spec error_report(Report) -> ok when Report :: report().

记录一个标准错误事件。错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

该事件由默认的 Logger 处理程序处理。

保留此函数是为了向后兼容，新代码不得使用它。请改用 ?LOG_ERROR 宏或 logger:error/1,2,3。

示例

2> error_logger:error_report([{tag1,data1},a_term,{tag2,data}]).
=ERROR REPORT==== 22-May-2018::11:24:23.699306 ===
    tag1: data1
    a_term
    tag2: data
ok
3> error_logger:error_report("Serious error in my module").
=ERROR REPORT==== 22-May-2018::11:24:45.972445 ===
Serious error in my module
ok

-spec error_report(Type, Report) -> ok when Type :: term(), Report :: report().

记录一个用户定义的错误事件。错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

错误日志记录器还会向此事件的元数据添加一个值为 [Type] 的 domain 字段，导致默认 Logger 处理程序的过滤器丢弃该事件。必须添加不同的 Logger 处理程序或错误日志记录器事件处理程序来处理此事件。

建议 Report 遵循与 error_report/1 相同的结构。

保留此函数是为了向后兼容，新代码不得使用它。请改用 ?LOG_ERROR 宏或 logger:error/1,2,3。

-spec format(Format, Data) -> ok when Format :: string(), Data :: list().

等效于 error_msg(Format, Data)。

-spec get_format_depth() -> unlimited | pos_integer().

返回 max(10, Depth)，其中 Depth 是 Kernel 应用程序中 error_logger_format_depth 的值（如果 Depth 是整数）。否则，返回 unlimited。

注意

自 Erlang/OTP 21.0 中引入 Logger API 后，error_logger_format_depth 变量已弃用。该变量和此函数被保留是为了向后兼容，因为它们仍然可能被旧的报告处理程序使用。

-spec info_msg(Format) -> ok when Format :: string().

等效于 info_msg(Format, [])。

-spec info_msg(Format, Data) -> ok when Format :: string(), Data :: list().

记录一个标准信息事件。Format 和 Data 参数与 STDLIB 中 io:format/2 的参数相同。

错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

该事件由默认的 Logger 处理程序处理。

这些函数被保留是为了向后兼容，新代码不得使用。请改用 ?LOG_INFO 宏或 logger:info/1,2,3。

示例

1> error_logger:info_msg("Something happened in ~p", [a_module]).
=INFO REPORT==== 22-May-2018::12:03:32.612462 ===
Something happened in a_module
ok

警告

如果在格式字符串中使用 Unicode 转换修饰符 (t)，则所有事件处理程序都必须确保格式化的输出已为 I/O 设备正确编码。

-spec info_report(Report) -> ok when Report :: report().

记录一个标准信息事件。错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

该事件由默认的 Logger 处理程序处理。

此函数被保留是为了向后兼容，新代码不得使用。请改用 ?LOG_INFO 宏或 logger:info/1,2,3。

示例

2> error_logger:info_report([{tag1,data1},a_term,{tag2,data}]).
=INFO REPORT==== 22-May-2018::12:06:35.994440 ===
    tag1: data1
    a_term
    tag2: data
ok
3> error_logger:info_report("Something strange happened").
=INFO REPORT==== 22-May-2018::12:06:49.066872 ===
Something strange happened
ok

-spec info_report(Type, Report) -> ok when Type :: any(), Report :: report().

记录一个用户定义的信息事件。错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

错误日志记录器还会向此事件的元数据添加一个值为 [Type] 的 domain 字段，导致默认 Logger 处理程序的过滤器丢弃该事件。必须添加不同的 Logger 处理程序或错误日志记录器事件处理程序来处理此事件。

建议 Report 遵循与 info_report/1 相同的结构。

此函数被保留是为了向后兼容，新代码不得使用。请改用 ?LOG_INFO 宏或 logger:info/1,2,3。

-spec logfile(Request :: {open, Filename}) -> ok | {error, OpenReason}
                 when Filename :: file:name(), OpenReason :: allready_have_logfile | open_error();
             (Request :: close) -> ok | {error, CloseReason} when CloseReason :: module_not_found;
             (Request :: filename) -> Filename | {error, FilenameReason}
                 when Filename :: file:name(), FilenameReason :: no_log_file.

启用或禁用将标准事件打印到文件。

这是通过添加或删除 error_logger_file_h 事件处理程序来完成的，从而间接地将 error_logger 添加为 Logger 处理程序。

请注意，此函数不会直接操作 Logger 配置，这意味着如果默认 Logger 处理程序已经在写入文件，则此函数可能会导致写入第二个文件。

此函数在开发和测试期间可以用作快捷方式，但不应在生产系统中使用。有关如何为实时系统配置 Logger 的信息，请参阅 Kernel 用户指南中的 日志记录 部分，以及 logger 手册页。

Request 是以下之一

• {open, Filename} - 打开日志文件 Filename。如果成功，则返回 ok；如果已启用写入文件，则返回 {error, allready_have_logfile}；如果发生其他错误（例如，无法打开 Filename），则返回错误元组。该文件以 UTF-8 编码打开。

• close - 关闭当前的日志文件。返回 ok，或 {error, module_not_found}。

• filename - 返回日志文件 Filename 的名称，如果未启用写入文件，则返回 {error, no_log_file}。

-spec tty(Flag) -> ok when Flag :: boolean().

启用（Flag == true）或禁用（Flag == false）将标准事件打印到终端。

这是通过操作 Logger 配置来完成的。此函数在开发和测试期间可以用作快捷方式，但不应在生产系统中使用。有关如何为实时系统配置 Logger 的信息，请参阅 Kernel 用户指南中的 日志记录 部分，以及 logger 手册页。

-spec warning_map() -> Tag when Tag :: error | warning | info.

返回警告事件的当前映射。

使用 warning_msg/1,2 或 warning_report/1,2 发送的事件会根据命令行标志 +W 的值标记为错误、警告（默认）或信息。

示例

os$ erl
Erlang (BEAM) emulator version 5.4.8 [hipe] [threads:0] [kernel-poll]

Eshell V5.4.8  (abort with ^G)
1> error_logger:warning_map().
warning
2> error_logger:warning_msg("Warnings tagged as: ~p~n", [warning]).

=WARNING REPORT==== 11-Aug-2005::15:31:55 ===
Warnings tagged as: warning
ok
3>
User switch command
 --> q
os$ erl +W e
Erlang (BEAM) emulator version 5.4.8 [hipe] [threads:0] [kernel-poll]

Eshell V5.4.8  (abort with ^G)
1> error_logger:warning_map().
error
2> error_logger:warning_msg("Warnings tagged as: ~p~n", [error]).

=ERROR REPORT==== 11-Aug-2005::15:31:23 ===
Warnings tagged as: error
ok

-spec warning_msg(Format) -> ok when Format :: string().

等效于 warning_msg(Format, [])。

-spec warning_msg(Format, Data) -> ok when Format :: string(), Data :: list().

记录一个标准警告事件。Format 和 Data 参数与 STDLIB 中 io:format/2 的参数相同。

错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

该事件由默认的 Logger 处理程序处理。可以将日志级别更改为错误或信息，请参阅 warning_map/0。

这些函数被保留是为了向后兼容，新代码不得使用。请改用 ?LOG_WARNING 宏或 logger:warning/1,2,3。

警告

如果在格式字符串中使用 Unicode 转换修饰符 (t)，则所有事件处理程序都必须确保格式化的输出已为 I/O 设备正确编码。

-spec warning_report(Report) -> ok when Report :: report().

记录一个标准警告事件。错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

该事件由默认的 Logger 处理程序处理。可以将日志级别更改为错误或信息，请参阅 warning_map/0。

此函数被保留是为了向后兼容，新代码不得使用。请改用 ?LOG_WARNING 宏或 logger:warning/1,2,3。

-spec warning_report(Type, Report) -> ok when Type :: any(), Report :: report().

记录一个用户定义的警告事件。错误记录器将事件转发到 Logger，包括允许与旧的错误记录器事件处理程序向后兼容的元数据。

错误日志记录器还会向此事件的元数据添加一个值为 [Type] 的 domain 字段，导致默认 Logger 处理程序的过滤器丢弃该事件。必须添加不同的 Logger 处理程序或错误日志记录器事件处理程序来处理此事件。

可以将日志级别更改为错误或信息，请参阅 warning_map/0。

建议 Report 遵循与 warning_report/1 相同的结构。

此函数被保留是为了向后兼容，新代码不得使用。请改用 ?LOG_WARNING 宏或 logger:warning/1,2,3。