Monitor the index rebuild process

Abstract

How to monitor the stage and progress of an index rebuild process.

The index rebuild process can take a long time, and it does not let you know how far it has progressed. However, you can monitor the state of an active rebuild process with a PowerShell command.

To monitor the index rebuild process:

  1. Go to the <xConnect role root>\App_Data\job\continuous\IndexWorker\ folder.

  2. Run the Sitecore.XConnectSearchIndexer.exe -RebuildMonitor command. You can also use the shorter -rm argument.

The command continuously outputs the following three items of information in real time:

Stage

The current rebuild stage.

Stage progress

The current stage completion from 0 to 100 percent.

Total progress

The total progress completion from 0 to 100 percent.

Note

The format of the command output might vary depending on the console output stream redirection. If the output is redirected to a file, the output appears as a log of records.

The rebuild stage can have one of several values:

Default

No index rebuild is requested or running.

RebuildRequested

The index rebuild is requested but has not started yet.

Starting

The index rebuild is in the preparation stage.

RebuildingExistingData

The existing xDB collection data is being extracted and re-indexed.

RebuildingIncomingChanges

Data added during the previous stage is being indexed.

Finishing

The post-rebuild steps are being performed.

Finished

The index rebuild activities have finished.

Note

The default Sitecore logging level is set to Information, which includes the index rebuild progress in the log. You can change the log level in the <xConnect role root>\App_Data\Config\Sitecore\CoreServices\sc.Serilog.xml file.