Configuring Logging

In the vgwproperties.txt file, Vocera SIP Telephony Gateway and Vocera Client Gateway provide several properties that let you control logging.

Table 1. Logging properties

Property

Description

PJSIPLogLevel

Controls the level of logging from the PJSIP stack. Specify a value from 1 (least amount of logging) to 10 (greatest amount of logging). Generally, you should set this to 5 or lower unless you are experiencing problems. The default is 4.

VCGLogOPTIONSPayload

Specifies whether to log the payload in the OPTIONS message for a call. The default is FALSE. If you want to see what's being passed for debugging purposes, set it to TRUE.

VGWConsoleLoggingLevel

Sets the logging level for the console. Specify 0 to 8, 0 being the least amount of logging and 8 being the most. The default is 4 (DEBUG).

0 = FATAL
1 = ERROR
2 = WARNING
3 = INFO
4 = DEBUG
5 = PJSIP
6 = SIP_MSGS
7 = DEBUG_VERBOSE
8 = RTP_INFO

If you specify 5 (PJSIP), the amount of PJSIP logging depends on the PJSIPLogLevel property.

VGWFileLoggingLevel

Sets the logging level for the log file. Specify 0 to 8, 0 being the least amount of logging and 8 being the most. See VGWConsoleLoggingLevel for the list of logging levels. The default is 6 (SIP_MSGS).

VGWMaxLinesPerLogfile

Sets the maximum size of each log file. The default is 70,000 lines.

VGWNumLogFilesToKeep

Sets the maximum number of log files to keep for the current gateway process. If you have plenty of disk space available and you do not want to delete older log files, you can set this property to 0. The default is 50.

Note: Each time the gateway service is stopped and started, it will create up to VGWNumLogFilesToKeep new log files.

VGWMaxDaysToKeepLogfiles

Sets the maximum number of days to keep log files for the current gateway process. The default is 21 days. When the Vocera SIP Telephony Gateway or Vocera Client Gateway is started, it finds log files that have not been modified within the VGWMaxDaysToKeepLogfiles period, and it deletes those files. This keeps the logs directory from growing too large.

To preserve all log files and not automatically delete them, set VGWMaxDaysToKeepLogfiles to 0.

VCGLogMaxLines

Sets the maximum size of each VCG console log file. This property does not affect the size of debug log files. The default is 100,000 lines.

VCGLogMaxFiles

Sets the maximum number of VCG console log files. The default is 100 files.

VTGLogMaxLines

Sets the maximum size of each VSTG console log file. This property does not affect the size of debug log files. The default is 100,000 lines.

VTGLogMaxFiles

Sets the maximum number of VSTG console log files. The default is 100 files.

Both Vocera SIP Telephony Gateway and Vocera Client Gateway maintain log files in their own \vocera\logs directory. The names of these files begin with the vtg and vcg prefixes, respectively. The names of debug-level logs, which have more detail than the console logs, begin with the vtg-dlog and vcg-dlog prefixes, respectively.

Each Vocera SIP Telephony Gateway and Vocera Client Gateway log statement has a preamble consisting of four sections: