Get transform stats APIedit

Retrieves the operational statistics of one or more transforms. The API accepts a GetDataFrameTransformStatsRequest object and returns a GetDataFrameTransformStatsResponse.

Get transform stats requestedit

A GetDataFrameTransformStatsRequest requires a data frame transform id or the special wildcard _all to get the statistics for all transforms.

GetDataFrameTransformStatsRequest request =
        new GetDataFrameTransformStatsRequest(id); 

Constructing a new GET Stats request referencing an existing transform

Optional argumentsedit

The following arguments are optional.

request.setPageParams(new PageParams(0, 100)); 
request.setAllowNoMatch(true); 

The page parameters from and size. from specifies the number of transform stats to skip. size specifies the maximum number of transform stats to get. Defaults to 0 and 100 respectively.

Whether to ignore if a wildcard expression matches no transforms.

Synchronous executionedit

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

GetDataFrameTransformStatsResponse response =
    client.dataFrame()
        .getDataFrameTransformStats(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 GetDataFrameTransformStatsRequest 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 get-data-frame-transform-stats method:

client.dataFrame().getDataFrameTransformStatsAsync(
        request, RequestOptions.DEFAULT, listener);  

The GetDataFrameTransformStatsRequest 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 get-data-frame-transform-stats looks like:

ActionListener<GetDataFrameTransformStatsResponse> listener =
        new ActionListener<GetDataFrameTransformStatsResponse>() {
            @Override
            public void onResponse(
                    GetDataFrameTransformStatsResponse response) {
                
            }

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

Called when the execution is successfully completed.

Called when the whole GetDataFrameTransformStatsRequest fails.

Responseedit

The returned GetDataFrameTransformStatsResponse contains the requested transform statistics.

DataFrameTransformStateAndStats stateAndStats =
    response.getTransformsStateAndStats().get(0);   
DataFrameTransformTaskState taskState =
    stateAndStats.getTransformState().getTaskState(); 
IndexerState indexerState =
    stateAndStats.getTransformState().getIndexerState();  
DataFrameIndexerTransformStats transformStats =
    stateAndStats.getTransformStats();              
DataFrameTransformProgress progress =
    stateAndStats.getTransformState().getProgress(); 
NodeAttributes node =
    stateAndStats.getTransformState().getNode(); 

The response contains a list of DataFrameTransformStateAndStats objects

The running state of the transform task e.g started

The running state of the transform indexer e.g started, indexing, etc.

The overall transform statistics recording the number of documents indexed etc.

The progress of the current run in the transform. Supplies the number of docs left until the next checkpoint and the total number of docs expected.

The assigned node information if the task is currently assigned to a node and running.