SipTrace Module

Daniel-Constantin Mierla

   <miconda@gmail.com>

Edited by

Daniel-Constantin Mierla

   <miconda@gmail.com>

   Copyright © 2006 voice-system.ro
   Revision History
   Revision $Revision: 5906 $ $Date: 2009-07-21 10:45:05 +0300
                              (Tue, 21 Jul 2009) $
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSIPS Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. db_url (str)
              1.3.2. trace_flag (integer)
              1.3.3. trace_on (integer)
              1.3.4. enable_ack_trace (integer)
              1.3.5. traced_user_avp (str)
              1.3.6. trace_table_avp (str)
              1.3.7. duplicate_uri (str)
              1.3.8. trace_local_ip (str)
              1.3.9. table (str)

        1.4. Exported Functions

              1.4.1. sip_trace()
              1.4.2. trace_dialog()

        1.5. Exported MI Functions

              1.5.1. sip_trace

        1.6. Database setup
        1.7. Known issues

   List of Examples

   1.1. Set db_url parameter
   1.2. Set trace_flag parameter
   1.3. Set trace_on parameter
   1.4. Set enable_ack_trace parameter
   1.5. Set traced_user_avp parameter
   1.6. Set trace_table_avp parameter
   1.7. Set duplicate_uri parameter
   1.8. Set trace_local_ip parameter
   1.9. Set sip_trace parameter
   1.10. sip_trace() usage
   1.11. trace_dialog() usage

Chapter 1. Admin Guide

1.1. Overview

   Offer 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

1.2. Dependencies

1.2.1. OpenSIPS Modules

   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.

1.2.2. External Libraries or Applications

   The following libraries or applications must be installed
   before running OpenSIPS with this module loaded:
     * None.

1.3. Exported Parameters

1.3.1. db_url (str)

   Database URL.

   Default value is "".

   Example 1.1. Set db_url parameter
...
modparam("siptrace", "db_url", "mysql://user:passwd@host/dbname")
...

1.3.2. trace_flag (integer)

   Which flag is used to mark messages to trace

   Default value is "0".

   Example 1.2. Set trace_flag parameter
...
modparam("siptrace", "trace_flag", 22)
...

1.3.3. trace_on (integer)

   Parameter to enable/disable trace (on(1)/off(0))

   Default value is "0".

   Example 1.3. Set trace_on parameter
...
modparam("siptrace", "trace_on", 1)
...

1.3.4. enable_ack_trace (integer)

   Parameter to enable/disable tracing of statelessly received
   ACKs (on(1)/off(0))

   Default value is "0".

   Example 1.4. Set enable_ack_trace parameter
...
modparam("siptrace", "enable_ack_trace", 1)
...

1.3.5. traced_user_avp (str)

   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(i:123)")
modparam("siptrace", "traced_user_avp", "$avp(s:user)")
...

1.3.6. trace_table_avp (str)

   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(i:345)")
modparam("siptrace", "trace_table_avp", "$avp(s:siptrace_table)")
...

1.3.7. duplicate_uri (str)

   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")
...

1.3.8. trace_local_ip (str)

   The address to be used in fromip field for local generated
   messages. If not set, the module sets it to the address of the
   socket that will be used to send the message.

   Default value is "NULL".

   Example 1.8. Set trace_local_ip parameter
...
modparam("siptrace", "trace_local_ip", "10.1.1.1:5064")
...

1.3.9. table (str)

   Name of the table where to store the SIP messages.

   Default value is "sip_trace".

   Example 1.9. Set sip_trace parameter
...
modparam("siptrace", "table", "strace")
...

1.4. Exported Functions

1.4.1.  sip_trace()

   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.

   Example 1.10. sip_trace() usage
...
sip_trace();
...

1.4.2.  trace_dialog()

   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.

   Example 1.11. trace_dialog() usage
...
if(is_method("INVITE") && !has_totag())
        trace_dialog();
...

1.5. Exported MI Functions

1.5.1.  sip_trace

   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_

1.6. Database setup

   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.

1.7. Known issues

   Stateless forwarded messages (forward()) are not logged if you
   set the flag, use sip_trace().