561 lines
18 KiB
Erlang
561 lines
18 KiB
Erlang
%%--------------------------------------------------------------------
|
|
%% Copyright (c) 2020-2023 EMQ Technologies Co., Ltd. All Rights Reserved.
|
|
%%
|
|
%% Licensed under the Apache License, Version 2.0 (the "License");
|
|
%% you may not use this file except in compliance with the License.
|
|
%% You may obtain a copy of the License at
|
|
%%
|
|
%% http://www.apache.org/licenses/LICENSE-2.0
|
|
%%
|
|
%% Unless required by applicable law or agreed to in writing, software
|
|
%% distributed under the License is distributed on an "AS IS" BASIS,
|
|
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
%% See the License for the specific language governing permissions and
|
|
%% limitations under the License.
|
|
%%--------------------------------------------------------------------
|
|
|
|
-module(emqx_resource).
|
|
|
|
-include("emqx_resource.hrl").
|
|
-include("emqx_resource_utils.hrl").
|
|
-include("emqx_resource_errors.hrl").
|
|
|
|
%% APIs for resource types
|
|
|
|
-export([list_types/0]).
|
|
|
|
%% APIs for instances
|
|
|
|
-export([
|
|
check_config/2,
|
|
check_and_create/4,
|
|
check_and_create/5,
|
|
check_and_create_local/4,
|
|
check_and_create_local/5,
|
|
check_and_recreate/4,
|
|
check_and_recreate_local/4
|
|
]).
|
|
|
|
%% Sync resource instances and files
|
|
%% provisional solution: rpc:multicall to all the nodes for creating/updating/removing
|
|
%% todo: replicate operations
|
|
|
|
%% store the config and start the instance
|
|
-export([
|
|
create/4,
|
|
create/5,
|
|
create_local/4,
|
|
create_local/5,
|
|
%% run start/2, health_check/2 and stop/1 sequentially
|
|
create_dry_run/2,
|
|
create_dry_run_local/2,
|
|
%% this will do create_dry_run, stop the old instance and start a new one
|
|
recreate/3,
|
|
recreate/4,
|
|
recreate_local/3,
|
|
recreate_local/4,
|
|
%% remove the config and stop the instance
|
|
remove/1,
|
|
remove_local/1,
|
|
reset_metrics/1,
|
|
reset_metrics_local/1
|
|
]).
|
|
|
|
%% Calls to the callback module with current resource state
|
|
%% They also save the state after the call finished (except query/2,3).
|
|
|
|
-export([
|
|
start/1,
|
|
start/2,
|
|
restart/1,
|
|
restart/2,
|
|
%% verify if the resource is working normally
|
|
health_check/1,
|
|
%% set resource status to disconnected
|
|
set_resource_status_connecting/1,
|
|
%% stop the instance
|
|
stop/1,
|
|
%% query the instance
|
|
query/2,
|
|
query/3,
|
|
%% query the instance without batching and queuing messages.
|
|
simple_sync_query/2,
|
|
%% functions used by connectors to register resources that must be
|
|
%% freed when stopping or even when a resource manager crashes.
|
|
allocate_resource/3,
|
|
has_allocated_resources/1,
|
|
get_allocated_resources/1,
|
|
get_allocated_resources_list/1,
|
|
forget_allocated_resources/1
|
|
]).
|
|
|
|
%% Direct calls to the callback module
|
|
|
|
-export([
|
|
%% get the callback mode of a specific module
|
|
get_callback_mode/1,
|
|
%% start the instance
|
|
call_start/3,
|
|
%% verify if the resource is working normally
|
|
call_health_check/3,
|
|
%% stop the instance
|
|
call_stop/3,
|
|
%% get the query mode of the resource
|
|
query_mode/3
|
|
]).
|
|
|
|
%% list all the instances, id only.
|
|
-export([
|
|
list_instances/0,
|
|
%% list all the instances
|
|
list_instances_verbose/0,
|
|
%% return the data of the instance
|
|
get_instance/1,
|
|
get_metrics/1,
|
|
fetch_creation_opts/1,
|
|
%% return all the instances of the same resource type
|
|
list_instances_by_type/1,
|
|
generate_id/1,
|
|
list_group_instances/1
|
|
]).
|
|
|
|
-export([apply_reply_fun/2]).
|
|
|
|
-export_type([
|
|
query_mode/0,
|
|
resource_id/0,
|
|
resource_data/0,
|
|
resource_status/0
|
|
]).
|
|
|
|
-optional_callbacks([
|
|
on_query/3,
|
|
on_batch_query/3,
|
|
on_query_async/4,
|
|
on_batch_query_async/4,
|
|
on_get_status/2,
|
|
query_mode/1
|
|
]).
|
|
|
|
%% when calling emqx_resource:start/1
|
|
-callback on_start(resource_id(), resource_config()) ->
|
|
{ok, resource_state()} | {error, Reason :: term()}.
|
|
|
|
%% when calling emqx_resource:stop/1
|
|
-callback on_stop(resource_id(), resource_state()) -> term().
|
|
|
|
%% when calling emqx_resource:get_callback_mode/1
|
|
-callback callback_mode() -> callback_mode().
|
|
|
|
%% when calling emqx_resource:query/3
|
|
-callback on_query(resource_id(), Request :: term(), resource_state()) -> query_result().
|
|
|
|
%% when calling emqx_resource:on_batch_query/3
|
|
-callback on_batch_query(resource_id(), Request :: term(), resource_state()) -> query_result().
|
|
|
|
%% when calling emqx_resource:on_query_async/4
|
|
-callback on_query_async(
|
|
resource_id(),
|
|
Request :: term(),
|
|
{ReplyFun :: function(), Args :: list()},
|
|
resource_state()
|
|
) -> query_result().
|
|
|
|
%% when calling emqx_resource:on_batch_query_async/4
|
|
-callback on_batch_query_async(
|
|
resource_id(),
|
|
Request :: term(),
|
|
{ReplyFun :: function(), Args :: list()},
|
|
resource_state()
|
|
) -> query_result().
|
|
|
|
%% when calling emqx_resource:health_check/2
|
|
-callback on_get_status(resource_id(), resource_state()) ->
|
|
resource_status()
|
|
| {resource_status(), resource_state()}
|
|
| {resource_status(), resource_state(), term()}.
|
|
|
|
-callback query_mode(Config :: term()) -> query_mode().
|
|
|
|
-spec list_types() -> [module()].
|
|
list_types() ->
|
|
discover_resource_mods().
|
|
|
|
-spec discover_resource_mods() -> [module()].
|
|
discover_resource_mods() ->
|
|
[Mod || {Mod, _} <- code:all_loaded(), is_resource_mod(Mod)].
|
|
|
|
-spec is_resource_mod(module()) -> boolean().
|
|
is_resource_mod(Module) ->
|
|
Info = Module:module_info(attributes),
|
|
Behaviour =
|
|
proplists:get_value(behavior, Info, []) ++
|
|
proplists:get_value(behaviour, Info, []),
|
|
lists:member(?MODULE, Behaviour).
|
|
|
|
%% =================================================================================
|
|
%% APIs for resource instances
|
|
%% =================================================================================
|
|
-spec create(resource_id(), resource_group(), resource_type(), resource_config()) ->
|
|
{ok, resource_data() | 'already_created'} | {error, Reason :: term()}.
|
|
create(ResId, Group, ResourceType, Config) ->
|
|
create(ResId, Group, ResourceType, Config, #{}).
|
|
|
|
-spec create(resource_id(), resource_group(), resource_type(), resource_config(), creation_opts()) ->
|
|
{ok, resource_data() | 'already_created'} | {error, Reason :: term()}.
|
|
create(ResId, Group, ResourceType, Config, Opts) ->
|
|
emqx_resource_proto_v1:create(ResId, Group, ResourceType, Config, Opts).
|
|
% --------------------------------------------
|
|
|
|
-spec create_local(resource_id(), resource_group(), resource_type(), resource_config()) ->
|
|
{ok, resource_data() | 'already_created'} | {error, Reason :: term()}.
|
|
create_local(ResId, Group, ResourceType, Config) ->
|
|
create_local(ResId, Group, ResourceType, Config, #{}).
|
|
|
|
-spec create_local(
|
|
resource_id(),
|
|
resource_group(),
|
|
resource_type(),
|
|
resource_config(),
|
|
creation_opts()
|
|
) ->
|
|
{ok, resource_data()}.
|
|
create_local(ResId, Group, ResourceType, Config, Opts) ->
|
|
emqx_resource_manager:ensure_resource(ResId, Group, ResourceType, Config, Opts).
|
|
|
|
-spec create_dry_run(resource_type(), resource_config()) ->
|
|
ok | {error, Reason :: term()}.
|
|
create_dry_run(ResourceType, Config) ->
|
|
emqx_resource_proto_v1:create_dry_run(ResourceType, Config).
|
|
|
|
-spec create_dry_run_local(resource_type(), resource_config()) ->
|
|
ok | {error, Reason :: term()}.
|
|
create_dry_run_local(ResourceType, Config) ->
|
|
emqx_resource_manager:create_dry_run(ResourceType, Config).
|
|
|
|
-spec recreate(resource_id(), resource_type(), resource_config()) ->
|
|
{ok, resource_data()} | {error, Reason :: term()}.
|
|
recreate(ResId, ResourceType, Config) ->
|
|
recreate(ResId, ResourceType, Config, #{}).
|
|
|
|
-spec recreate(resource_id(), resource_type(), resource_config(), creation_opts()) ->
|
|
{ok, resource_data()} | {error, Reason :: term()}.
|
|
recreate(ResId, ResourceType, Config, Opts) ->
|
|
emqx_resource_proto_v1:recreate(ResId, ResourceType, Config, Opts).
|
|
|
|
-spec recreate_local(resource_id(), resource_type(), resource_config()) ->
|
|
{ok, resource_data()} | {error, Reason :: term()}.
|
|
recreate_local(ResId, ResourceType, Config) ->
|
|
recreate_local(ResId, ResourceType, Config, #{}).
|
|
|
|
-spec recreate_local(resource_id(), resource_type(), resource_config(), creation_opts()) ->
|
|
{ok, resource_data()} | {error, Reason :: term()}.
|
|
recreate_local(ResId, ResourceType, Config, Opts) ->
|
|
emqx_resource_manager:recreate(ResId, ResourceType, Config, Opts).
|
|
|
|
-spec remove(resource_id()) -> ok | {error, Reason :: term()}.
|
|
remove(ResId) ->
|
|
emqx_resource_proto_v1:remove(ResId).
|
|
|
|
-spec remove_local(resource_id()) -> ok | {error, Reason :: term()}.
|
|
remove_local(ResId) ->
|
|
emqx_resource_manager:remove(ResId).
|
|
|
|
-spec reset_metrics_local(resource_id()) -> ok.
|
|
reset_metrics_local(ResId) ->
|
|
emqx_resource_manager:reset_metrics(ResId).
|
|
|
|
-spec reset_metrics(resource_id()) -> ok | {error, Reason :: term()}.
|
|
reset_metrics(ResId) ->
|
|
emqx_resource_proto_v1:reset_metrics(ResId).
|
|
|
|
%% =================================================================================
|
|
-spec query(resource_id(), Request :: term()) -> Result :: term().
|
|
query(ResId, Request) ->
|
|
query(ResId, Request, #{}).
|
|
|
|
-spec query(resource_id(), Request :: term(), query_opts()) ->
|
|
Result :: term().
|
|
query(ResId, Request, Opts) ->
|
|
case emqx_resource_manager:lookup_cached(ResId) of
|
|
{ok, _Group, #{query_mode := QM, error := Error}} ->
|
|
case {QM, Error} of
|
|
{_, unhealthy_target} ->
|
|
?RESOURCE_ERROR(unhealthy_target, "unhealthy target");
|
|
{_, {unhealthy_target, _Message}} ->
|
|
?RESOURCE_ERROR(unhealthy_target, "unhealthy target");
|
|
{simple_async, _} ->
|
|
%% TODO(5.1.1): pass Resource instead of ResId to simple APIs
|
|
%% so the buffer worker does not need to lookup the cache again
|
|
Opts1 = Opts#{is_buffer_supported => true},
|
|
emqx_resource_buffer_worker:simple_async_query(ResId, Request, Opts1);
|
|
{simple_sync, _} ->
|
|
%% TODO(5.1.1): pass Resource instead of ResId to simple APIs
|
|
%% so the buffer worker does not need to lookup the cache again
|
|
emqx_resource_buffer_worker:simple_sync_query(ResId, Request, Opts);
|
|
{sync, _} ->
|
|
emqx_resource_buffer_worker:sync_query(ResId, Request, Opts);
|
|
{async, _} ->
|
|
emqx_resource_buffer_worker:async_query(ResId, Request, Opts)
|
|
end;
|
|
{error, not_found} ->
|
|
?RESOURCE_ERROR(not_found, "resource not found")
|
|
end.
|
|
|
|
-spec simple_sync_query(resource_id(), Request :: term()) -> Result :: term().
|
|
simple_sync_query(ResId, Request) ->
|
|
emqx_resource_buffer_worker:simple_sync_query(ResId, Request).
|
|
|
|
-spec start(resource_id()) -> ok | {error, Reason :: term()}.
|
|
start(ResId) ->
|
|
start(ResId, #{}).
|
|
|
|
-spec start(resource_id(), creation_opts()) -> ok | {error, Reason :: term()}.
|
|
start(ResId, Opts) ->
|
|
emqx_resource_manager:start(ResId, Opts).
|
|
|
|
-spec restart(resource_id()) -> ok | {error, Reason :: term()}.
|
|
restart(ResId) ->
|
|
restart(ResId, #{}).
|
|
|
|
-spec restart(resource_id(), creation_opts()) -> ok | {error, Reason :: term()}.
|
|
restart(ResId, Opts) ->
|
|
emqx_resource_manager:restart(ResId, Opts).
|
|
|
|
-spec stop(resource_id()) -> ok | {error, Reason :: term()}.
|
|
stop(ResId) ->
|
|
emqx_resource_manager:stop(ResId).
|
|
|
|
-spec health_check(resource_id()) -> {ok, resource_status()} | {error, term()}.
|
|
health_check(ResId) ->
|
|
emqx_resource_manager:health_check(ResId).
|
|
|
|
set_resource_status_connecting(ResId) ->
|
|
emqx_resource_manager:set_resource_status_connecting(ResId).
|
|
|
|
-spec get_instance(resource_id()) ->
|
|
{ok, resource_group(), resource_data()} | {error, Reason :: term()}.
|
|
get_instance(ResId) ->
|
|
emqx_resource_manager:lookup_cached(ResId).
|
|
|
|
-spec get_metrics(resource_id()) ->
|
|
emqx_metrics_worker:metrics().
|
|
get_metrics(ResId) ->
|
|
emqx_resource_manager:get_metrics(ResId).
|
|
|
|
-spec fetch_creation_opts(map()) -> creation_opts().
|
|
fetch_creation_opts(Opts) ->
|
|
maps:get(resource_opts, Opts, #{}).
|
|
|
|
-spec list_instances() -> [resource_id()].
|
|
list_instances() ->
|
|
[Id || #{id := Id} <- list_instances_verbose()].
|
|
|
|
-spec list_instances_verbose() -> [_ResourceDataWithMetrics :: map()].
|
|
list_instances_verbose() ->
|
|
[
|
|
Res#{metrics => get_metrics(ResId)}
|
|
|| #{id := ResId} = Res <- emqx_resource_manager:list_all()
|
|
].
|
|
|
|
-spec list_instances_by_type(module()) -> [resource_id()].
|
|
list_instances_by_type(ResourceType) ->
|
|
filter_instances(fun
|
|
(_, RT) when RT =:= ResourceType -> true;
|
|
(_, _) -> false
|
|
end).
|
|
|
|
-spec generate_id(term()) -> resource_id().
|
|
generate_id(Name) when is_binary(Name) ->
|
|
Id = integer_to_binary(erlang:unique_integer([monotonic, positive])),
|
|
<<Name/binary, ":", Id/binary>>.
|
|
|
|
-spec list_group_instances(resource_group()) -> [resource_id()].
|
|
list_group_instances(Group) -> emqx_resource_manager:list_group(Group).
|
|
|
|
-spec get_callback_mode(module()) -> callback_mode().
|
|
get_callback_mode(Mod) ->
|
|
Mod:callback_mode().
|
|
|
|
-spec call_start(resource_id(), module(), resource_config()) ->
|
|
{ok, resource_state()} | {error, Reason :: term()}.
|
|
call_start(ResId, Mod, Config) ->
|
|
try
|
|
%% If the previous manager process crashed without cleaning up
|
|
%% allocated resources, clean them up.
|
|
clean_allocated_resources(ResId, Mod),
|
|
Mod:on_start(ResId, Config)
|
|
catch
|
|
throw:Error ->
|
|
{error, Error};
|
|
Kind:Error:Stacktrace ->
|
|
{error, #{
|
|
exception => Kind,
|
|
reason => Error,
|
|
stacktrace => emqx_utils:redact(Stacktrace)
|
|
}}
|
|
end.
|
|
|
|
-spec call_health_check(resource_id(), module(), resource_state()) ->
|
|
resource_status()
|
|
| {resource_status(), resource_state()}
|
|
| {resource_status(), resource_state(), term()}
|
|
| {error, term()}.
|
|
call_health_check(ResId, Mod, ResourceState) ->
|
|
?SAFE_CALL(Mod:on_get_status(ResId, ResourceState)).
|
|
|
|
-spec call_stop(resource_id(), module(), resource_state()) -> term().
|
|
call_stop(ResId, Mod, ResourceState) ->
|
|
?SAFE_CALL(begin
|
|
Res = Mod:on_stop(ResId, ResourceState),
|
|
case Res of
|
|
ok ->
|
|
emqx_resource:forget_allocated_resources(ResId);
|
|
_ ->
|
|
ok
|
|
end,
|
|
Res
|
|
end).
|
|
|
|
-spec query_mode(module(), term(), creation_opts()) -> query_mode().
|
|
query_mode(Mod, Config, Opts) ->
|
|
case erlang:function_exported(Mod, query_mode, 1) of
|
|
true ->
|
|
Mod:query_mode(Config);
|
|
false ->
|
|
maps:get(query_mode, Opts, sync)
|
|
end.
|
|
|
|
-spec check_config(resource_type(), raw_resource_config()) ->
|
|
{ok, resource_config()} | {error, term()}.
|
|
check_config(ResourceType, Conf) ->
|
|
emqx_hocon:check(ResourceType, Conf).
|
|
|
|
-spec check_and_create(
|
|
resource_id(),
|
|
resource_group(),
|
|
resource_type(),
|
|
raw_resource_config()
|
|
) ->
|
|
{ok, resource_data() | 'already_created'} | {error, term()}.
|
|
check_and_create(ResId, Group, ResourceType, RawConfig) ->
|
|
check_and_create(ResId, Group, ResourceType, RawConfig, #{}).
|
|
|
|
-spec check_and_create(
|
|
resource_id(),
|
|
resource_group(),
|
|
resource_type(),
|
|
raw_resource_config(),
|
|
creation_opts()
|
|
) ->
|
|
{ok, resource_data() | 'already_created'} | {error, term()}.
|
|
check_and_create(ResId, Group, ResourceType, RawConfig, Opts) ->
|
|
check_and_do(
|
|
ResourceType,
|
|
RawConfig,
|
|
fun(ResConf) -> create(ResId, Group, ResourceType, ResConf, Opts) end
|
|
).
|
|
|
|
-spec check_and_create_local(
|
|
resource_id(),
|
|
resource_group(),
|
|
resource_type(),
|
|
raw_resource_config()
|
|
) ->
|
|
{ok, resource_data()} | {error, term()}.
|
|
check_and_create_local(ResId, Group, ResourceType, RawConfig) ->
|
|
check_and_create_local(ResId, Group, ResourceType, RawConfig, #{}).
|
|
|
|
-spec check_and_create_local(
|
|
resource_id(),
|
|
resource_group(),
|
|
resource_type(),
|
|
raw_resource_config(),
|
|
creation_opts()
|
|
) -> {ok, resource_data()} | {error, term()}.
|
|
check_and_create_local(ResId, Group, ResourceType, RawConfig, Opts) ->
|
|
check_and_do(
|
|
ResourceType,
|
|
RawConfig,
|
|
fun(ResConf) -> create_local(ResId, Group, ResourceType, ResConf, Opts) end
|
|
).
|
|
|
|
-spec check_and_recreate(
|
|
resource_id(),
|
|
resource_type(),
|
|
raw_resource_config(),
|
|
creation_opts()
|
|
) ->
|
|
{ok, resource_data()} | {error, term()}.
|
|
check_and_recreate(ResId, ResourceType, RawConfig, Opts) ->
|
|
check_and_do(
|
|
ResourceType,
|
|
RawConfig,
|
|
fun(ResConf) -> recreate(ResId, ResourceType, ResConf, Opts) end
|
|
).
|
|
|
|
-spec check_and_recreate_local(
|
|
resource_id(),
|
|
resource_type(),
|
|
raw_resource_config(),
|
|
creation_opts()
|
|
) ->
|
|
{ok, resource_data()} | {error, term()}.
|
|
check_and_recreate_local(ResId, ResourceType, RawConfig, Opts) ->
|
|
check_and_do(
|
|
ResourceType,
|
|
RawConfig,
|
|
fun(ResConf) -> recreate_local(ResId, ResourceType, ResConf, Opts) end
|
|
).
|
|
|
|
check_and_do(ResourceType, RawConfig, Do) when is_function(Do) ->
|
|
case check_config(ResourceType, RawConfig) of
|
|
{ok, ResConf} -> Do(ResConf);
|
|
Error -> Error
|
|
end.
|
|
|
|
apply_reply_fun({F, A}, Result) when is_function(F) ->
|
|
_ = erlang:apply(F, A ++ [Result]),
|
|
ok;
|
|
apply_reply_fun(From, Result) ->
|
|
gen_server:reply(From, Result).
|
|
|
|
-spec allocate_resource(resource_id(), any(), term()) -> ok.
|
|
allocate_resource(InstanceId, Key, Value) ->
|
|
true = ets:insert(?RESOURCE_ALLOCATION_TAB, {InstanceId, Key, Value}),
|
|
ok.
|
|
|
|
-spec has_allocated_resources(resource_id()) -> boolean().
|
|
has_allocated_resources(InstanceId) ->
|
|
ets:member(?RESOURCE_ALLOCATION_TAB, InstanceId).
|
|
|
|
-spec get_allocated_resources(resource_id()) -> map().
|
|
get_allocated_resources(InstanceId) ->
|
|
Objects = ets:lookup(?RESOURCE_ALLOCATION_TAB, InstanceId),
|
|
maps:from_list([{K, V} || {_InstanceId, K, V} <- Objects]).
|
|
|
|
-spec get_allocated_resources_list(resource_id()) -> list(tuple()).
|
|
get_allocated_resources_list(InstanceId) ->
|
|
ets:lookup(?RESOURCE_ALLOCATION_TAB, InstanceId).
|
|
|
|
-spec forget_allocated_resources(resource_id()) -> ok.
|
|
forget_allocated_resources(InstanceId) ->
|
|
true = ets:delete(?RESOURCE_ALLOCATION_TAB, InstanceId),
|
|
ok.
|
|
|
|
%% =================================================================================
|
|
|
|
filter_instances(Filter) ->
|
|
[Id || #{id := Id, mod := Mod} <- list_instances_verbose(), Filter(Id, Mod)].
|
|
|
|
clean_allocated_resources(ResourceId, ResourceMod) ->
|
|
case emqx_resource:has_allocated_resources(ResourceId) of
|
|
true ->
|
|
%% The resource entries in the ETS table are erased inside
|
|
%% `call_stop' if the call is successful.
|
|
ok = call_stop(ResourceId, ResourceMod, _ResourceState = undefined),
|
|
ok;
|
|
false ->
|
|
ok
|
|
end.
|