Configure VoiceConsole On Prem Deployment Logs

This topic applies only to VoiceConsole On Prem deployment customers.

The Logs page in the Administration tab of a VoiceConsole On Prem deployment user interface displays several types of logs. Logs track user activities in the application and are useful for analyzing unexpected issues. Many of the logs listed on this page are generated by Apache Tomcat. In most cases, you do not need to reference these logs.

For troubleshooting purposes, you may need to review logs specific to the VoiceConsole On Prem deployment. These logs are created using log4 (learn more at https://logging.apache.org/log4j/).

  • VoiceConsole.log: Contains INFO, WARN, ERROR, and FATAL level messages that result from device communication or user actions.
  • VoiceConsole.err: Contains a subset of the VoiceConsole log. It contains all information logged at a level ERROR or more critical.

Log Count and Maximum Size

By default, a VoiceConsole On Prem deployment keeps up to 30 log files and 30 archived log files, each at a maximum size of 4 MB. You can increase the number or size of the log files if necessary.

To change the log size and count for VoiceConsole.log and VoiceConsole.err, perform the following steps.

  1. Stop the VocollectWebApplicationsVC service.
  2. Find the logging configuration file at InstallLocation\VoiceConsole\tomcat\webapps\VoiceConsole\WEB-INF\classes\log4j.properties.
  3. Open log4j.properties in a text editor.
  4. Modify the MaxFileSize or MaxBackupIndex properties as shown below.
    VoiceConsole.log parameters for logs
    log4j.appender.voc.MaxFileSize=4MB
    log4j.appender.voc.MaxBackupIndex=30
    VoiceConsole.log parameters for archived logs
    log4j.appender.voc.MaxArchiveFileSize=4MB
    log4j.appender.voc.MaxArchiveBackupIndex=30

     


    VoiceConsole.err parameters for logs
    log4j.appender.voc_err.MaxFileSize=4MB
    log4j.appender.voc_err.MaxBackupIndex=30
    VoiceConsole.err parameters for archived logs
    log4j.appender.voc_err.MaxArchiveFileSize=4MB
    log4j.appender.voc_err.MaxArchiveBackupIndex=30
    The MaxFileSize and MaxBackupIndex values should not exceed the space available where the logs are stored.
  5. Save your changes.
  6. Restart the VocollectWebApplicationsVC service.

Log Location

The location of the VoiceConsole.log and VoiceConsole.err is specified during installation.

To change the log location at any time after installation, perform the following steps.

  1. Stop the VocollectWebApplicationsVC service.
  2. Find the logging properties files at InstallLocation\VoiceConsole\tomcat\webapps\VoiceConsole\WEB-INF\classes.
  3. Open log.properties in a text editor.
  4. Modify the system.log.directory value.
    system.log.directory=C:\\Program Files\\Vocollect\\VoiceConsole\\Logs
  5. Save your changes.
  6. Open log4j.properties in a text editor.
  7. Modify the applicationLogs value.
    applicationLogs=C:\\Program Files\\Vocollect\\VoiceConsole\\Logs
  8. Save your changes.
  9. Restart the VocollectWebApplicationsVC service.