github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-25 07:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Augments cat transforms API (#53776)

Browse source 
Co-Authored-By: Benjamin Trent <ben.w.trent@gmail.com>
This commit is contained in:
Lisa Cawley 2020-03-25 12:35:01 -07:00 • committed by GitHub
parent 202b4fb490
commit 6fceef73e4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 274 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

64
docs/reference/transform/apis/get-transform-stats.asciidoc
View file

@ -77,7 +77,8 @@ informational; you cannot update their values.
`checkpointing`::
(object) Contains statistics about <<transform-checkpoints,checkpoints>>.
`checkpointing`.`changes_last_detected_at`:::
(date) The timestamp when changes were last detected in the source indices.
(date)
include::{docdir}/rest-api/common-parms.asciidoc[tag=checkpointing-changes-last-detected-at]
`checkpointing`.`last`:::
(object) Contains statistics about the last completed checkpoint.
`checkpointing`.`last`.`checkpoint`::::
@ -127,56 +128,53 @@ started.
`node`.`transport_address`:::
(string) The host and port where transport HTTP connections are accepted. For
example, `127.0.0.1:9300`.
`reason`::
(string)
include::{docdir}/rest-api/common-parms.asciidoc[tag=state-transform-reason]
`state`::
(string) The status of the {transform}, which can be one of the following values:
+
--
* `aborting`: The {transform} is aborting.
* `failed`: The {transform} failed. For more information about the failure,
check the reason field.
* `indexing`: The {transform} is actively processing data and creating new
documents.
* `started`: The {transform} is running but not actively indexing data.
* `stopped`: The {transform} is stopped.
* `stopping`: The {transform} is stopping.
--
(string)
include::{docdir}/rest-api/common-parms.asciidoc[tag=state-transform]
`stats`::
(object) An object that provides statistical information about the {transform}.
`stats`.`documents_indexed`:::
(long) The number of documents that have been indexed into the destination index
for the {transform}.
`stats`.`documents_processed`:::
(long) The number of documents that have been processed from the source index of
the {transform}.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-processed]
`stats`.`exponential_avg_checkpoint_duration_ms`:::
(double) Exponential moving average of the duration of the checkpoint, in milliseconds.
(double)
include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-checkpoint-duration-ms]
`stats`.`exponential_avg_documents_indexed`:::
(double) Exponential moving average of the number of new documents that have been
indexed.
(double)
include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-indexed]
`stats`.`exponential_avg_documents_processed`:::
(double) Exponential moving average of the number of documents that have been
processed.
(double)
include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed]
`stats`.`index_failures`:::
(long) The number of indexing failures.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-failures]
`stats`.`index_time_in_ms`:::
(long) The amount of time spent indexing, in milliseconds.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-time-ms]
`stats`.`index_total`:::
(long) The number of indices created.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-total]
`stats`.`pages_processed`:::
(long) The number of search or bulk index operations processed. Documents are
processed in batches instead of individually.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pages-processed]
`stats`.`search_failures`:::
(long) The number of search failures.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=search-failures]
`stats`.`search_time_in_ms`:::
(long) The amount of time spent searching, in milliseconds.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=search-time-ms]
`stats`.`search_total`:::
(long) The number of search operations on the source index for the {transform}.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=search-total]
`stats`.`trigger_count`:::
(long) The number of times the {transform} has been triggered by the scheduler.
For example, the scheduler triggers the {transform} indexer to check for updates
or ingest new data at an interval specified in the
<<put-transform-request-body,`frequency` property>>.
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=trigger-count]
[[get-transform-stats-response-codes]]
==== {api-response-codes-title}