Skip to content

Commit

Permalink
Update docs/reference/ml/anomaly-detection/ml-delayed-data-detection.…
Browse files Browse the repository at this point in the history
…asciidoc

Co-authored-by: István Zoltán Szabó <[email protected]>
  • Loading branch information
droberts195 and szabosteve authored Jan 25, 2024
1 parent 9417ea6 commit eb805de
Showing 1 changed file with 14 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,21 @@ for the periods where these delays occur:
[role="screenshot"]
image::images/ml-annotations.png["Delayed data annotations in the Single Metric Viewer"]

IMPORTANT: Because we are comparing `doc_count` from an aggregation with the
job's bucket results, the delayed data check will not work correctly if the
job's datafeed is using aggregations and its `analysis_config` does not have
its `summary_count_field_name` set to `doc_count`, or if your job is _not_
using aggregations and `summary_count_field_name` is set to anything. If your
job's datafeed is using aggregations then it's highly likely that your
`summary_count_field_name` should be `doc_count`. If `summary_count_field_name`
is set at all, and is _not_ set to `doc_count`, then you must disable the
delayed data check for that job.
[IMPORTANT]
====
As the `doc_count` from an aggregation is compared with the
bucket results of the job, the delayed data check will not work correctly in the
following cases:
* if the datafeed uses aggregations and its `analysis_config` does not have its
`summary_count_field_name` set to `doc_count`,
* if your job is _not_ using aggregations and `summary_count_field_name` is set to
any value.
If the datafeed is using aggregations then it's highly likely that the
`summary_count_field_name` should be set to `doc_count`. If
`summary_count_field_name` is set to any value other than `doc_count`, the
delayed data check for that job must be disabled.
====
There is another tool for visualizing the delayed data on the *Annotations* tab
in the {anomaly-detect} job management page:

Expand Down

0 comments on commit eb805de

Please sign in to comment.