refactor(pluglib): move `emqx_plugin_libs_proto_v1` into emqx app

And rename it to `emqx_metrics_proto_v1` in the process.
This commit is contained in:
Andrew Mayorov 2023-06-07 17:45:14 +03:00
parent 9fccae8a7a
commit 79d430cf03
No known key found for this signature in database
GPG Key ID: 2837C62ACFBFED5D
3 changed files with 87 additions and 78 deletions

View File

@ -14,25 +14,26 @@
%% limitations under the License. %% limitations under the License.
%%-------------------------------------------------------------------- %%--------------------------------------------------------------------
-module(emqx_plugin_libs_proto_v1). -module(emqx_metrics_proto_v1).
-behaviour(emqx_bpapi). -behaviour(emqx_bpapi).
-export([ -export([
introduced_in/0, introduced_in/0,
get_metrics/3 get_metrics/4
]). ]).
-include_lib("emqx/include/bpapi.hrl"). -include("bpapi.hrl").
introduced_in() -> introduced_in() ->
"5.0.0". "5.1.0".
-spec get_metrics( -spec get_metrics(
node(), [node()],
emqx_metrics_worker:handler_name(), emqx_metrics_worker:handler_name(),
emqx_metrics_worker:metric_id() emqx_metrics_worker:metric_id(),
) -> emqx_metrics_worker:metrics() | {badrpc, _}. timeout()
get_metrics(Node, HandlerName, MetricId) -> ) -> emqx_rpc:erpc_multicall(emqx_metrics_worker:metrics()).
rpc:call(Node, emqx_metrics_worker, get_metrics, [HandlerName, MetricId]). get_metrics(Nodes, HandlerName, MetricId, Timeout) ->
erpc:multicall(Nodes, emqx_metrics_worker, get_metrics, [HandlerName, MetricId], Timeout).

View File

@ -1,7 +1,7 @@
%% -*- mode: erlang -*- %% -*- mode: erlang -*-
{application, emqx_plugin_libs, [ {application, emqx_plugin_libs, [
{description, "EMQX Plugin utility libs"}, {description, "EMQX Plugin utility libs"},
{vsn, "4.3.11"}, {vsn, "4.3.12"},
{modules, []}, {modules, []},
{applications, [kernel, stdlib]}, {applications, [kernel, stdlib]},
{env, []} {env, []}

View File

@ -44,10 +44,13 @@
%% query callback %% query callback
-export([qs2ms/2, run_fuzzy_match/2, format_rule_info_resp/1]). -export([qs2ms/2, run_fuzzy_match/2, format_rule_info_resp/1]).
-define(RPC_GET_METRICS_TIMEOUT, 5000).
-define(ERR_BADARGS(REASON), begin -define(ERR_BADARGS(REASON), begin
R0 = err_msg(REASON), R0 = err_msg(REASON),
<<"Bad Arguments: ", R0/binary>> <<"Bad Arguments: ", R0/binary>>
end). end).
-define(CHECK_PARAMS(PARAMS, TAG, EXPR), -define(CHECK_PARAMS(PARAMS, TAG, EXPR),
case emqx_rule_api_schema:check_params(PARAMS, TAG) of case emqx_rule_api_schema:check_params(PARAMS, TAG) of
{ok, CheckedParams} -> {ok, CheckedParams} ->
@ -56,6 +59,7 @@ end).
{400, #{code => 'BAD_REQUEST', message => ?ERR_BADARGS(REASON)}} {400, #{code => 'BAD_REQUEST', message => ?ERR_BADARGS(REASON)}}
end end
). ).
-define(METRICS( -define(METRICS(
MATCH, MATCH,
PASS, PASS,
@ -87,6 +91,7 @@ end).
'matched.rate.last5m' => RATE_5 'matched.rate.last5m' => RATE_5
} }
). ).
-define(metrics( -define(metrics(
MATCH, MATCH,
PASS, PASS,
@ -527,10 +532,19 @@ printable_function_name(Mod, Func) ->
list_to_binary(lists:concat([Mod, ":", Func])). list_to_binary(lists:concat([Mod, ":", Func])).
get_rule_metrics(Id) -> get_rule_metrics(Id) ->
Format = fun Nodes = emqx:running_nodes(),
( Results = emqx_metrics_proto_v1:get_metrics(Nodes, rule_metrics, Id, ?RPC_GET_METRICS_TIMEOUT),
Node, NodeResults = lists:zip(Nodes, Results),
#{ NodeMetrics = [format_metrics(Node, Metrics) || {Node, {ok, Metrics}} <- NodeResults],
NodeErrors = [Result || Result = {_Node, {NOk, _}} <- NodeResults, NOk =/= ok],
NodeErrors == [] orelse
?SLOG(warning, #{
msg => "rpc_get_rule_metrics_errors",
errors => NodeErrors
}),
NodeMetrics.
format_metrics(Node, #{
counters := counters :=
#{ #{
'matched' := Matched, 'matched' := Matched,
@ -549,8 +563,7 @@ get_rule_metrics(Id) ->
'matched' := 'matched' :=
#{current := Current, max := Max, last5m := Last5M} #{current := Current, max := Max, last5m := Last5M}
} }
} }) ->
) ->
#{ #{
metrics => ?METRICS( metrics => ?METRICS(
Matched, Matched,
@ -569,7 +582,7 @@ get_rule_metrics(Id) ->
), ),
node => Node node => Node
}; };
(Node, _Metrics) -> format_metrics(Node, _Metrics) ->
%% Empty metrics: can happen when a node joins another and a bridge is not yet %% Empty metrics: can happen when a node joins another and a bridge is not yet
%% replicated to it, so the counters map is empty. %% replicated to it, so the counters map is empty.
#{ #{
@ -589,12 +602,7 @@ get_rule_metrics(Id) ->
_Last5M = 0 _Last5M = 0
), ),
node => Node node => Node
} }.
end,
[
Format(Node, emqx_plugin_libs_proto_v1:get_metrics(Node, rule_metrics, Id))
|| Node <- mria:running_nodes()
].
aggregate_metrics(AllMetrics) -> aggregate_metrics(AllMetrics) ->
InitMetrics = ?METRICS(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0), InitMetrics = ?METRICS(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),