Monitor the index rebuild process

Version:

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:

StageThe current rebuild stage.
Stage progressThe current stage completion from 0 to 100 percent.
Total progressThe 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:

DefaultNo index rebuild is requested or running.
RebuildRequestedThe index rebuild is requested but has not started yet.
StartingThe index rebuild is in the preparation stage.
RebuildingExistingDataThe existing xDB collection data is being extracted and re-indexed.
RebuildingIncomingChangesData added during the previous stage is being indexed.
FinishingThe post-rebuild steps are being performed.
FinishedThe 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.

If you have suggestions for improving this article, let us know!