The indexing build summary report
A thorough indexing build status report is created at the end of each full re-indexing Ingest operation. You can use this report to optimize the different stages of the index process, and troubleshoot issues such as longer-than-expected processing times.
How the report is generated
Each time you perform an indexing run, a runId is generated for
the process. For example, consider the following indexing
query.
https://ingest-server:port/connectors/auth.reindex/run?storeId=11&envType=authThe
process returns an identifying runId JSON token pair. For
example:{
"runId": "05abc9b9-6b1c-4215-a300-b4e9adae586a"
} You can call the indexing build report by inputting this
runId value in a call to the /status
endpoint of the auth.reindex
process.https://ingest.demoqa.hclcomdev4.com/connectors/auth.reindex/runs/05abc9b9-6b1c-4215-a300-b4e9adae586a/statusThe response is an extensive report that includes process information, database calls, and the duration of each subprocess. You can review the Sample index build status report. The sections, values and measures used for each are presented below.
Interpreting the indexing build summary report
The report is a single document containing three sections:
- An overall description of the Ingest operation.
- A summary of messages collected during the run.
- Statistics collected at each stage,such as SQL response times, number of documents processed, and elasped times for the different parts of the run.
- Summary
- The first section of the report contains the start and end time
according to standard GMT, then the unique run identifier for the
process. After that it contains any parameters that were passed in to
this ingest operation. This is important information collected out of
the run for the given Store and
Catalog.
{ "start": "2023-02-08T03:27:15.627Z", "end": "2023-02-08T03:50:27.339Z", "run": "i-1a282ccf-dc44-4844-97ba-74a9b546f912", "parameters": { "connector": "auth.reindex", "store": "1" }, - Messages
- The second section of the report contains an overall status of each
message type (Informational, Warning, Error), a brief description of
each encountered message code and the location where they were
found.
"attributes": { "supported.catalog": "10502, 10001, 10501", "supported.language": "-5, -2, -1", "master.catalog": "10001", "default.catalog": "10502", "default.language": "-1", "default.contract": "10005", "default.currency": "USD", "flow.database.listagg": "true", "flow.language.fallback": "true", "flow.version": "9112" }, "severities": { "I": "16" }, "codes": { "DI0002I": "14", "DI0003I": "2" }, "messages": { "DI0002I": "Successfully initialized {0} index schema", "DI0003I": "Run {0} of connector {1} for catalog {2} in store {3} have been processed successfully in {4} seconds" }, "locations": { "info": { "Others": "14", "Terminal Stage": "2" } }, - Elapsed time and processing speed
- The last section contains the overall absolute ingest time (in milliseconds) and its corresponding stage level breakdown, as well as the cumulative elapsed time (in milliseconds from all processing threads) spent at each stage. It includes a rollup total (also in milliseconds) for each index type.