Skip to content

[DOCS] Add processing details to get transforms stats API #54368

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.

Sign up for GitHub

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 4 commits into from
Apr 1, 2020
Merged

[DOCS] Add processing details to get transforms stats API #54368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5175b4e
[DOCS] Add processing details to get transforms stats API
lcawl Mar 27, 2020
484cc1f
[DOCS] Uses tagged section in cat transforms
lcawl Mar 30, 2020
51347a1
Merge branch 'master' into transform-stats
lcawl Mar 31, 2020
3cdd197
[DOCS] Fix example transform name
lcawl Apr 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/cat/transforms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=dest-pipeline]
include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-processed]

`processing_time`, `pt`:::
The total time spent processing documents.
include::{docdir}/rest-api/common-parms.asciidoc[tag=processing-time-ms]

`reason`, `r`:::
include::{docdir}/rest-api/common-parms.asciidoc[tag=state-transform-reason]
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,14 @@ tag::preference[]
performed on. Random by default.
end::preference[]

tag::processing-time-ms[]
The amount of time spent processing results, in milliseconds.
end::processing-time-ms[]

tag::processing-total[]
The number of processing operations.
end::processing-total[]

tag::search-q[]
`q`::
(Optional, string) Query in the Lucene query string syntax.
Expand Down
74 changes: 36 additions & 38 deletions docs/reference/transform/apis/get-transform-stats.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,14 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index-total]
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pages-processed]

`processing_time_in_ms`:::
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=processing-time-ms]

`processing_total`:::
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=processing-total]

`search_failures`:::
(long)
include::{docdir}/rest-api/common-parms.asciidoc[tag=search-failures]
Expand Down Expand Up @@ -257,12 +265,11 @@ GET _transform/_stats?from=5&size=10
--------------------------------------------------
// TEST[skip:todo]

The following example gets usage information for the `ecommerce_transform`
{transform}:
The following example gets usage information for the {transform}:

[source,console]
--------------------------------------------------
GET _transform/ecommerce_transform/_stats
GET _transform/ecommerce-customer-transform/_stats
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

look like line 268 has to be changed, too:

The following example gets usage information for the ecommerce_transform

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I've removed that qualifier

--------------------------------------------------
// TEST[skip:todo]

Expand All @@ -274,48 +281,39 @@ The API returns the following results:
"count" : 1,
"transforms" : [
{
"id" : "ecommerce_transform",
"state" : "indexing",
"id" : "ecommerce-customer-transform",
"state" : "started",
"node" : {
"id" : "cpTIGMsVQ8Gqwqlxxxxxxx",
"name" : "my.home",
"ephemeral_id" : "5-L21nFsQxxxxxxxxxx-xx",
"transport_address" : "127.0.0.1:9300",
"attributes" : { }
},
"stats" : {
"pages_processed" : 2,
"documents_processed" : 1220,
"documents_indexed" : 13,
"trigger_count" : 1,
"index_time_in_ms" : 19,
"index_total" : 1,
"pages_processed" : 78,
"documents_processed" : 6027,
"documents_indexed" : 68,
"trigger_count" : 168,
"index_time_in_ms" : 412,
"index_total" : 20,
"index_failures" : 0,
"search_time_in_ms" : 52,
"search_total" : 2,
"search_time_in_ms" : 353,
"search_total" : 78,
"search_failures" : 0,
"exponential_avg_checkpoint_duration_ms" : 77,
"exponential_avg_documents_indexed" : 2,
"exponential_avg_documents_processed" : 12
"processing_time_in_ms" : 8,
"processing_total" : 78,
"exponential_avg_checkpoint_duration_ms" : 97.30637923893185,
"exponential_avg_documents_indexed" : 2.2064915040974062,
"exponential_avg_documents_processed" : 179.89419945785045
},
"checkpointing" : {
"last" : {
"checkpoint" : 100,
"timestamp_millis" : 1561740252497,
"time_upper_bound_millis" : 1561740192497
},
"next" : {
"checkpoint" : 101,
"position" : {
"indexer_position" : {
"hashtag" : "abcd1234"
},
"buckets_position" : {
"hashtag" : "abcd5678"
}
},
"checkpoint_progress" : {
"documents_processed": 100,
"documents_indexed": 1
},
"changes_last_detected_at": 1561740629170,
"timestamp_millis" : 1561740629172,
"time_upper_bound_millis" : 1561740569172
"checkpoint" : 20,
"timestamp_millis" : 1585344558220,
"time_upper_bound_millis" : 1585344498220
},
"operations_behind": 27000
"changes_last_detected_at" : 1585344558219
}
}
]
Expand Down