How to enable Spectrum debug for the Performance Management integration

Products

• CA Performance Management - Usage and Administration
• DX NetOps

Issue/Introduction

When standard logging doesn't provide enough information to determine the root cause for a problem, enabling debug may be necessary.

This will detail the steps necessary to enable, manage and disable the Spectrum OneClick Tomcat web server debug for the Performance Management integration.

Helps to determine possible causes for various issues related to the product integration

Environment

All supported Spectrum releases integrated with all supported Performance Management releases

Resolution

Enable Debug

1. Launch the Spectrum OneClick tomcat web servers administration page in web browser. Default is <OC_HostName>:80.
2. Log in as the Spectrum administrative user.
3. Go to the Administration page.
4. Just below the Administration option, in the horizontal grey bar, select the Debugging option.
5. From the grey bar on the left side select the "Web Server Debug Page (Runtime)" option.
6. There are three debug options for the CA Performance Management to CA Spectrum integration listed in the Debug Controller list.
   
   1. Performance Center Integration
   2. Performance Center Integration Alarm Sync Tracking
   3. Performance Center Integration Sync
7. If the problems with the integration are related to Alarm and Event synchronization enable all three options.
8. If the problems with the integration are related to synchronization issues enable the "Performance Center Integration" & "Performance Center Integration Sync" options.
9. At the bottom of the page ensure the Current Debug Level is set to MAX.
10. Select the Apply button.

Managing Debug

• This will generate logging in the Spectrum OneClick tomcat web servers log files. In Unix review the catalina.out file, in Windows review the stdout.log file.
• If leaving this enabled long term, monitor log file growth to ensure unexpected disk full outages aren't encountered.
• If necessary, to reset the log file and have it rotated, restart the tomcat web server service.
• Note that that step will disable the debug. Ensure it's enabled again after the web server is restarted.

Disabling Debug

Option A: Disable debug

1. Launch the Spectrum OneClick tomcat web servers administration page in web browser. Default is <OC_HostName>:80.
2. Log in as the Spectrum administrative user.
3. Go to the Administration page.
4. Just below the Administration option, in the horizontal grey bar, select the Debugging option.
5. From the grey bar on the left side select the "Web Server Debug Page (Runtime)" option.
6. At the bottom of the Debug Controller List page select the "All Off" button.

Option B: Disable debug via service restart.

Disabling debug via Option A disables further logging but won't rotate the logs if they have become large.

To disable the debug and rotate the logs at the same time, restart the restart the tomcat web server service.

Additional Information

Turn on DM debug for DataSourcePull and DataSourcePush: 
http://Portal:8481/dm/admin/config/logs?listing=described

https://Portal:8482/dm/admin/config/logs?listing=described

 

Change DataSourcePull and DataSourcePush from INHERITED to DEBUG  and click the "Update" button at the top of the screen

 

Or change the /opt/CA/PerformanceCenter/DM/resources/log4j2.properties file

Uncomment these lines:
#logger.DataSourcePull.name = com.ca.im.portal.dm.productsync.DataSourcePull
#logger.DataSourcePull.level = DEBUG

#logger.DataSourcePush.name = com.ca.im.portal.dm.productsync.DataSourcePush
#logger.DataSourcePush.level = DEBUG

On Portal web page Manage Data Sources select Spectrum and Perform a Full Resynchronization

This will generate logging in the Portal machine /opt/CA/PerformanceCenter/DM/logs/DMService.log file.

Note: To disable Debug back to the original /opt/CA/PerformanceCenter/DM/resources/log4j2.properties file