Skip to main content

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:

  1. Update the ProcessStudio.bat file:

    1. Go to the installation directory and open the .bat file.

      ProcessStudio.bat
    2. Add the following JVM Parameters before application startup:

      -DAE_LOG_LEVEL=DEBUG
      Note

      Enables DEBUG logging for AutomationEdge components only.

      Important

      Enable Root Level DEBUG (Only if instructed).

      -DROOT_LOG_LEVEL=DEBUG
      Note

      Enables DEBUG logging for all components (global logging).

    3. Save the changes. Stop the Process Studio and then start it again.

  2. 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).
    Note

    Each level includes all levels above it. For example, Debug includes Info, Warn, and Error.

  3. 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
    Note

    Copilot logs capture activities and issues specifically related to Process Studio Copilot.

    Important

    Best practice:

    Start with:

    -DAE_LOG_LEVEL=DEBUG

    Enable root-level DEBUG only if instructed by support.

    DEBUG logging can:

    • Impact performance
    • Generate large log files
  4. After troubleshooting, revert to INFO (default):

    -DAE_LOG_LEVEL=INFO

    OR

    Remove the parameter (default is INFO).

Summarizing the details:

  • Default logging level is INFO.
  • Use -DAE_LOG_LEVEL=DEBUG for troubleshooting AutomationEdge components.
  • Use -DROOT_LOG_LEVEL=DEBUG only when required.
  • Logs are stored under the logs folder.
  • Copilot logs are stored separately in ps_copilot.log.
  • Always revert settings after debugging.