PortSIP has built the PortSIP Trace Server on top of the open-source HOMER project to provide a powerful, centralized solution for troubleshooting SIP signaling, SIP trunks, endpoints, and media quality issues.
The Trace Server enables you to:
Access SIP and RTCP (QoS) captures through a web-based UI
Centrally store SIP capture data from multiple hosts
Filter SIP messages intuitively and correlate them to dialogs and transactions
Automatically age out capture data after a configurable retention period
Visualize calls and RTCP QoS metrics using clear, interactive charts
Supported Operating Systems
Ubuntu: 20.04, 22.04, 24.04
Architecture: 64-bit only
Preparing the Linux Host
Because the Trace Server processes a high volume of SIP and RTCP data, it requires sufficient CPU and memory resources.
Recommended Hardware Specifications
Concurrent Calls
CPU Cores
Memory
Important
The PortSIP Trace Server must not be installed on the same server as the PortSIP PBX. Running both services on one host may lead to performance degradation or undefined behavior.
Firewall Requirements
Ensure that the server firewall and any cloud security groups allow the following ports:
TCP 9061 – Receiving SIP messages from PortSIP PBX
TCP 9080 – Trace Server Web Portal
Installing PortSIP Trace Server
System date and time must be correctly synchronized
All commands must be executed as root
Download Installation Scripts
Install the Docker Environment
Run the Trace Server (Default Settings)
Optional Runtime Parameters
You can customize the Trace Server using the following options:
-p – Data storage path (default: /var/lib/portsip)
-k – Retention period in days (default: 5)
-l – Web portal listening port (default: 9080)
-z – SIP message receiving port (default: 9061)
Note
Ensure the specified data path contains no spaces.
Example: Custom Configuration
Data path: /opt/portsip/trace
SIP receiving port: 23456
Accessing the Trace Server Web Portal
If deployed on a cloud platform, ensure the web portal port is allowed in the cloud firewall or security group.
Default Credentials
Security Recommendation
Change the default password immediately after first login.
Enabling SIP Trace in PortSIP PBX
Sign in to the PortSIP PBX Web Portal
Go to: Advanced > Settings
On the General page, enter the Trace Server details:
Trace Server Port (default: 9061 or the value specified with -z)
After configuration, the PBX will forward all SIP messages to the Trace Server.
Important
Always enter the actual Trace Server IP and port used during installation.
Disabling SIP Trace in PortSIP PBX
Go to: Advanced > Settings
Clear the Trace Server IP and Port fields
Best Practice
SIP tracing should remain disabled during normal operation and enabled only for troubleshooting, as continuous tracing consumes CPU, memory, and disk resources and may affect PBX performance.
Troubleshooting SIP Messages
In the Trace Server Web Portal:
Select Home to view call-related SIP messages
Select REGISTRATION to view REGISTER traffic
Click a SIP method name to view detailed message contents.
Advanced Searching
You can search SIP messages using:
These identifiers allow precise tracking of calls across multiple legs and systems.
Clicking a Session ID displays the complete SIP call flow for that session.
Troubleshooting RTP and QoS
The Trace Server supports monitoring call quality using RTCP data.
Analyze metrics such as:
Other RTP quality indicators
These charts help identify media issues such as network congestion, packet loss, or jitter spikes.
Managing the Trace Server
Use the following commands to manage the service:
Upgrading the Trace Server
To upgrade to the latest version: