alog_control.md

Module alog_control

Module alog_control

• Description
• Data Types
• Function Index
• Function Details

Main interface for work with log flows.

Behaviours: gen_server.

Data Types

filter()

filter() = {mod, atom()} | {mod, [atom()]} | {tag, atom()} | {tag, [atom()]} | {app, atom()}

logger()

logger() = atom()

priority()

priority() = debug | info | notice | warning | error | critical | alert | emergency | integer()

priority_expr()

priority_expr() = '<' | '>' | '=<' | '>=' | '==' | '/='

priority_pattern()

priority_pattern() = [{priority_expr(), priority()}] | {priority_expr(), priority()} | priority()

Function Index

add_logger/1	Add and start new logger.
add_new_flow/3	Add new flow.
delete_all_flows/0	Delete all flows.
delete_flow/1	Delete existing flow.
delete_logger/1	Delete exist logger.
disable_flow/1	Temporary disable existing flow.
dump_to_config/1	Update flows configuration in .config file.
enable_flow/1	Enable existing flow.
get_flows/0	Return all flows.
get_loggers/0
print_flows/0	Print all flows.
replace_flows/1	Replace all flows on new.
replace_loggers/1
set_flow_filter/2	Set new filter for existing flow.
set_flow_loggers/2	Set new loggers for existing flow.
set_flow_priority/2	Set new priority_pattern for existing flow.

Function Details

add_logger/1

add_logger(Logger::logger()) -> ok | {error, term()}

Add and start new logger.

add_new_flow/3

add_new_flow(Filter::filter(), Priority::priority_pattern(), Loggers::[logger()]) -> ok | {error, term()}

Add new flow.

delete_all_flows/0

delete_all_flows() -> ok | {error, term()}

Delete all flows.

delete_flow/1

delete_flow(Id::non_neg_integer()) -> ok | {error, term()}

Delete existing flow.

delete_logger/1

delete_logger(Logger::logger()) -> ok | {error, term()}

Delete exist logger. All flows use this logger became disabled.

disable_flow/1

disable_flow(Id::non_neg_integer()) -> ok | {error, term()}

Temporary disable existing flow.

dump_to_config/1

dump_to_config(File::string()) -> ok | {error, term()}

Update flows configuration in .config file

enable_flow/1

enable_flow(Id::non_neg_integer()) -> ok | {error, term()}

Enable existing flow.

get_flows/0

get_flows() -> {ok, [#flow{}]} | {error, term()}

Return all flows.

get_loggers/0

get_loggers() -> {ok, [logger()]}

print_flows/0

print_flows() -> ok

Print all flows.

replace_flows/1

replace_flows(Flow::[#flow{}]) -> ok | {error, term()}

Replace all flows on new.

replace_loggers/1

replace_loggers(Loggers::[logger()]) -> ok | {error, term()}

set_flow_filter/2

set_flow_filter(Id::non_neg_integer(), Filter::filter()) -> ok | {error, term()}

Set new filter for existing flow.

set_flow_loggers/2

set_flow_loggers(Id::non_neg_integer(), Loggers::[logger()]) -> ok | {error, term()}

Set new loggers for existing flow.

set_flow_priority/2

set_flow_priority(Id::non_neg_integer(), Priority::priority_pattern()) -> ok | {error, term()}

Set new priority_pattern for existing flow.