Merge pull request #6740 from k32/bpapi-dashboard

refactor(bpapi): Decorate remote procedure calls

apps/emqx_conf/src/emqx_conf_app.erl

@@ -44,7 +44,7 @@ copy_override_conf_from_core_node() ->
             ?SLOG(debug, #{msg => "skip_copy_overide_conf_from_core_node"}),
             {ok, -1};
         Nodes ->
-            {Results, Failed} = rpc:multicall(Nodes, ?MODULE, get_override_config_file, [], 20000),
+            {Results, Failed} = emqx_conf_proto_v1:get_override_config_file(Nodes),
             {Ready, NotReady0} = lists:partition(fun(Res) -> element(1, Res) =:= ok end, Results),
             NotReady = lists:filter(fun(Res) -> element(1, Res) =:= error end, NotReady0),
             case (Failed =/= [] orelse NotReady =/= []) andalso Ready =/= [] of

apps/emqx_conf/src/proto/emqx_conf_proto_v1.erl

@@ -31,6 +31,8 @@
 
         , reset/2
         , reset/3
+
+        , get_override_config_file/1
         ]).
 
 -include_lib("emqx/include/bpapi.hrl").
@@ -89,3 +91,7 @@ reset(KeyPath, Opts) ->
               | emqx_rpc:badrpc().
 reset(Node, KeyPath, Opts) ->
     rpc:call(Node, emqx, reset_config, [KeyPath, Opts]).
+
+-spec get_override_config_file([node()]) -> emqx_rpc:multicall_result().
+get_override_config_file(Nodes) ->
+    rpc:multicall(Nodes, emqx_conf_app, get_override_config_file, [], 20000).

apps/emqx_dashboard/src/emqx_dashboard_collection.erl

@@ -20,7 +20,7 @@
         , code_change/3
         ]).
 
--export([get_collect/0]).
+-export([get_collect/0, select_data/0]).
 
 -export([get_universal_epoch/0]).
 
@@ -52,6 +52,11 @@ start_link() ->
 
 get_collect() -> gen_server:call(whereis(?MODULE), get_collect).
 
+-spec select_data() -> [#mqtt_collect{}].
+select_data() ->
+    Time = emqx_dashboard_collection:get_universal_epoch() - 7200000,
+    ets:select(?TAB_COLLECT, [{{mqtt_collect,'$1','$2'}, [{'>', '$1', Time}], ['$_']}]).
+
 init([]) ->
     timer(next_interval(), collect),
     timer(get_today_remaining_seconds(), clear_expire_data),

apps/emqx_dashboard/src/emqx_dashboard_monitor_api.erl

@@ -215,10 +215,8 @@ list_collect(Aggregate) ->
             merger_counters(Counters)
     end.
 
-get_collect(Node) when Node =:= node() ->
-    emqx_dashboard_collection:get_collect();
 get_collect(Node) ->
-    case rpc:call(Node, emqx_dashboard_collection, get_collect, []) of
+    case emqx_dashboard_proto_v1:get_collect(Node) of
         {badrpc, _Reason} -> ?EMPTY_COLLECTION;
         Res -> Res
     end.
@@ -267,19 +265,13 @@ key_replace([Term | List], All, Comparison, Default) ->
             key_replace(List, All, Comparison, Default)
     end.
 
-sampling(Node) when Node =:= node() ->
-    format(lists:sort(select_data()));
 sampling(Node) ->
-    rpc:call(Node, ?MODULE, sampling, [Node]).
+    Data = emqx_dashboard_proto_v1:select_data(Node),
+    format(lists:sort(Data)).
 
-sampling(Node, Counter) when Node =:= node() ->
-    format_single(lists:sort(select_data()), Counter);
 sampling(Node, Counter) ->
-    rpc:call(Node, ?MODULE, sampling, [Node, Counter]).
+    Data = emqx_dashboard_proto_v1:select_data(Node),
-
+    format_single(lists:sort(Data), Counter).
-select_data() ->
-    Time = emqx_dashboard_collection:get_universal_epoch() - 7200000,
-    ets:select(?TAB_COLLECT, [{{mqtt_collect,'$1','$2'}, [{'>', '$1', Time}], ['$_']}]).
 
 format(Collects) ->
     format(Collects, {[],[],[],[],[],[]}).

apps/emqx_dashboard/src/proto/emqx_dashboard_proto_v1.erl

@@ -0,0 +1,40 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2022 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_dashboard_proto_v1).
+
+-behaviour(emqx_bpapi).
+
+-export([ introduced_in/0
+
+        , get_collect/1
+        , select_data/1
+        ]).
+
+-include("emqx_dashboard.hrl").
+-include_lib("emqx/include/bpapi.hrl").
+
+introduced_in() ->
+    "5.0.0".
+
+-spec get_collect(node()) -> _.
+get_collect(Node) ->
+    rpc:call(Node, emqx_dashboard_collection, get_collect, []).
+
+-spec select_data(node()) -> [#mqtt_collect{}]
+                           | emqx_rpc:badrpc().
+select_data(Node) ->
+    rpc:call(Node, emqx_dashboard_collection, select_data, []).

apps/emqx_prometheus/src/emqx_prometheus.erl

@@ -41,7 +41,6 @@
         % for rpc
         , do_start/0
         , do_stop/0
-        , do_restart/0
         ]).
 
 %% APIs
