Setting Up Pulse in Debug Mode

Debug mode increases the verbosity of Pulse log output, making it easier to diagnose complex issues. This article explains how to enable and disable debug mode, and what to expect from the additional logging.

When to Use Debug Mode

Enable debug mode when:

• Pulse support or Cubewise has requested debug logs to investigate an issue.

• You are troubleshooting a connection, documentation, or migration problem that is not explained by standard log output.

• Intermittent errors are occurring and you need more detail to identify the root cause.

Important: Debug mode generates significantly more log data. Disk space usage for Pulse logs will increase. Disable debug mode once the issue has been investigated.

Enabling Debug Mode

Option 1 — Via Pulse.cfg (Application Server)

1. Stop the Pulse Application Server service.

2. Open conf/Pulse.cfg in a text editor.

3. In the [WebServer] section, there is no direct debug flag — debug logging is typically enabled via the logging configuration file.

4. Navigate to <Pulse Install Directory>\webapps\ROOT\WEB-INF\classes\ and open log4j2.xml (or similar logging config).

5. Change the log level from INFO to DEBUG for the relevant appenders.

6. Save and restart the Pulse Application Server service.

Option 2 — Via Pulse Monitor (monitor.yml)

To enable debug logging for the Pulse Monitor:

1. Stop the Pulse Monitor service.

2. Open conf/monitor.yml.

3. Change:

4. Save and restart the Pulse Monitor service.

Debug logs for the monitor are written to <Pulse Install Directory>\logs\monitor.log.

Log File Locations

Disabling Debug Mode

Once the investigation is complete:

1. Revert the log level back to INFO in the relevant configuration file.

2. Restart the affected Pulse service.

Log Rotation Settings

Log file size and rotation are controlled in monitor.yml for the Monitor:

These settings limit each log file to 128 MB and keep a maximum of 5 rotated files. Adjust these if you need to capture more history during a debug session.