Reviewing Item Logs
A member with the appropriate privileges (member of any built-in groups) can use the Coveo Cloud administration console Log Browser page to inspect the status of an item sent through the indexing pipeline (see Coveo Cloud V2 Indexing Pipeline). Since each log corresponds to a stage of the indexing pipeline for a single item, you can retrieve precise information from this page after having narrowed down your search. The Log Browser page is therefore especially useful when troubleshooting indexing issues regarding specific items.
An item cannot be found or seems not to have been indexed, so you want to see which stage of the indexing pipeline failed.
You want to review recently logged indexing errors and warnings in a proactive approach.
In this article, the word item is used as a generic term including all kind of files and items you want to index, such as web pages, text items, videos, drawings, etc.
Inspect Indexing Logs
On the Log Browser page, in the table, you can review the history of item addition, addition by reference, batch pushing, and deletion operations within your organization index.
In the Action bar, click the date range to open a date picker dialog:
In the calendar, click a start date and an end date within seven days.
Under Date range, click one of the suggested time windows: Last 5 minutes, Last 30 minutes, Last hour or Last day.
Use the start and end date inputs to enter a valid date value in the following format:
You can also click the set to now icon () that automatically enters the current date and time.
Click Apply to apply your time window choice and close the date picker dialog.
The longest time window you can select is seven full days. Since some sources can be scheduled to rescan only once a week, a seven-day time window allows you to show logs for at least one rescan (see Refresh VS Rescan VS Rebuild). You may want to access the Edit a Source Schedule panel to see when a source is refreshed or rescanned (see Edit a Source Schedule).
Logs are available for a month from the moment the log was generated.
If you want to target the time window of the last refresh or rescan of a certain source, you may want to access the Sources page to see in the Status column when such a process was last completed (see Adding and Managing Sources and Refresh VS Rescan VS Rebuild).
Next to the Select a start date and Select an end date boxes, you may click the Set to now button () to apply the current date and time to the corresponding box.
Like in the Coveo Cloud search interfaces, the Log Browser has facets on the left-hand side of the page. These facets allow you to filter logs by selecting the characteristics of the logs you want to show. The Sources, Operations, Results, Stages, and Resources facets display the options you can choose from (see Reference and Resources).
You want to review the items for which an error occurred. On the Log Browser page, in the Results facet, you select the Error check box.
Conversely, you can exclude facet items to narrow your view to all items but those. To do so, hover over the area to the left of the item number and click the no symbol that appears.
Once you are done with the filters, you can bookmark the web page or copy/paste the URL in the place of your choice to be able to later access the same state of the Log Browser.
You can select more than one value per facet.
Once the focus is in a facet check box, you can press the Tab key to navigate between facet values, and then press the Space or
Enterkey to select values.
Expand the list of visible facet values by clicking More, and then use the Filter box to find and select facet values.
Clear your facet value selection by clicking the X icon at the top-right corner of the facet box.
The Resources facet displays extensions applied to sources in the indexing pipeline (see Adding and Managing Extensions). Selecting an extension ID check box in the Resources facet displays logs of sources to which the selected extension has been applied.
The MAPPING_EXTENSION option corresponds to a Coveo Cloud V2 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.
Filtering logs by URI allows you to see logs per stage of the indexing pipeline for an item and its children (if any). There are two ways to filter logs by URI and display the logs corresponding to a specific item and its children (if any):
On the Log Browser page, click a log of the desired item, and then in the Action bar, click Filter by URI.
When you have already copied an URI to your clipboard, for instance when reviewing items in the Content Browser, paste it in the Search an exact item URI filter box.
To clear the filter and display all logs again, in the Action bar, click Clear URI Filter.
The information you can review in the page table is:
Log date and time
Indexing process stage result indicator (see Result column):
Indicator color Stage result Green Completed or Skipped Yellow Warning Red Error or Rejected
An operation is the intent of the indexing process. For instance, you can send items through the indexing pipeline to be added to or deleted from the index. The possible operations are:
Operation Description Add Indexing item or updating index Add reference Indexing item by reference (see Indexing by Reference) Batch
Pushing a batch of items
Pushing content in batches can be done through the Push API only (see Push API Usage Overview).
A batch may contain a single item.
Delete Deleting item from index Delete with children
Deleting item from index along with child items
This operation can be done through the Push API only (see Push API Usage Overview).
When deleting a folder that contains subfolders, you delete an item and its children.
At each stage of the indexing pipeline, the item undergoes a data handling process whose end result is included in the log. Some rows may be expanded to show additional details (see Log 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
You apply a pipeline extension to reject any item matching a certain condition.
During a source refresh, the crawler skips items that did not change since the last refresh. If the entire source did not change, the indexing process is dropped, and restarts at the next refresh.
In the source JSON, you set the
ignore(see Manage Format Handling in Source JSON).
Something unexpected was encountered during the process, but it did not cause the process to fail, as it may work properly later or with a different method.
- The source is not ready for the Push API to push items. Items will be added later, when the source will be ready to receive content.
- An error occurred when trying to retrieve an item. The
ActionOnErrorsetting will be applied (see Manage Format Handling in Source JSON).
The name of the source to which the item belongs.
Item URI column
URI of the processed item.
Stage of the indexing pipeline for which a log is issued (see Coveo Cloud V2 Indexing Pipeline). The possible stages are:
Applying extensions (pre-conversion) (optional)
Applying extensions (post-conversion) (optional)
Logs with a downward arrow () can be expanded. Click this arrow to show additional information.
When the indexing pipeline updates the index, the log has Add in the Activity column just like if the item was added for the first time. However, the expanded log row shows “Activity: updated”, which indicates that the item had already been indexed and was actually updated.
|Action||Service - Domain||Required access level|
|View Log Browser||
Content - Fields
Content - Sources