-
Notifications
You must be signed in to change notification settings - Fork 428
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document instrumentation #4355
Document instrumentation #4355
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## feature/instrument #4355 +/- ##
======================================================
+ Coverage 84.79% 85.02% +0.23%
======================================================
Files 551 551
Lines 33877 33877
======================================================
+ Hits 28727 28805 +78
+ Misses 5150 5072 -78 ☔ View full report in Codecov by Sentry. |
This comment was marked as outdated.
This comment was marked as outdated.
6105664
to
3d67e13
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
5e71f48
to
252a0da
Compare
This comment was marked as outdated.
This comment was marked as outdated.
252a0da
to
3d67e13
Compare
- Use tabbed content to differentiate between Prometheus and Exometer. Since MarkDown headings break Table of Content on the right, but look nice, HTML tags are used in tabbed content instead. - Remove hook metrics mention, and use the new all_metrics_are_global option. - Update metric types to the ones that we use for Exometer. - Unify how CETS metrics are described with the rest of the file. - Fixed some small errors in metric names. - Added some additional links.
3d67e13
to
30190ee
Compare
elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 30190ee small_tests_26 / small_tests / 30190ee small_tests_27 / small_tests / 30190ee small_tests_27_arm64 / small_tests / 30190ee ldap_mnesia_26 / ldap_mnesia / 30190ee ldap_mnesia_27 / ldap_mnesia / 30190ee dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 30190ee dynamic_domains_mysql_redis_27 / mysql_redis / 30190ee internal_mnesia_27 / internal_mnesia / 30190ee dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 30190ee pgsql_cets_27 / pgsql_cets / 30190ee pgsql_mnesia_27 / pgsql_mnesia / 30190ee pgsql_mnesia_26 / pgsql_mnesia / 30190ee mysql_redis_27 / mysql_redis / 30190ee mssql_mnesia_27 / odbc_mssql_mnesia / 30190ee service_domain_db_SUITE:db:plain_db_sequential:db_event_could_appear_with_lower_id{error,
{{badmatch,20},
[{service_domain_db_SUITE,db_event_could_appear_with_lower_id,1,
[{file,
"/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
{line,763}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 30190ee graphql_server_SUITE:admin_cli:clustering_tests:remove_dead_from_cluster{error,{{have_node_in_mnesia,true,[{times,60,false}],ok},
[{mongoose_helper,do_wait_until,2,
[{file,"/home/circleci/project/big_tests/../test/common/mongoose_helper.erl"},
{line,359}]},
{graphql_server_SUITE,remove_dead_from_cluster,1,
[{file,"/home/circleci/project/big_tests/tests/graphql_server_SUITE.erl"},
{line,204}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} graphql_server_SUITE:admin_cli:clustering_tests:stop_node_test{error,{#{what => invalid_response_code,expected_type => ok,
response_code => {exit_status,3}},
[{graphql_helper,assert_response_code,2,
[{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
{line,258}]},
{graphql_helper,get_ok_value,2,
[{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
{line,241}]},
{graphql_server_SUITE,stop_node_test,1,
[{file,"/home/circleci/project/big_tests/tests/graphql_server_SUITE.erl"},
{line,230}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} service_domain_db_SUITE:init_per_suite{'EXIT',
{{badrpc,nodedown},
[{distributed_helper,rpc,
[#{node => mongooseim3@localhost},
mongoose_service,loaded_services_with_opts,[]],
[{file,
"/home/circleci/project/big_tests/../test/common/distributed_helper.erl"},
{line,140}]},
{dynamic_services,save_services,2,
[{file,
"/home/circleci/project/big_tests/tests/dynamic_services.erl"},
{line,15}]},
{lists,foldl_1,3,[{file,"lists.erl"},{line,2151}]},
{service_domain_db_SUITE,init_per_suite,1,
[{file,
"/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
{line,198}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1391}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} service_mongoose_system_metrics_SUITE:log_transparency:just_removed_from_config_logs_question{error,
{{badrpc,nodedown},
[{distributed_helper,rpc,
[#{node => mongooseim3@localhost},
mongoose_service,ensure_stopped,
[service_mongoose_system_metrics]],
[{file,
"/home/circleci/project/big_tests/../test/common/distributed_helper.erl"},
{line,140}]},
{service_mongoose_system_metrics_SUITE,disable_system_metrics,1,
[{file,
"/home/circleci/project/big_tests/tests/service_mongoose_system_metrics_SUITE.erl"},
{line,437}]},
{service_mongoose_system_metrics_SUITE,
just_removed_from_config_logs_question,1,
[{file,
"/home/circleci/project/big_tests/tests/service_mongoose_system_metrics_SUITE.erl"},
{line,283}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 30190ee mssql_mnesia_27 / odbc_mssql_mnesia / 30190ee |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! I can see a lot of effort was put into updating and improving the documentation. I just have a few small comments.
Co-authored-by: jacekwegr <[email protected]>
elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 9636520 small_tests_27 / small_tests / 9636520 small_tests_26 / small_tests / 9636520 small_tests_27_arm64 / small_tests / 9636520 dynamic_domains_mysql_redis_27 / mysql_redis / 9636520 ldap_mnesia_27 / ldap_mnesia / 9636520 ldap_mnesia_26 / ldap_mnesia / 9636520 dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 9636520 internal_mnesia_27 / internal_mnesia / 9636520 dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 9636520 pgsql_cets_27 / pgsql_cets / 9636520 dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 9636520 mysql_redis_27 / mysql_redis / 9636520 pgsql_mnesia_26 / pgsql_mnesia / 9636520 pgsql_mnesia_27 / pgsql_mnesia / 9636520 mssql_mnesia_27 / odbc_mssql_mnesia / 9636520 |
elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / e0e819c small_tests_26 / small_tests / e0e819c small_tests_27 / small_tests / e0e819c small_tests_27_arm64 / small_tests / e0e819c ldap_mnesia_26 / ldap_mnesia / e0e819c dynamic_domains_mysql_redis_27 / mysql_redis / e0e819c ldap_mnesia_27 / ldap_mnesia / e0e819c internal_mnesia_27 / internal_mnesia / e0e819c dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / e0e819c pgsql_cets_27 / pgsql_cets / e0e819c dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / e0e819c pgsql_mnesia_27 / pgsql_mnesia / e0e819c mysql_redis_27 / mysql_redis / e0e819c pgsql_mnesia_26 / pgsql_mnesia / e0e819c dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / e0e819c amp_big_SUITE:basic:drop_deliver_to_offline_user_test{error,{{badrpc,timeout},
[{escalus_rpc,call_with_cookie_match,
[mongooseim@localhost,ejabberd_admin,register,
[<<"bOb_drop_deliver_to_offline_user_test_111_drop_deliver_to_offline_user_test_124">>,
<<"domain.example.com">>,<<"makrolika">>],
3000,mongooseim],
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_rpc.erl"},
{line,34}]},
{lists,foreach_1,2,[{file,"lists.erl"},{line,2310}]},
{escalus_ejabberd,create_users,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_ejabberd.erl"},
{line,211}]},
{escalus_fresh,create_users,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_fresh.erl"},
{line,62}]},
{escalus_fresh,story,3,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_fresh.erl"},
{line,27}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} amp_big_SUITE:basic:notify_deliver_to_online_user_recipient_privacy_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"bob_notify_deliver_to_online_user_recipient_privacy_test_72@domain.example.com/res1">>,
escalus_tcp,<0.1942.0>,
[{event_manager,<0.1607.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_online_user_recipient_privacy_test_72">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.1607.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_online_user_recipient_privacy_test_72">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_notify_deliver_to_online_user_recipient_privacy_test_72">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bOb_notify_deliver_to_online_user_recipient_privacy_test_72">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"makrolika">>},
{stream_id,<<"7c87e8c50ef0a966">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{privacy_helper,activate_list,2,
[{... amp_big_SUITE:basic:notify_deliver_to_offline_user_recipient_privacy_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"bob_notify_deliver_to_offline_user_recipient_privacy_test_77@domain.example.com/res1">>,
escalus_tcp,<0.1939.0>,
[{event_manager,<0.1634.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_77">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.1634.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_77">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_notify_deliver_to_offline_user_recipient_privacy_test_77">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_77">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"makrolika">>},
{stream_id,<<"c206ae8212524c1d">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{privacy_helper,set_default_list,2,
... amp_big_SUITE:basic:notify_deliver_to_online_user_recipient_privacy_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"alice_notify_deliver_to_online_user_recipient_privacy_test_68@domain.example.com/res1">>,
escalus_tcp,<0.1889.0>,
[{event_manager,<0.1586.0>},
{server,<<"domain.example.com">>},
{username,
<<"alicE_notify_deliver_to_online_user_recipient_privacy_test_68">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.1586.0>},
{server,<<"domain.example.com">>},
{username,
<<"alicE_notify_deliver_to_online_user_recipient_privacy_test_68">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"alice_notify_deliver_to_online_user_recipient_privacy_test_68">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"alicE_notify_deliver_to_online_user_recipient_privacy_test_68">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"matygrysa">>},
{stream_id,<<"b7768d310596b17d">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{amp_big_SUITE,client_receives_g... amp_big_SUITE:basic:notify_deliver_to_offline_user_recipient_privacy_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"bob_notify_deliver_to_offline_user_recipient_privacy_test_75@domain.example.com/res1">>,
escalus_tcp,<0.1952.0>,
[{event_manager,<0.1624.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_75">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.1624.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_75">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_notify_deliver_to_offline_user_recipient_privacy_test_75">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_75">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"makrolika">>},
{stream_id,<<"6c9a144f2167e18c">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{privacy_helper,set_default_list,2,
... amp_big_SUITE:basic:notify_deliver_to_offline_user_recipient_privacy_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"bob_notify_deliver_to_offline_user_recipient_privacy_test_78@domain.example.com/res1">>,
escalus_tcp,<0.1954.0>,
[{event_manager,<0.1640.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_78">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.1640.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_78">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_notify_deliver_to_offline_user_recipient_privacy_test_78">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bOb_notify_deliver_to_offline_user_recipient_privacy_test_78">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"makrolika">>},
{stream_id,<<"8bc935d4bbb2c562">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{privacy_helper,set_default_list,2,
... amp_big_SUITE:basic:notify_deliver_to_offline_user_recipient_privacy_test{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"alice_notify_deliver_to_offline_user_recipient_privacy_test_80@domain.example.com/res1">>,
escalus_tcp,<0.1899.0>,
[{event_manager,<0.1650.0>},
{server,<<"domain.example.com">>},
{username,
<<"alicE_notify_deliver_to_offline_user_recipient_privacy_test_80">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.1650.0>},
{server,<<"domain.example.com">>},
{username,
<<"alicE_notify_deliver_to_offline_user_recipient_privacy_test_80">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"alice_notify_deliver_to_offline_user_recipient_privacy_test_80">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"alicE_notify_deliver_to_offline_user_recipient_privacy_test_80">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"matygrysa">>},
{stream_id,<<"b88d73bf799b8fc0">>}]},
5000],
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{amp_big_SUITE,client_recei... amp_big_SUITE:basic:notify_deliver_to_offline_user_test{error,{{badmatch,0},
[{escalus_story,drop_presences,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,191}]},
{escalus_story,'-start_ready_clients/2-fun-0-',3,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,135}]},
{lists,foldl,3,[{file,"lists.erl"},{line,2146}]},
{escalus_story,start_ready_clients,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,128}]},
{lists,flatmap_1,2,[{file,"lists.erl"},{line,2116}]},
{escalus_story,story,4,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,69}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]}]}} amp_big_SUITE:basic:drop_deliver_to_offline_user_test{error,
{{badmatch,
{error,
{connection_step_failed,
{{escalus_session,session},
{client,
<<"bob_drop_deliver_to_offline_user_test_107_drop_deliver_to_offline_user_test_125@domain.example.com/res1">>,
escalus_tcp,<0.2011.0>,undefined,
[{event_client,
[{event_manager,<0.1802.0>},
{server,<<"domain.example.com">>},
{username,
<<"bOb_drop_deliver_to_offline_user_test_107_drop_deliver_to_offline_user_test_125">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_drop_deliver_to_offline_user_test_107_drop_deliver_to_offline_user_test_125">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{port,5222},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bOb_drop_deliver_to_offline_user_test_107_drop_deliver_to_offline_user_test_125">>},
{server,<<"domain.example.com">>},
{host,<<"localhost">>},
{password,<<"makrolika">>},
{stream_id,<<"c8c549a2cc1b391c">>}]},
[{compression,false},
{starttls,true},
{stream_management,true},
{advanced_message_processing,true},
{client_state_indication,false},
{sasl_mechanisms,[<<"SCRAM-SHA-256">>,<<"PLAIN">>]},
... graphql_account_SUITE:admin_account_http:admin_register_user_limit_error{error,
{{badmap,null},
[{erlang,map_get,
[<<"message">>,null],
[{error_info,#{module => erl_erts_errors}}]},
{graphql_helper,get_value,2,
[{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
{line,342}]},
{graphql_account_SUITE,admin_register_user_limit_error,1,
[{file,
"/home/circleci/project/big_tests/tests/graphql_account_SUITE.erl"},
{line,387}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} graphql_account_SUITE:admin_account_cli:admin_register_user_limit_error{error,
{#{what => invalid_response_code,expected_type => ok,
response_code => {exit_status,1}},
[{graphql_helper,assert_response_code,2,
[{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
{line,258}]},
{graphql_helper,get_ok_value,2,
[{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
{line,241}]},
{graphql_account_SUITE,admin_register_user_limit_error,1,
[{file,
"/home/circleci/project/big_tests/tests/graphql_account_SUITE.erl"},
{line,387}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} graphql_account_SUITE:domain_admin_account:admin_register_user_limit_error{error,
{{badmap,null},
[{erlang,map_get,
[<<"message">>,null],
[{error_info,#{module => erl_erts_errors}}]},
{graphql_helper,get_value,2,
[{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
{line,342}]},
{graphql_account_SUITE,admin_register_user_limit_error,1,
[{file,
"/home/circleci/project/big_tests/tests/graphql_account_SUITE.erl"},
{line,387}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} graphql_last_SUITE:admin_http:admin_last_configured:admin_old_users:admin_list_old_users_domain{error,{{badmatch,[#{<<"jid">> => <<"[email protected]">>,
<<"timestamp">> => <<"2024-08-13T11:58:21.000000Z">>},
#{<<"jid">> =>
<<"bob_drop_deliver_to_offline_user_test_111_drop_deliver_to_offline_user_test_124@domain.example.com">>,
<<"timestamp">> => null}]},
[{graphql_last_SUITE,admin_list_old_users_domain_story,3,
[{file,"/home/circleci/project/big_tests/tests/graphql_last_SUITE.erl"},
{line,388}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} graphql_last_SUITE:admin_http:admin_last_configured:admin_old_users:admin_list_old_users_global{error,{{badmatch,[#{<<"jid">> => <<"[email protected]">>,
<<"timestamp">> => <<"2024-08-13T11:58:21.000000Z">>},
#{<<"jid">> => <<"[email protected]">>,
<<"timestamp">> => <<"2024-08-13T11:58:21.000000Z">>},
#{<<"jid">> =>
<<"bob_drop_deliver_to_offline_user_test_111_drop_deliver_to_offline_user_test_124@domain.example.com">>,
<<"timestamp">> => null}]},
[{graphql_last_SUITE,admin_list_old_users_global_story,4,
[{file,"/home/circleci/project/big_tests/tests/graphql_last_SUITE.erl"},
{line,412}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} graphql_last_SUITE:admin_http:admin_last_configured:admin_old_users:admin_remove_old_users_domain{error,{{badmatch,[#{<<"jid">> => <<"[email protected]">>,
<<"timestamp">> => <<"2024-08-13T11:58:21.000000Z">>},
#{<<"jid">> =>
<<"bob_drop_deliver_to_offline_user_test_111_drop_deliver_to_offline_user_test_124@domain.example.com">>,
<<"timestamp">> => null}]},
[{graphql_last_SUITE,admin_remove_old_users_domain_story,4,
[{file,"/home/circleci/project/big_tests/tests/graphql_last_SUITE.erl"},
{line,340}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}} mam_SUITE:rdbms_async_pool_prefs_cases:messages_filtered_when_prefs_default_policy_is_always{error,
{{assertion_failed,assert,is_iq_result,
[{xmlel,<<"iq">>,
[{<<"type">>,<<"set">>},
{<<"id">>,<<"1e1d76db4ec30f6f257f4f6ae47cfc54">>}],
[{xmlel,<<"prefs">>,
[{<<"xmlns">>,<<"urn:xmpp:mam:1">>},
{<<"default">>,<<"always">>}],
[{xmlel,<<"always">>,[],[]},{xmlel,<<"never">>,[],[]}]}]}],
{xmlel,<<"iq">>,
[{<<"from">>,
<<"alice_messages_filtered_when_prefs_default_policy_is_always_2309@domain.example.com">>},
{<<"to">>,
<<"alice_messages_filtered_when_prefs_default_policy_is_always_2309@domain.example.com/res1">>},
{<<"id">>,<<"push7b2b133632e52405">>},
{<<"type">>,<<"set">>}],
[{xmlel,<<"query">>,
[{<<"xmlns">>,<<"jabber:iq:roster">>}],
[{xmlel,<<"item">>,
[{<<"jid">>,
<<"bob_messages_filtered_when_prefs_default_policy_is_always_2309@domain.example.com">>},
{<<"subscription">>,<<"both">>}],
[]}]}]},
"<iq from='alice_messages_filtered_when_prefs_default_policy_is_always_2309@domain.example.com' to='alice_messages_filtered_when_prefs_default_policy_is_always_2309@domain.example.com/res1' id='push7b2b133632e52405' type='set'><query xmlns='jabber:iq:roster'><item jid='bob_messages_filtered_when_prefs_default_policy_is_always_2309@domain.example.com' subscription='both'/></query></iq>"},
[{escalus_new_assert,assert_true,2,
[{file,
"/home/circleci/project/big_test... mam_SUITE:rdbms_async_pool_prefs_cases:messages_filtered_when_prefs_default_policy_is_roster{error,
{thrown,
{timeout,
[{escalus_connection,receive_stanza,2,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_connection.erl"},
{line,302}]},
{mam_helper,run_prefs_case,6,
[{file,
"/home/circleci/project/big_tests/tests/mam_helper.erl"},
{line,1243}]},
{mam_SUITE,'-run_prefs_cases/2-lc$^0/1-0-',7,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3777}]},
{mam_SUITE,'-run_prefs_cases/2-lc$^0/1-0-',7,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3778}]},
{mam_SUITE,'-run_prefs_cases/2-fun-3-',6,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3778}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]}]}}} mam_SUITE:rdbms_async_pool_prefs_cases:messages_filtered_when_prefs_default_policy_is_never{error,
{thrown,
{timeout,
[{escalus_connection,receive_stanza,2,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_connection.erl"},
{line,302}]},
{mam_helper,run_prefs_case,6,
[{file,
"/home/circleci/project/big_tests/tests/mam_helper.erl"},
{line,1243}]},
{mam_SUITE,'-run_prefs_cases/2-lc$^0/1-0-',7,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3777}]},
{mam_SUITE,'-run_prefs_cases/2-lc$^0/1-0-',7,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3778}]},
{mam_SUITE,'-run_prefs_cases/2-fun-3-',6,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3778}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]}]}}} mam_SUITE:rdbms_async_pool_prefs_cases:run_set_and_get_prefs_cases{error,
{thrown,
{timeout,
[{escalus_connection,receive_stanza,2,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_connection.erl"},
{line,302}]},
{mam_helper,run_set_and_get_prefs_case,4,
[{file,
"/home/circleci/project/big_tests/tests/mam_helper.erl"},
{line,1367}]},
{mam_SUITE,'-run_set_and_get_prefs_cases/1-lc$^0/1-0-',4,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3835}]},
{mam_SUITE,'-run_set_and_get_prefs_cases/1-lc$^0/1-0-',4,
[{file,
"/home/circleci/project/big_tests/tests/mam_SUITE.erl"},
{line,3835}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1303}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1235}]}]}}} mam_SUITE:rdbms_async_pool_prefs_cases:end_per_group{error,
{{unregistering_failed,
{amount,7},
{unregistered_items,
[{{<<"_run_set_and_get_prefs_cases_2311">>,
[{escalus_event_mgr,<0.48269.0>},
{tc_name,run_set_and_get_prefs_cases},
{escalus_cleaner,<0.48268.0>},
{watchdog,<0.48267.0>},
{basic_group,prefs_cases},
{configuration,rdbms_async_pool},
{wait_for_parallel_writer,[pm]},
{mam_meta_opts,
#{cache =>
#{module => internal,strategy => fifo,number_of_segments => 3,
time_to_live => 480},
backend => rdbms,
async_writer =>
#{enabled => true,batch_size => 30,flush_interval => 1,
pool_size => 16},
pm => #{archive_groupchats => false,same_mam_id_for_peers => false},
send_message => mod_mam_utils,max_result_limit => 50,
archive_chat_markers => false,no_stanzaid_element => false,
user_prefs_store => rdbms,cache_users => false,
full_text_search => true,message_retraction => true,
enforce_simple_queries => false,default_result_limit => 50,
is_archivable_message => mod_mam_utils}},
{mod_offline_loaded,false},
{escalus_user_db,{module,escalus_ejabberd}},
{preset,"odbc_mssql_mnesia"},
{mim_data_dir,"/home/circleci/project/big_tests/tests/mam_SUITE_data"},
{tc_logfile,
"https://circleci-mim-results.s3.eu-central-1.amazonaws.com/PR/4355/235269/odbc_mssql_mnesia.27.0.1-amd64/big/ct_run.test%40249ae3300ea0.2024-08-13_11.52.46/big_tests.tests.mam_SUITE.logs/run.2024-08-13_12.03.18/mam_suite.run_set_and_get_prefs_cases.89219.html"},
{tc_group_pr... mssql_mnesia_27 / odbc_mssql_mnesia / e0e819c dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / e0e819c |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Thank you for the changes!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found some places where the docs can be improved. I think we could address them in a follow-up PR.
I tried to address the issues found after the review in #4360 |
This PR adds documentation for instrumentation. There are also a number of small changes related with it that update the documentation and fix errors.
Instrumentation changes:
Instrumentation
page underConfiguration
, which documents the configuration options.Logging and Monitoring
, Prometheus is described as an Exometer alternative, as well as GraphQL endpoint is mentioned. This file could be maybe revisited and updated later, maybe changed to a tutorial on setting up metrics/instrumentation.Operation and maintenance/Metrics
have been updated, mainly with the new Prometheus naming scheme.Other changes:
Configuration
page back toMAM
page), but I think it's not a big issue, and the addition is worth it.c2s_message_processing_time
had an incorrect measurement declared -byte_size
. It was supposed to betime
, but then, the name would bec2s_message_processing_time_time
for Exometer. So, the metric was renamed toc2s_message_processed
, and the measurement fixed totime
.