@@ -87,9 +86,17 @@ update(Config) ->
             {error, Reason}
     end.
 
-start()   -> cluster_call(do_start, []).
+start() ->
-stop()    -> cluster_call(do_stop, []).
+    {_, []} = emqx_prometheus_proto_v1:start(mria_mnesia:running_nodes()),
-restart() -> cluster_call(do_restart, []).
+    ok.
+
+stop() ->
+    {_, []} = emqx_prometheus_proto_v1:stop(mria_mnesia:running_nodes()),
+    ok.
+
+restart() ->
+    stop(),
+    stop().
 
 do_start() ->
     emqx_prometheus_sup:start_child(?APP, emqx_conf:get([prometheus])).
@@ -102,24 +109,6 @@ do_stop() ->
             ok
     end.
 
-do_restart() ->
-    ok = do_stop(),
-    ok = do_start(),
-    ok.
-
-cluster_call(F, A) ->
-    [ok = rpc_call(N, F, A) || N <- mria_mnesia:running_nodes()],
-    ok.
-
-rpc_call(N, F, A) ->
-    case rpc:call(N, ?MODULE, F, A, 5000) of
-        {badrpc, R} ->
-            ?LOG(error, "RPC Node: ~p ~p ~p failed, Reason: ~p", [N, ?MODULE, F, R]),
-            {error, {badrpc, R}};
-        Result ->
-            Result
-    end.
-
 %%--------------------------------------------------------------------
 %% APIs
 %%--------------------------------------------------------------------

apps/emqx_prometheus/src/proto/emqx_prometheus_proto_v1.erl

@@ -0,0 +1,38 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2022 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_prometheus_proto_v1).
+
+-behaviour(emqx_bpapi).
+
+-export([ introduced_in/0
+
+        , start/1
+        , stop/1
+        ]).
+
+-include_lib("emqx/include/bpapi.hrl").
+
+introduced_in() ->
+    "5.0.0".
+
+-spec start([node()]) -> emqx_rpc:multicall_result().
+start(Nodes) ->
+    rpc:multicall(Nodes, emqx_prometheus, do_start, [], 5000).
+
+-spec stop([node()]) -> emqx_rpc:multicall_result().
+stop(Nodes) ->
+    rpc:multicall(Nodes, emqx_prometheus, do_stop, [], 5000).

apps/emqx_prometheus/test/emqx_prometheus_SUITE.erl

@@ -16,8 +16,14 @@
 
 -module(emqx_prometheus_SUITE).
 
+-include_lib("stdlib/include/assert.hrl").
+
 -compile(nowarn_export_all).
 -compile(export_all).
 
-all() ->
+all() -> emqx_common_test_helpers:all(?MODULE).
-    [].
+
+t_start_stop(_) ->
+    ?assertMatch(ok, emqx_prometheus:start()),
+    ?assertMatch(ok, emqx_prometheus:stop()),
+    ?assertMatch(ok, emqx_prometheus:restart()).