diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index f121946ce15..f1924abe94d 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -17,8 +17,8 @@
Overview
The SIPtrace module offer a possibility to store incoming and outgoing SIP
- messages in a database and/or duplicate to the capturing server (using HEP
- the Homer encapsulation protocol or plain SIP mode)
+ messages in a database and/or duplicate to the capturing server (using HEP,
+ the Homer encapsulation protocol, or plain SIP mode)
There are two ways of storing information:
@@ -42,8 +42,7 @@
- The tracing can be turned on/off using Kamailio mi or RPC
- commands.
+ The tracing can be turned on/off using Kamailio RPC commands.
&ctltool; fifo sip_trace on
@@ -57,12 +56,12 @@
&kamailio; Modules
- The following modules must be loaded before this module:
+ The following modules must be conditionally loaded before this module:
A database module - Mysql, Postgres,
- dbtext, unixODBC...
+ dbtext, unixODBC... Optional, if tracing to DB is enabled.
@@ -199,7 +198,7 @@ modparam("siptrace", "traced_user_avp", "$avp(s:user)")
store the SIP messages. If it is not set, the value of
table
parameter is used. In this way one can select
dynamically where to store the traced messages. The table
- must exists, and must have the same structure as the sip_trace
+ must exist, and must have the same structure as the sip_trace
table.
@@ -395,8 +394,9 @@ modparam("siptrace", "hep_mode_on", 1)
hep_version (integer)
The parameter indicate the version of the HEP protocol.
- Can be 1
or 2
. In HEPv2 the timestamp and capture agent ID
- will be included to HEP header.
+ Can be 1
, 2
or 3
.
+ In HEPv2 and HEPv3 the timestamp and capture agent ID will be
+ included in the HEP header.
@@ -407,7 +407,7 @@ modparam("siptrace", "hep_mode_on", 1)
Set hep_version parameter
...
-modparam("siptrace", "hep_version", 2)
+modparam("siptrace", "hep_version", 3)
...
@@ -416,8 +416,8 @@ modparam("siptrace", "hep_version", 2)
hep_capture_id (integer)
The parameter indicate the capture agent ID for the HEPv2
- protocol.
- Limitation: 16-bit integer.
+ or HEPv3 protocol.
+ Limitation: 16-bit integer for HEPv2, 32-bit for HEPv3.
@@ -425,8 +425,7 @@ modparam("siptrace", "hep_version", 2)
- Set hep_capture_id
- parameter
+ Set hep_capture_id parameter
...
modparam("siptrace", "hep_capture_id", 234)
@@ -456,7 +455,7 @@ modparam("siptrace", "trace_delayed", 1)
force_send_sock (str)
- The local interface in the form of SIP uri from where to send
+ The local interface in the form of SIP URI from where to send
the duplicated traffic. In the absence of this parameter
&kamailio; automatically picks an interface.
@@ -490,6 +489,25 @@ modparam("siptrace", "force_send_sock", "sip:10.1.1.2:5000")
...
modparam("siptrace", "trace_mode", 1)
...
+
+
+
+
+ auth_key (integer)
+
+A string with an authorization key.
+Supported on HEPv3 only.
+
+
+ Default value is empty.
+
+
+ Set auth_key
+ parameter
+
+...
+modparam("siptrace", "auth_key", "spoihepuirthpeuia")
+...
@@ -499,7 +517,7 @@ modparam("siptrace", "trace_mode", 1)
Functions
- sip_trace([address])
+ sip_trace([address][, correlation_id])
Store or forward the current processed SIP message in database. It is stored in the
@@ -508,10 +526,14 @@ modparam("siptrace", "trace_mode", 1)
Meaning of the parameters is as follows:
- address - The address in form of SIP uri
+ address - The address in form of SIP URI
where to send a duplicate of traced message. This parameter trumps
duplicate_uri and allows tracing to more than one server.
+ correlation_id - A string with a correlation ID
+ to be added to the HEP header when using HEPv3.
+ It's possible to use PVs.
+
@@ -529,6 +551,8 @@ sip_trace();
...
sip_trace("sip:10.1.1.2:5085");
...
+sip_trace("sip:10.1.1.2:5085", "$ci-abc");
+...
@@ -549,7 +573,7 @@ sip_trace("sip:10.1.1.2:5085");
Parameters:
- on or off: turns on/off SIP message tracing..
+ on or off: turns on/off SIP message tracing.
Possible values are:
on