[sr-dev] git:master:75e6e370: siptrace: improve documentation about sip_trace and DB setup

Module: kamailio Branch: master Commit: 75e6e370ceb701eabbdb2a1b7f12311ba0ae5024 URL: https://github.com/kamailio/kamailio/commit/75e6e370ceb701eabbdb2a1b7f12311… Author: Henning Westerholt &lt;hw(a)skalatan.de&gt; Committer: Henning Westerholt &lt;hw(a)skalatan.de&gt; Date: 2020-06-05T10:25:46Z siptrace: improve documentation about sip_trace and DB setup --- Modified: src/modules/siptrace/doc/siptrace_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/75e6e370ceb701eabbdb2a1b7f12311… Patch: https://github.com/kamailio/kamailio/commit/75e6e370ceb701eabbdb2a1b7f12311… --- diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml index 5bd274a2f0..7d5b0d34ef 100644 --- a/src/modules/siptrace/doc/siptrace_admin.xml +++ b/src/modules/siptrace/doc/siptrace_admin.xml @@ -643,7 +643,9 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia") <para> Store or forward the current processed SIP message/transaction/dialog in database. It is stored in the form prior applying changes made to it. Based on mode, one can trace - the current message('m' - default), the current transaction('t') or the current dialog('d'). + the current message('m'), the current transaction('t') or the current dialog('d'). + If no mode is given, it falls back to the default mode - transaction tracking when + trace_flag is set, otherwise only the current message. </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist> @@ -795,12 +797,12 @@ hlog("$hdr(P-MyID)", "Another one with a custom correlation ID"); <section> <title>Database setup</title> <para> - Before running &kamailio; with siptrace, you have to setup the database - tables where the module will store the data. For that, if the - table were not created by the installation script or you choose - to install everything by yourself you can use the siptrace-create.sql - <acronym>SQL</acronym> script in the database directories in the - kamailio/scripts folder as template. + Before running &kamailio; with siptrace and activated trace_to_database + parameter, you have to setup the database tables where the module will + store the data. For that, if the table were not created by the + installation script or you choose to install everything by yourself + you can use the siptrace-create.sql <acronym>SQL</acronym> script in + the database directories in the kamailio/scripts folder as template. You can also find the complete database documentation on the project webpage, &kamailiodbdocslink;. </para>