[KBA-76408] How to enable the Sipelia™ VoIP logs in Sipelia™ 2.4 GA and later - Sipelia 2.4 GA and later

series
Sipelia 2.4 GA and later
revised_modified
2018-03-21

[KBA-76408] How to enable the Sipelia™ VoIP logs in Sipelia™ 2.4 GA and later

This article describes how to enable the VoIP logs in the Sipelia™ product.

Summary

The Sipelia product VoIP logs provide greater visibility and detailed diagnostic information about Sipelia issues related to the SIP protocol. By default, the Sipelia VoIP logs are disabled in the product. Logs can be enabled separately for the Sipelia Security Desk client and the Sipelia Plugin (server).

IMPORTANT: Because the VoIP logs generate a lot of information that can take up much of your disk space, you must disable the logs after you have gathered the required information.

To enable the VoIP logs for Sipelia Security Desk client:

  1. Close Security Desk and Config Tool.
  2. Go to the following path: %PROGRAMDATA%\Genetec Sipelia\Logs\Client.
  3. Edit the SipeliaLogger.config configuration file. Note that the log configuration file is case sensitive.
  4. Locate the FileLogger XML element under the VoIPSDK element and change the Enabled attribute value from False to True.
  5. Set the required log level by changing the Level attribute (for example, to Debug). Other log levels include: Trace, Debug, Info, Warn, Error.
    NOTE: Use Trace level for gathering diagnostic logs.
  6. Save your changes.
  7. Start Security Desk.

As SIP activity occurs, in Security Desk you will see a new file named Client_VoIPSDK_Log.log that appears in the following directory: %PROGRAMDATA%\Genetec Sipelia\Logs. This file is the Sipelia VoIP client log.

To enable the VoIP logs for Sipelia Plugin (server):

  1. Deactivate the Sipelia plugin role.
  2. Go to the following path: %PROGRAMDATA%\Genetec Sipelia\Logs\Server.
  3. Edit the SipeliaLogger.config configuration file. Note that the log configuration file is case sensitive.
  4. Locate the FileLogger XML element under the VoIPSDK element and change the Enabled attribute value from False to True.
  5. Set the required log level by changing the Level attribute (for example, to Debug). Other log levels include: Trace, Debug, Info, Warn, Error.
    NOTE: Use Trace level for gathering diagnostic logs.
  6. Save your changes.
  7. Activate the Sipelia plugin role.

As SIP activity occurs, in Security Desk you will see a new file named Server_VoIPSDK_Log.log that appears in the following directory: %PROGRAMDATA%\Genetec Sipelia\Logs. This file is the Sipelia VoIP server log.

More Information

If you accidentally corrupt the XML configuration file and are unable to return it to its normal state, you can restore the configuration file to its default state. To restore the configuration file to its default state, delete the file and then restart whichever application you are currently using; either Security Desk or the Sipelia Plugin role.