SipTrace Module

Daniel-Constantin Mierla

   voice-system.ro

Edited by

Daniel-Constantin Mierla

   Copyright © 2006 voice-system.ro
     __________________________________________________________

   Table of Contents
   1. User's Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSER Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. db_url (str)
              1.3.2. table (str)
              1.3.3. trace_flag (integer)
              1.3.4. trace_on (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.4. Exported Functions

              1.4.1. sip_trace()

        1.5. Exported MI Functions

              1.5.1. sip_trace

        1.6. Database setup
        1.7. Known issues

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. Set db_url parameter
   1-2. Set sip_trace parameter
   1-3. Set trace_flag parameter
   1-4. Set trace_on 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. sip_trace() usage
     __________________________________________________________

Chapter 1. User's 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 OpenSER
       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.

   openserctl fifo sip_trace on

   openserctl fifo sip_trace off
     __________________________________________________________

1.2. Dependencies

1.2.1. OpenSER 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 OpenSER 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. table (str)

   Name of the table where to store the SIP messages.

   Default value is "sip_trace".

   Example 1-2. Set sip_trace parameter
...
modparam("siptrace", "table", "strace")
...
     __________________________________________________________

1.3.3. trace_flag (integer)

   Which flag is used to mark messages to trace

   Default value is "0".

   Example 1-3. Set trace_flag parameter
...
modparam("siptrace", "trace_flag", 22)
...
     __________________________________________________________

1.3.4. trace_on (integer)

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

   Default value is "0".

   Example 1-4. Set trace_on parameter
...
modparam("siptrace", "trace_on", 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.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-9. sip_trace() usage
...
sip_trace();
...
     __________________________________________________________

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

   MI FIFO Command Format:
                :sip_trace:_reply_fifo_file_
                trace_mode
                _empty_line_
     __________________________________________________________

1.6. Database setup

   Before running OpenSER 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 openser/scripts folder as template. You can also find the
   complete database documentation on the project webpage,
   http://www.openser.org/docs/db-tables/openser-db-devel.html.
     __________________________________________________________

1.7. Known issues

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

Chapter 2. Developer's Guide

   The module does not provide any API to use in other OpenSER
   modules.
     __________________________________________________________

Chapter 3. Frequently Asked Questions

   3.1. Where can I find more about OpenSER?
   3.2. Where can I post a question about this module?
   3.3. How can I report a bug?

   3.1. Where can I find more about OpenSER?

   Take a look at http://www.openser.org/.

   3.2. Where can I post a question about this module?

   First at all check if your question was already answered on one
   of our mailing lists:

     * User Mailing List -
       http://lists.openser.org/cgi-bin/mailman/listinfo/users
     * Developer Mailing List -
       http://lists.openser.org/cgi-bin/mailman/listinfo/devel

   E-mails regarding any stable OpenSER release should be sent to
   <users@lists.openser.org> and e-mails regarding development
   versions should be sent to <devel@lists.openser.org>.

   If you want to keep the mail private, send it to
   <team@lists.openser.org>.

   3.3. How can I report a bug?

   Please follow the guidelines provided at:
   http://sourceforge.net/tracker/?group_id=139143.
