Instrumentation documentation fixes #4360

gustawlippa · 2024-08-20T10:13:33Z

This PR is a follow up to #4355, which addresses issues found when reviewing documentation once more.

mongoose-im · 2024-08-20T10:21:56Z

elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 5774c7f
Reports root/ big
OK: 461 / Failed: 0 / User-skipped: 49 / Auto-skipped: 0

small_tests_27 / small_tests / 5774c7f
Reports root / small

small_tests_26 / small_tests / 5774c7f
Reports root / small

small_tests_27_arm64 / small_tests / 5774c7f
Reports root / small

ldap_mnesia_26 / ldap_mnesia / 5774c7f
Reports root/ big
OK: 2341 / Failed: 0 / User-skipped: 910 / Auto-skipped: 0

dynamic_domains_mysql_redis_27 / mysql_redis / 5774c7f
Reports root/ big
OK: 4671 / Failed: 1 / User-skipped: 151 / Auto-skipped: 0

domain_isolation_SUITE:two_domains:routing_one2one_message_to_another_domain_gets_dropped

{error,{test_case_failed,"Incorrect number of instrumentation events - matched: 0, expected: 1"}}

Report log

domain_isolation_SUITE:end_per_suite

{error,{test_case_failed,"Instrumentation events that were logged, but not tested:\n[{router_stanza_dropped,#{host_type => <<\"test type\">>}}]\nYou need to test them with instrument_helper:assert/3"}}

Report log

ldap_mnesia_27 / ldap_mnesia / 5774c7f
Reports root/ big
OK: 2341 / Failed: 0 / User-skipped: 910 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 5774c7f
Reports root/ big
OK: 4705 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 5774c7f
Reports root/ big
OK: 4705 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0

internal_mnesia_27 / internal_mnesia / 5774c7f
Reports root/ big
OK: 2483 / Failed: 0 / User-skipped: 768 / Auto-skipped: 0

pgsql_cets_27 / pgsql_cets / 5774c7f
Reports root/ big
OK: 4594 / Failed: 0 / User-skipped: 185 / Auto-skipped: 0

pgsql_mnesia_26 / pgsql_mnesia / 5774c7f
Reports root/ big
OK: 5096 / Failed: 0 / User-skipped: 127 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 5774c7f
Reports root/ big
OK: 4702 / Failed: 0 / User-skipped: 121 / Auto-skipped: 0

mysql_redis_27 / mysql_redis / 5774c7f
Reports root/ big
OK: 5077 / Failed: 0 / User-skipped: 146 / Auto-skipped: 0

pgsql_mnesia_27 / pgsql_mnesia / 5774c7f
Reports root/ big
OK: 5096 / Failed: 0 / User-skipped: 127 / Auto-skipped: 0

mssql_mnesia_27 / odbc_mssql_mnesia / 5774c7f
Reports root/ big
OK: 5092 / Failed: 1 / User-skipped: 130 / Auto-skipped: 0

service_domain_db_SUITE:db:rest_without_auth:rest_without_auth_parallel:rest_delete_domain_cleans_data_from_mam

