Document low-level MAM options #3329
Conversation
This comment has been minimized.
This comment has been minimized.
Codecov Report
@@ Coverage Diff @@
## master #3329 +/- ##
==========================================
+ Coverage 80.67% 80.69% +0.01%
==========================================
Files 397 397
Lines 32440 32440
==========================================
+ Hits 26172 26176 +4
+ Misses 6268 6264 -4
Continue to review full report at Codecov.
|
gustawlippa
force-pushed
the
doc-mam-options
branch
from
e930834 to
f46b973
Compare
|
small_tests_24 / small_tests / f46b973 internal_mnesia_24 / internal_mnesia / f46b973 small_tests_23 / small_tests / f46b973 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / f46b973 service_domain_db_SUITE:db:db_keeps_syncing_after_cluster_join{error,{test_case_failed,{[<<"example1.com">>],
[<<"example1.com">>,<<"example2.com">>]}}}service_domain_db_SUITE:db:rest_with_auth:rest_delete_domain_cleans_data_from_mam{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"bob_rest_delete_domain_cleans_data_from_mam_80.477531@example.org/res1">>,
escalus_tcp,<0.28588.1>,
[{event_manager,<0.28582.1>},
{server,<<"example.org">>},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_80.477531">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.28582.1>},
{server,<<"example.org">>},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_80.477531">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_80.477531">>},
{server,<<"example.org">>},
{host,<<"localhost">>},
{port,5232},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_80.477531">>},
{server,<<"example.org">>},
{host,<<"localhost">>},
{password,<<"makota3">>},
{port,5232},
{stream_id,<<"efd11ff63ba977c4">>}]},
5000],
[{file,
"/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{service_domain_db_SUITE,
'-rest_delete_domain_cleans_data_from_mam/1-fun-0-',5...service_domain_db_SUITE:db:rest_without_auth:rest_delete_domain_cleans_data_from_mam{error,
{timeout_when_waiting_for_stanza,
[{escalus_client,wait_for_stanza,
[{client,
<<"bob_rest_delete_domain_cleans_data_from_mam_88.310183@example.org/res1">>,
escalus_tcp,<0.29232.1>,
[{event_manager,<0.29226.1>},
{server,<<"example.org">>},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_88.310183">>},
{resource,<<"res1">>}],
[{event_client,
[{event_manager,<0.29226.1>},
{server,<<"example.org">>},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_88.310183">>},
{resource,<<"res1">>}]},
{resource,<<"res1">>},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_88.310183">>},
{server,<<"example.org">>},
{host,<<"localhost">>},
{port,5232},
{auth,{escalus_auth,auth_plain}},
{wspath,undefined},
{username,
<<"bob_rest_delete_domain_cleans_data_from_mam_88.310183">>},
{server,<<"example.org">>},
{host,<<"localhost">>},
{password,<<"makota3">>},
{port,5232},
{stream_id,<<"a8a39fa945db4643">>}]},
5000],
[{file,
"/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
{line,136}]},
{service_domain_db_SUITE,
'-rest_delete_domain_cleans_data_from_mam/1-fun-0-',5...ldap_mnesia_24 / ldap_mnesia / f46b973 dynamic_domains_mysql_redis_24 / mysql_redis / f46b973 dynamic_domains_mssql_mnesia_24 / odbc_mssql_mnesia / f46b973 dynamic_domains_pgsql_mnesia_23 / pgsql_mnesia / f46b973 ldap_mnesia_23 / ldap_mnesia / f46b973 pgsql_mnesia_24 / pgsql_mnesia / f46b973 elasticsearch_and_cassandra_24 / elasticsearch_and_cassandra_mnesia / f46b973 mysql_redis_24 / mysql_redis / f46b973 mssql_mnesia_24 / odbc_mssql_mnesia / f46b973 pgsql_mnesia_23 / pgsql_mnesia / f46b973 riak_mnesia_24 / riak_mnesia / f46b973 mod_ping_SUITE:server_ping:server_ping_pong{error,{{badmatch,[{[<<"localhost">>,mod_ping,ping_response],
{expected_diff,5},
{before_story,0},
{after_story,4}}]},
[{escalus_mongooseim,post_story_check_metrics,1,
[{file,"/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_mongooseim.erl"},
{line,74}]},
{escalus_mongooseim,maybe_check_metrics_post_story,1,
[{file,"/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_mongooseim.erl"},
{line,51}]},
{escalus_story,story,4,
[{file,"/home/circleci/app/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,75}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1292}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1224}]}]}}dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / f46b973 |
This PR addresses #3191 (review).
It adds documentation for low-level MAM options. Although some are for example RDBMS only, I think it's better to keep them all in their own group, as these are probably really rarely used.
async_writer_rdbms_poolis not documented - if I am not mistaken this option is not read by anything, but I left it for now, because I'm not sure.simpleseems weird and from what I understand it doubles whatdb_message_formatalready does. It may be useful maybe for setups with multiple backends with different formats? If not, the code formod_mam_cassandra_archandmod_mam_muc_cassandra_archcould be simplified.The options and their structure in the TOML config could use a refactor in my opinion, but that may be done in the future.
Some other minor changes like typos fixed (there is no
"mod_mam_rdbms_async_writer").