Process Studio DEBUG Logging
The Process Studio uses Log4j2 for logging. By default, logging is set to INFO level. For troubleshooting, users can enable more detailed logging such as DEBUG.
To enable DEBUG logging:
-
Update the ProcessStudio.bat file:
-
Go to the installation directory and open the .bat file.
ProcessStudio.bat -
Add the following JVM Parameters before application startup:
-DAE_LOG_LEVEL=DEBUGNoteEnables DEBUG logging for AutomationEdge components only.
ImportantEnable Root Level DEBUG (Only if instructed).
-DROOT_LOG_LEVEL=DEBUGNoteEnables DEBUG logging for all components (global logging).
-
Save the changes. Stop the Process Studio and then start it again.
-
-
Log Levels in Log4j2
Log levels determine how much detail is captured in logs:
- Error: Critical issues that may cause application failure.
- Warn: Potential issues or warnings.
- Info: General application information (default).
- Debug: Detailed information for troubleshooting.
- TRACE: Very detailed logs (lowest level, rarely used).
NoteEach level includes all levels above it. For example, Debug includes Info, Warn, and Error.
-
All logs are stored in the logs folder inside the Process Studio directory:
-
Main Logs
logs/process-studio.log -
Copilot Logs
logs/ps_copilot.log
NoteCopilot logs capture activities and issues specifically related to Process Studio Copilot.
ImportantBest practice:
Start with:
-DAE_LOG_LEVEL=DEBUGEnable root-level DEBUG only if instructed by support.
DEBUG logging can:
- Impact performance
- Generate large log files
-
-
After troubleshooting, revert to INFO (default):
-DAE_LOG_LEVEL=INFOOR
Remove the parameter (default is INFO).
Summarizing the details:
- Default logging level is INFO.
- Use
-DAE_LOG_LEVEL=DEBUGfor troubleshooting AutomationEdge components. - Use
-DROOT_LOG_LEVEL=DEBUGonly when required. - Logs are stored under the logs folder.
- Copilot logs are stored separately in
ps_copilot.log. - Always revert settings after debugging.