-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Defines data frame transform stats API objects #44197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
befca79
[DOCS] Defines data frame transform stats API objects
lcawl c95538d
[DOCS] Drafts response for get transform stats API
lcawl ee6097d
[DOCS] Removes unnecessary resource page
lcawl c07e37c
[DOCS] More draft info
lcawl 92335b4
[DOCS] Addresses feedback
lcawl 5e28e9d
[DOCS] Adds missing data types
lcawl 29e27d9
[DOCS] Clarifies timestamp properties
lcawl fdd53d7
[DOCS] More timestamp clarifications
lcawl cb5a77b
[DOCS] Addresses more feedback
lcawl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -72,9 +72,109 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=size-transforms] | |
[[get-transform-stats-response]] | ||
==== {api-response-body-title} | ||
|
||
`transforms`:: | ||
(array) An array of statistics objects for {transforms}, which are | ||
sorted by the `id` value in ascending order. | ||
The API returns an array of statistics objects for {transforms}, which are | ||
sorted by the `id` value in ascending order. All of these properties are | ||
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. | ||
`checkpointing`.`last`::: | ||
(object) Contains statistics about the last completed checkpoint. | ||
`checkpointing`.`last`.`checkpoint`:::: | ||
(integer) The sequence number for the checkpoint. | ||
`checkpointing`.`last`.`time_upper_bound_millis`:::: | ||
(date) When using time-based synchronization, this timestamp indicates the | ||
upper bound of data that is included in the checkpoint. | ||
`checkpointing`.`last`.`timestamp_millis`:::: | ||
(date) The timestamp of the checkpoint, which indicates when the checkpoint | ||
was created. | ||
`checkpointing`.`next`::: | ||
(object) Contains statistics about the next checkpoint that is currently in | ||
progress. This object appears only when the {transform} `state` is `indexing`. | ||
`checkpointing`.`next`.`checkpoint`:::: | ||
(integer) The sequence number for the checkpoint. | ||
`checkpointing`.`next`.`checkpoint_progress`:::: | ||
(object) Contains statistics about the progress of the checkpoint. For example, | ||
it lists the `total_docs`, `docs_remaining`, `percent_complete`, | ||
`docs_processed`, and `docs_indexed`. This information is available only for | ||
batch {transforms} and the first checkpoint of {ctransforms}. | ||
`checkpointing`.`next`.`time_upper_bound_millis`:::: | ||
(date) When using time-based synchronization, this timestamp indicates the | ||
upper bound of data that is included in the checkpoint. | ||
`checkpointing`.`next`.`timestamp_millis`:::: | ||
(date) The timestamp of the checkpoint, which indicates when the checkpoint was | ||
created. | ||
|
||
`id`:: | ||
(string) | ||
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-id] | ||
|
||
`node`:: | ||
(object) For started {transforms} only, the node upon which the {transform} is | ||
started. | ||
`node`.`attributes`::: | ||
(object) A list of attributes for the node. | ||
`node`.`ephemeral_id`::: | ||
(string) The node ephemeral ID. | ||
`node`.`id`::: | ||
(string) The unique identifier of the node. For example, "0-o0tOoRTwKFZifatTWKNw". | ||
`node`.`name`::: | ||
(string) The node name. For example, `0-o0tOo`. | ||
`node`.`transport_address`::: | ||
(string) The host and port where transport HTTP connections are accepted. For | ||
example, `127.0.0.1:9300`. | ||
`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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
* `stopping`: The {transform} is stopping. | ||
-- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
`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}. | ||
`stats`.`exponential_avg_checkpoint_duration_ms`::: | ||
(double) Exponential moving average of the duration of the checkpoint, in milliseconds. | ||
`stats`.`exponential_avg_documents_indexed`::: | ||
(double) Exponential moving average of the number of new documents that have been | ||
indexed. | ||
`stats`.`exponential_avg_documents_processed`::: | ||
(double) Exponential moving average of the number of documents that have been | ||
processed. | ||
`stats`.`index_failures`::: | ||
(long) The number of indexing failures. | ||
`stats`.`index_time_in_ms`::: | ||
(long) The amount of time spent indexing, in milliseconds. | ||
`stats`.`index_total`::: | ||
(long) The number of indices created. | ||
`stats`.`pages_processed`::: | ||
(long) The number of search or bulk index operations processed. Documents are | ||
processed in batches instead of individually. | ||
`stats`.`search_failures`::: | ||
(long) The number of search failures. | ||
`stats`.`search_time_in_ms`::: | ||
(long) The amount of time spent searching, in milliseconds. | ||
`stats`.`search_total`::: | ||
(long) The number of search operations on the source index for the {transform}. | ||
`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>>. | ||
|
||
[[get-transform-stats-response-codes]] | ||
==== {api-response-codes-title} | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
checkpointing
.
next`:::optional (object) Contains statistics about the next - currently in progress - checkpoint. This object only appears if the transform is currently processing data and only for the 1st checkpoint
It uses the same fields at last but has one more object:
checkpoint_progress
::(object) Contains statistics about the progress of the checkpoint.
Not sure how much we want to go into the details, the inner fields are:
This information is only available for batch transforms and for the 1st checkpoint of a continuous transform.