Browse Source

[DOCS] Describes the relationship of the time-related settings in anomaly detection docs (#50959)

Co-Authored-By: David Roberts <dave.roberts@elastic.co>
István Zoltán Szabó 5 years ago
parent
commit
406810c172

+ 24 - 0
docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc

@@ -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)
@@ -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)
@@ -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}
 

+ 5 - 0
docs/reference/ml/anomaly-detection/apis/put-job.asciidoc

@@ -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)