Copyright © 2006 Voice Sistem SRL
| Revision History | |
|---|---|
| Revision $Revision: 8742 $ | $Date: 2012-02-22 18:34:34 +0100 (Wed, 22 Feb 2012) $ |
Table of Contents
List of Examples
db_url parametertrace_flag parametertrace_on parameterenable_ack_trace parametertraced_user_avp parametertrace_table_avp parameterduplicate_uri parametertrace_local_ip parametersip_trace parametersip_trace() usagetrace_dialog() usageOffer a possibility to store incoming/outgoing SIP messages in database.
There are two ways of storing information.
by calling explicitely the sip_trace() method in OpenSIPS configuration file. In this case the original message is processed.
by setting the flag equal with the value of 'trace_flag' (e.g., setflag(__trace_flag__)) parameter of the module. In this case, the\ message sent forward is processed. The logging mechanism is based on TM/SL callbacks, so only messages processed with TM/SL are logged.
The tracing can be turned on/off using fifo commad.
opensipsctl fifo sip_trace on
opensipsctl fifo sip_trace off
The following modules must be loaded before this module:
database module - mysql, postrgress, dbtext, unixodbc...
tm and sl modules - optional, only if you want to trace messages forwarded by these modules.
Database URL.
Default value is "".
Example 1.1. Set db_url parameter
...
modparam("siptrace", "db_url", "mysql://user:passwd@host/dbname")
...
Which flag is used to mark messages to trace
Default value is "0".
Parameter to enable/disable trace (on(1)/off(0))
Default value is "0".
Parameter to enable/disable tracing of statelessly received ACKs (on(1)/off(0))
Default value is "0".
The name of the AVP storing the SIP URI of the traced user. If the AVP is set, messages are stored in database table and 'traced_user' column is filled with AVP's value. You can store the message many times for many users by having multiple values for this AVP.
Default value is "NULL" (feature disabled).
Example 1.5. Set traced_user_avp parameter
...
modparam("siptrace", "traced_user_avp", "$avp(123)")
modparam("siptrace", "traced_user_avp", "$avp(user)")
...
The name of the AVP storing the name of the table where to 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 'sip_trace' table.
Default value is "NULL" (feature disabled).
Example 1.6. Set trace_table_avp parameter
...
modparam("siptrace", "trace_table_avp", "$avp(345)")
modparam("siptrace", "trace_table_avp", "$avp(siptrace_table)")
...
The address in form of SIP uri where to send a duplicate of traced message. It uses UDP all the time.
Default value is "NULL".
Example 1.7. Set duplicate_uri parameter
...
modparam("siptrace", "duplicate_uri", "sip:10.1.1.1:5888")
...
Store current processed SIP message in database. It is stored in the form prior applying chages made to it.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
The function triggers the tracing of all messages belonging to a dialog. The function must be called for the initial request (that starts the dialog) and it will automatically take care of tracing evertyhing related to that dialog.
When using this function, you do not have to explicity set any tracing flag or to explicitly call anothe trace function.
This function can be used from REQUEST_ROUTE.
Name: sip_trace
Parameters:
trace_mode : turns on/off SIP message tracing. Possible values are:
on
off
The parameter is optional - if missing, the command will return the status of the SIP message tracing (as string “on” or “off” ) without changing anything.
MI FIFO Command Format:
:sip_trace:_reply_fifo_file_ trace_mode _empty_line_
Before running OpenSIPS 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 SQL script in the database directories in the opensips/scripts folder as template. You can also find the complete database documentation on the project webpage, http://www.opensips.org/html/docs/db/db-schema-devel.html.