Product DocsMenu

Installing the Coveo Diagnostic Tool

The Coveo Diagnostic Tool eases the troubleshooting process with Coveo Support when you experience issues with Coveo Enterprise Search (see About the Coveo Diagnostic Tool). You can install the Coveo Diagnostic Tool on the Coveo Master server (where Coveo Enterprise Search is installed) and on the mirror servers (Coveo Diagnostic Tool 7.0.90+ (June 2017)). Once installed, the Coveo Diagnostic Tool runs as a Windows service.

To install the Coveo Diagnostic Tool

Note: CES 7.0.8850+ (March 2017) The Coveo Diagnostic Tool Setup Wizard is automatically launched after a Coveo Enterprise Search installation or update. You may also download the latest version of the Diagnostic Tool from productupdate.coveo.com.

  1. Ensure your environment meets the following requirements:

    • CES 7

    • Information Internet Services 5.1 (IIS 5.1+) or higher

  2. Depending on whether you have installed the Coveo Diagnostic Tool:

    • When the tool is not installed on the master server, optionally install the tool.

    • CES 7.0.8996+ (June 2017) When a new version of the tool is available, you are prone to update and install the latest version.

    • When the tool installed is the latest version available, the installation wizards is automatically closed.

  3. Coveo Diagnostic Tool 7.0.90+ (June 2017) Depending on the version of the Coveo Diagnostic Tool you have installed on your server and the installer you run:

    • (Only on a Coveo Master server with internet access) When a new version of the tool is available, in the Update Available screen that appears, click Update.

      The latest version is automatically downloaded and installed.

    • (Only on a Coveo Master server with internet access) When the versions installed is the latest available, the installation wizards closes automatically.

    • When the Coveo Master server does not have internet access, the version of the Diagnostic Tool embedded in the Coveo Enterprise Search 7.0 is installed.

    • When you run the installer of the latest available Diagnostic Tool version, continue to step 7.

  4. In the Welcome to the Coveo Diagnostic Tool Setup Wizard screen, click Next.

  5. In the Select Installation Folder screen: 

    1. When the default installation folder is not appropriate C:\Program Files\Coveo Diagnostic Tool\), select the desired folder.

    2. Click Next.

  6. In the Service Account screen: 

    Important: You must configure all Diagnostic Tool instances with the same service account.

    1. In the User Name, Password, and Domain boxes, enter the credentials of the account that you want to use for the Diagnostic Tool service.

      Note: It is recommended to use the same account as the Coveo Enterprise Search (CES) service, which is a Windows administrator dedicated to CES with a strong password that never changes (see About the CES Service Logon Account).

    2. Click Next.

  7. In the Service Port screen:

    Important: You must configure all Diagnostic Tool instances with the same service port (by default 52581). The port must also be opened on CES mirror servers to allow incoming requests from the master server.

    1. (Optionally) When another Windows service uses the port 52581, in the Service Port box, change the default port used by the Diagnostic Tool service.

    2. Coveo Diagnostic Tool 7.0.266+ (May 2018) (Only when installing the tool on the Coveo Master server) In the Notification Email (for When a Problem Is Detected box, enter the email address of the person that will receive notifications when a dump is generated.

      Note: It is recommended to notify your system administrator.

    3. Click Next.

  8. In the Ready to Install screen, click Install.

  9. In the Completing the Coveo Diagnostic Tool Setup Wizard screen, click Finish.

  10. Coveo Diagnostic Tool 7.0.90+ (June 2017) Install the Coveo Diagnostic Tool on all mirror servers to have a complete coverage of your environment when monitoring or gathering files for Coveo Support.

What's Next?

People who viewed this topic also viewed