{error,
  {{badrpc,
     {'EXIT',
       {{badmatch,
          {badrpc,
            {'EXIT',
              {timeout,
                {gen_server,call,[<10456.173841.0>,ping]}}}}},
        [{service_domain_db,'-sync_local/0-lc$^1/1-1-',2,
           [{file,
            "/home/circleci/project/src/domain/service_domain_db.erl"},
          {line,98}]},
         {service_domain_db,sync_local,0,
           [{file,
            "/home/circleci/project/src/domain/service_domain_db.erl"},
          {line,98}]}]}}},
   [{distributed_helper,rpc,
      [#{node => mongooseim@localhost},service_domain_db,sync_local,[]],
      [{file,
         "/home/circleci/project/big_tests/../test/common/distributed_helper.erl"},
       {line,140}]},
    {service_domain_db_SUITE,sync_local,1,
      [{file,
         "/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
       {line,1212}]},
    {service_domain_db_SUITE,sync,0,
      [{file,
         "/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
       {line,1191}]},
    {service_domain_db_SUITE,
      '-rest_delete_domain_cleans_data_from_mam/1-fun-0-',5,
      [{file,
         "/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
       {line,963}]},
    {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_...

Report log

dynamic_domains_mysql_redis_27 / mysql_redis / 5774c7f
Reports root/ big
OK: 4672 / Failed: 0 / User-skipped: 151 / Auto-skipped: 0

mssql_mnesia_27 / odbc_mssql_mnesia / 5774c7f
Reports root/ big
OK: 5092 / Failed: 1 / User-skipped: 130 / Auto-skipped: 0

service_domain_db_SUITE:db:rest_without_auth:rest_without_auth_parallel:rest_delete_domain_cleans_data_from_mam

{error,
  {{badrpc,timeout},
   [{distributed_helper,rpc,
      [#{node => mongooseim@localhost},service_domain_db,sync_local,[]],
      [{file,
         "/home/circleci/project/big_tests/../test/common/distributed_helper.erl"},
       {line,140}]},
    {service_domain_db_SUITE,sync_local,1,
      [{file,
         "/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
       {line,1212}]},
    {service_domain_db_SUITE,sync,0,
      [{file,
         "/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
       {line,1191}]},
    {service_domain_db_SUITE,rest_delete_domain_cleans_data_from_mam,1,
      [{file,
         "/home/circleci/project/big_tests/tests/service_domain_db_SUITE.erl"},
       {line,952}]},
    {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}]}]}}

Report log

mssql_mnesia_27 / odbc_mssql_mnesia / 5774c7f
Reports root/ big
OK: 5091 / Failed: 2 / User-skipped: 130 / Auto-skipped: 0

muc_SUITE:register:user_submits_registration_form_twice

{error,
  {{assertion_failed,assert,is_iq_result,
     [{xmlel,<<"iq">>,
        [{<<"type">>,<<"set">>},
         {<<"id">>,<<"5c7cb20dd5fa46aacbd3e8cc62ba7221">>},
         {<<"to">>,<<"muc.localhost">>}],
        [{xmlel,<<"query">>,
           [{<<"xmlns">>,<<"jabber:iq:register">>}],
           [{xmlel,<<"x">>,
            [{<<"xmlns">>,<<"jabber:x:data">>},
             {<<"type">>,<<"submit">>}],
            [{xmlel,<<"field">>,
               [{<<"type">>,<<"hidden">>},
                {<<"var">>,<<"FORM_TYPE">>}],
               [{xmlel,<<"value">>,[],
                  [{xmlcdata,<<"jabber:iq:register">>}]}]},
             {xmlel,<<"field">>,
               [{<<"type">>,<<"text-single">>},
                {<<"var">>,<<"nick">>}],
               [{xmlel,<<"value">>,[],
                  [{xmlcdata,
                     <<"thirdwitchroom-6c80b486c8">>}]}]}]}]}]}],
     {xmlel,<<"iq">>,
       [{<<"from">>,<<"muc.localhost">>},
        {<<"to">>,
         <<"alice_user_submits_registration_form_twice_3058@localhost/res1">>},
        {<<"type">>,<<"error">>},
        {<<"id">>,<<"5c7cb20dd5fa46aacbd3e8cc62ba7221">>}],
       [{xmlel,<<"query">>,
          [{<<"xmlns">>,<<"jabber:iq:register">>}],
          [{xmlel,<<"x">>,
             [{<<"xmlns">>,<<"jabber:x:data">>},
            {<<"type">>,<<"submit">>}],
             [{xmlel,<<"field">>,
              [{<<"type">>,<<"hidden">>},
               {<<"var">>,<<"FORM_TYPE">>}],
              [{xmlel,<<"value">>,[],
   ...

Report log

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}]}]}}

Report log

mssql_mnesia_27 / odbc_mssql_mnesia / 5774c7f
Reports root/ big
OK: 5093 / Failed: 0 / User-skipped: 130 / Auto-skipped: 0

codecov · 2024-08-20T10:22:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.02%. Comparing base (229b40d) to head (9a8a509).
Report is 17 commits behind head on feature/instrument.

Additional details and impacted files

@@                 Coverage Diff                 @@
##           feature/instrument    #4360   +/-   ##
===================================================
  Coverage               85.01%   85.02%           
===================================================
  Files                     550      550           
  Lines                   33857    33857           
===================================================
+ Hits                    28785    28786    +1     
+ Misses                   5072     5071    -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

chrzaszcz

Looks good in general. I added minor comments.

doc/configuration/instrumentation.md

doc/modules/mod_ping.md

mongoose-im · 2024-08-20T14:50:38Z

elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 9a8a509
Reports root/ big
OK: 461 / Failed: 0 / User-skipped: 49 / Auto-skipped: 0

small_tests_26 / small_tests / 9a8a509
Reports root / small

small_tests_27 / small_tests / 9a8a509
Reports root / small

small_tests_27_arm64 / small_tests / 9a8a509
Reports root / small

ldap_mnesia_26 / ldap_mnesia / 9a8a509
Reports root/ big
OK: 2341 / Failed: 0 / User-skipped: 910 / Auto-skipped: 0

ldap_mnesia_27 / ldap_mnesia / 9a8a509
Reports root/ big
OK: 2341 / Failed: 0 / User-skipped: 910 / Auto-skipped: 0

dynamic_domains_mysql_redis_27 / mysql_redis / 9a8a509
Reports root/ big
OK: 4672 / Failed: 0 / User-skipped: 151 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 9a8a509
Reports root/ big
OK: 4705 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 9a8a509
Reports root/ big
OK: 4702 / Failed: 0 / User-skipped: 121 / Auto-skipped: 0

pgsql_cets_27 / pgsql_cets / 9a8a509
Reports root/ big
OK: 4594 / Failed: 0 / User-skipped: 185 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 9a8a509
Reports root/ big
OK: 4705 / Failed: 0 / User-skipped: 118 / Auto-skipped: 0

internal_mnesia_27 / internal_mnesia / 9a8a509
Reports root/ big
OK: 2483 / Failed: 0 / User-skipped: 768 / Auto-skipped: 0

mysql_redis_27 / mysql_redis / 9a8a509
Reports root/ big
OK: 5077 / Failed: 0 / User-skipped: 146 / Auto-skipped: 0

pgsql_mnesia_27 / pgsql_mnesia / 9a8a509
Reports root/ big
OK: 5096 / Failed: 0 / User-skipped: 127 / Auto-skipped: 0

pgsql_mnesia_26 / pgsql_mnesia / 9a8a509
Reports root/ big
OK: 5096 / Failed: 0 / User-skipped: 127 / Auto-skipped: 0

mssql_mnesia_27 / odbc_mssql_mnesia / 9a8a509
Reports root/ big
OK: 5093 / Failed: 0 / User-skipped: 130 / Auto-skipped: 0

chrzaszcz

Looking good 👌

gustawlippa added 13 commits August 20, 2024 12:01

Correct module name

0c74dd0

Remove StatsD reporter mention

4447d7e

Clarify Prometheus endpoint

6b436b4

Add all_metrics_are_global description

a4f6dc3

Describe loglevel option

b8969b5

Fix event name

4aaa227

Add missing word

7575e72

Fix module name

aabaeeb

Fix event name

07a87d2

Fix event name

30e16c6

Fix event name

03ecfe6

Fix Exometer event type

df0da1e

Document when probes are updated clearly

5774c7f

gustawlippa mentioned this pull request Aug 20, 2024

Document instrumentation #4355

Merged

gustawlippa changed the title ~~Correct module name~~ Instrumentation documentation fixes Aug 20, 2024

gustawlippa marked this pull request as ready for review August 20, 2024 13:04

chrzaszcz reviewed Aug 20, 2024

View reviewed changes

doc/configuration/instrumentation.md Outdated Show resolved Hide resolved

doc/configuration/instrumentation.md Outdated Show resolved Hide resolved

doc/modules/mod_ping.md Outdated Show resolved Hide resolved

gustawlippa added 3 commits August 20, 2024 16:20

Fix mod_ping_response_timeout_count event name

e4b8918

Rephrase all_metrics_are_global description

3f3a664

Note logging verbosity and possible level override

9a8a509

chrzaszcz approved these changes Aug 21, 2024

View reviewed changes

chrzaszcz merged commit 2bf2b51 into feature/instrument Aug 21, 2024
4 checks passed

chrzaszcz deleted the instrumentation/documentation_fixes branch August 21, 2024 06:06

jacekwegr added this to the 6.3.0 milestone Oct 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Instrumentation documentation fixes #4360

Instrumentation documentation fixes #4360

gustawlippa commented Aug 20, 2024

mongoose-im commented Aug 20, 2024 •

edited

Loading

codecov bot commented Aug 20, 2024 •

edited

Loading

chrzaszcz left a comment

mongoose-im commented Aug 20, 2024 •

edited

Loading

chrzaszcz left a comment

Instrumentation documentation fixes #4360

Instrumentation documentation fixes #4360

Conversation

gustawlippa commented Aug 20, 2024

mongoose-im commented Aug 20, 2024 • edited Loading

codecov bot commented Aug 20, 2024 • edited Loading

Codecov Report

chrzaszcz left a comment

Choose a reason for hiding this comment

mongoose-im commented Aug 20, 2024 • edited Loading

chrzaszcz left a comment

Choose a reason for hiding this comment

mongoose-im commented Aug 20, 2024 •

edited

Loading

codecov bot commented Aug 20, 2024 •

edited

Loading

mongoose-im commented Aug 20, 2024 •

edited

Loading