From f9804dca36d28db9dfe7bc3437675258e1724fda Mon Sep 17 00:00:00 2001 From: Hendrik Muhs Date: Mon, 2 Jul 2018 10:40:53 +0200 Subject: [PATCH] add documentation about forecast statistics shown as part of jobcounts. --- x-pack/docs/en/rest-api/ml/jobcounts.asciidoc | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/x-pack/docs/en/rest-api/ml/jobcounts.asciidoc b/x-pack/docs/en/rest-api/ml/jobcounts.asciidoc index b2e24a298cbd0..df4362bb84ce6 100644 --- a/x-pack/docs/en/rest-api/ml/jobcounts.asciidoc +++ b/x-pack/docs/en/rest-api/ml/jobcounts.asciidoc @@ -20,6 +20,10 @@ progress of a job. (object) An object that provides information about the size and contents of the model. See <> +`forecasts_stats`:: + (object) An object that provides statistical information about forecasts + of this job. See <> + `node`:: (object) For open jobs only, contains information about the node where the job runs. See <>. @@ -177,6 +181,33 @@ NOTE: The `over` field values are counted separately for each detector and parti `timestamp`:: (date) The timestamp of the `model_size_stats` according to the timestamp of the data. +[float] +[[ml-forecastsstats]] +==== Forecasts Stats Objects + +The `forecasts_stats` object shows statistics about forecasts. It has the following properties: + +`total`:: + (long) The number of forecasts currently available for this model. + +`forecasted_jobs`:: + (long) Number of jobs that have at least one forecast. + +`memory_bytes`:: + (object) Statistics about the memory usage: min, max, avg and total. + +`records`:: + (object) Statistics about the number of forecast records: min, max, avg and total. + +`processing_time_ms`:: + (object) Statistics about the forecast runtime in milliseconds: min, max, avg and total. + +`status`:: + (object) Counts per forecast status, for example: {"finished" : 2}. + +NOTE: `memory_bytes`, `records`, `processing_time_ms`, `status` require at least 1 forecast, otherwise +these fields are ommitted. + [float] [[ml-stats-node]] ==== Node Objects