Module: kamailio
Branch: master
Commit: 87b8c506f0dc77f0d39eb662df24fbe500bef9bb
URL: 
https://github.com/kamailio/kamailio/commit/87b8c506f0dc77f0d39eb662df24fbe500bef9bb

Author: Daniel-Constantin Mierla <[email protected]>
Committer: Daniel-Constantin Mierla <[email protected]>
Date: 2020-04-07T12:33:47+02:00

siptrace: docs updates for trace_mode parameter

---

Modified: src/modules/siptrace/doc/siptrace_admin.xml

---

Diff:  
https://github.com/kamailio/kamailio/commit/87b8c506f0dc77f0d39eb662df24fbe500bef9bb.diff
Patch: 
https://github.com/kamailio/kamailio/commit/87b8c506f0dc77f0d39eb662df24fbe500bef9bb.patch

---

diff --git a/src/modules/siptrace/doc/siptrace_admin.xml 
b/src/modules/siptrace/doc/siptrace_admin.xml
index 9a33b36456..511dda3a98 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -33,7 +33,7 @@
                </listitem>
                <listitem>
                <para>
-               by setting <quote>trace_mode</quote> to mirror all traffic.
+               by setting <quote>trace_mode</quote> to mirror or store to db 
all traffic.
                </para>
                </listitem>
                </itemizedlist>
@@ -468,16 +468,40 @@ modparam("siptrace", "force_send_sock", 
"sip:10.1.1.2:5000")
        <section id="siptrace.p.trace_mode">
                 <title><varname>trace_mode</varname> (integer)</title>
                 <para>
-                               If set to 1, the module uses core events 
triggered when receiving
-                               or sending SIP traffic to mirror traffic to a 
SIP capture server
-                               using HEP. It will automatically do the 
mirroring of all SIP traffic.
+                               If not set to 0, the module uses core events 
triggered when receiving
+                               or sending SIP traffic to store it to database 
or mirror it to a SIP
+                               capture server using HEP or UDP forwarding.
+                               It will automatically do the handling of all 
SIP traffic.
                                It is no longer needed to set the siptrace flag 
per request or
-                               execute sip_trace(), if it is done, then there 
mirroring is
+                               execute sip_trace(), if it is done, then the 
storing and mirroring is
                                duplicated.
                 </para>
+                               <para>
+                               The value of the parameter can be a combination 
of next values:
+                               <itemizedlist>
+                               <listitem>
                 <para>
-                If set to 0, no automatic mirroring of SIP traffic via HEP.
+                0 - no automatic mirroring or storing of SIP traffic.
                 </para>
+                               </listitem>
+                               <listitem>
+                               <para>
+                               1 (1st bit set) - mirror the traffic to HEP 
server.
+                               </para>
+                               </listitem>
+                               <listitem>
+                               <para>
+                               2 (2nd bit set) - store the traffic to database 
server.
+                               </para>
+                               </listitem>
+                               <listitem>
+                               <para>
+                               4 (3rd bit set) - mirro the traffic to the SIP 
URI specified by
+                               duplicate_uri.
+                               </para>
+                               </listitem>
+                               </itemizedlist>
+                               </para>
                 <para>
                 The trace_on parameter still has to be set, allowing also to 
control
                 this mode of mirroring via RPC commands.
@@ -493,6 +517,8 @@ modparam("siptrace", "force_send_sock", "sip:10.1.1.2:5000")
 modparam("siptrace", "trace_on", 1)
 modparam("siptrace", "trace_mode", 1)
 ...
+modparam("siptrace", "trace_mode", 3)
+...
 </programlisting>
                 </example>
         </section>


_______________________________________________
Kamailio (SER) - Development Mailing List
[email protected]
https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev

Reply via email to