[ML] Add option for per-partition categorization to categorization job wizard #75061

qn895 · 2020-08-14T16:53:59Z

Summary

This is a fixed PR for the original one because I accidentally pulled in changes from Dima's PR.
#74592

Part of meta issue #73968 which adds the ability check for per-partition in categorization job creation wizard.

UI-related changes

Categorization job creation wizard
- Navigating to next screen and back should persist the settings
- Switching to a different type of detector after setting the per-partition field name should persist the partition_field_name in the detector config
- Turning off per_partition should also set stop_on_warn to false
Advanced job creation wizard (when a category field is selected)

If the detectors with mlcategory keyword have different values for partition_field_name then give error feedback upon validation step

If viewing the results of a per-partition categorization job in the Anomaly Explorer, and if stop_on_warn was enabled, add an indicator somewhere in the view if the categorization status goes to warn for a partition. This is needed to explain to the user that there may be fewer results than there could have been.

API-related

Added api/ml/anomaly_detectors/{jobId}/categorizer_stats for retrieving categorizer_stats documents
Added api/ml/anomaly_detectors/{jobId}/stopped_partitions to find out which partitions we stopped categorizing (searching for categorizer_stats documents in the job's results index)

1. First get the job config and check if analysis_config.per_partition_categorization.stop_on_warn is true
2. If so, search for categorizer_stats documents for the current job where the categorization_status is warn
3. Return all the partition_field_value values from the documents found
If analysis_config.per_partition_categorization.stop_on_warn is false then we won’t have stopped categorizing anything, so you can return an empty list

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
This was checked for cross-browser compatibility

…rtitions

…n_name

…r-partition # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

…port multiple jobs

…r-partition # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

- Refactor context -> legacyclient - Update naming & formatted strings - Update schema - Update some functions to useCallback or useMemo - Rename perPartitionStopOnWarn

…tition # Conflicts: # x-pack/plugins/ml/common/util/job_utils.ts

jgowdyelastic · 2020-08-18T16:55:15Z

in advanced wizard with a single detector, if you enable per-partition categorisation but do not add a partition field to the detector the validation fails.

I don't know whether this should be caught and displayed on the "Pick fields" step rather than the validation step.
We show a warning about duplicate detectors there:

peteharverson

Couple more comments related to the new endpoints.

x-pack/plugins/ml/server/routes/results_service.ts

qn895 · 2020-08-19T03:26:04Z

in advanced wizard with a single detector, if you enable per-partition categorization but do not add a partition field to the detector the validation fails.

I have added validation for both when user adds a detector and for the validation screen in the latest change. The detectors now notify 3 types of error:

Both checks should also now be in the final Job validation page:

jgowdyelastic · 2020-08-19T08:42:54Z

x-pack/plugins/ml/public/application/jobs/new_job/common/job_validator/job_validator.ts

@@ -273,6 +277,14 @@ export class JobValidator {
    this._advancedValidations.categorizationFieldValid.valid = valid;
  }

+  public get categorizerMissingPerPartition() {


these should be checked in isPickFieldsStepValid below to disable the Next button.

Updated in 38edcdd

x-pack/plugins/ml/common/util/job_utils.ts

jgowdyelastic

LGTM

peteharverson · 2020-08-19T14:53:58Z

x-pack/plugins/ml/server/routes/results_service.ts

+   *
+   * @api {get} /api/ml/results/:jobId/categorizer_stats
+   * @apiName GetCategorizerStats
+   * @apiDescription Returns the categorizer snapshots for the specified job ID


Should this say categorizer stats rather than snapshots ?

…tition

peteharverson · 2020-08-19T15:03:46Z

x-pack/plugins/ml/server/routes/results_service.ts

+   *
+   * @api {get} /api/ml/results/category_stopped_partitions
+   * @apiName GetCategoryStoppedPartitions
+   * @apiDescription Returns list of partitions we stopped categorizing whens status changed to warn


Typo with whens. Suggest changing this to something like

Returns information on the partitions that have stopped being categorized due to the categorization not working well. Can return either the list of stopped partitions for each job, or just the list of job IDs.

[ML] Update api descriptions to be clearer

peteharverson

Tested latest edits and LGTM

kibanamachine · 2020-08-19T17:40:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: cbeb5f6

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
ml	1373	+7	1366

async chunks size

id	value	diff	baseline
ml	8.2MB	+55.0KB	8.1MB

page load bundle size

id	value	diff	baseline
ml	576.4KB	+2.6KB	573.7KB

History

💚 Build #69086 succeeded 38edcdd
💔 Build #69111 failed 7c5dfde
💚 Build #68954 succeeded cd59230
💚 Build #68883 succeeded fd5fa9b
💚 Build #68820 succeeded 5328182

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…b wizard (elastic#75061)

…ion job wizard (#75061) (#75472)

qn895 added 29 commits August 6, 2020 11:34

[ML] Add option to add per-partition categorization for cat jobs

5cb13f5

[ML] Add per partition endpoints for categorizer_stats and stopped_pa…

6a3e91f

…rtitions

[ML] Add callout on AE page if there's a stopped partition

283db47

[ML] Add schema to get stopped_partitions for multiple jobs

9b513cf

[ML] Add support for per-partition advanced categorization wizard

10746ca

[ML] Remove unused getStoppedPartitionsSchema

ae61c2a

[ML] Fix so if cat detector changes type it will accommodate partitio…

ad453e3

…n_name

[ML] Update query size for stopped_partition to 0 since it's unused

cbb857c

[ML] Fix random anomalyExplorerLabel

5aaf226

[ML] Move logic to results service from anomaly_detectors

1591562

[ML] Fix untranslated strings

a35ec15

[ML] Refactor core logic to Results model

abe77e7

[ML] Update callAsInternalUser and text descriptions

f0a3cf4

[ML] Update callAsInternalUser and text descriptions, refactor to sup…

5ddeaab

…port multiple jobs

[ML] Update callAsInternalUser and text descriptions, refactor to sup…

98bb431

…port multiple jobs

[ML] Update namings and expect for partition field

9ca076b

[ML] Change job_id and partition_field to constants, refactor shape

ddb2fd8

[ML] Update tests to reflect API changes

bb698b6

[ML] Update naming and refactor context

a94ecaf

- Refactor context -> legacyclient - Update naming & formatted strings - Update schema - Update some functions to useCallback or useMemo - Rename perPartitionStopOnWarn

[ML] Change i18n to FormattedMessage

621d3c5

[ML] Remove this._partitionField

0a813e1

[ML] Fix type errors

3686b73

[ML] Change advanced wizard to not have the dropdown per partition field

4b99f60

Merge remote-tracking branch 'upstream/master' into duplicate-per-par…

aefe830

…tition # Conflicts: # x-pack/plugins/ml/common/util/job_utils.ts

[ML] Update catFields to categoryFields for per partition selection

fe52499

[ML] Update test to use a different partition

12ae456

[ML] Move per partition validation to before call to est model memory

2906997

qn895 added the release_note:enhancement label Aug 14, 2020

jgowdyelastic closed this Aug 18, 2020

jgowdyelastic reopened this Aug 18, 2020

peteharverson reviewed Aug 18, 2020

View reviewed changes

x-pack/plugins/ml/server/routes/results_service.ts Outdated Show resolved Hide resolved

x-pack/plugins/ml/server/routes/results_service.ts Show resolved Hide resolved

qn895 added 6 commits August 18, 2020 12:25

[ML] Change api name, schema name, update influencers

7d8c39b

[ML] Add validation to detector

982e846

[ML] Add API doc, rename getCategoryStoppedPartitions

981e6e4

[ML] Fix type for categorizationPerPartitionField

fd5fa9b

[ML] Add documentation

3e7de3a

[ML] Change so check for varying partition names filter out undefined

cd59230

jgowdyelastic reviewed Aug 19, 2020

View reviewed changes

darnautov reviewed Aug 19, 2020

View reviewed changes

x-pack/plugins/ml/common/util/job_utils.ts Outdated Show resolved Hide resolved

peteharverson changed the title ~~[ML] Add option to add per-partition categorization for cat jobs~~ [ML] Add option for per-partition categorization to categorization job wizard Aug 19, 2020

[ML] Add check to isPickFieldsStepValid and remove lodash/uniq

38edcdd

jgowdyelastic approved these changes Aug 19, 2020

View reviewed changes

peteharverson reviewed Aug 19, 2020

View reviewed changes

Merge remote-tracking branch 'upstream/master' into duplicate-per-par…

66d8f47

…tition

peteharverson reviewed Aug 19, 2020

View reviewed changes

[ML] Update api descriptions to be clearer

7c5dfde

[ML] Update api descriptions to be clearer

peteharverson approved these changes Aug 19, 2020

View reviewed changes

[ML] Remove duplicate imports

cbeb5f6

qn895 merged commit 3469e16 into elastic:master Aug 19, 2020

qn895 deleted the duplicate-per-partition branch August 19, 2020 18:03

qn895 mentioned this pull request Aug 19, 2020

[7.x] [ML] Add option for per-partition categorization to categorization job wizard (#75061) #75472

Merged

qn895 added a commit to qn895/kibana that referenced this pull request Aug 19, 2020

[ML] Add option for per-partition categorization to categorization jo…

993d485

…b wizard (elastic#75061)

qn895 added a commit that referenced this pull request Aug 19, 2020

[7.x] [ML] Add option for per-partition categorization to categorizat…

f00108c

…ion job wizard (#75061) (#75472)

pheyos mentioned this pull request Aug 20, 2020

[ML] Functional tests - fix imports in results API tests #75533

Merged

pheyos added the test-api-integration label Aug 25, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Add option for per-partition categorization to categorization job wizard #75061

[ML] Add option for per-partition categorization to categorization job wizard #75061

qn895 commented Aug 14, 2020 •

edited

Loading

jgowdyelastic commented Aug 18, 2020

peteharverson left a comment

qn895 commented Aug 19, 2020

jgowdyelastic Aug 19, 2020

qn895 Aug 19, 2020

jgowdyelastic left a comment

peteharverson Aug 19, 2020

peteharverson Aug 19, 2020

peteharverson left a comment

kibanamachine commented Aug 19, 2020

[ML] Add option for per-partition categorization to categorization job wizard #75061

[ML] Add option for per-partition categorization to categorization job wizard #75061

Conversation

qn895 commented Aug 14, 2020 • edited Loading

Summary

Checklist

jgowdyelastic commented Aug 18, 2020

peteharverson left a comment

Choose a reason for hiding this comment

qn895 commented Aug 19, 2020

jgowdyelastic Aug 19, 2020

Choose a reason for hiding this comment

qn895 Aug 19, 2020

Choose a reason for hiding this comment

jgowdyelastic left a comment

Choose a reason for hiding this comment

peteharverson Aug 19, 2020

Choose a reason for hiding this comment

peteharverson Aug 19, 2020

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

kibanamachine commented Aug 19, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

async chunks size

page load bundle size

History

qn895 commented Aug 14, 2020 •

edited

Loading