Skip to main content

Logging settings

You can set the server logging level, configure automatic roll over and cleanup, and view and download log files.

Setting the logging level

The logging level determines what type of information is written to the log files. The log files provide information about Qlik Compose Server and Qlik Compose Agent processes.

The following logging levels are available (ordered from the lowest level to the highest level):

  1. Errors
  2. Warnings
  3. Info
  4. Trace
  5. Verbose

The higher levels always include the messages from the lower levels. Therefore, if you select Error, only error messages are written to the log files. However, if you select Info, informational messages, warnings, and error messages will be included. Selecting Verbose writes all possible messages to the log.

  1. From the Management menu, select Logs|Log Management. The Log Management window opens displaying the Server Log tab.

  2. To set a global logging level, move the top slider to the desired logging level. All of the sliders for the individual modules move to the same level that you set in the main slider.
  3. To set a logging level for individual Compose components, select a module and then move its slider to the desired logging level.

  4. Click OK to save your changes and close the Log Management window.
  1. From the Management menu, select Logs|Log Management. The Log Management window opens displaying the Server Log tab.

  2. Select the Qlik Compose Agent log tab, and then move the slider to the desired logging level.

  3. Click OK to save your changes and close the Log Management window.
Note:

Changes to the logging level take place immediately. There is no need to restart the Qlik Compose service.

Setting automatic roll over and cleanup

You can define when log files should be automatically rolled over as well as how many log files to keep. Rolling over log files keeps any single log file from becoming too large and provides an easy way to identify files that are no longer being used so that an automated script can clean the logging directory. Automatic deletion of old log files ensures that the logs do not take up too much disk space when there is a lot of activity in the system.

  1. From the Management menu, select Logs|Log Management. The Log Management window opens.

  2. Select the Log Settings tab.
  3. The following options are available:

    • Enable automatic roll over: Select this check box to determine the maximum size a log file can reach before it is rolled over. The current log file is called Compose.log and saved (older) log files are called Compose_xxxxxxxxxxxx.log where xxxxxxxxxxxx represents a 12-digit timestamp.

      • Roll over the log if the log file is larger than (MB): Use the counter or type in the maximum amount of megabytes for a specific log file. When the log file reaches the specified size, the old log is saved with a timestamp appended to its name and a new log file is started. The default value is 10 megabytes.

      Note:

      The scheduled job that checks the log size runs every five minutes. Consequently, the actual size of the log when rolled over might be larger than specified.

    • Enable automatic cleanup: Select this check box to define the maximum number of log files to keep.

      • Maximum number of log files to keep: Use the counter or type in the maximum number of log files to keep. When the number of log files reaches the specified maximum, Compose will delete the oldest log file whenever a new log file is created, thereby ensuring the number of log files never exceeds the set limit. The default is 45.

  4. Click OK to save your settings and close the Log Management window.

Viewing and downloading Compose log files

This section explains how to view and download Compose log files.

Note:

The logs are in four different locations:

  • <product_dir>\data\logs – Server log file
  • <product_dir>\java\data\logsCompose Agent log file
  • <product_dir>\data\projects\<project_name>\logs – project logs , workflow logs, and command task logs
  1. From the Management menu, select Logs|View Logs. The Log File Viewer opens.

  2. Select the log file you want to view from the list in the Log Files pane.

    The contents of the log file will be displayed in the right pane. When you select a row in the log file, a tooltip will display the full message of the selected row.

  3. Browse through the log file using the scroll bar on the right and the navigation buttons at the top of the window.
  4. To search for a specific string in the log file, enter the search string in the search box at the top of the window. Any terms that match the specified string will be highlighted blue.

  1. From the Management menu, select Logs|View Logs. The Log File Viewer opens.

  2. From the list in the Log Files pane, select the log file you want to download.
  3. Click the Download Log File button in the top right of the window. The log file is downloaded.