Community

Product DocsMenu

Diagnostic Tool - Service Health Tab

Sub-sections in this topic
Access the "Service Health" Tab
Switch the Index to Read-Only/Read-Write Mode
Schedule a Health Check
References

Coveo Diagnostic Tool 7.0.266+ (May 2018)

As a Coveo Enterprise Search 7 (CES 7) administrator, you do not want to monitor yourself if the CES service responsible for the searching, crawling, and indexing functions is running. The Service Health tab allows you to schedule tests ensuring the CES Administration Tool is responsive and the IIS application pool running CES 7 is configured properly. If the Administration Tool is unresponsive, you can also use the tab to switch your Coveo Enterprise Search 7 (CES 7) index between read-only and read-write mode.

Access the "Service Health" Tab

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

  2. In the Diagnostic Tool, click the Service Health tab.

Switch the Index to Read-Only/Read-Write Mode

In the Service Health tab, under Read-Only Mode, click Switch to read-only mode or Switch to read-write mode (see Access the "Service Health" Tab). When the CES 7 service is unavailable or unresponsive, a panel appears offering you to Force the read-only mode.

Important: The index must be in the read-only mode while:

  • You back up, restore, relocate, or scan the index for virus (see CES and Anti-Virus Software).

  • If CES runs on a virtual machine, when you create a snapshot of the virtual machine.

Notes:

  • The Read-Only Mode section allows you to review the actual mode of the index.

  • The switch allows you to stabilize the CES service when the Administration Tool is unavailable, and thus prevents you from having to modify the CES 7 registry key or the config.txt file directly to make the switch.

  • When the Administration Tool is available, you can toggle the index between both modes directly in the Details page (see Toggling the Index Between the Read-Write and Read-Only Modes).

Schedule a Health Check

Note: When the CES service is stopped, health checks are not performed to avoid generating false alerts.

Example: When you upgrade CES or reboot the CES server to install Windows updates, you do not want to generate dump series.

  1. In the Service Health tab, under Health Check, click the Enable system health check check box (see Access the "Service Health" Tab). The system health check is enabled by default.

  2. In the first box, enter the interval (in minutes) at which a system health check is done. By default, the Diagnostic Tool performs a check every 2 minutes.

  3. In the second box, enter the number of Consecutive failures before generating dumps. By default, a mini-dump is generated for all running CES processes on all servers (master and mirror) after 5 failed checks in a row.

    Note: When the health check generates CES dumps:

    • The configuration of the Settings subtab applies, meaning that a notification is sent to the specified email addresses (see Send Notifications on Generated Dumps).

    • (If you selected the Notify Coveo technical support when dumps are generated check box) A system status is also generated automatically and uploaded in the support case, along with the .NET Framework DLLs of all CES servers.

References

The Diagnostic Tool tests CES 7 in three steps:

  1. Check the Administration Tool IIS options and automatically fix the options with wrong values (if any).

    The options that are checked with their expected values (and location in IIS Manager) are the following:

    • .NET CLR version (Application Pools > CESAppPool admin > Basic Settings): .NET CLR Version v4.0.nnnnn

    • Managed pipeline mode (Application Pools > CESAppPool admin > Basic Settings): Classic

    • Start application pool immediately (Application Pools > CESAppPool admin > Basic Settings): True

    • Enabled 32-Bit Applications (Application Pools > CESAppPool admin > Advanced Settings): False

    • Anonymous Authentication (Sites > Coveo Enterprise Search 7 Admin > Authentication): Disabled

    • ASP.NET Impersonation (Sites > Coveo Enterprise Search 7 Admin > Authentication): Enabled

    • Windows Authentication (Sites > Coveo Enterprise Search 7 Admin > Authentication): Enabled

  2. Simulating a user who would open the Administration Tool on the CES master server. The following Administration Tool pages are tested:

  3. (If queries are enabled in CES) Asking the master and each mirror to execute a test query using the same API than a regular search page [i.e., Coveo Messaging Framework (CMF)].

    Note: The test queries do not appear in CES query logs.

People who viewed this topic also viewed