Starting from 2023 version a new functionality was added on top of OpenSIPS 3.4 - export of SIP log data to the remote system like Kamalio or Homer for further analysis.
This was made possible with the usage of proto_hep module.
HEP Tracing should only be enabled through the web interface at System Management - SIP Features - SIP, Media, LRN, HEP. This should not be configured through our xmlapi system, since this way will allow for checks to verify you are using the correct version of OpenSIPS prior to making this configuration change.
Below is an example of how to set up HEP parameters:
Setup from Sippy side allows to set the following parameters in system_config:
- Enable - true to enable, false to disable export. If disabled, previously saved HEP settings are retained in the database, so you can restore or adjust them later by simply re-enabling HEP.
- Local (Source) Port - port from which SIP logs are sent via HEP. Must be a number in the range 1–65535 and cannot be left empty.
- Collector - hostname/IP address of remote system where to send the logs to. E.g. 1.2.3.4:5060
- Transport - the HEP transport protocol can be UDP or TCP.
- only UDP transport is supported as of 2023 version (11.04.2025)
- TCP can be chosen at your own risk. If TCP is selected, the system will warn you that it is not recommended.
- HEP Version - possible values for version are 1,2,3. 2 for UDP and 3 for TCP. If using TCP then version 3 will be automatically set. Other combinations may cause export to fallback to UDP.
When HEP is disabled, the previously saved HEP configuration (Local Port, Collector, Transport, HEP Version) is retained in the database. Re-enabling HEP later automatically restores those values for further editing.