Community

Product DocsMenu

Diagnostic Tool - Logs Tab

Sub-sections in this topic
Access the "Logs" Subtab
Update Coveo Diagnostic Tool On Mirror Servers
Generate a ZIP file Containing CES 7 Logs

Coveo Diagnostic Tool 7.0.266+ (May 2018)

By default, Coveo Enterprise Search 7 (CES 7) produces different log types detailing events that occurred during system tasks, queries, and indexing operations.

When troubleshooting CES 7 issues, Coveo Support can ask for logs. The Logs tab of the Diagnostic Tool allows you to package CES 7 logs and send them to Coveo Support.

Access the "Logs" Subtab

  1. Open the Coveo Diagnostic Tool (see Opening the Coveo Diagnostic Tool).

  2. In the Diagnostic Tool, click the Logs tab.

Update Coveo Diagnostic Tool On Mirror Servers

  1. Open the Coveo Diagnostic Tool (see Opening the Coveo Diagnostic Tool).

  2. In the Logs tab, on the row of the mirror server on which the Diagnostic Tool version is Outdated, click Update (see Access the "Logs" Subtab).

    The Diagnostic Tool version installed on the master server is automatically installed on the selected mirror.

Generate a ZIP file Containing CES 7 Logs

  1. Access the Logs subtab (see Access the "Logs" Subtab).

  2. In the left-side of the table, select one or more servers from which you want to retrieve logs. You can select the check box next to Server Name to select all servers.

  3. In the right-side of the table, for each server, select one or more log types that you want to gather between the following options:

    Note: You can modify the level of details registered for each log type (see Modifying the Log Settings).

    You can also select the check box next to Type to select all types.

  4. Click the Select Start Date and Select End Date inputs, and then select the start and end dates.

    Notes:

    • By default, logs are kept 90 days. You can modify the number of days for which the logs are kept (see Modifying the Log Settings).

    • Dates without logs are grayed.

    • The current date is highlighted in yellow.

  5. (Optional) When the server available disk space is limited, in the Size Limit box, enter a log size limit (in GB).

    Notes:

    • When the limit is reached, the uncompressed (and incomplete) logs are automatically compressed, sent to Coveo Support, and then deleted. Therefore, logs are split into multiple parts. When you choose to save logs on your server, log parts (the size of the limit) are copied to the specified path.

    • By default, all generated logs are processed only when the end time is reached, so in one file.

  6. If not already done, open a Coveo support case in Salesforce and schedule a logging task (see Coveo Support Login Page and Diagnostic Tool - Logs Tab).

  7. Send the logs to Coveo Support, depending on the connectivity of your CES server:

    • When your server has internet access:

      1. Under Select Sharing Option, select the Send to Coveo Support radio button.

      2. Whether you a have a support case:

        • When you have a case, after clicking in the Case number box:

          • Select between the suggested Salesforce case numbers.

            Note: When you do not see your newly created support case in the drop-down list, click the refresh icon ().

            OR

          • Enter your Salesforce case number.

        • When you do not have a support case, click the Don't have a case? Create one here! link to log in and access the Coveo support case creation page.

      3. Click Gather and Send.

        The Coveo Diagnostic Tool zips the selected logs, and then sends the file to Coveo Support. Once the file is uploaded to the Coveo secure server, a message is sent in your case to acknowledge the document is successfully uploaded.

    • When your server is not connected to the internet:

      1. Under Select Sharing Option, select the Save on your server radio button.

      2. Click Browse.

      3. In the Select Folder on [Server_Name] window, select the folder in the server in which you want to save the logs, and then click OK.

      4. Click Gather and Save.

        You will then be able to send the file to your Coveo support case manually.

People who viewed this topic also viewed