github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 01:13:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.8] Not selecting any days in alerts filter maps to all weekdays (#156913) (#157211)

Browse source 
# Backport

This will backport the following commits from `main` to `8.8`:
- [Not selecting any days in alerts filter maps to all weekdays
(#156913)](https://github.com/elastic/kibana/pull/156913)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Ersin
Erdal","email":"92688503+ersin-erdal@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-05-09T15:29:14Z","message":"Not
selecting any days in alerts filter maps to all weekdays
(#156913)\n\nFixes: #156878\r\n\r\nAs discussed in the issue just
turning `if alert is generated within\r\ntimeframe` on should not change
the filter scope.\r\nAnd the UI should not confuse the users by setting
some days as default.\r\n\r\nAnd as discussed in #154680, default hours
filter should cover the whole\r\nday.\r\n\r\nTherefore, this PR sets
default alerts filter options as:\r\n```\r\n {\r\n days: [],\r\n hours:
{\r\n start: '00:00',\r\n end: '00:00',\r\n },\r\n
};\r\n```\r\n\r\nempty days array maps to all weekdays
`[1,2,3,4,5,6,7]`\r\nand hours `00:00 -> 00:00` maps to `00:00 ->
24:00`","sha":"d15738989a6544c9b939cde5afc3533c9850d7d4","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Team:ResponseOps","v8.8.0","v8.9.0"],"number":156913,"url":"https://github.com/elastic/kibana/pull/156913","mergeCommit":{"message":"Not
selecting any days in alerts filter maps to all weekdays
(#156913)\n\nFixes: #156878\r\n\r\nAs discussed in the issue just
turning `if alert is generated within\r\ntimeframe` on should not change
the filter scope.\r\nAnd the UI should not confuse the users by setting
some days as default.\r\n\r\nAnd as discussed in #154680, default hours
filter should cover the whole\r\nday.\r\n\r\nTherefore, this PR sets
default alerts filter options as:\r\n```\r\n {\r\n days: [],\r\n hours:
{\r\n start: '00:00',\r\n end: '00:00',\r\n },\r\n
};\r\n```\r\n\r\nempty days array maps to all weekdays
`[1,2,3,4,5,6,7]`\r\nand hours `00:00 -> 00:00` maps to `00:00 ->
24:00`","sha":"d15738989a6544c9b939cde5afc3533c9850d7d4"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156913","number":156913,"mergeCommit":{"message":"Not
selecting any days in alerts filter maps to all weekdays
(#156913)\n\nFixes: #156878\r\n\r\nAs discussed in the issue just
turning `if alert is generated within\r\ntimeframe` on should not change
the filter scope.\r\nAnd the UI should not confuse the users by setting
some days as default.\r\n\r\nAnd as discussed in #154680, default hours
filter should cover the whole\r\nday.\r\n\r\nTherefore, this PR sets
default alerts filter options as:\r\n```\r\n {\r\n days: [],\r\n hours:
{\r\n start: '00:00',\r\n end: '00:00',\r\n },\r\n
};\r\n```\r\n\r\nempty days array maps to all weekdays
`[1,2,3,4,5,6,7]`\r\nand hours `00:00 -> 00:00` maps to `00:00 ->
24:00`","sha":"d15738989a6544c9b939cde5afc3533c9850d7d4"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Ersin Erdal 2023-05-15 13:59:22 +02:00 • committed by GitHub
parent b37d329ffd
commit bf7e0f9528
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 195 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

1
x-pack/plugins/alerting/common/index.ts
View file

@ -45,6 +45,7 @@ export * from './rrule_type';
export * from './maintenance_window';
export * from './default_rule_aggregation';
export * from './rule_tags_aggregation';
export * from './iso_weekdays';
export { mappingFromFieldMap, getComponentTemplateFromFieldMap } from './alert_schema';

9
x-pack/plugins/alerting/common/iso_weekdays.ts Normal file
View file

@ -0,0 +1,9 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
export type IsoWeekday = 1 | 2 | 3 | 4 | 5 | 6 | 7;
export const ISO_WEEKDAYS: IsoWeekday[] = [1, 2, 3, 4, 5, 6, 7];

2
x-pack/plugins/alerting/common/rule.ts
View file

@ -11,6 +11,7 @@ import type {
SavedObjectsResolveResponse,
} from '@kbn/core/server';
import type { Filter, KueryNode } from '@kbn/es-query';
import { IsoWeekday } from './iso_weekdays';
import { RuleNotifyWhenType } from './rule_notify_when_type';
import { RuleSnooze } from './rule_snooze_type';
@ -83,7 +84,6 @@ export interface RuleActionFrequency extends SavedObjectAttributes {
throttle: string | null;
}
export type IsoWeekday = 1 | 2 | 3 | 4 | 5 | 6 | 7;
export interface AlertsFilterTimeframe extends SavedObjectAttributes {
days: IsoWeekday[];
timezone: string;

4
x-pack/plugins/alerting/public/pages/maintenance_windows/constants.ts
View file

@ -7,7 +7,7 @@
import { invert, mapValues } from 'lodash';
import moment from 'moment';
import * as i18n from './translations';
import { MaintenanceWindowStatus } from '../../../common';
import { ISO_WEEKDAYS, MaintenanceWindowStatus } from '../../../common';
// TODO - consolidate enum with backend
export enum Frequency {
@ -86,8 +86,6 @@ export const CREATE_FORM_CUSTOM_FREQUENCY = (interval: number = 1) => [
},
];
export const ISO_WEEKDAYS = [1, 2, 3, 4, 5, 6, 7];
export const WEEKDAY_OPTIONS = ISO_WEEKDAYS.map((n) => ({
id: String(n),
label: moment().isoWeekday(n).format('ddd'),

3
x-pack/plugins/alerting/public/pages/maintenance_windows/helpers/get_initial_by_weekday.ts
View file

@ -6,7 +6,8 @@
*/
import { Moment } from 'moment';
import { ISO_WEEKDAYS, ISO_WEEKDAYS_TO_RRULE } from '../constants';
import { ISO_WEEKDAYS } from '../../../../common';
import { ISO_WEEKDAYS_TO_RRULE } from '../constants';
export const getInitialByWeekday = (initialStateByweekday: string[], date: Moment | null) => {
const dayOfWeek = date ? date.isoWeekday() : 1;

162
x-pack/plugins/rule_registry/server/utils/create_get_summarized_alerts_fn.test.ts
View file

@ -2434,6 +2434,168 @@ describe('createGetSummarizedAlertsFn', () => {
});
});
it('creates function that correctly returns lifecycle alerts using alerts filter with no days selected', async () => {
ruleDataClientMock.getReader().search.mockResolvedValueOnce({
hits: {
total: {
value: 1,
},
hits: [
{
_id: '1',
_index: '.alerts-default-000001',
_source: {
[TIMESTAMP]: '2020-01-01T12:00:00.000Z',
[ALERT_RULE_EXECUTION_UUID]: 'abc',
[ALERT_RULE_UUID]: 'rule-id',
[EVENT_ACTION]: 'open',
[ALERT_INSTANCE_ID]: 'TEST_ALERT_3',
[ALERT_UUID]: 'uuid1',
},
},
],
},
} as any);
ruleDataClientMock.getReader().search.mockResolvedValueOnce({
hits: {
total: {
value: 0,
},
hits: [],
},
} as any);
ruleDataClientMock.getReader().search.mockResolvedValueOnce({
hits: {
total: {
value: 0,
},
hits: [],
},
} as any);
const getSummarizedAlertsFn = createGetSummarizedAlertsFn({
ruleDataClient: ruleDataClientMock,
useNamespace: false,
isLifecycleAlert: true,
})();
await getSummarizedAlertsFn({
executionUuid: 'abc',
ruleId: 'rule-id',
spaceId: 'space-id',
excludedAlertInstanceIds: [],
alertsFilter: {
query: {
kql: 'kibana.alert.rule.name:test',
dsl: '{"bool":{"minimum_should_match":1,"should":[{"match":{"kibana.alert.rule.name":"test"}}]}}',
filters: [],
},
timeframe: {
days: [],
hours: { start: '08:00', end: '17:00' },
timezone: 'UTC',
},
},
});
expect(ruleDataClientMock.getReader).toHaveBeenCalledWith();
expect(ruleDataClientMock.getReader().search).toHaveBeenCalledTimes(3);
expect(ruleDataClientMock.getReader().search).toHaveBeenNthCalledWith(1, {
body: {
size: 100,
track_total_hits: true,
query: {
bool: {
filter: [
{
term: {
[ALERT_RULE_EXECUTION_UUID]: 'abc',
},
},
{
term: {
[ALERT_RULE_UUID]: 'rule-id',
},
},
{
bool: {
must_not: {
exists: {
field: ALERT_MAINTENANCE_WINDOW_IDS,
},
},
},
},
{
term: {
[EVENT_ACTION]: 'open',
},
},
{
bool: {
minimum_should_match: 1,
should: [
{
match: {
'kibana.alert.rule.name': 'test',
},
},
],
},
},
{
script: {
script: {
params: {
datetimeField: '@timestamp',
days: [1, 2, 3, 4, 5, 6, 7],
timezone: 'UTC',
},
source:
'params.days.contains(doc[params.datetimeField].value.withZoneSameInstant(ZoneId.of(params.timezone)).dayOfWeek.getValue())',
},
},
},
{
script: {
script: {
params: {
datetimeField: '@timestamp',
end: '17:00',
start: '08:00',
timezone: 'UTC',
},
source: `
def alertsDateTime = doc[params.datetimeField].value.withZoneSameInstant(ZoneId.of(params.timezone));
def alertsTime = LocalTime.of(alertsDateTime.getHour(), alertsDateTime.getMinute());
def start = LocalTime.parse(params.start);
def end = LocalTime.parse(params.end);
if (end.isBefore(start) || end.equals(start)){ // overnight
def dayEnd = LocalTime.parse("23:59:59");
def dayStart = LocalTime.parse("00:00:00");
if ((alertsTime.isAfter(start) && alertsTime.isBefore(dayEnd)) || (alertsTime.isAfter(dayStart) && alertsTime.isBefore(end))) {
return true;
} else {
return false;
}
} else {
if (alertsTime.isAfter(start) && alertsTime.isBefore(end)) {
return true;
} else {
return false;
}
}
`,
},
},
},
],
},
},
},
});
});
it('throws error if search throws error', async () => {
ruleDataClientMock.getReader().search.mockImplementation(() => {
throw new Error('search error');

8
x-pack/plugins/rule_registry/server/utils/create_get_summarized_alerts_fn.ts
View file

@ -23,12 +23,13 @@ import {
QueryDslQueryContainer,
SearchTotalHits,
} from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
import { AlertsFilter } from '@kbn/alerting-plugin/common';
import { AlertsFilter, ISO_WEEKDAYS } from '@kbn/alerting-plugin/common';
import { ParsedTechnicalFields } from '../../common';
import { ParsedExperimentalFields } from '../../common/parse_experimental_fields';
import { IRuleDataClient, IRuleDataReader } from '../rule_data_client';
const MAX_ALERT_DOCS_TO_RETURN = 100;
export type AlertDocument = Partial<ParsedTechnicalFields & ParsedExperimentalFields>;
interface CreateGetSummarizedAlertsFnOpts {
@ -585,7 +586,10 @@ const generateAlertsFilterDSL = (alertsFilter: AlertsFilter): QueryDslQueryConta
source:
'params.days.contains(doc[params.datetimeField].value.withZoneSameInstant(ZoneId.of(params.timezone)).dayOfWeek.getValue())',
params: {
days: alertsFilter.timeframe.days,
days:
alertsFilter.timeframe.days.length === 0
? ISO_WEEKDAYS
: alertsFilter.timeframe.days,
timezone: alertsFilter.timeframe.timezone,
datetimeField: TIMESTAMP,
},

6
x-pack/plugins/security_solution/public/management/cypress/e2e/mocked_data/response_actions.cy.ts
View file

@ -99,7 +99,8 @@ describe('Response actions', () => {
cleanupRule(ruleId);
});
it('edit response action inside of a rule', () => {
// Flaky
it.skip('edit response action inside of a rule', () => {
visitRuleActions(ruleId);
cy.getByTestSubj(`response-actions-list-item-0`).within(() => {
cy.getByTestSubj('input').should('have.value', 'Isolate host');
@ -123,7 +124,8 @@ describe('Response actions', () => {
cy.contains(`${ruleName} was saved`).should('exist');
});
it('delete response action inside of a rule', () => {
// Flaky
it.skip('delete response action inside of a rule', () => {
visitRuleActions(ruleId);
cy.getByTestSubj(`response-actions-list-item-0`).within(() => {
cy.getByTestSubj('remove-response-action').click();

8
x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/action_alerts_filter_timeframe.tsx
View file

@ -20,8 +20,8 @@ import {
EuiComboBox,
} from '@elastic/eui';
import deepEqual from 'fast-deep-equal';
import { AlertsFilterTimeframe, IsoWeekday } from '@kbn/alerting-plugin/common';
import { I18N_WEEKDAY_OPTIONS_DDD, ISO_WEEKDAYS } from '../../../common/constants';
import { AlertsFilterTimeframe, ISO_WEEKDAYS, IsoWeekday } from '@kbn/alerting-plugin/common';
import { I18N_WEEKDAY_OPTIONS_DDD } from '../../../common/constants';
interface ActionAlertsFilterTimeframeProps {
state?: AlertsFilterTimeframe;
@ -49,11 +49,11 @@ const useDefaultTimezone = () => {
const useTimeframe = (initialTimeframe?: AlertsFilterTimeframe) => {
const timezone = useDefaultTimezone();
const DEFAULT_TIMEFRAME = {
days: ISO_WEEKDAYS,
days: [],
timezone,
hours: {
start: '00:00',
end: '23:59',
end: '00:00',
},
};
return useState<AlertsFilterTimeframe>(initialTimeframe || DEFAULT_TIMEFRAME);

3
x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/constants.ts
View file

@ -8,7 +8,8 @@ import { i18n } from '@kbn/i18n';
import { invert, mapValues } from 'lodash';
import { RRuleFrequency } from '../../../../../../types';
export { ISO_WEEKDAYS, I18N_WEEKDAY_OPTIONS } from '../../../../../../common/constants';
export { I18N_WEEKDAY_OPTIONS } from '../../../../../../common/constants';
export { ISO_WEEKDAYS } from '@kbn/alerting-plugin/common';
export const RECURRENCE_END_OPTIONS = [
{ id: 'never', label: 'Never' },

3
x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rule_snooze/recurrence_scheduler/helpers.tsx
View file

@ -8,9 +8,10 @@
import { i18n } from '@kbn/i18n';
import moment, { Moment } from 'moment';
import { ISO_WEEKDAYS } from '@kbn/alerting-plugin/common';
import { RecurrenceSchedule, RRuleFrequency } from '../../../../../../types';
import { i18nMonthDayDate } from '../../../../../lib/i18n_month_day_date';
import { ISO_WEEKDAYS, ISO_WEEKDAYS_TO_RRULE, RRULE_WEEKDAYS_TO_ISO_WEEKDAYS } from './constants';
import { ISO_WEEKDAYS_TO_RRULE, RRULE_WEEKDAYS_TO_ISO_WEEKDAYS } from './constants';
import { i18nFreqSummary, i18nNthWeekdayShort } from './translations';
export interface CustomFrequencyState {

4
x-pack/plugins/triggers_actions_ui/public/common/constants/i18n_weekdays.ts
View file

@ -4,11 +4,9 @@
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { IsoWeekday } from '@kbn/alerting-plugin/common';
import { ISO_WEEKDAYS } from '@kbn/alerting-plugin/common';
import moment from 'moment';
export const ISO_WEEKDAYS: IsoWeekday[] = [1, 2, 3, 4, 5, 6, 7];
export const I18N_WEEKDAY_OPTIONS = ISO_WEEKDAYS.map((n) => ({
id: String(n),
label: moment().isoWeekday(n).format('dd'),