Community

Product DocsMenu

Diagnostic Tool - Profiling Tab

Sub-sections in this topic
Access the "Profiling" Subtab
Update Coveo Diagnostic Tool On Mirror Servers
Schedule a Query Profiling Task

Coveo Diagnostic Tool 7.0.266+ (May 2018)

A Coveo search interface typically returns results in less than one second. When you experience slower query performances, you can use the Profiling tab to temporarily enable query or transaction profiling to gather information that can help Coveo Support identify the cause of the problem.

Note: It is recommended to turn off query and transaction profiling as soon as possible to minimize the impact on server resources, particularly when the rate of queries is high.

Access the "Profiling" Subtab

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

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

Update Coveo Diagnostic Tool On Mirror Servers

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

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

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

Schedule a Query Profiling Task

  1. Access the Profiling tab (see Access the "Profiling" Subtab).

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

  3. Under Select Profiling Types, select the type(s) of profiling you want to log: Query profiling or Transaction profiling.

  4. Under Select Start Time, select a datetime to start logging:

    1. Click the input (containing the current date), and then select a start date.

    2. Using the hour, minutes, and meridiem drop-down list menus, select the start time.

    OR

    Click one of the available suggestions: Now, In 1 hour, In 1 day, In 1 week.

  5. Under Select End Time, select a datetime to stop logging:

    Note: Ensure that query performance issues occur during the selected period:

    • If performance issues occur only from time to time, let query profiling run for a few days.

    • If performance issues can easily be reproduced, select the For 30 minutes option, and then perform 10 to 15 slow queries.

    1. Click the input (containing the current date), and then select an end date.

    2. Using the hour, minutes, and meridiem drop-down list menus, select the end time.

    OR

    Click one the available suggestions starting from the selected start datetime: For 30 minutes, For 1 hour, For 2 hours, For 3 hours, For 6 hours, For 12 hours, In 1 day, For 3 days.

  6. (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.

  7. If not already done, open a Coveo support case in Salesforce and schedule a logging task (see Coveo Support Login Page and Schedule a Query Profiling Task).

  8. Send the output 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 Schedule Profiling Task.

        Note: When you want to stop creating logs, click Cancel Profiling Task.

        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 Schedule Profiling Task.

        Note: When you want to stop creating logs, click Cancel Profiling Task.

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

People who viewed this topic also viewed