Skip to content

Commit

Permalink
siptrace: docs updates for trace_mode and whitespacing
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Apr 6, 2020
1 parent 6704c51 commit ab6f384
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions src/modules/siptrace/doc/siptrace_admin.xml
Expand Up @@ -183,8 +183,7 @@ modparam("siptrace", "trace_on", 1)
<title>Set <varname>traced_user_avp</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("siptrace", "traced_user_avp", "$avp(i:123)")
modparam("siptrace", "traced_user_avp", "$avp(s:user)")
modparam("siptrace", "traced_user_avp", "$avp(user)")
...
</programlisting>
</example>
Expand Down Expand Up @@ -238,12 +237,12 @@ modparam("siptrace", "duplicate_uri", "sip:10.1.1.1:5888")
<title><varname>trace_to_database</varname> (integer)</title>
<para>
Parameter to enable/disable inserts to the database from this
&kamailio;.
&kamailio;.
</para>
<para>
In case we only want to send the SIP messages to the
<quote>duplicate_uri</quote> and not store the information to the local
database we can set this to "0".
In case we only want to send the SIP messages to the
<quote>duplicate_uri</quote> and not store the information to the local
database we can set this to "0".
</para>
<para>
<emphasis>
Expand Down Expand Up @@ -325,7 +324,7 @@ modparam("siptrace", "trace_sl_acks", 0)
side.
</para>
<para>
<emphasis>Note:</emphasis> The headers are first read, then written. This allows
<emphasis>Note:</emphasis> The headers are first read, then written. This allows
relaying the information over more than two &kamailio; servers by setting both
<varname>xheaders_write</varname> and <varname>xheaders_read</varname>
to "1" on the servers in the middle.
Expand Down Expand Up @@ -387,7 +386,7 @@ modparam("siptrace", "hep_mode_on", 1)
</programlisting>
</example>
</section>

<section id="siptrace.p.hep_version">
<title><varname>hep_version</varname> (integer)</title>
<para>
Expand Down Expand Up @@ -480,13 +479,18 @@ modparam("siptrace", "force_send_sock", "sip:10.1.1.2:5000")
If set to 0, no automatic mirroring of SIP traffic via HEP.
</para>
<para>
The trace_on parameter still has to be set, allowing also to control
this mode of mirroring via RPC commands.
</para>
<para>
Default value is <emphasis>0</emphasis>.
</para>
<example>
<title>Set <varname>trace_mode</varname>
parameter</title>
<programlisting format="linespecific">
...
modparam("siptrace", "trace_on", 1)
modparam("siptrace", "trace_mode", 1)
...
</programlisting>
Expand Down Expand Up @@ -674,7 +678,7 @@ 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
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
Expand Down Expand Up @@ -714,6 +718,6 @@ onsend_route {
</programlisting>
</example>
</section>

</chapter>

0 comments on commit ab6f384

Please sign in to comment.