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

[8.x] [Security Solution] Display cardinality for threshold rules (#201162) #201960

Merged
merged 1 commit into from
Nov 27, 2024
Merged

[8.x] [Security Solution] Display cardinality for threshold rules (#201162) #201960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 24 additions & 15 deletions ...solution/public/detection_engine/rule_creation_ui/components/description_step/helpers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import { FilterBadgeGroup } from '@kbn/unified-search-plugin/public';
import { IntervalAbbrScreenReader } from '../../../../common/components/accessibility';
import type {
RequiredFieldArray,
Threshold,
AlertSuppressionMissingFieldsStrategy,
} from '../../../../../common/api/detection_engine/model/rule_schema';
import { AlertSuppressionMissingFieldsStrategyEnum } from '../../../../../common/api/detection_engine/model/rule_schema';
Expand All @@ -50,6 +49,7 @@ import { defaultToEmptyTag } from '../../../../common/components/empty_value';
import { RequiredFieldIcon } from '../../../rule_management/components/rule_details/required_field_icon';
import { ThreatEuiFlexGroup } from './threat_description';
import { AlertSuppressionLabel } from './alert_suppression_label';
import type { FieldValueThreshold } from '../threshold_input';

const NoteDescriptionContainer = styled(EuiFlexItem)`
height: 105px;
Expand Down Expand Up @@ -490,20 +490,29 @@ export const buildRuleTypeDescription = (label: string, ruleType: Type): ListIte
}
};

export const buildThresholdDescription = (label: string, threshold: Threshold): ListItems[] => [
{
title: label,
description: (
<>
{isEmpty(threshold.field[0])
? `${i18n.THRESHOLD_RESULTS_ALL} >= ${threshold.value}`
: `${i18n.THRESHOLD_RESULTS_AGGREGATED_BY} ${
Array.isArray(threshold.field) ? threshold.field.join(',') : threshold.field
} >= ${threshold.value}`}
</>
),
},
];
export const buildThresholdDescription = (
label: string,
threshold: FieldValueThreshold
): ListItems[] => {
let thresholdDescription = isEmpty(threshold.field[0])
? `${i18n.THRESHOLD_RESULTS_ALL} >= ${threshold.value}`
: `${i18n.THRESHOLD_RESULTS_AGGREGATED_BY} ${threshold.field.join(',')} >= ${threshold.value}`;

if (threshold.cardinality?.value && threshold.cardinality?.field.length > 0) {
thresholdDescription = i18n.THRESHOLD_CARDINALITY(
thresholdDescription,
threshold.cardinality.field[0],
threshold.cardinality.value
);
}

return [
{
title: label,
description: <>{thresholdDescription}</>,
},
];
};

export const buildThreatMappingDescription = (
title: string,
Expand Down
54 changes: 53 additions & 1 deletion ...ution/public/detection_engine/rule_creation_ui/components/description_step/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,10 +451,62 @@ describe('description_step', () => {

expect(result[0].title).toEqual('Threshold label');
expect(React.isValidElement(result[0].description)).toBeTruthy();
expect(mount(result[0].description as React.ReactElement).html()).toContain(
expect(mount(result[0].description as React.ReactElement).html()).toEqual(
'Results aggregated by user.name >= 100'
);
});

test('returns threshold description when threshold exist, field is set, and cardinality is not set', () => {
const mockThreshold = {
threshold: {
field: ['user.name'],
value: 100,
cardinality: {
field: [],
value: 0,
},
},
};
const result: ListItems[] = getDescriptionItem(
'threshold',
'Threshold label',
mockThreshold,
mockFilterManager,
mockLicenseService
);

expect(result[0].title).toEqual('Threshold label');
expect(React.isValidElement(result[0].description)).toBeTruthy();
expect(mount(result[0].description as React.ReactElement).html()).toEqual(
'Results aggregated by user.name >= 100'
);
});

test('returns threshold description when threshold exist, field is set and cardinality is set', () => {
const mockThreshold = {
threshold: {
field: ['user.name'],
value: 100,
cardinality: {
field: ['host.test_value'],
value: 10,
},
},
};
const result: ListItems[] = getDescriptionItem(
'threshold',
'Threshold label',
mockThreshold,
mockFilterManager,
mockLicenseService
);

expect(result[0].title).toEqual('Threshold label');
expect(React.isValidElement(result[0].description)).toBeTruthy();
expect(mount(result[0].description as React.ReactElement).html()).toContain(
'Results aggregated by user.name >= 100 when unique values count of host.test_value >= 10'
);
});
});

describe('references', () => {
Expand Down
18 changes: 18 additions & 0 deletions ...tion/public/detection_engine/rule_creation_ui/components/description_step/translations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,24 @@ export const THRESHOLD_RESULTS_AGGREGATED_BY = i18n.translate(
}
);

export const THRESHOLD_CARDINALITY = (
thresholdFieldsGroupedBy: string,
cardinalityField: string,
cardinalityValue: string | number
) =>
i18n.translate(
'xpack.securitySolution.detectionEngine.ruleDescription.thresholdResultsCardinalityDescription',
{
defaultMessage:
'{thresholdFieldsGroupedBy} when unique values count of {cardinalityField} >= {cardinalityValue}',
values: {
thresholdFieldsGroupedBy,
cardinalityField,
cardinalityValue,
},
}
);

export const EQL_EVENT_CATEGORY_FIELD_LABEL = i18n.translate(
'xpack.securitySolution.detectionEngine.ruleDescription.eqlEventCategoryFieldLabel',
{
Expand Down
26 changes: 17 additions & 9 deletions ...blic/detection_engine/rule_management/components/rule_details/rule_definition_section.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,15 +185,23 @@ interface ThresholdProps {
threshold: ThresholdType;
}

export const Threshold = ({ threshold }: ThresholdProps) => (
<div data-test-subj="thresholdPropertyValue">
{isEmpty(threshold.field[0])
? `${descriptionStepI18n.THRESHOLD_RESULTS_ALL} >= ${threshold.value}`
: `${descriptionStepI18n.THRESHOLD_RESULTS_AGGREGATED_BY} ${
Array.isArray(threshold.field) ? threshold.field.join(',') : threshold.field
} >= ${threshold.value}`}
</div>
);
export const Threshold = ({ threshold }: ThresholdProps) => {
let thresholdDescription = isEmpty(threshold.field[0])
? `${descriptionStepI18n.THRESHOLD_RESULTS_ALL} >= ${threshold.value}`
: `${descriptionStepI18n.THRESHOLD_RESULTS_AGGREGATED_BY} ${
Array.isArray(threshold.field) ? threshold.field.join(',') : threshold.field
} >= ${threshold.value}`;

if (threshold.cardinality && threshold.cardinality.length > 0) {
thresholdDescription = descriptionStepI18n.THRESHOLD_CARDINALITY(
thresholdDescription,
threshold.cardinality[0].field,
threshold.cardinality[0].value
);
}

return <div data-test-subj="thresholdPropertyValue">{thresholdDescription}</div>;
};

interface AnomalyThresholdProps {
anomalyThreshold: number;
Expand Down
4 changes: 2 additions & 2 deletions ...ypress/e2e/detection_response/rule_management/prebuilt_rules/prebuilt_rules_preview.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ describe(
const { threshold } = THRESHOLD_RULE_INDEX_PATTERN['security-rule'] as {
threshold: Threshold;
};
assertThresholdPropertyShown(threshold.value);
assertThresholdPropertyShown(threshold);

const { index } = THRESHOLD_RULE_INDEX_PATTERN['security-rule'] as { index: string[] };
assertIndexPropertyShown(index);
Expand Down Expand Up @@ -952,7 +952,7 @@ describe(
const { threshold } = UPDATED_THRESHOLD_RULE_INDEX_PATTERN['security-rule'] as {
threshold: Threshold;
};
assertThresholdPropertyShown(threshold.value);
assertThresholdPropertyShown(threshold);

const { index } = UPDATED_THRESHOLD_RULE_INDEX_PATTERN['security-rule'] as {
index: string[];
Expand Down
15 changes: 12 additions & 3 deletions x-pack/test/security_solution_cypress/cypress/tasks/prebuilt_rules_preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
import { capitalize } from 'lodash';
import type { ThreatMapping } from '@kbn/securitysolution-io-ts-alerting-types';
import type { Module } from '@kbn/ml-plugin/common/types/modules';
import { AlertSuppression } from '@kbn/security-solution-plugin/common/api/detection_engine/model/rule_schema';
import {
AlertSuppression,
Threshold,
} from '@kbn/security-solution-plugin/common/api/detection_engine/model/rule_schema';
import type { Filter } from '@kbn/es-query';
import type { PrebuiltRuleAsset } from '@kbn/security-solution-plugin/server/lib/detection_engine/prebuilt_rules';
import {
Expand Down Expand Up @@ -312,9 +315,15 @@ export const assertMachineLearningPropertiesShown = (
});
};

export const assertThresholdPropertyShown = (thresholdValue: number) => {
export const assertThresholdPropertyShown = (threshold: Threshold) => {
cy.get(THRESHOLD_TITLE).should('have.text', 'Threshold');
cy.get(THRESHOLD_VALUE).should('contain', thresholdValue);
cy.get(THRESHOLD_VALUE).should('contain', threshold.value);
if (threshold.cardinality) {
cy.get(THRESHOLD_VALUE).should(
'contain',
`when unique values count of ${threshold.cardinality[0].field} >= ${threshold.cardinality[0].value}`
);
}
};

export const assertEqlQueryPropertyShown = (query: string) => {
Expand Down