You are here: Reference > Tools, accelerators, and wizards > About the Log Files tool

About the Log Files tool

Use the Log Files tool to view or download the current Pega log, Security log, Alert log, or other logs on the server node that you are accessing.

Access the Log Files tool by clicking Designer Studio > System > Operations > Logs.

Types of logs

The logs that display depend on the contents of the prlogging.xml file for the node. The following rows are listed by default in the Log File Download window:

Viewing the logs

Click a file name to view a log. Typically, the date portion of the file name indicates that this file contains only log instances since the start of that day (in local time on the server).

The initial display shows only lines of the log for your own Operator ID (for all your sessions on this node), in pages of 25 lines each. Click a number at the bottom of the display to see the corresponding page, or next to see the next group.

Click the Options link to view or set log filtering criteria.

Field

Description

Lines per page

Enter an integer between 1 and 200.

Number of Pages Presented

Set a maximum number of pages to present as numbered links, between 2 and 20.

Filter by

Optional. Enter a text string to limit the display to only lines containing an exact match anywhere within the line. Leave blank for no filtering.

Case is not significant. For example, enter [email protected] to find lines containing this value, or containing [email protected].

Click Apply to review the log again with updated criteria.

Click Back to return to the Log File Download window.

Downloading a log

Application server authentication might be required depending on your access settings, which are controlled by the PegaDiagnosticUser role in the web.xml file for the DiagnosticData servlet. Consult the Installation Guide for more information and instructions.

Note: Because of how the system writes log output, the contents on the disk log file might not yet contain recently written output, depending on volume.

Tools — System