What does it do?

First and foremost, the CMS Log Collector (CMSLC) is a tool to collect pre-existing logs from a Cisco Meeting Server. This means that if you need to collect in-depth debugging you must first enable detailed tracing. This can be done at https://<CMSIP>/detailed_tracing.html. In order to access this page, WebAdmin must be enabled.

Additionally, CMS Log Collector can be used to collect real-time information on active calls. It can even generate a report for problematic calls that it will automatically download and store locally.

Requirements

CMS Log Collector relies heavily on having SSH, SFTP, and HTTPS connections to the Cisco Meeting Server. This means that in order to get full use of the CMS Log Collection application, WebAdmin must be enabled and the client running the application must have access to the required IP:Port combinations in use for these services. The local WebAdmin IP configured on the Cisco Meeting Server must be reachable from the PC running CMSLC.

How to Use CMSLC

Log Collection

After it launches, CMSLC will look like the above image. Here you can plug in the IP address or hostname of your MMP as well as the username/password to connect to the server. CMSLC will use the MMP to determine the WebAdmin IP and port, so there is no need to enter that information.

Advanced Settings

If you click on Advanced, you will see the following:

If you want to take a backup file from the server, make sure the Backup checkbox is checked (it is collected by default).

Only select the devdebug checkbox if specifically requested by Cisco TAC. The process required to collect this file can take a long time and is prone to running into issues. If a log collection run fails and this box has been checked, please make sure it is unchecked and try again. This is unchecked by default.

If you want to collect information on the CoSpaces, please check the CoSpaces box. In some environments there can be tens of thousands of CoSpaces, so it may take a long time for runs to complete if you have a large number of CoSpaces. This is unchecked by default.

If you want to collect detailed information on CoSpaces (useful for debugging CoSpace issues), check the CoSpace Detail box. Collecting the details of a CoSpace will cause CMSLC to make an API request for every CoSpace on the server, so it may take a while for runs to complete if this is checked. This is unchecked by default.

If you are interested in collecting CoSpace information, but you have a large number of CoSpaces, the CoSpace Filter field can be used to pull only the specific CoSpaces you want logged. The filter matches the requirements outlined in the CMS API documentation.

If you want to collect information on the Users, please check the Users box. In some environments there can be tens of thousands of Users, so it may take a long time for runs to complete if you have a large number of Users. This is unchecked by default.

If you want to collect detailed information on Users (useful for debugging Users issues), check the Users Detail box. Collecting the details of Users will cause CMSLC to make an API request for every User on the server, so it may take a while for runs to complete if this is checked. This is unchecked by default.

If you are interested in collecting User information, but you have a large number of Users, the User Filter field can be used to pull only the specific Users you want logged. The filter matches the requirements outlined in the CMS API documentation.

Launching a log collection run

When you are ready to begin, click on run. The window to the right will begin to fill with logs telling you what is occurring. When the run is complete, click on Open Log Output Folder. Your log file should be there. You will know the log collection is complete because the message “FINISHED” will print in the log window.

Real-Time Call Troubleshooting

In order to get a list of active call-legs on the CMS, enter the MMP Host address, Username, and Password. Then click on List Calls.

Once you have the list of active calls on your CMS you can select the details button to open up your browser to an API query for call information. Additionally, you can click generate report to generate a report of a call that is having issues. To view reports you have generated, select the Open Report Output Folder button.