[DOCS] Per-partition categorization (#61506)

This commit is contained in:
Lisa Cawley 2020-08-26 17:07:46 -07:00 committed by lcawl
parent 580ef8eb0c
commit 6d6f5d4acc
1 changed files with 23 additions and 0 deletions

View File

@ -98,6 +98,29 @@ to disregard multiple sections of the categorization field value. In this
example, you might create a filter like `[ "\\[statement:.*\\]"]` to remove the
SQL statement from the categorization algorithm.
[discrete]
[[ml-per-partition-categorization]]
== Per-partition categorization
If you enable per-partition categorization, categories are determined
independently for each partition. For example, if your data includes messages
from multiple types of logs from different applications, you can use a field
like the ECS {ecs-ref}/ecs-event.html[`event.dataset` field] as the
`partition_field_name` and categorize the messages for each type of log
separately.
If your job has multiple detectors, every detector that uses the `mlcategory`
keyword must also define a `partition_field_name`. You must use the same
`partition_field_name` value in all of these detectors. Otherwise, when you
create or update a job and enable per-partition categorization, it fails.
When per-partition categorization is enabled, you can also take advantage of a
`stop_on_warn` configuration option. If the categorization status for a
partition changes to `warn`, it doesn't categorize well and can cause a lot of
unnecessary resource usage. When you set `stop_on_warn` to `true`, the job stops
analyzing these problematic partitions. You can thus avoid an ongoing
performance cost for partitions that are unsuitable for categorization.
[discrete]
[[ml-configuring-analyzer]]
== Customizing the categorization analyzer