[sr-dev] git:master:2d2c0bec: siptrace: documented trace_mode parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 2d2c0bec3170b3ef6c10dc9a3b9e990b8d50e0bc
URL: https://github.com/kamailio/kamailio/commit/2d2c0bec3170b3ef6c10dc9a3b9e990b8d50e0bc

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-01-11T22:30:09+01:00

siptrace: documented trace_mode parameter

---

Modified: modules/siptrace/doc/siptrace_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/2d2c0bec3170b3ef6c10dc9a3b9e990b8d50e0bc.diff
Patch: https://github.com/kamailio/kamailio/commit/2d2c0bec3170b3ef6c10dc9a3b9e990b8d50e0bc.patch

---

diff --git a/modules/siptrace/doc/siptrace_admin.xml b/modules/siptrace/doc/siptrace_admin.xml
index c766531..7c454f7 100644
--- a/modules/siptrace/doc/siptrace_admin.xml
+++ b/modules/siptrace/doc/siptrace_admin.xml
@@ -469,6 +469,30 @@ 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>
 	</section>
 	
 	<section>