Ver código fonte

chore: add spec for clear_table/0

zhongwencool 1 ano atrás
pai
commit
0b351afb1c

+ 1 - 1
apps/emqx_dashboard/src/emqx_dashboard_monitor.erl

@@ -351,7 +351,7 @@ sample_nodes(Nodes, Time) ->
     lists:foldl(fun(I, B) -> merge_samplers(Time, I, B) end, #{}, Success).
     lists:foldl(fun(I, B) -> merge_samplers(Time, I, B) end, #{}, Success).
 
 
 concurrently_sample_nodes(Nodes, Time) ->
 concurrently_sample_nodes(Nodes, Time) ->
-    %% emqx_dashboard_proto_v1:do_sample has a timeout (5s),
+    %% emqx_dashboard_proto_v2:do_sample has a timeout (5s),
     %% call emqx_utils:pmap here instead of a rpc multicall
     %% call emqx_utils:pmap here instead of a rpc multicall
     %% to avoid having to introduce a new bpapi proto version
     %% to avoid having to introduce a new bpapi proto version
     emqx_utils:pmap(fun(Node) -> do_sample(Node, Time) end, Nodes, infinity).
     emqx_utils:pmap(fun(Node) -> do_sample(Node, Time) end, Nodes, infinity).

+ 3 - 3
apps/emqx_dashboard/src/proto/emqx_dashboard_proto_v1.erl

@@ -20,9 +20,9 @@
 
 
 -export([
 -export([
     introduced_in/0,
     introduced_in/0,
-    deprecated_since/0,
     do_sample/2,
     do_sample/2,
-    current_rate/1
+    current_rate/1,
+    deprecated_since/0
 ]).
 ]).
 
 
 -include("emqx_dashboard.hrl").
 -include("emqx_dashboard.hrl").
@@ -32,7 +32,7 @@ introduced_in() ->
     "5.0.0".
     "5.0.0".
 
 
 deprecated_since() ->
 deprecated_since() ->
-    "5.8.1".
+    "5.8.4".
 
 
 -spec do_sample(node(), Latest :: pos_integer() | infinity) -> list(map()) | emqx_rpc:badrpc().
 -spec do_sample(node(), Latest :: pos_integer() | infinity) -> list(map()) | emqx_rpc:badrpc().
 do_sample(Node, Latest) ->
 do_sample(Node, Latest) ->

+ 2 - 1
apps/emqx_dashboard/src/proto/emqx_dashboard_proto_v2.erl

@@ -29,12 +29,13 @@
 -include_lib("emqx/include/bpapi.hrl").
 -include_lib("emqx/include/bpapi.hrl").
 
 
 introduced_in() ->
 introduced_in() ->
-    "5.8.1".
+    "5.8.4".
 
 
 -spec do_sample(node(), Latest :: pos_integer() | infinity) -> list(map()) | emqx_rpc:badrpc().
 -spec do_sample(node(), Latest :: pos_integer() | infinity) -> list(map()) | emqx_rpc:badrpc().
 do_sample(Node, Latest) ->
 do_sample(Node, Latest) ->
     erpc:call(Node, emqx_dashboard_monitor, do_sample, [Node, Latest], ?RPC_TIMEOUT).
     erpc:call(Node, emqx_dashboard_monitor, do_sample, [Node, Latest], ?RPC_TIMEOUT).
 
 
+-spec clear_table(Nodes :: [node()]) -> emqx_rpc:erpc_multicall(ok).
 clear_table(Nodes) ->
 clear_table(Nodes) ->
     erpc:multicall(Nodes, emqx_dashboard_monitor, clear_table, [], ?RPC_TIMEOUT).
     erpc:multicall(Nodes, emqx_dashboard_monitor, clear_table, [], ?RPC_TIMEOUT).