How to Collect PBX Logs

When seeking support, it is often helpful to review the log files located in  /var/log/asterisk/sangomartapi/ to gather information.  /var/log/asterisk/sangomartapi/ 

• By default, these log files have their log levels set to 'warn'. however, there may be instances where it becomes necessary to set them to 'debug'.

  • To enable debug mode for SangomaRTAPI, you can navigate to the advanced settings under Sangoma RTAPI and modify the 'Enable RTAPI Logs' field.

  • After making these adjustments, the sangomartapi service needs to be reloaded using either the command "fwconsole reload" or "fwconsole pm2 --restart sangomartapi".

  • It is recommended to revert the log levels back to "warn" when debugging is no longer required to avoid unnecessary disk space usage.

The Sangoma Phone desktop client does most of its server interactions through the RealTimeAPI (module:  sangomartapi). To collect RealTimeAPI debugging logs from the PBX, ssh to your PBX and run the following command: 

Collect connect debug logs

tar -cvf /tmp/SangomaPhoneRtapiDebug.tar /var/log/asterisk/sangomartapi/*

Then collect the generated /tmp/SangomaPhoneRtapiDebug.tar file and share it with Sangoma Support.

Feature-Specific Logs for Enhanced Troubleshooting

In addition to the general logs, now we have the option to enable feature-specific logs for various functionalities within the system.
As of now the feature logs provide detailed debugging information related to queues, intercom, conferences, and making calls with features.

To enable the feature logs, navigate to the Sangoma RTAPI section located within the Advanced Settings page user interface.

Open

It is essential to ensure that the Enable RTAPI Logs field is enabled for the feature logs to function correctly.

Once the feature logs are enabled, they will be appended to the file "/var/log/asterisk/sangomartapi/rtapi_feature_logs.log.".
This log file is generated when feature actions are performed on a feature with logging enabled.
This consolidated file will contain the logs for all the listed features, providing a centralized location for easier troubleshooting and analysis.

By leveraging these feature-wise logs, you can gain insights into the specific functionalities and identify any potential issues or anomalies, enhancing the overall troubleshooting and debugging process.
Log enabled features

Features with logging enabled

1. Queue Log: Detailed logs of queue calls, queue member add/remove events, permission changes, etc. Both SCD and P phone queue logs will be displayed.

2. Intercom Log: Currently, the logs include SPD intercom call details.

3. Making Calls With Log: Detailed flow logging for making calls with the specified feature.

4. Conference Log: Logging of all conference-related events.