KBEA-00138 - Turning on debugging on the Cluster Manager

Description

This article discusses turning on debugging for the Cluster Manager, which writes more detailed information to accelerator.log and ElectricAcceleratorCMService.log which are located in the "logs" folder of the installation folder.

Use Case

You want to debug what's going on in the Cluster Manager, the communication protocol between agents, eMake, and Cluster Manager. Moreover, you want to get more information on how the wrapper works for starting/restarting/stopping the Cluster Manager server.

Summary

For accelerator.log:

1. Go to the "conf" folder in the Cluster Manager installation location (e.g. default Windows Cluster Manager installation location is C:\ECloud\i686_win32\conf) and open log4j.xml.
2. Under <appender class="org.apache.log4j.RollingFileAppender">, locate the line containing <param value="true"/> and replace "true" with "false". This turns off log4j's buffering mode of so the Cluster Manager will output the log immediately without buffering.
3. Determine what debug level you want; default is all "INFO". Sometimes users want to trace down to the more detailed "TRACE" level. However, the "DEBUG" level is more than enough for general debugging. Therefore, change all the <priority value="info"/> to <priority value="debug"/>.
4. Save the file, and restart the server or Cluster Manager service. 

For accelerator.log (in Accelerator-5.x):

1. Go to the "conf" folder in the Cluster Manager installation location (e.g. default windows Cluster Manager installation location is C:\ECloud\i686_win32\conf) and open logback.xml.
2. Under <appender class="ch.qos.logback.core.rolling.RollingFileAppender">, locate the line with <param value="true"/> and replace "true" with "false". This turns off logback's buffering mode so the Cluster Manager will output the log immediately without buffering.
3. Change the following entries from "info" to "debug":
       a. <logger level="debug"/>
       b. <logger name="com.electriccloud.accelerator.server.XmlRequestHandlerImpl" level="debug"/>
4. Save the file, and restart the server or Cluster Manager service.

For ElectricAcceleratorCMService.log:

1. Go to the "conf" folder in the Cluster Manager installation location (e.g. default windows Cluster Manager installation location is C:\ECloud\i686_win32\conf) and open wrapper.conf.
2. Add the following line above the line "wrapper.working.dir=../", make sure there is no "#" at the beginning of the new inserted line because "#" means comment.
   wrapper.debug=TRUE
3. Save the file, and restart the Cluster Manager service.

See Also

KBEA-00116 - Changing the Cluster Manager debug level
The above link will change the debug option in the current active session only.