Skip to content

Commit 4d2c8e6

Browse files
kibanamachinewalterra
kibanamachine
and
walterra
authored
[ML] Anomaly Detection: Migrate validation messages links to use docLinks. (#94568) (#94778)
- To make use of the docsLinks service which is only usable in client side code, Anomaly Detection's validation messages are not fully returned from the server anymore. Instead just the message ID and necessary metadata to parse the message template gets returned. - getMessages() no longer uses inline hard coded documentation links but picks links from the docsLinks service. - The code that rendered the messages originally on the server has been move to a function parseMessages() which can now be used on the client side and accepts the docsLinks services to get URLs to documentation from it. - This means we no longer need to get the current version/branch information for the server side code. - Tests have been updated to reflect the changes: API integration tests only check for the now reduced messages containing only message IDs and metadata. The expected results of the API integration tests are used as mocks for the client side function parseMessages(), this allows use to cover the same code and messages as previously. Co-authored-by: Walter Rafelsberger <walter@elastic.co>
1 parent 7eb713a commit 4d2c8e6

File tree

10 files changed

+363
-276
lines changed

10 files changed

+363
-276
lines changed

‎src/core/public/doc_links/doc_links_service.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,16 @@ export class DocLinksService {
162162
aggregations: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-configuring-aggregation.html`,
163163
anomalyDetection: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/xpack-ml.html`,
164164
anomalyDetectionJobs: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-jobs.html`,
165+
anomalyDetectionConfiguringCategories: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-configuring-categories.html`,
166+
anomalyDetectionBucketSpan: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html#bucket-span`,
167+
anomalyDetectionCardinality: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html#cardinality`,
168+
anomalyDetectionCreateJobs: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html`,
169+
anomalyDetectionDetectors: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html#detectors`,
170+
anomalyDetectionInfluencers: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-influencers.html`,
171+
anomalyDetectionJobResource: `${ELASTICSEARCH_DOCS}ml-put-job.html#ml-put-job-path-parms`,
172+
anomalyDetectionJobResourceAnalysisConfig: `${ELASTICSEARCH_DOCS}ml-put-job.html#put-analysisconfig`,
165173
anomalyDetectionJobTips: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html#job-tips`,
174+
anomalyDetectionModelMemoryLimits: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html#model-memory-limits`,
166175
calendars: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-calendars.html`,
167176
classificationEvaluation: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-dfanalytics-evaluate.html#ml-dfanalytics-classification`,
168177
customRules: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-rules.html`,

‎x-pack/plugins/ml/common/constants/messages.test.mock.ts‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/*
2+
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
3+
* or more contributor license agreements. Licensed under the Elastic License
4+
* 2.0; you may not use this file except in compliance with the Elastic License
5+
* 2.0.
6+
*/
7+
8+
/* To keep tests in sync, these mocks should be used in API intregation tests
9+
* as expected values to check against, and in the client side jest tests to be
10+
* the values used as function arguments for `parseMessages()` to retrieve the
11+
* messages populated with translations and documentation links.
12+
*/
13+
14+
export const basicValidJobMessages = [
15+
{
16+
id: 'job_id_valid',
17+
},
18+
{
19+
id: 'detectors_function_not_empty',
20+
},
21+
{
22+
id: 'success_bucket_span',
23+
bucketSpan: '15m',
24+
},
25+
{
26+
id: 'success_time_range',
27+
},
28+
{
29+
id: 'success_mml',
30+
},
31+
];
32+
33+
export const basicInvalidJobMessages = [
34+
{
35+
id: 'job_id_invalid',
36+
},
37+
{
38+
id: 'detectors_function_not_empty',
39+
},
40+
{
41+
id: 'bucket_span_valid',
42+
bucketSpan: '15m',
43+
},
44+
{
45+
id: 'skipped_extended_tests',
46+
},
47+
];
48+
49+
export const nonBasicIssuesMessages = [
50+
{
51+
id: 'job_id_valid',
52+
},
53+
{
54+
id: 'detectors_function_not_empty',
55+
},
56+
{
57+
id: 'cardinality_model_plot_high',
58+
},
59+
{
60+
id: 'cardinality_partition_field',
61+
fieldName: 'order_id',
62+
},
63+
{
64+
id: 'bucket_span_high',
65+
},
66+
{
67+
bucketSpanCompareFactor: 25,
68+
id: 'time_range_short',
69+
minTimeSpanReadable: '2 hours',
70+
},
71+
{
72+
id: 'success_influencers',
73+
},
74+
{
75+
id: 'half_estimated_mml_greater_than_mml',
76+
mml: '1MB',
77+
},
78+
{
79+
id: 'missing_summary_count_field_name',
80+
},
81+
];

‎x-pack/plugins/ml/common/constants/messages.test.ts‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
/*
2+
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
3+
* or more contributor license agreements. Licensed under the Elastic License
4+
* 2.0; you may not use this file except in compliance with the Elastic License
5+
* 2.0.
6+
*/
7+
8+
import { docLinksServiceMock } from 'src/core/public/mocks';
9+
10+
import { parseMessages } from './messages';
11+
12+
import {
13+
basicValidJobMessages,
14+
basicInvalidJobMessages,
15+
nonBasicIssuesMessages,
16+
} from './messages.test.mock';
17+
18+
describe('Constants: Messages parseMessages()', () => {
19+
const docLinksService = docLinksServiceMock.createStartContract();
20+
21+
it('should parse valid job configuration messages', () => {
22+
expect(parseMessages(basicValidJobMessages, docLinksService)).toStrictEqual([
23+
{
24+
heading: 'Job ID format is valid',
25+
id: 'job_id_valid',
26+
status: 'success',
27+
text:
28+
'Lowercase alphanumeric (a-z and 0-9) characters, hyphens or underscores, starts and ends with an alphanumeric character, and is no more than 64 characters long.',
29+
url:
30+
'https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/ml-put-job.html#ml-put-job-path-parms',
31+
},
32+
{
33+
heading: 'Detector functions',
34+
id: 'detectors_function_not_empty',
35+
status: 'success',
36+
text: 'Presence of detector functions validated in all detectors.',
37+
url:
38+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#detectors',
39+
},
40+
{
41+
bucketSpan: '15m',
42+
heading: 'Bucket span',
43+
id: 'success_bucket_span',
44+
status: 'success',
45+
text: 'Format of "15m" is valid and passed validation checks.',
46+
url:
47+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#bucket-span',
48+
},
49+
{
50+
heading: 'Time range',
51+
id: 'success_time_range',
52+
status: 'success',
53+
text: 'Valid and long enough to model patterns in the data.',
54+
},
55+
{
56+
heading: 'Model memory limit',
57+
id: 'success_mml',
58+
status: 'success',
59+
text: 'Valid and within the estimated model memory limit.',
60+
url:
61+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#model-memory-limits',
62+
},
63+
]);
64+
});
65+
66+
it('should parse basic invalid job configuration messages', () => {
67+
expect(parseMessages(basicInvalidJobMessages, docLinksService)).toStrictEqual([
68+
{
69+
id: 'job_id_invalid',
70+
status: 'error',
71+
text:
72+
'Job ID is invalid. It can contain lowercase alphanumeric (a-z and 0-9) characters, hyphens or underscores and must start and end with an alphanumeric character.',
73+
url:
74+
'https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/ml-put-job.html#ml-put-job-path-parms',
75+
},
76+
{
77+
heading: 'Detector functions',
78+
id: 'detectors_function_not_empty',
79+
status: 'success',
80+
text: 'Presence of detector functions validated in all detectors.',
81+
url:
82+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#detectors',
83+
},
84+
{
85+
bucketSpan: '15m',
86+
heading: 'Bucket span',
87+
id: 'bucket_span_valid',
88+
status: 'success',
89+
text: 'Format of "15m" is valid.',
90+
url:
91+
'https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/ml-put-job.html#put-analysisconfig',
92+
},
93+
{
94+
id: 'skipped_extended_tests',
95+
status: 'warning',
96+
text:
97+
'Skipped additional checks because the basic requirements of the job configuration were not met.',
98+
},
99+
]);
100+
});
101+
102+
it('should parse non-basic issues messages', () => {
103+
expect(parseMessages(nonBasicIssuesMessages, docLinksService)).toStrictEqual([
104+
{
105+
heading: 'Job ID format is valid',
106+
id: 'job_id_valid',
107+
status: 'success',
108+
text:
109+
'Lowercase alphanumeric (a-z and 0-9) characters, hyphens or underscores, starts and ends with an alphanumeric character, and is no more than 64 characters long.',
110+
url:
111+
'https://www.elastic.co/guide/en/elasticsearch/reference/mocked-test-branch/ml-put-job.html#ml-put-job-path-parms',
112+
},
113+
{
114+
heading: 'Detector functions',
115+
id: 'detectors_function_not_empty',
116+
status: 'success',
117+
text: 'Presence of detector functions validated in all detectors.',
118+
url:
119+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#detectors',
120+
},
121+
{
122+
id: 'cardinality_model_plot_high',
123+
status: 'warning',
124+
text:
125+
'The estimated cardinality of undefined of fields relevant to creating model plots might result in resource intensive jobs.',
126+
},
127+
{
128+
fieldName: 'order_id',
129+
id: 'cardinality_partition_field',
130+
status: 'warning',
131+
text:
132+
'Cardinality of partition_field "order_id" is above 1000 and might result in high memory usage.',
133+
url:
134+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#cardinality',
135+
},
136+
{
137+
heading: 'Bucket span',
138+
id: 'bucket_span_high',
139+
status: 'info',
140+
text:
141+
'Bucket span is 1 day or more. Be aware that days are considered as UTC days, not local days.',
142+
url:
143+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#bucket-span',
144+
},
145+
{
146+
bucketSpanCompareFactor: 25,
147+
heading: 'Time range',
148+
id: 'time_range_short',
149+
minTimeSpanReadable: '2 hours',
150+
status: 'warning',
151+
text:
152+
'The selected or available time range might be too short. The recommended minimum time range should be at least 2 hours and 25 times the bucket span.',
153+
},
154+
{
155+
id: 'success_influencers',
156+
status: 'success',
157+
text: 'Influencer configuration passed the validation checks.',
158+
url:
159+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/ml-influencers.html',
160+
},
161+
{
162+
id: 'half_estimated_mml_greater_than_mml',
163+
mml: '1MB',
164+
status: 'warning',
165+
text:
166+
'The specified model memory limit is less than half of the estimated model memory limit and will likely hit the hard limit.',
167+
url:
168+
'https://www.elastic.co/guide/en/machine-learning/mocked-test-branch/create-jobs.html#model-memory-limits',
169+
},
170+
{
171+
id: 'missing_summary_count_field_name',
172+
status: 'error',
173+
text:
174+
'A job configured with a datafeed with aggregations must set summary_count_field_name; use doc_count or suitable alternative.',
175+
},
176+
]);
177+
});
178+
});

0 commit comments

Comments
 (0)