leo_logger_appender_file

• Description
• Function Index
• Function Details

The file appender.

Behaviours: `leo_logger_behavior <leo_logger_behavior.html>`__.

References

• https://github.com/leo-project/leo_logger/blob/master/src/leo_logger_appender_file.erl

Description

The file appender

Function Index

append/2	Append a message to a file.
bulk_output/2	Output messages.
close/1	Close the log file.
format/2	Format a log message.
init/3	Initialize the logger.
rotate/2	Rotate the log file.
sync/1	Synchronize the file.

Function Details

append/2

append(Msg, State) -> #logger_state{}

• Msg = #message_log{}
• State = #logger_state{}

Append a message to a file

bulk_output/2

bulk_output(Logs, State) -> #logger_state{}

• Logs = [term()]
• State = #logger_state{}

Output messages

close/1

close(State) -> ok | {error, any()}

• State = #logger_state{}

Close the log file

format/2

format(Type, Msg) -> Ret

• Type = split | bulk
• Msg = #message_log{}
• Ret = string()

Format a log message

init/3

init(Appender, CallbackMod, Props) -> {ok, #logger_state{}} | {error, term()}

• Appender = atom()
• CallbackMod = module()
• Props = [{atom(), any()}]

Initialize the logger

rotate/2

rotate(Hours, State) -> {ok, #logger_state{}}

• Hours = {integer(), integer(), integer(), integer()}
• State = #logger_state{}

Rotate the log file

sync/1

sync(State) -> ok | {error, term()}

• State = #logger_state{}

Synchronize the file