Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for new AD settings #4835

Merged
merged 6 commits into from
Sep 21, 2023
Merged

Update documentation for new AD settings #4835

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fa30429
Update documentation for new AD settings
JonahCalvo Aug 18, 2023
a9caf4d
update wording for verbose
JonahCalvo Aug 18, 2023
7add23c
Update _data-prepper/pipelines/configuration/processors/anomaly-detec…
JonahCalvo Sep 14, 2023
6446c98
Update _data-prepper/pipelines/configuration/processors/anomaly-detec…
JonahCalvo Sep 14, 2023
418aa5b
Update _data-prepper/pipelines/configuration/processors/anomaly-detec…
JonahCalvo Sep 14, 2023
62b99dc
Remove 'few' from description
JonahCalvo Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _data-prepper/pipelines/configuration/processors/anomaly-detector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ You can configure the anomaly detector processor by specifying a key and the opt
| :--- | :--- | :--- |
| `keys` | Yes | A non-ordered `List<String>` that is used as input to the ML algorithm to detect anomalies in the values of the keys in the list. At least one key is required.
| `mode` | Yes | The ML algorithm (or model) used to detect anomalies. You must provide a mode. See [random_cut_forest mode](#random_cut_forest-mode).
| `identification_keys` | No | If provided, anomalies will be detected within each unique instance of this key. For example, providing `ip` here will have anomalies detected seperately for each unique IP address.
JonahCalvo marked this conversation as resolved.
Show resolved Hide resolved
| `cardinality_limit` | No | If using `identification_keys`, a new ML model will be created for every degree of cardinality. This can cause a large amount of memory usage, so setting a limit to the number of models is useful. Defaults to 5000.
JonahCalvo marked this conversation as resolved.
Show resolved Hide resolved
| `verbose` | No | By default, the RCF algorithm will alert once on a level shift. For example, if latency is consistently 50-100 and jumps to consistently ~1000, only one anomaly will be detected. Setting `verbose` to `true` will alert many times for such a shift.
Copy link

@sudiptoguha sudiptoguha Aug 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"RCF algorithm will alert once on a level shift" -> this is too strong. How about "RCF will try to auto learn and reduce the number of anomalies. For example if latency is consistently 50-100 and jumps to consistently ~1000, only the first few points after the transition will be detected (unless there are other spikes/anomalies). Likewise, for repeated spikes to the same level, RCF will likely eliminate many of the spikes after a few initial ones. The goal of this default setting is to minimize alerts. Setting verbose to true will alert consistently on these repeated cases and may be useful in detecting anomalous behavior that lasts an extended period of time." Please free to reword as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made this change, thanks for the suggestion.



### Keys

Expand Down