siptrace: documented trace_mode parameter

kamailio · Jan 11, 2016 · 2d2c0be · 2d2c0be
1 parent 57e7b28
commit 2d2c0be
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/modules/siptrace/doc/siptrace_admin.xml b/modules/siptrace/doc/siptrace_admin.xml
@@ -466,6 +466,30 @@ modparam("siptrace", "trace_delayed", 1)
 ...
 modparam("siptrace", "force_send_sock", "sip:10.1.1.2:5000")
 ...
+</programlisting>
+                </example>
+        </section>
+	<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 traffic,
+				no need to set the siptrace flag per request.
+                </para>
+                <para>
+                If set to 0, no automatic mirroring of SIP traffic via HEP.
+                </para>
+                <para>
+                Default value is <emphasis>0</emphasis>.
+                </para>
+                <example>
+                <title>Set <varname>trace_mode</varname>
+                parameter</title>
+                <programlisting format="linespecific">
+...
+modparam("siptrace", "trace_mode", 1)
+...
 </programlisting>
                 </example>
         </section>