Skip to content

Commit

Permalink
[DOCS] Describes the relationship of the time-related settings in ano…
Browse files Browse the repository at this point in the history
…maly detection docs (#50959)

Co-Authored-By: David Roberts <[email protected]>
  • Loading branch information
szabosteve and droberts195 committed Jan 15, 2020
1 parent ffc7fc3 commit 8bec50e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config]
`frequency`::
(Optional, <<time-units, time units>>)
include::{docdir}/ml/ml-shared.asciidoc[tag=frequency]
+
--
To learn more about the relationship between time related settings, see
<<ml-put-datafeed-time-related-settings>>.
--

`indices`::
(Required, array)
Expand All @@ -84,6 +89,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=query]
`query_delay`::
(Optional, <<time-units, time units>>)
include::{docdir}/ml/ml-shared.asciidoc[tag=query-delay]
+
--
To learn more about the relationship between time related settings, see
<<ml-put-datafeed-time-related-settings>>.
--

`script_fields`::
(Optional, object)
Expand All @@ -93,6 +103,20 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=script-fields]
(Optional, unsigned integer)
include::{docdir}/ml/ml-shared.asciidoc[tag=scroll-size]


[[ml-put-datafeed-time-related-settings]]
===== Interaction between time-related settings

Time-related settings have the following relationships:

* Queries run at `query_delay` after the end of
each `frequency`.

* When `frequency` is shorter than `bucket_span` of the associated job, interim
results for the last (partial) bucket are written, and then overwritten by the
full bucket results eventually.


[[ml-put-datafeed-example]]
==== {api-examples-title}

Expand Down
5 changes: 5 additions & 0 deletions docs/reference/ml/anomaly-detection/apis/put-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=analysis-config]
`analysis_config`.`bucket_span`:::
(<<time-units,time units>>)
include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-span]
+
--
To learn more about the relationship between time related settings, see
<<ml-put-datafeed-time-related-settings>>.
--

`analysis_config`.`categorization_field_name`:::
(string)
Expand Down

0 comments on commit 8bec50e

Please sign in to comment.