/pega-logviewer

The log viewing tool helps users understand and debug Pega log files. To download the tool, click on the "release" link, scroll to the bottom, and download the logviewer zip file.

Primary LanguageJavaApache License 2.0Apache-2.0

Pega-LogViewer

Java CI with Gradle GitHub tag JitPack

Pega-LogViewer is a Java Swing based tool to view most Pega generated log files

  • Rules
  • Alert
  • Alert overviews with aggregation
  • SecurityAlert
  • CTI
  • Hotfix scan inventory zip files.
  • System state output (Pega 7.4+) (both json and zip).

For Pega RULES and ALERT file, the line/entries are shown in a table format. The columns are marked based on the log pattern.

The log pattern used are the ootb ones from prlogging.xml -> PEGA appender.

Some customers updates PEGA appender pattern. In case the tool can't recognize the pattern automatically, it will present a dialog to enter the pattern, so you might be required to get customised pattern from prlogging.xml or prlog4j2.xml.

For PegaRULES log the row entries are color coded based on log level, Red for Error, Green for Info, Light Blue for Debug etc. For ALERT log, only Critical Alerts entries are coded Red.

The timeline graph is governed by the data in the table. in case you filter the data in the table using any of the column filter, the chart will change.

Features

  • See memory, requestor counts in a chart.
  • System starts, exceptions and thread dump occurences are superimposed on the timeline.
  • Search within the file output for useful content. results are highlighted in yellow
  • Set Filters for certain Log and Alert data columns.
  • Overview dialog to show (if any)
    • PegaRULES log
      1. System Start details
      2. Errors
      3. Thread Dumps
      4. Bookmarks
      5. Search results
    • Pega ALERT log
      1. Alert Overview with consolidated Alerts statistics
      2. Individual Alert tabs with details.

How it works :

  • Note: Java is required (Min version: Java 11) and JAVA_HOME env variable needs to be set to run this applicaiton.

The tool can be downloaded from Releases page under Assets section.

  1. Extract 'pega-logviewer-<version>.zip' to a folder.
  2. The tool is launched using the one of the scripts in the ‘bin’ folder. For Windows - ‘pega-logviewer.bat’ For ubuntu and Mac - ‘pega-logviewer’
  3. Ootb, heap size is set to 4G.
  4. The heap size and other jvm parameter can be updated by modifying the launch script and updating the ‘DEFAULT_JVM_OPTS’ variable.

Build from source :

To build the project use the following command:

$ ./gradlew build

The release build is 'pega-logviewer-<version>-SNAPSHOT.zip' file under \build\distributions folder.

The project can be run from the gradle command line with the following command:

$ ./gradlew run

PegaRULES log file:

PegaRULES-ALERT log file:

PegaRULES-ALERT Overview Dialog

![][alertlog_overview]