How to ... Enable and Gather Serviceability API Logs

To troubleshoot Serviceability API issues, the partner needs to enable and gather the Soap Web Service logs and the SOAP Message logs at the debug level.

Enable the SOAP Web Service Logs from the Serviceability Window

  1. From the Unified CM Administration window, choose Application > Unified CM Serviceability.
  2. Choose Trace > Configuration.
  3. From the Servers column, select the server and click GO.
  4. From the Service Group box, select Soap Services and click GO.
  5. From the Services box, select the Cisco SOAPMessage Service and click GO.
  6. Check the Trace On check box.
  7. If you want the trace to apply to all Unified CM servers in the cluster, select the Apply to All Nodes check box.
  8. From the Debug Trace Level field, select Debug.
  9. Repeat for the Soap Web Service log
  10. In the Trace Output Settings section, set Maximum No. of Files*: 200 and Maximum File Size (MB)*: 2MB
  11. Click Save.

Gather the Serviceability Logs using the RTMT Tool

  1. Log into CUCM Administration.
  2. Go to Applications, choose Plugins.
  3. Search and find the Real Time Monitoring Tool
  4. Download the Cisco Unified CM Real-Time Monitoring tool (RTMT).
  5. Install the RTMT tool.
  6. Start the RTMT tool.
  7. Enter the address of the CUCM server you want to monitor.
  8. Log into the server.
  9. To collect logs and traces, go to Trace central and double-click Collect Files.
  10. Check All Servers for Cisco CallManager, Cisco Database Layer Monitor, Cisco SOAP Web Service and Cisco SOAPMessage Service servers.
  11. On Collect File Options screen, select an Absolute Range approx. 30 min before and after your test run. Zip-ing the files is convenient. Please email or attach to your case using the online TAC case tool.