Review Item Logs

Index Content Coveo Relevance Cloud Developer System Administrator Product Documentation

The Log Browser (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console allows members with the required privileges to inspect the status of an item sent through the Coveo 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 particularly useful when troubleshooting indexing issues that apply to specific items.

  • You want to see which stage of the indexing pipeline failed because an item can’t be found or doesn’t seem to have been indexed.

  • You want to proactively review recently-logged indexing errors and warnings.

Inspect Indexing Logs

On the Log Browser (platform-ca | platform-eu | platform-au) page, you can review the history of item addition. You can also perform addition by reference, batch pushing, and deletion operations within your organization index.

  1. In the Action bar, click the date range to open the date picker dialog.

  2. In the date picker dialog, perform one of the following actions:

    • In the calendar, click a start date and an end date within a seven-day range.

    • Under Date range, click one of the suggested time windows: Last 5 minutes, Last 30 minutes, Last hour or Last day.

    • To automatically enter the current date and time, you can also click Set-to-Now.

  3. Click Apply.

    • 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. You may want to access the Edit a Source Schedule panel to see when a source is refreshed or rescanned.

    • Logs are available for 14 days from the moment they’re generated.

    • If you want to target the time window of the last refresh or rescan of a certain source, you can access the Sources (platform-ca | platform-eu | platform-au) page to see in the Status column when such a process was last completed (see Manage Sources).

Filter Logs Using Facets

Like in the Coveo-powered search interfaces, the Log Browser (platform-ca | platform-eu | platform-au) 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 (platform-ca | platform-eu | platform-au) 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. See Using Facets for more information.

Admin-LogBrowserExcludeFacet

  • Once you’re done with the filters, you can bookmark the web page or copy and paste the URL to a location of your choice. This allows you to access the same Log Browser state at a later time.

Resources

The Resources facet displays extensions applied to sources in the indexing pipeline (see Manage 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 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.

Filter Logs by URI

Filtering logs by URI allows you to see one log per stage of the indexing pipeline for a certain item. There are two ways to filter logs by URI and display the logs corresponding to a specific item:

To clear the filter and display all logs again, in the Action bar, click Clear URI Filter.

Reference

The information you can review in the page table is:

  • Date column

    • Log date and time

    • Indexing process stage result indicator (see Result column):

      Indicator color Stage result
      Green Completed or Skipped
      Yellow Warning or Rejected
      Red Error

  • Operation column

    An operation is the intent of the indexing process. For example, you can send items through the indexing pipeline to be added to or deleted from the index. The possible operations are:

    Operation Description
    Add Indexes an item or updates the index.
    Add reference Indexes an item by reference (see Customize the Indexing Process).
    Batch

    Pushes 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 Deletes an item from the index.
    Delete with children

    Deletes an item from the 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.

  • Result column

    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.
    Skipped

    Item skipped.

    • 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 set the action parameter to ignore (see Handling File Formats in Source JSON).
    Warning

    Something unexpected was encountered during the process, but it didn't cause the process to fail, as it may work properly later or with a different method.

    • The source isn't 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 ActionOnError setting will be applied (see Handling File Formats in Source JSON).

  • Source column

    The name of the source to which the item belongs.

  • Item URI column

    URI of the processed item.

  • Stage column

    Stage of the indexing pipeline for which a log is issued (see Coveo Indexing Pipeline). The possible stages are:

    • Crawling

    • Streaming

    • Consuming

    • Applying extensions (pre-conversion) (optional)

    • Processing

    • Mapping

    • Applying extensions (post-conversion) (optional)

    • Indexing

Log Details

Logs with Expand 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.

Required Privileges

By default, members of the Administrators, Content Managers, and Users built-in groups can inspect the status of an item sent through the indexing pipeline.

The following table indicates the privileges required to view elements of the Log Browser (platform-ca | platform-eu | platform-au) page (see Manage Privileges and Privilege Reference).

Action Service - Domain Required access level
View Log Browser

Content - Fields

Content - Sources

Organization - Organization

 View