Enabling verbose-level Runtime logging
|Curator Assigned||Michael Chambers|
|Request to Publish|
|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|
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ Please Read Below ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
Enter your content below. Use the basic wiki template that is provided to organize your content. After making your edits, add a summary comment that briefly describes your work, and then click "SAVE". To edit your content later, select the page from your "Watchlist" summary. If you can not find your article, search the design pattern title.
When your content is ready for publishing, next to the "Request to Publish" field above, type "Yes". A Curator then reviews and publishes the content, which might take up to 48 hours.
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ The above text will be removed prior to being published ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
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:
- Before starting Pega Robot Runtime, navigate to the RuntimeConfig.xml file.
- Open the xml file in your preferred text editor.
- Find type=“OpenSpan.Diagnostics.Publishers.FilePublisher" near the top of the document. On the same line, set the publisher mode to on.
- Towards the bottom of the file, find the <LogCategories> section. For each category, change the logLevel attribute from its current value to 4.
In Notepad, all logLevels can be set to 4 at once, using the Ctrl+H and Replace window.
- Save the file.
- Re-create the issue that you experienced. Take note of when you began the steps to re-create the issue and when you finished.
- After you re-create the issue, turn off the logging by setting the publisher mode to off for type=“OpenSpan.Diagnostics.Publishers.FilePublisher”.
- Collect the log file, timestamps, and any additional notes about the issue and provide them to your Support Engineer for analysis.
You can find the log files in the same folder as the RuntimeConfig.xml file. The file is assigned the name RuntimeLog.txt.