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

Jump to bottom

[Custom threshold] Add missing prefill fields to the custom threshold rule #174690

Merged
merged 8 commits into from
Jan 24, 2024
Merged

[Custom threshold] Add missing prefill fields to the custom threshold rule #174690

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cb5cd09
Fix prefilling time size and unit in custom threshold
maryam-saeidi Jan 11, 2024
934bb76
Merge branch 'main' into fix-time-prefill
maryam-saeidi Jan 11, 2024
af96534
Fix prefilling optional filter query and alertOnGroupDisappear
maryam-saeidi Jan 15, 2024
245bee4
Merge branch 'main' into fix-time-prefill
maryam-saeidi Jan 15, 2024
2365425
Merge branch 'main' into fix-time-prefill
fkanout Jan 16, 2024
78c939c
Merge branch 'main' into fix-time-prefill
maryam-saeidi Jan 22, 2024
57cd386
Add prefill for equation and label in test
maryam-saeidi Jan 22, 2024
44ef6be
Merge branch 'main' into fix-time-prefill
maryam-saeidi Jan 24, 2024
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
31 changes: 22 additions & 9 deletions ...bservability/public/components/custom_threshold/custom_threshold_rule_expression.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
*/

import React from 'react';
import { RuleTypeParams } from '@kbn/alerting-plugin/common';
import { Query } from '@kbn/data-plugin/common';
import { dataViewPluginMocks } from '@kbn/data-views-plugin/public/mocks';
import { queryClient } from '@kbn/osquery-plugin/public/query_client';
import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers';
Expand All @@ -15,7 +17,7 @@ import { Aggregators, Comparator } from '../../../common/custom_threshold_rule/t
import { useKibana } from '../../utils/kibana_react';
import { kibanaStartMock } from '../../utils/kibana_react.mock';
import Expressions from './custom_threshold_rule_expression';
import { CustomThresholdPrefillOptions } from './types';
import { AlertParams, CustomThresholdPrefillOptions } from './types';

jest.mock('../../utils/kibana_react');
jest.mock('./components/preview_chart/preview_chart', () => ({
Expand All @@ -42,7 +44,7 @@ describe('Expression', () => {
currentOptions?: CustomThresholdPrefillOptions,
customRuleParams?: Record<string, unknown>
) {
const ruleParams = {
const ruleParams: RuleTypeParams & AlertParams = {
criteria: [],
groupBy: undefined,
sourceId: 'default',
Expand Down Expand Up @@ -161,34 +163,45 @@ describe('Expression', () => {
it('should prefill the rule using the context metadata', async () => {
const index = 'changedMockedIndex';
const currentOptions: CustomThresholdPrefillOptions = {
alertOnGroupDisappear: false,
groupBy: ['host.hostname'],
filterQuery: 'foo',
searchConfiguration: { index },
searchConfiguration: {
index,
query: {
query: 'foo',
language: 'kuery',
},
},
criteria: [
{
metrics: [
{ name: 'A', aggType: Aggregators.AVERAGE, field: 'system.load.1' },
{ name: 'B', aggType: Aggregators.CARDINALITY, field: 'system.cpu.user.pct' },
],
comparator: Comparator.LT_OR_EQ,
threshold: [500],
timeSize: 7,
timeUnit: 'h',
},
],
};

const { ruleParams } = await setup(currentOptions, { searchConfiguration: undefined });

expect(ruleParams.alertOnGroupDisappear).toEqual(false);
expect(ruleParams.groupBy).toEqual(['host.hostname']);
expect(ruleParams.searchConfiguration.query.query).toBe('foo');
expect((ruleParams.searchConfiguration.query as Query).query).toBe('foo');
expect(ruleParams.searchConfiguration.index).toBe(index);
expect(ruleParams.criteria).toEqual([
{
metrics: [
{ name: 'A', aggType: Aggregators.AVERAGE, field: 'system.load.1' },
{ name: 'B', aggType: Aggregators.CARDINALITY, field: 'system.cpu.user.pct' },
],
comparator: Comparator.GT,
threshold: [100],
timeSize: 1,
timeUnit: 'm',
comparator: Comparator.LT_OR_EQ,
threshold: [500],
timeSize: 7,
timeUnit: 'h',
},
]);
});
Expand Down
35 changes: 15 additions & 20 deletions ...ins/observability/public/components/custom_threshold/custom_threshold_rule_expression.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ export default function Expressions(props: Props) {
if (!ruleParams.searchConfiguration || !ruleParams.searchConfiguration.index) {
if (metadata?.currentOptions?.searchConfiguration) {
initialSearchConfiguration = {
...metadata.currentOptions.searchConfiguration,
query: {
query: ruleParams.searchConfiguration?.query ?? '',
language: 'kuery',
},
...metadata.currentOptions.searchConfiguration,
};
} else {
const newSearchSource = data.search.searchSource.createEmpty();
Expand Down Expand Up @@ -164,10 +164,6 @@ export default function Expressions(props: Props) {
preFillCriteria();
}

if (!ruleParams.filterQuery) {
preFillFilterQuery();
}

if (!ruleParams.groupBy) {
preFillGroupBy();
}
Expand All @@ -176,7 +172,7 @@ export default function Expressions(props: Props) {
setRuleParams('alertOnNoData', true);
}
if (typeof ruleParams.alertOnGroupDisappear === 'undefined') {
setRuleParams('alertOnGroupDisappear', true);
preFillAlertOnGroupDisappear();
}
}, [metadata]); // eslint-disable-line react-hooks/exhaustive-deps

Expand Down Expand Up @@ -277,23 +273,13 @@ export default function Expressions(props: Props) {
[ruleParams.criteria, setRuleParams]
);

const preFillFilterQuery = useCallback(() => {
Copy link
Member Author

Choose a reason for hiding this comment

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

@fkanout I changed how we prefill filter so it matches how we save it in the rule. It will also allow us to extend this filter more easily in the future. Here is what the new structure looks like:

searchConfiguration: {
  index: 'metrics-*',
  query: {
    query: 'host.name: host-1',
    language: 'kuery',
  },
},

So we don't need to prefill the filter query separately anymore.

const md = metadata;

if (md && md.currentOptions?.filterQuery) {
setRuleParams('searchConfiguration', {
...ruleParams.searchConfiguration,
query: {
query: md.currentOptions.filterQuery,
language: 'kuery',
},
});
}
}, [metadata, setRuleParams, ruleParams.searchConfiguration]);

const preFillCriteria = useCallback(() => {
const md = metadata;
if (md?.currentOptions?.criteria?.length) {
const { timeSize: prefillTimeSize, timeUnit: prefillTimeUnit } =
md.currentOptions.criteria[0];
if (prefillTimeSize) setTimeSize(prefillTimeSize);
if (prefillTimeUnit) setTimeUnit(prefillTimeUnit);
setRuleParams(
'criteria',
md.currentOptions.criteria.map((criterion) => ({
Expand All @@ -313,6 +299,15 @@ export default function Expressions(props: Props) {
}
}, [metadata, setRuleParams]);

const preFillAlertOnGroupDisappear = useCallback(() => {
const md = metadata;
if (md && typeof md.currentOptions?.alertOnGroupDisappear !== 'undefined') {
setRuleParams('alertOnGroupDisappear', md.currentOptions.alertOnGroupDisappear);
} else {
setRuleParams('alertOnGroupDisappear', true);
}
}, [metadata, setRuleParams]);

const hasGroupBy = useMemo(
() => ruleParams.groupBy && ruleParams.groupBy.length > 0,
[ruleParams.groupBy]
Expand Down