Use the Log Browser to review indexing logs

This is for:

Developer System Administrator

The Log Browser (platform-ca | platform-eu | platform-au) allows members with the required privileges to review indexing logs.

Coveo sources are responsible to send a copy of your content to your index, and to periodically update this index. When a source indexes your content, your content items go through a series of small data handling processes. This series is called the indexing pipeline, and each of the processes is a stage. Every time an item goes through a stage of the pipeline, Coveo creates a log with the process result and details. Therefore, each log represents an item at a stage of the indexing pipeline.

The Log Browser is a search page for indexing logs. It’s particularly useful when troubleshooting indexing issues that apply to specific items. For example, you could use it to:

  • Proactively review recently-logged indexing errors and warnings.

  • Follow an item through the pipeline and find which stage failed because the item doesn’t seem to have been indexed.

Filter logs

By default, the Log Browser (platform-ca | platform-eu | platform-au) shows all logs for all items during the selected time period.

To filter logs, you can:

Filter logs using facets

Use the facets on the left to narrow down the information displayed. For details on the facet values, see Operations, Results, and Resources. See also Indexing pipeline stages for details on the stages of the query pipeline, which appear in the Stages facet.

Filter logs by URI

Filtering logs by URI allows you to display logs for a single item.

In the Log Browser (platform-ca | platform-eu | platform-au), select a log of the desired item, and then click Filter by URI in the Action bar.

Alternatively, if you already have the desired URI, paste it in the Search an exact item URI box. Item URIs can be obtained from the Content Browser (platform-ca | platform-eu | platform-au).

Operations

An operation is what happens with the item at the end of the indexing process. For example, you can send items through the indexing pipeline for them to be added to or deleted from the index.

The possible operations are:

Operation Description

Add

Indexes the item for the first time or updates the item that is already indexed.

Add reference

Indexes the item by reference.

Batch

Pushes a batch of items. This operation can only be done through the Push API.

Delete

Deletes the item from the index.

Delete with children

Deletes the item from the index along with child items. For example, when deleting a folder that contains subfolders, you delete the item and its children. This operation can only be done through the Push API.

Results

Each stage of the indexing pipeline represents a process. The result of this process is included in the stage log. Most rows may be expanded to show details.

The possible stage results are:

Result Description

Completed

Stage completed successfully.

Error

An error occurred and the process failed.

Rejected

Item rejected by the indexing pipeline. For example, when an indexing pipeline extension (IPE) rejects any item matching a certain condition.

Skipped

Item skipped. For example:

  • During a source refresh, the crawler skips items that didn’t change since the last refresh. If the entire source didn’t change, the indexing process is dropped, and restarts at the next refresh.

  • In the source JSON, you’ve set the action parameter to ignore for items of a certain format.

Warning

Something unexpected happened during the indexing process, but it didn’t cause it to fail. The process may work properly later or with a different method. For example:

  • The source wasn’t ready for the Push API to push items. Items will be added later, when the source is ready to receive content.

  • An error occurred when trying to retrieve the item. The ActionOnError setting will be applied.

Resources

The Resources facet displays extensions applied to sources in the indexing pipeline. Selecting an extension displays logs of sources to which this extension has been applied.

Note

The Mapping extension option corresponds to a Coveo default extension that applies source mappings. Therefore, when selected, the Mapping extension option shows the same logs as the Mapping option in the Stages facet.

Required privileges

The following table indicates the privileges required for members to view elements of the Log Browser (platform-ca | platform-eu | platform-au) page (see Manage Privileges and Privilege Reference). This includes the ability to inspect the status of an item sent through the indexing pipeline.

Action Service - Domain Required access level
View Log Browser

Content - Fields

Content - Sources

Organization - Organization

 View