Skip to content

Commit

Permalink
Merge pull request #3665 from esl/graphql/metrics
Browse files Browse the repository at this point in the history 
Metrics API for graphql
  • Loading branch information
@chrzaszcz
chrzaszcz authored Jun 15, 2022
2 parents 9fea697 + 27ad800 commit a7b3abd
Show file tree
Hide file tree
Showing 12 changed files with 769 additions and 7 deletions.
1 change: 1 addition & 0 deletions big_tests/default.spec
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
{suites, "tests", graphql_stanza_SUITE}.
{suites, "tests", graphql_vcard_SUITE}.
{suites, "tests", graphql_http_upload_SUITE}.
{suites, "tests", graphql_metric_SUITE}.
{suites, "tests", inbox_SUITE}.
{suites, "tests", inbox_extensions_SUITE}.
{suites, "tests", jingle_SUITE}.
Expand Down
1 change: 1 addition & 0 deletions big_tests/dynamic_domains.spec
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
{suites, "tests", graphql_stanza_SUITE}.
{suites, "tests", graphql_vcard_SUITE}.
{suites, "tests", graphql_http_upload_SUITE}.
{suites, "tests", graphql_metric_SUITE}.

{suites, "tests", inbox_SUITE}.

Expand Down
316 changes: 316 additions & 0 deletions big_tests/tests/graphql_metric_SUITE.erl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,316 @@
-module(graphql_metric_SUITE).

-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").
-include_lib("exml/include/exml.hrl").

-compile([export_all, nowarn_export_all]).

-import(distributed_helper, [require_rpc_nodes/1, rpc/4]).
-import(graphql_helper, [execute_auth/2, init_admin_handler/1]).

suite() ->
MIM2NodeName = maps:get(node, distributed_helper:mim2()),
%% Ensure nodes are connected
mongoose_helper:successful_rpc(net_kernel, connect_node, [MIM2NodeName]),
require_rpc_nodes([mim, mim2]) ++ escalus:suite().

all() ->
[{group, metrics}].

groups() ->
[{metrics, [], metrics_handler()}].

metrics_handler() ->
[get_all_metrics,
get_all_metrics_check_by_type,
get_by_name_global_erlang_metrics,
get_process_queue_length,
get_inet_stats,
get_vm_stats_memory,
get_metrics_as_dicts,
get_by_name_metrics_as_dicts,
get_metrics_as_dicts_with_key_one,
get_cluster_metrics,
get_by_name_cluster_metrics_as_dicts,
get_mim2_cluster_metrics].

init_per_suite(Config) ->
escalus:init_per_suite(init_admin_handler(Config)).

end_per_suite(Config) ->
escalus_fresh:clean(),
escalus:end_per_suite(Config).

init_per_testcase(CaseName, Config) ->
escalus:init_per_testcase(CaseName, Config).

end_per_testcase(CaseName, Config) ->
escalus:end_per_testcase(CaseName, Config).

