Get CCR Stats API

Request

The Get CCR Stats API allows you to get statistics about index following and auto following.

CcrStatsRequest request =
    new CcrStatsRequest(); 

The request accepts no parameters.

Response

The returned CcrStatsResponse always includes index follow statistics of all follow indices and auto follow statistics.

IndicesFollowStats indicesFollowStats =
    response.getIndicesFollowStats(); 
AutoFollowStats autoFollowStats =
    response.getAutoFollowStats(); 

The follow stats of active follower indices.

The auto follow stats of the cluster that has been queried.

Synchronous Execution

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

CcrStatsResponse response = client.ccr()
    .getCcrStats(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 Execution

Executing a CcrStatsRequest 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 ccr-get-stats method:

client.ccr().getCcrStatsAsync(request,
    RequestOptions.DEFAULT, listener); 

The CcrStatsRequest 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 ccr-get-stats looks like:

ActionListener<CcrStatsResponse> listener =
    new ActionListener<CcrStatsResponse>() {
        @Override
        public void onResponse(CcrStatsResponse response) { 
            IndicesFollowStats indicesFollowStats =
                response.getIndicesFollowStats();
            AutoFollowStats autoFollowStats =
                response.getAutoFollowStats();
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

Called when the execution is successfully completed.

Called when the whole CcrStatsRequest fails.