Investigating Coveo for Salesforce Performance

This is for:

Developer System Administrator

With the Salesforce Winter ‘19 release, Salesforce exposed Experienced Page Time (EPT) to everyone on the Salesforce Platform. As with any Cloud Solution, there are various considerations to consider for an exact performance measurement, such as the used device or browser, the organization configuration, or the geographic area (see Understanding Experienced Page Time).

This page explains how to enable the Coveo console timers to visualize the component metrics, which helps your administrators to understand the impact of Coveo’s performance on your organization.

For more information on different analysis tools available, see:

Enabling Console Timers

With the Coveo for Salesforce Summer ‘19 release, you can add a URL string in the URL bar to compute the load times of existing Coveo Lightning components. This enables the Coveo console timer, which provides information about the critical steps of each default Coveo components displayed on the page (see Timing functions).

In a Lightning App or a Lightning Console

  1. At the end of the address of your Lightning App or Lightning Console, add the following hash fragment:

    #perf_debug=true

    https://www.example.org:80/something/this.html?param1=value1&param2=value2#perf_debug=true

  2. Open the browser developer console.
  3. Reload the page.

On an Experience Cloud site

  1. At the end of the address of your Experience Cloud site, add the following query parameter fragment:

    ?perf_debug=true

    https://www.example.org:80/something/this.html?perf_debug=true

  2. Open the browser developer console.
  3. Reload the page.

Using Console Timers

Coveo provides a timer for each function that’s part of its default Aura/LWC component critical initialization path. You can find the timers in the Console tab of your browser developer console. The following metrics are the most relevant ones:

Notable metric (timer name) Description
Coveo getContent Time waiting for the page template content.
Coveo getEndpoint Time waiting for the endpoint configuration.
Coveo scriptLoaded Load time of the Coveo scripts.
Coveo customScriptLoad Load time of all custom scripts.
Coveo executeCustomScript Execution time of all custom scripts.
Coveo executeCoveoInitialization Initialization time of the Search-UI framework.

Profiling the Page Load Time

  1. Open your browser developer console.

  2. Open the Performance tab and follow the instructions.

    Open the Console tab of the your browser developer console to gather all values in milliseconds.

  3. Find the notable metrics by inspecting the console timer section and analyze them.

Now, you have a better understanding of the Coveo’s impact on your page performance.

What’s Next?

For more information about Salesforce performance recommendations, see: