Enable QlikView QIX performance / telemetry logging

QlikView November 2018 introduces QIX performance logging (telemetry). The QIX performance log provides detailed information on the QIX Engine performance. By default, the QIX Performance log file is disabled.

See more details on the output provided on the official Qlik Help site.

Note that enabling this will lead to a large amount of data being written to disk.

Environment:

• QlikView November 2018 (12.30) and later

Enabling the QIX performance log

To enable the QIX performance log, you must add the line QixPerformanceLogVerbosity to the QlikView Server Service (QVS) Settings.ini file, followed by the desired level of verbosity. For example:

QixPerformanceLogVerbosity=3

The levels of verbosity for the QIX performance log are as follows:

• 0 = Off
• 1 = Fatal
• 2 = Error
• 3 = Warning
• 4 = Info
• 5 = Debug

If you enable the QIX performance log, and set QixPerformanceLogVerbosity to level 3 or 2, the following four threshold parameters must also be added to the Settings.ini file:

• WarningProcessTimeMs
• ErrorProcessTimeMs
• WarningPeakMemory
• ErrorPeakMemory

To set QIX Performance logging for the Warning level, perform the following steps:

1. Stop the QlikView Server service
2. Open the QlikView Server Service (QVS) Settings.ini file, which by default is located in: %ProgramData%\QlikTech\QlikViewServer
3. Add the following line under the [Settings 7]:
   • QixPerformanceLogVerbosity=3
4. Enter desired values for the four measurement levels
   • WarningProcessTimeMs=3000
   • ErrorProcessTimeMs=6000
   • WarningPeakMemory= 1073741824
   • ErrorPeakMemory= 2147483648
5. Save the Settings.ini file
6. Restart the QlikView Server Service (QVS)

Parameter Descriptions

• ErrorPeakMemory: Default 2147483648 bytes (2 Gb).  If an engine operation requires more than this value of Peak Memory, a record is logged with log level ‘error’.  Peak Memory is the maximum, transient amount of RAM an operation uses. 
   
• WarningPeakMemory: Default 1073741824 bytes (1 Gb).  If an engine operation requires more than this value of Peak Memory, a record is logged with log level ‘warning’.  Peak Memory is the maximum, transient amount of RAM an operation uses. 
   
• ErrorProcessTimeMs: Default 60000 millisecond (60 seconds).  If an engine operation requires more than this value of process time, a record is logged with log level ‘error’.  Process Time is the end-to-end clock time of a request.
   
• WarningProcessTimeMs: Default 30000 millisecond (30 seconds).  If an engine operation requires more than this value of process time, a record is logged with log level ‘warning’.  Process Time is the end-to-end clock time of a request.
   

Note that it is possible to track only process time or peak memory.  It is not required to track both metrics.  However, if you set ErrorPeakMemory, you must set WarningPeakMemory.  If you set ErrorProcessTimeMs, you must set WarningProcessTimeMs.

Output file
The QIX Performance log will be written to the directory as configured for QlikView Server logging in the QlikView Management Console > System > Setup > QlikView Server > QVS@ > Logging tab > Log Folder section. The naming convention of the log will be as <Servername>_QixPerformance_Engine.log

Performance note
The QIX performance logging produces heavy logging, especially when the setting is 4 or 5. These values are intended to do complex troubleshooting during a short interval of time.