Working with Logs

The Logs page (Monitoring | Logs) is a log viewer for developers to view log information directly from the UI. From this page you can view, filter, navigate, export and refresh logs.

Advanced users can also add logs to the list of logs to display in the Log Display area.

This procedure describes how to view a log file.

Instructions on how to complete a procedure

To view a log file:

  1. In the UI, go to Monitoring | Logs.

  2. In the case of a cluster, from the Servers and Log Files list on the left, select a server from the drop-down menu.

  3. Select a log to view.

  4. The log information is displayed in the Logs Display area, with log file details displayed above (Log file name, number of lines, file size, last updated time stamp).

This procedure describes how to filter a log file to fine tune the information to display specific results.

Instructions on how to complete a procedure

To filter a log file:

  1. In the UI, go to Monitoring | Logs.

  2. Select a log to display.

  3. In the Action bar, use the available filters:

    • Search - Enter any text to search for patters within the log
    • Lines - Enter number of lines to be displayed (20-200).

  4. Press Enter.
    The results are displayed in the Logs Display area.

The following procedure describes how to display the most recent log entries in the last lines of the log that is currently being viewed.

Instructions on how to complete a procedure

To refresh a log:

  1. In the UI, go to Monitoring | Logs.

  2. Select a log to display.
  3. Click Refresh.

As long as the log is displayed, the information is refreshed. Each time you choose another log or exit the page, the settings are reset.

This procedure explains how to export logs by downloading them to your machine.

Instructions on how to complete a procedure

To download a log file:

  1. In the UI, go to Monitoring | Logs.

  2. From the Log Files list on the left, select a log.

  3. Click Download..
  4. Select a location to download the log file to, and click Save.
    The log file is downloaded to the selected location.

You can add and display other logs that are specific to your environment.

Warning!

This procedure requires that you view and access back-end application files which, in normal circumstances, should not be changed. For this reason, we highly recommend that you perform this task only if you clearly understand the supplied instructions.

Instructions on how to complete a procedure

To add log files to the list:

  1. Open the 'var/db/gui.db' file with your favorite SQLite browser (In cluster MYSQL).

  2. Insert a record into the 'GUI_AVAILABLE_LOGS' table in the same format as the existing files:

    • NAME - Name of log

    • ENABLED - Boolean 1 or 0

    • FILEPATH - Absolute file path to the log file

      -OR-

    • DIRECTIVE - Collect the file path from a known (ZSD) php directive

Note:

These last two entries are mutually exclusive.

  1. Save.
  2. Restart your server.