Briefly, this error occurs when Elasticsearch fails to clear a scroll ID. This could be due to an invalid scroll ID, a timeout, or a server issue. To resolve this, you can try the following: 1) Ensure the scroll ID is valid and hasn’t expired. 2) Increase the server timeout if the operation is taking too long. 3) Check the server health and logs for any underlying issues. 4) Retry the operation, as temporary network issues could cause this error.
This guide will help you check for common problems that cause the log ” clear scroll failed for scroll id [” + response.getScrollId() + “] ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: plugin, scroll, response.
Overview
In Elasticsearch, the concept of scroll comes into play when you have a large set of search results. Large search results are exhaustive for both the Elasticsearch cluster and the requesting client in terms of memory and processing. The scroll API enables you to take a snapshot of a large number of results from a single search request.
Examples
To perform a scroll search, you need to add the scroll parameter to a search query and specify how long Elasticsearch should keep the search context viable.
GET mydocs-2019/_search?scroll=40s
{
"size": 5000,
"query": {
"match_all": {}
},
"sort": [
{
"_doc": {
"order": "asc"
}
}
]
}This query will return a maximum of 5000 hits. If the scroll is idle for more than 40 seconds, it will be deleted. The response will return the first page of the results and a scroll ID. You can use the scroll ID to get additional documents from the scroll. You’ll be able to keep retrieving the documents until you have all of them.
Notes
- Changes made to documents after the scroll will not show up in your results.
- When you are done with the scroll, you can delete it manually using the scroll ID.
DELETE _search/scroll/<scroll_id>
Log Context
Log “clear scroll failed for scroll id [” + response.getScrollId() + “]” classname is TransportGetPipelineAction.java.
We extracted the following from Elasticsearch source code for those seeking an in-depth context :
clearScrollRequest.addScrollId(response.getScrollId());
client.clearScroll(
clearScrollRequest;
ActionListener.wrap(
(r) -> {};
e -> logger.warn(() -> "clear scroll failed for scroll id [" + response.getScrollId() + "]"; e)
)
);
}
};
handleFilteringSearchResponse(
