Trace server - A Better Way to Debug PortSIP UC
PortSIP has been building its SIP Trace Server base on the open-source project HOMER, which provides key information in troubleshooting SIP Trunks, SIP endpoints, and other SIP related issues. It provides a place to:
- Access singularly to retrieve SIP captures via Web UI
- Centrally store SIP capture data across many hosts
- More intuitively filter SIP capture data and correlate the data to the dialog/transactions each request/response is part of (this is immensely useful!)
- Gracefully age dated capture data you don’t want to persist for very long (though persisting longer term can be configured very easily)
- Charts! glorious charts!
- CentOS: 7.9
- Ubuntu: 18.04, 20.04, 22.04
- Debian: 10, 11
- Only supports 64bit OS
Since the Trace server usually will take large CPU and memory resources, we recommend below hardware specifications for the SIP Trace Server:
- CPU: 2-4 cores
- Memory: 2G - 4G
- CPU: 4 cores
- Memory: 4G
- CPU: 8 - 10 cores
- Memory: 8G
- CPU: 16 - 20 cores
- Memory: 16G
Important: Don't install the PortSIP Trace Server on the same server as the PortSIP PBX, since it will consume large resources and cause the PBX to not work smoothly.
We recommend installing the PortSIP Trace Server on the same LAN as the PortSIP PBX.
The firewall and cloud platform security group must allow the ports listed below.
- Port 9061 on TCP
- Port 9060 on TCP
- Ensure server date-time is synced correctly
- Must perform all Linux commands by the root user, please su root first
curl https://raw.githubusercontent.com/portsip/portsip-pbx-sh/master/trace-server/trace-server.sh -o trace-server.sh
/bin/sh trace-server.sh start
After the PortSIP Trace Server is successfully installed, you can access the trace server Web Portal by below URL:
The user name is
admin, the password is
Sign in to the PortSIP PBX Web Portal, click "Advanced" > "Settings", on the "General" page, and fill out the trace server information as shown in the below screenshot:
Important: replace the IP
192.168.1.17with your trance server IP.
After successfully setting up the SIP trace server information and clicking the "OK" button, the PBX will send all SIP messages to the trace server.
Sign in to the PortSIP PBX Web Portal, click "Advanced" > "Settings", on the "General" page, remove the information from the trace server fields, and click the "OK" button, the PortSIP PBX will stop to send the SIP message to trace server.
Important: SIP Trace should be off most of the time and only enabled when troubleshooting is required.
You can choose to display the registration messages or the call SIP messages on the SIP Trace Server Web Portal, as seen in the screenshot below; the "Home" is for calls, and the "REGISTRATION" is for the REGISTER messages.
You can view the details of a message by clicking on the method name, as shown in the screenshot below.
There is the way to check the call-id, X-Session-Id, and X-CID of the SIP message are as follows:
call-id, X-Session-Id, and X-CID can now be used to search SIP messages.
From the messages list, we can see the call flow by clicking the Session ID.
/bin/sh trace-server.sh start
/bin/sh trace-server.sh stop
/bin/sh trace-server.sh remove