SIPTRACE module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “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 http://www.sipcapture.org)
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
### Dependencies
#### OpenSIPS Modules
The following modules must be loaded before this module:
- *database module* - mysql, postrgress,dbtext, unixodbc...- *tm and sl modules* - optional, only ifyou want to trace messages forwarded by these modules.
#### External Libraries or Applications
The following libraries or applications must be installed before runningOpenSIPS with this module loaded:
- *None*.
### Exported Parameters
#### db_url (str)
Database URL.
*Default value is "".*
```opensips title="Set db_url parameter"...modparam("siptrace", "db_url", "mysql://user:passwd@host/dbname")...trace_flag (string/integer)
Section titled “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).
...modparam("siptrace", "trace_flag", "TRACE_FLAG")...trace_on (integer)
Section titled “trace_on (integer)”Parameter to enable/disable trace (on(1)/off(0))
Default value is “0”.
...modparam("siptrace", "trace_on", 1)...enable_ack_trace (integer)
Section titled “enable_ack_trace (integer)”Parameter to enable/disable tracing of statelessly received ACKs (on(1)/off(0))
Default value is “0”.
...modparam("siptrace", "enable_ack_trace", 1)...traced_user_avp (str)
Section titled “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).
...modparam("siptrace", "traced_user_avp", "$avp(123)")modparam("siptrace", "traced_user_avp", "$avp(user)")...trace_table_avp (str)
Section titled “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).
...modparam("siptrace", "trace_table_avp", "$avp(345)")modparam("siptrace", "trace_table_avp", "$avp(siptrace_table)")...duplicate_uri (str)
Section titled “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”.
...modparam("siptrace", "duplicate_uri", "sip:10.1.1.1:5888")...trace_local_ip (str)
Section titled “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”.
...modparam("siptrace", "trace_local_ip", "10.1.1.1:5064")...table (str)
Section titled “table (str)”Name of the table where to store the SIP messages.
Default value is “sip_trace”.
...modparam("siptrace", "table", "strace")...trace_to_database (integer)
Section titled “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”.
...modparam("siptrace", "trace_to_database", 0)...duplicate_with_hep (integer)
Section titled “duplicate_with_hep (integer)”Parameter to enable/disable homer encapsulate mode (on(1)/off(0))
Default value is “0”.
...modparam("siptrace", "duplicate_with_hep", 1)...hep_version (integer)
Section titled “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”.
...modparam("siptrace", "hep_version", 2)...hep_capture_id (integer)
Section titled “hep_capture_id (integer)”The parameter indicate the capture agent ID for HEPv2 protocol. Limitation: 16-bit integer.
Default value is “1”.
...modparam("siptrace", "hep_capture_id", 234)...Exported Functions
Section titled “Exported Functions”sip_trace()
Section titled “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.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
...sip_trace();...trace_dialog()
Section titled “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.
...if(is_method("INVITE") && !has_totag()) trace_dialog();...Exported MI Functions
Section titled “Exported MI Functions”sip_trace
Section titled “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_trace_to_database
Section titled “trace_to_database”Name: trace_to_database
Parameters:
-
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:
:trace_to_database:_reply_fifo_file_ trace_to_db_mode _empty_line_Database setup
Section titled “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.
Known Issues
Section titled “Known Issues”Stateless forwarded messages (forward()) are not logged if you set the flag, use sip_trace().
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 62 | 46 | 755 | 542 |
| 2. | Daniel-Constantin Mierla (@miconda) | 49 | 26 | 2247 | 223 |
| 3. | Vlad Paiu (@vladpaiu) | 20 | 8 | 337 | 530 |
| 4. | Razvan Crainea (@razvancrainea) | 16 | 9 | 244 | 199 |
| 5. | Stefan Darius (@dariusstefan) | 12 | 5 | 524 | 78 |
| 6. | Henning Westerholt (@henningw) | 11 | 6 | 158 | 167 |
| 7. | Liviu Chircu (@liviuchircu) | 8 | 6 | 20 | 9 |
| 8. | Alexandr Dubovikov (@adubovikov) | 7 | 1 | 527 | 31 |
| 9. | Dusan Klinec (@ph4r05) | 5 | 3 | 10 | 6 |
| 10. | Andreas Heise | 4 | 1 | 90 | 102 |
All remaining contributors: Sergio Gutierrez, Ionut Ionita (@ionutrazvanionita), Dan Pascu (@danpascu), Konstantin Bokarius, Iouri Kharon, Edson Gellert Schubert, Elena-Ramona Modroiu.
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Jun 2011 - Jun 2026 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jul 2006 - May 2017 |
| 4. | Liviu Chircu (@liviuchircu) | Jan 2013 - Oct 2016 |
| 5. | Ionut Ionita (@ionutrazvanionita) | Jan 2016 - Jan 2016 |
| 6. | Dusan Klinec (@ph4r05) | Dec 2015 - Jan 2016 |
| 7. | Vlad Paiu (@vladpaiu) | Jun 2011 - Nov 2013 |
| 8. | Alexandr Dubovikov (@adubovikov) | Nov 2011 - Nov 2011 |
| 9. | Sergio Gutierrez | Sep 2009 - Sep 2009 |
| 10. | Dan Pascu (@danpascu) | Nov 2008 - Nov 2008 |
All remaining contributors: Daniel-Constantin Mierla (@miconda), Iouri Kharon, Konstantin Bokarius, Edson Gellert Schubert, Henning Westerholt (@henningw), Andreas Heise, Elena-Ramona Modroiu.
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Alexandr Dubovikov (@adubovikov), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Henning Westerholt (@henningw), Elena-Ramona Modroiu.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0