We are currently experiencing minor technical difficulties. All Design Patterns are available and search is working. We expect to have the Portal pages working again shortly.

Difference between revisions of "Enabling verbose-level Runtime logging"

From PegaWiki
Jump to navigation Jump to search
(Added new template table prior to publishing)
Tag: Visual edit
(Added an Overview heading and sub-heading formatting)
Tag: Visual edit
Line 1: Line 1:
 
{{Design pattern|Title=Enabling verbose-level Runtime logging|Description=How to implement verbose-level logging to diagnose issues in Runtime|Version=19.1, 8.0 SP1|Applications=Robotic Process Automation|Capability Area=Robotic Automation|Owner=Michael Chambers}}
 
{{Design pattern|Title=Enabling verbose-level Runtime logging|Description=How to implement verbose-level logging to diagnose issues in Runtime|Version=19.1, 8.0 SP1|Applications=Robotic Process Automation|Capability Area=Robotic Automation|Owner=Michael Chambers}}
  
 +
=== Overview ===
 
Capturing verbose-level Runtime logging files can help to diagnose and resolve errors, when requested by the Pega Robotic Automation support team. The default location of the RuntimeConfig.xml may differ depending on the version of the product.  
 
Capturing verbose-level Runtime logging files can help to diagnose and resolve errors, when requested by the Pega Robotic Automation support team. The default location of the RuntimeConfig.xml may differ depending on the version of the product.  
 
* For Robot Runtime version v19.1: '''%appdata%\Pegasystems'''
 
* For Robot Runtime version v19.1: '''%appdata%\Pegasystems'''
 
* For Robot Runtime version 8.0 SP1 and earlier: '''%appdata%\Openspan'''
 
* For Robot Runtime version 8.0 SP1 and earlier: '''%appdata%\Openspan'''
  
== Use case example ==
+
=== Use case example ===
 
If you are designing an automation with Pega Robot Studio, and it isn't working as expected, verbose logging can help you or Pega Support determine what the issue is.  
 
If you are designing an automation with Pega Robot Studio, and it isn't working as expected, verbose logging can help you or Pega Support determine what the issue is.  
  
== Modifying the RuntimeConfig.xml file ==
+
=== Modifying the RuntimeConfig.xml file ===
 
To enable verbose logging, perform the following steps:  
 
To enable verbose logging, perform the following steps:  
 
# Before starting Pega Robot Runtime, navigate to the RuntimeConfig.xml file.  
 
# Before starting Pega Robot Runtime, navigate to the RuntimeConfig.xml file.  
Line 21: Line 22:
 
# Collect the log file, timestamps, and any additional notes about the issue and provide them to your Support Engineer for analysis.
 
# Collect the log file, timestamps, and any additional notes about the issue and provide them to your Support Engineer for analysis.
  
== Results ==
+
=== Results ===
 
You can find the log files in the same folder as the RuntimeConfig.xml file. The file is assigned the name RuntimeLog.txt.
 
You can find the log files in the same folder as the RuntimeConfig.xml file. The file is assigned the name RuntimeLog.txt.

Revision as of 15:36, 8 February 2021

Enabling verbose-level Runtime logging

Description How to implement verbose-level logging to diagnose issues in Runtime
Version as of 19.1, 8.0 SP1
Application Robotic Process Automation
Capability/Industry Area Robotic Automation



Overview

Capturing verbose-level Runtime logging files can help to diagnose and resolve errors, when requested by the Pega Robotic Automation support team. The default location of the RuntimeConfig.xml may differ depending on the version of the product.

  • For Robot Runtime version v19.1: %appdata%\Pegasystems
  • For Robot Runtime version 8.0 SP1 and earlier: %appdata%\Openspan

Use case example

If you are designing an automation with Pega Robot Studio, and it isn't working as expected, verbose logging can help you or Pega Support determine what the issue is.

Modifying the RuntimeConfig.xml file

To enable verbose logging, perform the following steps:

  1. Before starting Pega Robot Runtime, navigate to the RuntimeConfig.xml file.
  2. Open the xml file in your preferred text editor.
  3. Find type=“OpenSpan.Diagnostics.Publishers.FilePublisher" near the top of the document. On the same line, set the publisher mode to on.
  4. Towards the bottom of the file, find the <LogCategories> section. For each category, change the logLevel attribute from its current value to 4.
logLevel attribute for verbose logging

In Notepad, all logLevels can be set to 4 at once, using the Ctrl+H and Replace window.

  1. Save the file.
  2. Re-create the issue that you experienced. Take note of when you began the steps to re-create the issue and when you finished.
  3. After you re-create the issue, turn off the logging by setting the publisher mode to off  for type=“OpenSpan.Diagnostics.Publishers.FilePublisher”.
  4. Collect the log file, timestamps, and any additional notes about the issue and provide them to your Support Engineer for analysis.

Results

You can find the log files in the same folder as the RuntimeConfig.xml file. The file is assigned the name RuntimeLog.txt.