Briefly, this error occurs when Elasticsearch tries to execute a suggest query, but the suggestion object is missing in the request. The suggestion object is essential as it defines the type of suggestion and its parameters. To resolve this issue, ensure that your suggest query includes a suggestion object with the correct syntax. Also, verify that the field you’re suggesting on is of the correct type, typically a text field. Lastly, check that the field is indexed and searchable, as Elasticsearch cannot suggest on fields that are not indexed.
This guide will help you check for common problems that cause the log ” missing suggestion object ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: search.
Overview
Search refers to the searching of documents in an index or multiple indices. The simple search is just a GET API request to the _search endpoint. The search query can either be provided in query string or through a request body.
Examples
When looking for any documents in this index, if search parameters are not provided, every document is a hit and by default 10 hits will be returned.
GET my_documents/_search
A JSON object is returned in response to a search query. A 200 response code means the request was completed successfully.
{
"took" : 1,
"timed_out" : false,
"_shards" : {
"total" : 2,
"successful" : 2,
"failed" : 0
},
"hits" : {
"total" : 2,
"max_score" : 1.0,
"hits" : [
...
]
}
}Notes and good things to know
- Distributed search is challenging and every shard of the index needs to be searched for hits, and then those hits are combined into a single sorted list as a final result.
- There are two phases of search: the query phase and the fetch phase.
- In the query phase, the query is executed on each shard locally and top hits are returned to the coordinating node. The coordinating node merges the results and creates a global sorted list.
- In the fetch phase, the coordinating node brings the actual documents for those hit IDs and returns them to the requesting client.
- A coordinating node needs enough memory and CPU in order to handle the fetch phase.
Log Context
Log “missing suggestion object” class name is SuggestionBuilder.java. We extracted the following from Elasticsearch source code for those seeking an in-depth context :
} else if (token == XContentParser.Token.START_OBJECT) {
suggestionBuilder = parser.namedObject(SuggestionBuilder.class; currentFieldName; null);
}
}
if (suggestionBuilder == null) {
throw new ElasticsearchParseException("missing suggestion object");
}
if (suggestText != null) {
suggestionBuilder.text(suggestText);
}
if (prefix != null) {
