Crawling Module Monitoring

The Crawling Module page displays the state of the communication between Coveo Cloud and the Coveo On-Premises Crawling Module, as well as the state of each of the Crawling Module components once they are installed and communicating with Coveo Cloud (see Crawling Module). If you have not installed the Crawling Module yet, a button at the top right allows you to download it (see Crawling Module Deployment Overview).

Your Coveo Cloud organization license must allow Crawling Module sources for the Crawling Module page to be accessible. If you want to start using the Crawling Module to make on-premises content searchable, contact the Coveo Sales team to upgrade your license.

For further information on the Coveo On-Premises Crawling Module, review the related documentation.

About Crawling Module Updates

In the Crawling Module page, the date under Last update corresponds to the most recent Crawling Module component update.

Since version 0.3, released on March 30, 2018, the Coveo On-Premises Crawling Module update process is automatic. This allows you to benefit from the latest features and bug fixes, and prevents the Crawling Module from becoming incompatible with the most recent Coveo Cloud update. Therefore, to stay up to date, the Crawling Module periodically polls Coveo Cloud for a new version of its components. If an update is available, it will be downloaded and installed within 24 hours, at the scheduled update time. The default time is 11:00 PM (see Editing your On-Premises Crawling Module Configuration).

Disconnecting your server from the Internet or shutting it down will result in the Crawling Module not polling Coveo Cloud for updates. Upon the next successful call for an update, if a component is two or more versions behind, the workers will stop until the Crawling Module is up to date again.

If you installed the Crawling Module for the first time on March 30, 2018 or later, you do not need to launch the update process manually, unless it fails. In such a case, the Crawling Module page reports the issue, and you can either try to update manually or contact the Coveo Support team (see Updates).

If you still use the Crawling Module 0.2, see Updating the Crawling Module 0.2 for a last manual update before you can start benefiting from automatic updates.

Review the Activity Regarding the Crawling Module

On the Crawling Module page, in the right section of the page header, click the Activity icon (Activity icon) (see Review Events Related to Specific Coveo Cloud Administration Console Resources).

If the Activity icon is grayed and unresponsive, you do not have all of the required privileges to perform this action.


Depending on the situation, the Crawling Module page can display different messages. Use the table below as a reference. For further information on the Crawling Module components, see Components.

Message displayed Action to take

Up to date and communicating successfully.

The Crawling Module is working smoothly. No action required.

Some Crawling Module components are outdated. Update the Crawling Module to ensure it keeps operating smoothly (see Updates).
Crawling Module update is mandatory. The Crawling Module has stopped working because one or more components are obsolete. Update the Crawling Module as soon as possible to ensure that the search results in your Coveo-powered search page reflect your actual data (see Updates).
Your organization license does not have access to the Crawling Module. Your Coveo Cloud license does not include the Crawling Module, so you cannot use this tool (see Coveo On-Premises Crawling Module). Contact the Coveo Sales team to upgrade your license.
Install the Crawling Module. Download and deploy the Crawling Module to make your on-premises content searchable (see Coveo On-Premises Crawling Module and Deployment Overview).
Take advantage of the Crawling Module. The Crawling Module is installed, but it does not provide Coveo Cloud with any content. Create a source to make your on-premises data searchable in your Coveo-powered search page (see Supported Content).

Under the message, a status table allows you to determine at a glance whether each component of your Crawling Module instance is up to date. If you deploy more than one Crawling Module instance, each instance has its own table. Each Crawling Module instance is identified by a default name, which you can replace with something more convenient by editing the Maestro configuration of the desired instance.

For each instance, you can review the following information:

  • Last successful communication: last time the Coveo Cloud platform received a status update from the Crawling Module. The Crawling Module sends a status update every five minutes.
  • Last update: most recent Crawling Module component update.
  • Associated sources: number of sources paired with this Crawling Module (see Creating a Crawling Module Source).
  • Latest version: version number of the most recent update released by Coveo, to be compared with the Reported version.
  • Reported version: version number reported by the Crawling Module the last time it sent a status update to the Coveo Cloud platform. If components are outdated, you should update them as soon as possible to prevent the Crawling Module from stopping entirely (see Updates).

Required Privileges

The following table indicates the privileges required to view the Crawling Module page (see Privileges).

See Sources: Required Privileges for the additional privileges required to add and edit Crawling Module sources.

Actions Service - Domain Required access level

View the Crawling Module page

View Crawling Module related activities

Download the Crawling Module

Content - Crawling Module

Content - Sources

Content - Crawling Module

Organization - Activities

Recommended Articles