Get transform stats API
editGet transform stats API
editRetrieves the operational statistics of one or more transforms.
The API accepts a GetDataFrameTransformStatsRequest
object and returns a GetDataFrameTransformStatsResponse
.
Get transform stats request
editA GetDataFrameTransformStatsRequest
requires a data frame transform id or the special wildcard _all
to get the statistics for all transforms.
Synchronous execution
editWhen 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 execution
editExecuting 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-transform-stats method:
The |
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-transform-stats
looks like:
Response
editThe 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();
The response contains a list of |
|
The running state of the transform task e.g |
|
The running state of the transform indexer e.g |
|
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. |