[DOCS] Augments cat transforms API #53776
Conversation
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/ml-core (:ml/Transform) |
Co-Authored-By: Benjamin Trent <[email protected]>
| include::{docdir}/rest-api/common-parms.asciidoc[tag=dest-index] | ||
|
|
||
| `document_total`, `dt`::: | ||
| The total number of documents. |
There was a problem hiding this comment.
document_total
I don't see an equivalent stat in the "get transform stats" API. Is it based on documents_processed or documents_indexed?
There was a problem hiding this comment.
according to the PR it is documents_processed
| include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed] | ||
|
|
||
| `invocation_total`, `itotal`::: | ||
| The total number of invocations. |
There was a problem hiding this comment.
invocation_total
Is this related to continuous transforms? I couldn't see a matching item in the "get transform stats" API.
There was a problem hiding this comment.
this is called trigger_count in stats
| include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed] | ||
|
|
||
| `reason`, `r`::: | ||
| The reason for the current state. |
There was a problem hiding this comment.
reason
Does this information appear only when the state="failed"? Is it returned in those circumstances from the "get transform stats" API too?
There was a problem hiding this comment.
in the json output of get transform stats its only returned if set, which is only the case of a failure.
On the tabular output of _cat it can't be omitted, so it's in the table but usually empty
|
I think you made some fair points that the naming is inconsistent for the REST layer, the HLRC layer and the |
Co-Authored-By: Benjamin Trent <[email protected]>
Co-Authored-By: Benjamin Trent <[email protected]>
6 participants
Related to #53737 and #53643
This PR adds missing details for the cat transforms API.
Preview: http://elasticsearch_53776.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/cat-transforms.html