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

fix(rule_engine): mechanism of restarting resources (#3980)

This commit is contained in:
Shawn 2021-01-04 11:52:57 +08:00 committed by GitHub
parent 26021b37b3
commit e518828d8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 68 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
apps/emqx_rule_engine/src/emqx_rule_engine.erl
View File

@ -237,27 +237,32 @@ create_resource(#{type := Type, config := Config0} = Params) ->
}, },
ok = emqx_rule_registry:add_resource(Resource), ok = emqx_rule_registry:add_resource(Resource),
%% Note that we will return OK in case of resource creation failure, %% Note that we will return OK in case of resource creation failure,
%% users can always re-start the resource later. %% A timer is started to re-start the resource later.
catch cluster_call(init_resource, [M, F, ResId, Config]), catch cluster_call(init_resource, [M, F, ResId, Config, true]),
{ok, Resource}; {ok, Resource};
not_found -> not_found ->
{error, {resource_type_not_found, Type}} {error, {resource_type_not_found, Type}}
end. end.
update_resource(#{id := Id, type := Type, config := NewConfig, description := Description} update_resource(#{id := Id, type := Type, config := NewConfig,
= NewResource) -> description := Description} = NewResource) ->
case emqx_rule_registry:find_resource_type(Type) of case emqx_rule_registry:find_resource_type(Type) of
{ok, #resource_type{on_create = {Module, Create}, {ok, #resource_type{on_create = {Module, Create},
params_spec = ParamSpec}} -> params_spec = ParamSpec}} ->
Config = emqx_rule_validator:validate_params(NewConfig, ParamSpec), Config = emqx_rule_validator:validate_params(NewConfig, ParamSpec),
_ = delete_resource(Id), case delete_resource(Id) of
emqx_rule_registry:add_resource(#resource{id = Id, {error, not_found} -> {error, not_found};
config = Config, _ -> %% deletion might fail because of an associted rule.
type = Type, emqx_rule_registry:add_resource(
description = Description, #resource{
created_at = erlang:system_time(millisecond)}), id = Id,
catch cluster_call(init_resource, [Module, Create, Id, Config]), config = Config,
{ok, NewResource}; type = Type,
description = Description,
created_at = erlang:system_time(millisecond)}),
catch cluster_call(init_resource, [Module, Create, Id, Config, true]),
{ok, NewResource}
end;
not_found -> not_found ->
{error, {resource_type_not_found, Type}} {error, {resource_type_not_found, Type}}
end. end.
@ -281,7 +286,9 @@ start_resource(ResId) ->
-spec(test_resource(#{type := _, config := _, _ => _}) -> ok | {error, Reason :: term()}). -spec(test_resource(#{type := _, config := _, _ => _}) -> ok | {error, Reason :: term()}).
test_resource(#{type := Type, config := Config0}) -> test_resource(#{type := Type, config := Config0}) ->
case emqx_rule_registry:find_resource_type(Type) of case emqx_rule_registry:find_resource_type(Type) of
{ok, #resource_type{on_create = {ModC,Create}, on_destroy = {ModD,Destroy}, params_spec = ParamSpec}} -> {ok, #resource_type{on_create = {ModC, Create},
on_destroy = {ModD, Destroy},
params_spec = ParamSpec}} ->
Config = emqx_rule_validator:validate_params(Config0, ParamSpec), Config = emqx_rule_validator:validate_params(Config0, ParamSpec),
ResId = resource_id(), ResId = resource_id(),
try try
@ -319,7 +326,7 @@ get_resource_params(ResId) ->
delete_resource(ResId) -> delete_resource(ResId) ->
case emqx_rule_registry:find_resource(ResId) of case emqx_rule_registry:find_resource(ResId) of
{ok, #resource{type = ResType}} -> {ok, #resource{type = ResType}} ->
{ok, #resource_type{on_destroy = {ModD,Destroy}}} {ok, #resource_type{on_destroy = {ModD, Destroy}}}
= emqx_rule_registry:find_resource_type(ResType), = emqx_rule_registry:find_resource_type(ResType),
try try
ok = emqx_rule_registry:remove_resource(ResId), ok = emqx_rule_registry:remove_resource(ResId),
@ -328,7 +335,7 @@ delete_resource(ResId) ->
throw:Reason -> {error, Reason} throw:Reason -> {error, Reason}
end; end;
not_found -> not_found ->
ok {error, not_found}
end. end.
%%------------------------------------------------------------------------------ %%------------------------------------------------------------------------------
@ -344,7 +351,7 @@ refresh_resources() ->
"Can not re-stablish resource ~p: ~0p. The resource is disconnected." "Can not re-stablish resource ~p: ~0p. The resource is disconnected."
"Fix the issue and establish it manually.\n" "Fix the issue and establish it manually.\n"
"Stacktrace: ~0p", "Stacktrace: ~0p",
[ResId, {Error,Reason}, ST]) [ResId, {Error, Reason}, ST])
end end
end, emqx_rule_registry:get_resources()). end, emqx_rule_registry:get_resources()).
@ -486,10 +493,15 @@ cluster_call(Func, Args) ->
end. end.
init_resource(Module, OnCreate, ResId, Config) -> init_resource(Module, OnCreate, ResId, Config) ->
Params = ?RAISE(Module:OnCreate(ResId, Config), init_resource(Module, OnCreate, ResId, Config, false).
start_reinitial_loop(ResId),
{{init_resource_failure, node()}, init_resource(Module, OnCreate, ResId, Config, Restart) ->
{{Module, OnCreate}, {_EXCLASS_,_EXCPTION_, _ST_}}}), Params = ?RAISE(
Module:OnCreate(ResId, Config),
Restart andalso
timer:apply_after(timer:seconds(60), ?MODULE, do_init_resource,
[Module, OnCreate, ResId, Config, Restart]),
{{Module, OnCreate}, {_EXCLASS_, _EXCPTION_, _ST_}}),
ResParams = #resource_params{id = ResId, ResParams = #resource_params{id = ResId,
params = Params, params = Params,
status = #{is_alive => true}}, status = #{is_alive => true}},
@ -497,7 +509,9 @@ init_resource(Module, OnCreate, ResId, Config) ->
init_action(Module, OnCreate, ActionInstId, Params) -> init_action(Module, OnCreate, ActionInstId, Params) ->
ok = emqx_rule_metrics:create_metrics(ActionInstId), ok = emqx_rule_metrics:create_metrics(ActionInstId),
case ?RAISE(Module:OnCreate(ActionInstId, Params), {{init_action_failure, node()}, {{Module,OnCreate},{_EXCLASS_,_EXCPTION_,_ST_}}}) of case ?RAISE(Module:OnCreate(ActionInstId, Params),
{{init_action_failure, node()},
{{Module, OnCreate}, {_EXCLASS_, _EXCPTION_, _ST_}}}) of
{Apply, NewParams} when is_function(Apply) -> %% BACKW: =< e4.2.2 {Apply, NewParams} when is_function(Apply) -> %% BACKW: =< e4.2.2
ok = emqx_rule_registry:add_action_instance_params( ok = emqx_rule_registry:add_action_instance_params(
#action_instance_params{id = ActionInstId, params = NewParams, apply = Apply}); #action_instance_params{id = ActionInstId, params = NewParams, apply = Apply});
@ -616,14 +630,3 @@ find_type(ResId) ->
alarm_name_of_resource_down(Type, ResId) -> alarm_name_of_resource_down(Type, ResId) ->
list_to_binary(io_lib:format("resource/~s/~s/down", [Type, ResId])). list_to_binary(io_lib:format("resource/~s/~s/down", [Type, ResId])).
start_reinitial_loop(Id) ->
spawn(fun() ->
timer:sleep(60000),
case emqx_rule_registry:find_resource(Id) of
{ok, _}->
?LOG(warning, "try to re-initialize resource: ~p", [Id]),
start_resource(Id);
not_found -> ok
end
end).

51
apps/emqx_rule_engine/src/emqx_rule_engine_api.erl
View File

@ -255,12 +255,18 @@ show_action(#{name := Name}, _Params) ->
%% Resources API %% Resources API
%%------------------------------------------------------------------------------ %%------------------------------------------------------------------------------
create_resource(#{}, Params) -> create_resource(#{}, Params) ->
if_test(fun() -> do_create_resource(test_resource, Params) end, case parse_resource_params(Params) of
fun() -> do_create_resource(create_resource, Params) end, {ok, ParsedParams} ->
Params). if_test(fun() -> do_create_resource(test_resource, ParsedParams) end,
fun() -> do_create_resource(create_resource, ParsedParams) end,
Params);
{error, Reason} ->
?LOG(error, "~p failed: ~0p", [?FUNCTION_NAME, Reason]),
return({error, 400, ?ERR_BADARGS(Reason)})
end.
do_create_resource(Create, Params) -> do_create_resource(Create, ParsedParams) ->
case emqx_rule_engine:Create(parse_resource_params(Params)) of case emqx_rule_engine:Create(ParsedParams) of
ok -> ok ->
return(ok); return(ok);
{ok, Resource} -> {ok, Resource} ->
@ -322,23 +328,30 @@ start_resource(#{id := Id}, _Params) ->
end. end.
update_resource(#{id := Id}, Params) -> update_resource(#{id := Id}, Params) ->
case emqx_rule_registry:find_resource(Id) of case parse_resource_params(Params) of
{ok, #resource{id = Id, type = Type} = _OldResource} -> {ok, ParsedParams} ->
Config = maps:get(config, parse_resource_params(Params)), case emqx_rule_registry:find_resource(Id) of
Description = maps:get(description, parse_resource_params(Params)), {ok, #resource{id = Id, type = Type} = _OldResource} ->
_ = emqx_rule_engine:update_resource(#{id => Id, Config = maps:get(config, ParsedParams),
config => Config, Description = maps:get(description, ParsedParams),
type => Type, emqx_rule_engine:update_resource(
description => Description, #{id => Id,
created_at => erlang:system_time(millisecond)}), config => Config,
return(ok); type => Type,
_Other -> description => Description,
return({error, 400, ?ERR_NO_RESOURCE(Id)}) created_at => erlang:system_time(millisecond)}),
return(ok);
_Other ->
return({error, 400, ?ERR_NO_RESOURCE(Id)})
end;
{error, Reason} ->
return({error, 400, ?ERR_BADARGS(Reason)})
end. end.
delete_resource(#{id := Id}, _Params) -> delete_resource(#{id := Id}, _Params) ->
case emqx_rule_engine:delete_resource(Id) of case emqx_rule_engine:delete_resource(Id) of
ok -> return(ok); ok -> return(ok);
{error, not_found} -> return(ok);
{error, Reason} -> {error, Reason} ->
return({error, 400, ?ERR_BADARGS(Reason)}) return({error, 400, ?ERR_BADARGS(Reason)})
end. end.
@ -495,13 +508,13 @@ parse_action(Action) ->
parse_resource_params(Params) -> parse_resource_params(Params) ->
parse_resource_params(Params, #{config => #{}, description => <<"">>}). parse_resource_params(Params, #{config => #{}, description => <<"">>}).
parse_resource_params([], Res) -> parse_resource_params([], Res) ->
Res; {ok, Res};
parse_resource_params([{<<"id">>, Id} | Params], Res) -> parse_resource_params([{<<"id">>, Id} | Params], Res) ->
parse_resource_params(Params, Res#{id => Id}); parse_resource_params(Params, Res#{id => Id});
parse_resource_params([{<<"type">>, ResourceType} | Params], Res) -> parse_resource_params([{<<"type">>, ResourceType} | Params], Res) ->
try parse_resource_params(Params, Res#{type => binary_to_existing_atom(ResourceType, utf8)}) try parse_resource_params(Params, Res#{type => binary_to_existing_atom(ResourceType, utf8)})
catch error:badarg -> catch error:badarg ->
throw({resource_type_not_found, ResourceType}) {error, {resource_type_not_found, ResourceType}}
end; end;
parse_resource_params([{<<"config">>, Config} | Params], Res) -> parse_resource_params([{<<"config">>, Config} | Params], Res) ->
parse_resource_params(Params, Res#{config => json_term_to_map(Config)}); parse_resource_params(Params, Res#{config => json_term_to_map(Config)});

1
apps/emqx_rule_engine/src/emqx_rule_engine_cli.erl
View File

@ -183,6 +183,7 @@ resources(["show", ResourceId]) ->
resources(["delete", ResourceId]) -> resources(["delete", ResourceId]) ->
case emqx_rule_engine:delete_resource(list_to_binary(ResourceId)) of case emqx_rule_engine:delete_resource(list_to_binary(ResourceId)) of
ok -> emqx_ctl:print("ok~n"); ok -> emqx_ctl:print("ok~n");
{error, not_found} -> emqx_ctl:print("ok~n");
{error, Reason} -> {error, Reason} ->
emqx_ctl:print("Cannot delete resource as ~0p~n", [Reason]) emqx_ctl:print("Cannot delete resource as ~0p~n", [Reason])
end; end;