About Crawling Module logs

This is for:

Developer System Administrator

When you request help from the Coveo Support team for an issue with the Coveo Crawling Module, your Coveo Support agent downloads your instance logs or asks you to provide them. The information in the Crawling Module logs helps them investigate your issue.

You can also access Crawling Module logs for review and troubleshooting purposes, either through the Coveo Administration Console or directly on the Crawling Module host server.

Each log file contains traces of Crawling Module activity and events, which can be helpful when troubleshooting unusual issues.

For each Crawling Module instance:

  • Crawlers logs contain information regarding content update requests that have been received from Coveo. Each of these log files is identified with a source ID that’s also displayed on the Sources (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console.

  • Dumps are used by the Coveo Support team when investigating your issue, along with logs.

  • JobHandlers logs contain traces of the workers polling Coveo for update tasks. For example, these logs may be useful when you launch a refresh operation in the Coveo Administration Console, but the operation doesn’t appear to be processed by the Crawling Module.

  • Maestro logs are relevant when debugging issues affecting the Crawling Module as a whole, such as communication issues with Coveo, failure to start the workers, and inability to complete downloads.

  • Security logs contain information relative to security identity update requests that have been received from Coveo.

  • WorkerService logs, also known as NodeAgent logs, provide information on the worker launching process.

Notes

  • The Crawling Module includes source type-specific components. You can find troubleshooting information about these components in the following articles:

  • Component logs aren’t shared between Crawling Module instances. So, if you have more than one instance and encounter issues with a source, you must review the logs of the Crawling Module instance associated to this source. In other words, you must access the Logs folder on the server on which you deployed the Crawling Module instance with which this source is paired.

Access logs on your host server

On your server, all Crawling Module logs are located under C:\ProgramData\Coveo\Maestro\Logs (ProgramData is hidden by default), unless you changed this location.

Alternatively, you can use the Crawling Module API to create a compressed log archive

Download logs through the Administration Console

You can download Crawling Module logs from different pages of the Administration Console:

Update logs

Should you need more information about an ongoing or completed source or security provider update operation, you can download logs of the desired activity. Log files provide a detailed account of the update process, including any warning or error that hinders part or all the update operation.

Information in update logs is nonsensitive.

For a per-item breakdown of the source update operation, check the Log Browser (platform-ca | platform-eu | platform-au) instead. On the Sources (platform-ca | platform-eu | platform-au) page, click the desired source, and then click Open in Log Browser in the More menu. Alternatively, from the source configuration panel, click the Manage source menu and select Open in Log Browser.

Manage source menu | Coveo

To download an update log

  1. On the Sources (platform-ca | platform-eu | platform-au) or Security Identities (platform-ca | platform-eu | platform-au) page, click the desired resource, and then click Activity in the Action bar.

  2. In the Activity panel that opens, click the desired activity, and then click Download logs in the Action bar. The downloaded file is named after the unique operation ID representing the selected activity.

See Ways to review activity for alternative ways to access this information.

Source and security provider logs

You can download all activity logs for a given Crawling Module source or security provider. This way, you don’t need to navigate the resource’s activity history before downloading the desired logs when investigating an update issue.

The downloaded .zip file contains the following:

  • For a source: the source-specific content from the Crawlers and JobHandlers folders.

  • For a security provider: the security provider-specific content from the Security and JobHandlers folders.

To download logs for a source or security provider:

  1. On the Sources (platform-ca | platform-eu | platform-au) or Security Identities (platform-ca | platform-eu | platform-au) page, select the desired resource.

  2. In the Action bar, click Download logs in the More menu.

Crawling Module logs

You can download all logs for a given Crawling Module instance from the Crawling Modules (platform-ca | platform-eu | platform-au) page. These logs are especially useful for debugging issues affecting the Crawling Module as a whole, outside the scope of update logs.

The maximum download file size is 5 GB. If the file size exceeds this limit and your download fails, consider one of the previous download options or a Dumps folder cleanup on the Crawling Module host server.

Required privileges

The following table indicates the privileges required to download Crawling Module logs. See Manage privileges and Privilege reference for details.

Action Service Domain Required access level

Download Crawling Module logs

Content

Crawling Module

Edit

Crawling Module log request

Edit

Organization

Organization

View