Skip to content

Commit f9804dc

Browse files
author
Hendrik Muhs
committed
add documentation about forecast statistics shown as part of jobcounts.
1 parent a0f6ed5 commit f9804dc

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

x-pack/docs/en/rest-api/ml/jobcounts.asciidoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ progress of a job.
2020
(object) An object that provides information about the size and contents of the model.
2121
See <<ml-modelsizestats,model size stats objects>>
2222

23+
`forecasts_stats`::
24+
(object) An object that provides statistical information about forecasts
25+
of this job. See <<ml-forecastsstats, forecasts stats objects>>
26+
2327
`node`::
2428
(object) For open jobs only, contains information about the node where the
2529
job runs. See <<ml-stats-node,node object>>.
@@ -177,6 +181,33 @@ NOTE: The `over` field values are counted separately for each detector and parti
177181
`timestamp`::
178182
(date) The timestamp of the `model_size_stats` according to the timestamp of the data.
179183

184+
[float]
185+
[[ml-forecastsstats]]
186+
==== Forecasts Stats Objects
187+
188+
The `forecasts_stats` object shows statistics about forecasts. It has the following properties:
189+
190+
`total`::
191+
(long) The number of forecasts currently available for this model.
192+
193+
`forecasted_jobs`::
194+
(long) Number of jobs that have at least one forecast.
195+
196+
`memory_bytes`::
197+
(object) Statistics about the memory usage: min, max, avg and total.
198+
199+
`records`::
200+
(object) Statistics about the number of forecast records: min, max, avg and total.
201+
202+
`processing_time_ms`::
203+
(object) Statistics about the forecast runtime in milliseconds: min, max, avg and total.
204+
205+
`status`::
206+
(object) Counts per forecast status, for example: {"finished" : 2}.
207+
208+
NOTE: `memory_bytes`, `records`, `processing_time_ms`, `status` require at least 1 forecast, otherwise
209+
these fields are ommitted.
210+
180211
[float]
181212
[[ml-stats-node]]
182213
==== Node Objects

0 commit comments

Comments
 (0)