yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(logger): resolve issues when starting and stopping log handlers

This commit is contained in:
terry-xiaoyu 2020-08-24 15:04:06 +08:00 committed by Rory Z
parent faf0b5289c
commit 9985e2675c
3 changed files with 85 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
src/emqx_logger.erl
View File

@ -48,6 +48,7 @@
-export([ get_primary_log_level/0
, get_log_handlers/0
, get_log_handlers/1
, get_log_handler/1
]).
@ -61,6 +62,8 @@
-type(logger_dst() :: file:filename() | console | unknown).
-type(logger_handler_info() :: {logger:handler_id(), logger:level(), logger_dst()}).
-define(stopped_handlers, {?MODULE, stopped_handlers}).
%%--------------------------------------------------------------------
%% APIs
%%--------------------------------------------------------------------
@ -151,8 +154,12 @@ set_primary_log_level(Level) ->
-spec(get_log_handlers() -> [logger_handler_info()]).
get_log_handlers() ->
[log_hanlder_info(Conf, started) || Conf <- logger:get_handler_config()]
++
get_log_handlers(started) ++ get_log_handlers(stopped).
-spec(get_log_handlers(started | stopped) -> [logger_handler_info()]).
get_log_handlers(started) ->
[log_hanlder_info(Conf, started) || Conf <- logger:get_handler_config()];
get_log_handlers(stopped) ->
[log_hanlder_info(Conf, stopped) || Conf <- list_stopped_handler_config()].
-spec(get_log_handler(logger:handler_id()) -> logger_handler_info()).
@ -163,7 +170,7 @@ get_log_handler(HandlerId) ->
{error, _} ->
case read_stopped_handler_config(HandlerId) of
error -> {error, {not_found, HandlerId}};
Conf -> log_hanlder_info(Conf, stopped)
{ok, Conf} -> log_hanlder_info(Conf, stopped)
end
end.
@ -174,8 +181,11 @@ start_log_handler(HandlerId) ->
false ->
case read_stopped_handler_config(HandlerId) of
error -> {error, {not_found, HandlerId}};
Conf = #{module := Mod} ->
logger:add_handler(HandlerId, Mod, Conf)
{ok, Conf = #{module := Mod}} ->
case logger:add_handler(HandlerId, Mod, Conf) of
ok -> remove_stopped_handler_config(HandlerId);
{error, _} = Error -> Error
end
end
end.
@ -183,8 +193,10 @@ start_log_handler(HandlerId) ->
stop_log_handler(HandlerId) ->
case logger:get_handler_config(HandlerId) of
{ok, Conf} ->
save_stopped_handler_config(HandlerId, Conf),
logger:remove_handler(HandlerId);
case logger:remove_handler(HandlerId) of
ok -> save_stopped_handler_config(HandlerId, Conf);
Error -> Error
end;
{error, _} ->
{error, {not_started, HandlerId}}
end.
@ -196,7 +208,7 @@ set_log_handler_level(HandlerId, Level) ->
{error, _} ->
case read_stopped_handler_config(HandlerId) of
error -> {error, {not_found, HandlerId}};
Conf ->
{ok, Conf} ->
save_stopped_handler_config(HandlerId, Conf#{level => Level})
end
end.
@ -240,7 +252,7 @@ log_hanlder_info(#{id := Id, level := Level, module := _OtherModule}, Status) ->
set_all_log_handlers_level(Level) ->
set_all_log_handlers_level(get_log_handlers(), Level, []).
set_all_log_handlers_level([{ID, Level, _Dst} | List], NewLevel, ChangeHistory) ->
set_all_log_handlers_level([#{id := ID, level := Level} | List], NewLevel, ChangeHistory) ->
case set_log_handler_level(ID, NewLevel) of
ok -> set_all_log_handlers_level(List, NewLevel, [{ID, Level} | ChangeHistory]);
{error, Error} ->
@ -251,21 +263,36 @@ set_all_log_handlers_level([], _NewLevel, _NewHanlder) ->
ok.
rollback([{ID, Level} | List]) ->
emqx_logger:set_log_handler_level(ID, Level),
set_log_handler_level(ID, Level),
rollback(List);
rollback([]) -> ok.
save_stopped_handler_config(HandlerId, Config) ->
persistent_term:put({?MODULE, config}, #{HandlerId => Config}).
case persistent_term:get(?stopped_handlers, undefined) of
undefined ->
persistent_term:put(?stopped_handlers, #{HandlerId => Config});
ConfList ->
persistent_term:put(?stopped_handlers, ConfList#{HandlerId => Config})
end.
read_stopped_handler_config(HandlerId) ->
case persistent_term:get({?MODULE, config}, undefined) of
case persistent_term:get(?stopped_handlers, undefined) of
undefined -> error;
Conf -> maps:find(HandlerId, Conf)
ConfList -> maps:find(HandlerId, ConfList)
end.
remove_stopped_handler_config(HandlerId) ->
case persistent_term:get(?stopped_handlers, undefined) of
undefined -> ok;
ConfList ->
case maps:find(HandlerId, ConfList) of
error -> ok;
{ok, _} ->
persistent_term:put(?stopped_handlers, maps:remove(HandlerId, ConfList))
end
end.
list_stopped_handler_config() ->
case persistent_term:get({?MODULE, config}, undefined) of
undefined -> error;
Conf -> maps:to_list(Conf)
case persistent_term:get(?stopped_handlers, undefined) of
undefined -> [];
ConfList -> maps:values(ConfList)
end.
%% @doc The following parse-transforms stripped off the module attribute named

4
src/emqx_tracer.erl
View File

@ -97,7 +97,7 @@ stop_trace(Who) ->
%% @doc Lookup all traces
-spec(lookup_traces() -> [{Who :: trace_who(), LogFile :: string()}]).
lookup_traces() ->
lists:foldl(fun filter_traces/2, [], emqx_logger:get_log_handlers()).
lists:foldl(fun filter_traces/2, [], emqx_logger:get_log_handlers(started)).
install_trace_handler(Who, Level, LogFile) ->
case logger:add_handler(handler_id(Who), logger_disk_log_h,
@ -125,7 +125,7 @@ uninstall_trance_handler(Who) ->
{error, Reason}
end.
filter_traces({Id, Level, Dst}, Acc) ->
filter_traces(#{id := Id, level := Level, dst := Dst}, Acc) ->
case atom_to_list(Id) of
?TOPIC_TRACE_ID(T)->
[{?TOPIC_TRACE(T), {Level,Dst}} | Acc];

47
test/emqx_logger_SUITE.erl
View File

@ -23,6 +23,7 @@
-define(LOGGER, emqx_logger).
-define(a, "a").
-define(SUPPORTED_LEVELS, [emergency, alert, critical, error, warning, notice, info, debug]).
-define(PARSE_TRANS_TEST_CODE,
"-module(mytest).\n"
@ -83,22 +84,54 @@ t_get_log_handlers(_) ->
?assertMatch([_|_], ?LOGGER:get_log_handlers()).
t_get_log_handler(_) ->
[{HandlerId, _, _} | _ ] = ?LOGGER:get_log_handlers(),
?assertMatch({HandlerId, _, _}, ?LOGGER:get_log_handler(HandlerId)).
[?assertMatch(#{id := Id}, ?LOGGER:get_log_handler(Id))
|| #{id := Id} <- ?LOGGER:get_log_handlers()].
t_set_log_handler_level(_) ->
[{HandlerId, _, _} | _ ] = ?LOGGER:get_log_handlers(),
Level = debug,
?LOGGER:set_log_handler_level(HandlerId, Level),
?assertMatch({HandlerId, Level, _}, ?LOGGER:get_log_handler(HandlerId)).
[begin
?LOGGER:set_log_handler_level(Id, Level),
?assertMatch(#{id := Id, level := Level}, ?LOGGER:get_log_handler(Id))
end || #{id := Id} <- ?LOGGER:get_log_handlers(),
Level <- ?SUPPORTED_LEVELS],
?LOGGER:set_log_level(warning).
t_set_log_level(_) ->
?assertMatch({error, _Error}, ?LOGGER:set_log_level(for_test)),
?assertEqual(ok, ?LOGGER:set_log_level(debug)).
?assertEqual(ok, ?LOGGER:set_log_level(debug)),
?assertEqual(ok, ?LOGGER:set_log_level(warning)).
t_set_all_log_handlers_level(_) ->
?assertMatch({error, _Error}, ?LOGGER:set_all_log_handlers_level(for_test)).
t_start_stop_log_handler(_) ->
io:format("====== started: ~p~n", [?LOGGER:get_log_handlers(started)]),
io:format("====== stopped: ~p~n", [?LOGGER:get_log_handlers(stopped)]),
StartedN = length(?LOGGER:get_log_handlers(started)),
StoppedN = length(?LOGGER:get_log_handlers(stopped)),
[begin
io:format("------ stopping : ~p~n", [Id]),
ok = ?LOGGER:stop_log_handler(Id),
?assertEqual(StartedN - 1, length(?LOGGER:get_log_handlers(started))),
?assertEqual(StoppedN + 1, length(?LOGGER:get_log_handlers(stopped))),
io:format("------ starting : ~p~n", [Id]),
ok = ?LOGGER:start_log_handler(Id),
?assertEqual(StartedN, length(?LOGGER:get_log_handlers(started))),
?assertEqual(StoppedN, length(?LOGGER:get_log_handlers(stopped)))
end || #{id := Id} <- ?LOGGER:get_log_handlers(started)].
t_start_stop_log_handler2(_) ->
%% start a handler that is already started returns ok
[begin
ok = ?LOGGER:start_log_handler(Id)
end || #{id := Id} <- ?LOGGER:get_log_handlers(started)],
%% stop a no exists handler returns {not_started, Id}
?assertMatch({error, {not_started, invalid_handler_id}},
?LOGGER:stop_log_handler(invalid_handler_id)),
%% stop a handler that is already stopped retuns {not_started, Id}
ok = ?LOGGER:stop_log_handler(default),
?assertMatch({error, {not_started, default}},
?LOGGER:stop_log_handler(default)).
t_parse_transform(_) ->
{ok, Toks, _EndLine} = erl_scan:string(?PARSE_TRANS_TEST_CODE),
FormToks = split_toks_at_dot(Toks),