SipTrace Module

Daniel-Constantin Mierla

Edited by

Daniel-Constantin Mierla

Revision History
Revision $Revision: 8740 $$Date$

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 (string/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.3.10. trace_to_database (integer)
1.3.11. duplicate_with_hep (integer)
1.3.12. hep_version (integer)
1.3.13. hep_capture_id (integer)
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.5.2. trace_to_database
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. Set trace_to_databaseparameter
1.11. Set duplicate_with_hep parameter
1.12. Set hep_version parameter
1.13. Set hep_capture_id parameter
1.14. sip_trace() usage
1.15. trace_dialog() usage

Chapter 1. Admin Guide

1.1. Overview

Offer a possibility to capture and store incoming/outgoing SIP messages to an SQL database or to an external capturing node (via HEP) (see

There are two ways of triggering the tracing:

  • by setting the flag equal with the value of 'trace_flag' (e.g., setflag(TRACE_FLAG)) parameter of the module.

  • by setting an 'traced_user_avp' AVP (see below details)

Whatever triggering mode is used, there are three possible tracing scopes :

  • per SIP message - use sip_trace() function outside the context/scope of a transaction (is stateless mode)

  • per SIP transaction - use sip_trace() function inside the context/scope of a transaction (the transaction exists for that SIP requests)

  • per SIP dialog - use trace_dialog() function

The tracing can be turned on/off using fifo command.

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 (string/integer)

Which flag is used to mark messages to trace

WARNING: Setting INT flags is deprecated! Use quoted strings instead!

Default value is "NULL" (not set).

Example 1.2. Set trace_flag parameter

modparam("siptrace", "trace_flag", "TRACE_FLAG")

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(123)")
modparam("siptrace", "traced_user_avp", "$avp(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 exist, 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)")

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

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

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.3.10. trace_to_database (integer)

Parameter to enable/disable inserts to the Database from this OpenSIPS.

In case we only want to send the SIP-Messages to the duplicate_uri and not store the information to the local database we can set this to "0".

Default value is "1".

Example 1.10. Set trace_to_databaseparameter

modparam("siptrace", "trace_to_database", 0)

1.3.11. duplicate_with_hep (integer)

Parameter to enable/disable homer encapsulate mode (on(1)/off(0))

Default value is "0".

Example 1.11. Set duplicate_with_hep parameter

modparam("siptrace", "duplicate_with_hep", 1)

1.3.12. hep_version (integer)

The parameter indicate the version of HEP protocol. Can be 1 or 2. In HEPv2 the timestamp and capture agent ID will be included to HEP header.

Default value is "1".

Example 1.12. Set hep_version parameter

modparam("siptrace", "hep_version", 2)

1.3.13. hep_capture_id (integer)

The parameter indicate the capture agent ID for HEPv2 protocol. Limitation: 16-bit integer.

Default value is "1".

Example 1.13. Set hep_capture_id parameter

modparam("siptrace", "hep_capture_id", 234)

1.4. Exported Functions

1.4.1.  sip_trace()

Starts tracing for the currently processed SIP message. One of the tracing triggers must be set (the trace flags or traced user AVP).

Depending of the SIP transaction contect (if stateless or statefull) the function will perform either per SIP message tracing, either per SIP transaction tracing.


Example 1.14. sip_trace() usage


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.

One of the tracing triggers must be set (the trace flags or traced user AVP).

This function can be used from REQUEST_ROUTE.

Example 1.15. trace_dialog() usage

if(is_method("INVITE") && !has_totag())

1.5. Exported MI Functions

1.5.1.  sip_trace

Name: sip_trace


  • 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:


1.5.2.  trace_to_database

Name: trace_to_database


  • trace_to_db_mode : turns on/off SIP message tracing into DB. 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. The parameter can be switched from off to on, if db connection was before inizialized

MI FIFO Command Format:


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,

1.7. Known issues

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