Module logi_source_error_logger

Description
Data Types
Function Index
Function Details

A handler for the standard error_logger module to forward log messages.

Behaviours: gen_event.

Description

A handler for the standard error_logger module to forward log messages

If install/1 is invoked, then the messages issued via error_logger module are forwarded to a logi channel.

error_logger_event() = {error, group_leader(), {pid(), io:format(), logi_layout:data()}} | {error_report, group_leader(), {pid(), std_error, Report::term()}} | {error_report, group_leader(), {pid(), Type::term(), Report::term()}} | {warning_msg, group_leader(), {pid(), io:format(), logi_layout:data()}} | {warning_report, group_leader(), {pid(), std_warning, Report::term()}} | {warning_report, group_leader(), {pid(), Type::term(), Report::term()}} | {info_msg, group_leader(), {pid(), io:format(), logi_layout:data()}} | {info_report, group_leader(), {pid(), std_info, Report::term()}} | {info_report, group_leader(), {pid(), Type::term(), Report::term()}}

An event which is send by error_logger.

The list is excerpted from [error_logger#Events](http://www.erlang.org/doc/man/error_logger.html#id115197).

group_leader()

group_leader() = pid()

The PID of a group leader.

See official document of error_logger for more information on "group leader".

log_fun()

log_fun() = fun((error_logger_event(), logi:logger_instance()) -> logi:logger_instance())

A function which forwards log messages to a logi channel

option()

option() = {logger, logi:logger()} | {forward_logger, logi:logger()} | {max_message_queue_len, non_neg_integer()} | {log_fun, log_fun()}

logger: - The logger instance which is used to report internal events of the handler - default: logi:default_logger()

forward_logger: - The logger instance which is used to forward log messages issued via error_logger - default: logi:default_logger()

max_message_queue_len: - Maximum message queue length of the error_logger process - While the length exceeds the value, new arrival messages will not be forwarded (i.e., discarded) - default: 128

log_fun: - Log messages forwarding function - default: fun logi_source_error_logger:default_log_fun/2

options()

options() = [option()]

Function Index

default_log_fun/2	Default forwarding function.
install/0	Equivalent to `install([])`.
install/1	Installs the `error_logger` handler.
uninstall/0	Uninstalls the handler.

Generated by EDoc, Sep 27 2018, 23:13:24.