Cache Stats APIedit


Retrieves statistics about the shared cache for partially mounted indices.

CachesStatsRequest request = new CachesStatsRequest(); 
request = new CachesStatsRequest(  

Example of a request targeting all data nodes.

Example of a request targeting two specific nodes.


The returned CachesStatsResponse provides the following statistics:

final List<NodeCachesStats> nodeCachesStats =

The list of cache statistics for all nodes involved in the request.

Synchronous executionedit

When executing a CachesStatsRequest in the following manner, the client waits for the CachesStatsResponse to be returned before continuing with code execution:

final CachesStatsResponse response = client
    .cacheStats(request, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

Executing a CachesStatsRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous searchable-snapshots-caches-stats method:


The CachesStatsRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for searchable-snapshots-caches-stats looks like:

ActionListener<CachesStatsResponse> listener =
    new ActionListener<CachesStatsResponse>() {

        public void onResponse(final CachesStatsResponse response) {

        public void onFailure(final Exception e) {

Called when the execution is successfully completed.

Called when the whole CachesStatsRequest fails.