get_all_metrics(Config) ->
%% Get all metrics
Result = execute_auth(#{query => get_all_metrics_call(),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetrics">>, Result),
Map = maps:from_list([{Name, X} || X = #{<<"name">> := Name} <- ParsedResult]),
ReadsKey = [<<"global">>, <<"backends">>, <<"mod_roster">>, <<"read_roster_version">>],
Reads = maps:get(ReadsKey, Map),
%% Histogram integer keys have p prefix
check_histogram_p(Reads),
%% HistogramMetric type
#{<<"type">> := <<"histogram">>} = Reads.

get_all_metrics_check_by_type(Config) ->
%% Get all metrics
Result = execute_auth(#{query => get_all_metrics_call(),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetrics">>, Result),
lists:foreach(fun check_metric_by_type/1, ParsedResult).

check_metric_by_type(#{<<"type">> := Type} = Map) ->
values_are_integers(Map, type_to_keys(Type)).

type_to_keys(<<"histogram">>) ->
[<<"n">>, <<"mean">>, <<"min">>, <<"max">>, <<"median">>,
<<"p50">>, <<"p75">>, <<"p90">>, <<"p95">>, <<"p99">>, <<"p999">>];
type_to_keys(<<"counter">>) ->
[<<"value">>, <<"ms_since_reset">>];
type_to_keys(<<"spiral">>) ->
[<<"one">>, <<"count">>];
type_to_keys(<<"gauge">>) ->
[<<"value">>];
type_to_keys(<<"merged_inet_stats">>) ->
[<<"connections">>, <<"recv_cnt">>, <<"recv_max">>, <<"recv_oct">>,
<<"send_cnt">>, <<"send_max">>, <<"send_oct">>, <<"send_pend">>];
type_to_keys(<<"rdbms_stats">>) ->
[<<"workers">>, <<"recv_cnt">>, <<"recv_max">>, <<"recv_oct">>,
<<"send_cnt">>, <<"send_max">>, <<"send_oct">>, <<"send_pend">>];
type_to_keys(<<"vm_stats_memory">>) ->
[<<"atom_used">>, <<"binary">>, <<"ets">>,
<<"processes_used">>, <<"system">>, <<"total">>];
type_to_keys(<<"vm_system_info">>) ->
[<<"ets_limit">>, <<"port_count">>, <<"port_limit">>,
<<"process_count">>, <<"process_limit">>];
type_to_keys(<<"probe_queues">>) ->
[<<"fsm">>, <<"regular">>, <<"total">>].

get_by_name_global_erlang_metrics(Config) ->
%% Filter by name works
Result = execute_auth(#{query => get_metrics_call_with_args(<<"(name: [\"global\", \"erlang\"])">>),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetrics">>, Result),
Map = maps:from_list([{Name, X} || X = #{<<"name">> := Name} <- ParsedResult]),
Info = maps:get([<<"global">>, <<"erlang">>, <<"system_info">>], Map),
%% VMSystemInfoMetric type
#{<<"type">> := <<"vm_system_info">>} = Info,
check_metric_by_type(Info),
ReadsKey = [<<"global">>, <<"backends">>, <<"mod_roster">>, <<"read_roster_version">>],
%% Other metrics are filtered out
undef = maps:get(ReadsKey, Map, undef).

get_process_queue_length(Config) ->
Result = execute_auth(#{query => get_metrics_call_with_args(
<<"(name: [\"global\", \"processQueueLengths\"])">>),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetrics">>, Result),
Map = maps:from_list([{Name, X} || X = #{<<"name">> := Name} <- ParsedResult]),
Lens = maps:get([<<"global">>, <<"processQueueLengths">>], Map),
%% ProbeQueuesMetric type
#{<<"type">> := <<"probe_queues">>} = Lens,
check_metric_by_type(Lens).

get_inet_stats(Config) ->
Result = execute_auth(#{query => get_metrics_call_with_args(
<<"(name: [\"global\", \"data\", \"dist\"])">>),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetrics">>, Result),
Map = maps:from_list([{Name, X} || X = #{<<"name">> := Name} <- ParsedResult]),
Stats = maps:get([<<"global">>, <<"data">>, <<"dist">>], Map),
%% MergedInetStatsMetric type
#{<<"type">> := <<"merged_inet_stats">>} = Stats,
check_metric_by_type(Stats).

get_vm_stats_memory(Config) ->
Result = execute_auth(#{query => get_metrics_call_with_args(<<"(name: [\"global\"])">>),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetrics">>, Result),
Map = maps:from_list([{Name, X} || X = #{<<"name">> := Name} <- ParsedResult]),
Mem = maps:get([<<"global">>, <<"erlang">>, <<"memory">>], Map),
%% VMStatsMemoryMetric type
#{<<"type">> := <<"vm_stats_memory">>} = Mem,
check_metric_by_type(Mem).

get_metrics_as_dicts(Config) ->
Result = execute_auth(#{query => get_all_metrics_as_dicts_call(), variables => #{},
operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetricsAsDicts">>, Result),
check_node_result_is_valid(ParsedResult, false).

get_by_name_metrics_as_dicts(Config) ->
Args = <<"(name: [\"_\", \"xmppStanzaSent\"])">>,
Result = execute_auth(#{query => get_by_args_metrics_as_dicts_call(Args),
variables => #{}, operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetricsAsDicts">>, Result),
[_|_] = ParsedResult,
%% Only xmppStanzaSent type
lists:foreach(fun(#{<<"dict">> := Dict, <<"name">> := [_, <<"xmppStanzaSent">>]}) ->
check_spiral_dict(Dict)
end, ParsedResult).

get_metrics_as_dicts_with_key_one(Config) ->
Result = execute_auth(#{query => get_all_metrics_as_dicts_with_key_one_call(),
variables => #{},
operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getMetricsAsDicts">>, Result),
Map = dict_objects_to_map(ParsedResult),
SentName = [metric_host_type(), <<"xmppStanzaSent">>],
[#{<<"key">> := <<"one">>, <<"value">> := One}] = maps:get(SentName, Map),
true = is_integer(One).

get_cluster_metrics(Config) ->
%% We will have at least these two nodes
Node1 = atom_to_binary(maps:get(node, distributed_helper:mim())),
Node2 = atom_to_binary(maps:get(node, distributed_helper:mim2())),
Result = execute_auth(#{query => get_all_cluster_metrics_as_dicts_call(),
variables => #{},
operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getClusterMetricsAsDicts">>, Result),
#{Node1 := Res1, Node2 := Res2} = node_objects_to_map(ParsedResult),
check_node_result_is_valid(Res1, false),
check_node_result_is_valid(Res2, true).

get_by_name_cluster_metrics_as_dicts(Config) ->
Args = <<"(name: [\"_\", \"xmppStanzaSent\"])">>,
Result = execute_auth(#{query => get_by_args_cluster_metrics_as_dicts_call(Args),
variables => #{}, operationName => <<"Q1">>}, Config),
NodeResult = ok_result(<<"metric">>, <<"getClusterMetricsAsDicts">>, Result),
Map = node_objects_to_map(NodeResult),
%% Contains data for at least two nodes
true = maps:size(Map) > 1,
%% Only xmppStanzaSent type
maps:map(fun(_Node, [_|_] = NodeRes) ->
lists:foreach(fun(#{<<"dict">> := Dict,
<<"name">> := [_, <<"xmppStanzaSent">>]}) ->
check_spiral_dict(Dict)
end, NodeRes) end, Map).

get_mim2_cluster_metrics(Config) ->
Node = atom_to_binary(maps:get(node, distributed_helper:mim2())),
Result = execute_auth(#{query => get_node_cluster_metrics_as_dicts_call(Node),
variables => #{},
operationName => <<"Q1">>}, Config),
ParsedResult = ok_result(<<"metric">>, <<"getClusterMetricsAsDicts">>, Result),
[#{<<"node">> := Node, <<"result">> := ResList}] = ParsedResult,
check_node_result_is_valid(ResList, true).

check_node_result_is_valid(ResList, MetricsAreGlobal) ->
%% Check that result contains something
Map = dict_objects_to_map(ResList),
SentName = case MetricsAreGlobal of
true -> [<<"global">>, <<"xmppStanzaSent">>];
false -> [metric_host_type(), <<"xmppStanzaSent">>]
end,
check_spiral_dict(maps:get(SentName, Map)),
[#{<<"key">> := <<"value">>,<<"value">> := V}] =
maps:get([<<"global">>,<<"uniqueSessionCount">>], Map),
true = is_integer(V),
HistObjects = maps:get([<<"global">>, <<"data">>, <<"xmpp">>,
<<"sent">>, <<"compressed_size">>], Map),
check_histogram(kv_objects_to_map(HistObjects)).

check_histogram(Map) ->
Keys = [<<"n">>, <<"mean">>, <<"min">>, <<"max">>, <<"median">>,
<<"50">>, <<"75">>, <<"90">>, <<"95">>, <<"99">>, <<"999">>],
values_are_integers(Map, Keys).

check_histogram_p(Map) ->
Keys = type_to_keys(<<"histogram">>),
values_are_integers(Map, Keys).

dict_objects_to_map(List) ->
KV = [{Name, Dict} || #{<<"name">> := Name, <<"dict">> := Dict} <- List],
maps:from_list(KV).

node_objects_to_map(List) ->
KV = [{Name, Value} || #{<<"node">> := Name, <<"result">> := Value} <- List],
maps:from_list(KV).

kv_objects_to_map(List) ->
KV = [{Key, Value} || #{<<"key">> := Key, <<"value">> := Value} <- List],
maps:from_list(KV).

get_all_metrics_call() ->
get_metrics_call_with_args(<<>>).

get_metrics_call_with_args(Args) ->
<<"query Q1
{metric
{getMetrics", Args/binary, " {
... on HistogramMetric
{ name type n mean min max median p50 p75 p90 p95 p99 p999 }
... on CounterMetric
{ name type value ms_since_reset }
... on SpiralMetric
{ name type one count }
... on GaugeMetric
{ name type value }
... on MergedInetStatsMetric
{ name type connections recv_cnt recv_max recv_oct
send_cnt send_max send_oct send_pend }
... on RDBMSStatsMetric
{ name type workers recv_cnt recv_max recv_oct
send_cnt send_max send_oct send_pend }
... on VMStatsMemoryMetric
{ name type total processes_used atom_used binary ets system }
... on VMSystemInfoMetric
{ name type port_count port_limit process_count process_limit ets_limit }
... on ProbeQueuesMetric
{ name type fsm regular total }
}
}
}">>.

get_all_metrics_as_dicts_call() ->
get_by_args_metrics_as_dicts_call(<<>>).

get_by_args_metrics_as_dicts_call(Args) ->
<<"query Q1
{metric
{getMetricsAsDicts", Args/binary, " { name dict { key value }}}}">>.

get_all_metrics_as_dicts_with_key_one_call() ->
<<"query Q1
{metric
{getMetricsAsDicts(keys: [\"one\"]) { name dict { key value }}}}">>.

get_all_cluster_metrics_as_dicts_call() ->
get_by_args_cluster_metrics_as_dicts_call(<<>>).

get_by_args_cluster_metrics_as_dicts_call(Args) ->
<<"query Q1
{metric
{getClusterMetricsAsDicts", Args/binary,
" {node result { name dict { key value }}}}}">>.

get_node_cluster_metrics_as_dicts_call(NodeBin) ->
get_by_args_cluster_metrics_as_dicts_call(<<"(nodes: [\"", NodeBin/binary, "\"])">>).

%% Helpers
ok_result(What1, What2, {{<<"200">>, <<"OK">>}, #{<<"data">> := Data}}) ->
maps:get(What2, maps:get(What1, Data)).

error_result(ErrorNumber, {{<<"200">>, <<"OK">>}, #{<<"errors">> := Errors}}) ->
lists:nth(ErrorNumber, Errors).

check_spiral_dict(Dict) ->
[#{<<"key">> := <<"count">>, <<"value">> := Count},
#{<<"key">> := <<"one">>, <<"value">> := One}] = Dict,
true = is_integer(Count),
true = is_integer(One).

values_are_integers(Map, Keys) ->
lists:foreach(fun(Key) -> true = is_integer(maps:get(Key, Map)) end, Keys).

metric_host_type() ->
binary:replace(domain_helper:host_type(), <<" ">>, <<"_">>, [global]).
4 changes: 2 additions & 2 deletions big_tests/tests/mam_helper.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -655,9 +655,9 @@ send_muc_rsm_messages(Config) ->
escalus:wait_for_stanzas(Alice, 3),

%% Alice sends messages to Bob.
lists:foreach(fun(N) ->
lists:foreach(fun(NN) ->
escalus:send(Alice, escalus_stanza:groupchat_to(
RoomAddr, generate_message_text(N)))
RoomAddr, generate_message_text(NN)))
end, lists:seq(1, N)),
assert_list_size(N, escalus:wait_for_stanzas(Bob, N)),
assert_list_size(N, escalus:wait_for_stanzas(Alice, N)),
Expand Down
2 changes: 2 additions & 0 deletions priv/graphql/schemas/admin/admin_schema.gql
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ type AdminQuery{
vcard: VcardAdminQuery
"Private storage management"
private: PrivateAdminQuery
"Metrics management"
metric: MetricAdminQuery
}

"""
Expand Down
Loading

0 comments on commit a7b3abd

Please sign in to comment.