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

[ResponseOps] Update flapping logic order to determine whether an alert is flapping after it's returned for notification #151148

Merged
merged 10 commits into from
Mar 1, 2023
Merged

[ResponseOps] Update flapping logic order to determine whether an alert is flapping after it's returned for notification #151148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b923644
Updating flapping logic order
doakalexi Feb 14, 2023
0980e2d
Updating tests
doakalexi Feb 23, 2023
ab85a88
Adding a new test
doakalexi Feb 23, 2023
3a125b5
Merge branch 'main' of github.com:elastic/kibana into alerting/update…
doakalexi Feb 23, 2023
f4136e6
Merge branch 'main' of github.com:elastic/kibana into alerting/update…
doakalexi Feb 24, 2023
c66d9d9
Removing only
doakalexi Feb 24, 2023
271b602
Fixing test failure
doakalexi Feb 24, 2023
f80335b
Call flapping in the task runner
doakalexi Feb 27, 2023
de0b2d6
Merge branch 'main' into alerting/update-flapping-logic-order
doakalexi Feb 27, 2023
8b84af2
Merge branch 'main' into alerting/update-flapping-logic-order
doakalexi Feb 27, 2023
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
15 changes: 1 addition & 14 deletions x-pack/plugins/alerting/server/alerts_client/legacy_alerts_client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { createAlertFactory, getPublicAlertFactory } from '../alert/create_alert
import { Alert } from '../alert/alert';
import { alertingEventLoggerMock } from '../lib/alerting_event_logger/alerting_event_logger.mock';
import { ruleRunMetricsStoreMock } from '../lib/rule_run_metrics_store.mock';
import { getAlertsForNotification, processAlerts, setFlapping } from '../lib';
import { getAlertsForNotification, processAlerts } from '../lib';
import { logAlerts } from '../task_runner/log_alerts';
import { DEFAULT_FLAPPING_SETTINGS } from '../../common/rules_settings';

Expand Down Expand Up @@ -254,19 +254,6 @@ describe('Legacy Alerts Client', () => {
flappingSettings: DEFAULT_FLAPPING_SETTINGS,
});

expect(setFlapping).toHaveBeenCalledWith(
{
enabled: true,
lookBackWindow: 20,
statusChangeThreshold: 4,
},
{
'1': new Alert<AlertInstanceContext, AlertInstanceContext>('1', testAlert1),
'2': new Alert<AlertInstanceContext, AlertInstanceContext>('2', testAlert2),
},
{}
);

expect(getAlertsForNotification).toHaveBeenCalledWith(
{
enabled: true,
Expand Down
14 changes: 8 additions & 6 deletions x-pack/plugins/alerting/server/alerts_client/legacy_alerts_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,6 @@ export class LegacyAlertsClient<
flappingSettings,
});

setFlapping<State, Context, ActionGroupIds, RecoveryActionGroupId>(
flappingSettings,
processedAlertsActive,
processedAlertsRecovered
);

const { trimmedAlertsRecovered, earlyRecoveredAlerts } = trimRecoveredAlerts(
this.options.logger,
processedAlertsRecovered,
Expand Down Expand Up @@ -213,4 +207,12 @@ export class LegacyAlertsClient<
public getExecutorServices() {
return getPublicAlertFactory(this.alertFactory!);
}

public setFlapping(flappingSettings: RulesSettingsFlappingProperties) {
setFlapping<State, Context, ActionGroupIds, RecoveryActionGroupId>(
flappingSettings,
this.processedAlerts.active,
this.processedAlerts.recovered
);
}
}
2 changes: 2 additions & 0 deletions x-pack/plugins/alerting/server/task_runner/task_runner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,8 @@ export class TaskRunner<
}
});

this.legacyAlertsClient.setFlapping(flappingSettings);

let alertsToReturn: Record<string, RawAlertInstance> = {};
let recoveredAlertsToReturn: Record<string, RawAlertInstance> = {};
// Only serialize alerts into task state if we're auto-recovering, otherwise
Expand Down
87 changes: 81 additions & 6 deletions x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1015,7 +1015,7 @@ describe('createLifecycleExecutor', () => {
return { state };
});

await executor(
const serializedAlerts = await executor(
createDefaultAlertExecutorOptions({
alertId: 'TEST_ALERT_0',
params: {},
Expand Down Expand Up @@ -1061,6 +1061,43 @@ describe('createLifecycleExecutor', () => {
})
);

expect(serializedAlerts.state.trackedAlerts).toEqual({
TEST_ALERT_0: {
alertId: 'TEST_ALERT_0',
alertUuid: 'TEST_ALERT_0_UUID',
flapping: true,
flappingHistory: flapping.slice(1).concat([false]),
pendingRecoveredCount: 0,
started: '2020-01-01T12:00:00.000Z',
},
TEST_ALERT_1: {
alertId: 'TEST_ALERT_1',
alertUuid: 'TEST_ALERT_1_UUID',
flapping: false,
flappingHistory: [false, false, false],
pendingRecoveredCount: 0,
started: '2020-01-02T12:00:00.000Z',
},
TEST_ALERT_2: {
alertId: 'TEST_ALERT_2',
alertUuid: 'TEST_ALERT_2_UUID',
flapping: true,
flappingHistory: flapping.slice(1).concat([false]),
pendingRecoveredCount: 0,
started: '2020-01-01T12:00:00.000Z',
},
TEST_ALERT_3: {
alertId: 'TEST_ALERT_3',
alertUuid: 'TEST_ALERT_3_UUID',
flapping: true,
flappingHistory: [false, false, false],
pendingRecoveredCount: 0,
started: '2020-01-02T12:00:00.000Z',
},
});

expect(serializedAlerts.state.trackedAlertsRecovered).toEqual({});

expect((await ruleDataClientMock.getWriter()).bulk).toHaveBeenCalledWith(
expect.objectContaining({
body: [
Expand All @@ -1070,7 +1107,7 @@ describe('createLifecycleExecutor', () => {
[ALERT_INSTANCE_ID]: 'TEST_ALERT_0',
[ALERT_WORKFLOW_STATUS]: 'closed',
[ALERT_STATUS]: ALERT_STATUS_ACTIVE,
[ALERT_FLAPPING]: true,
[ALERT_FLAPPING]: false,
[EVENT_ACTION]: 'active',
[EVENT_KIND]: 'signal',
}),
Expand Down Expand Up @@ -1182,7 +1219,7 @@ describe('createLifecycleExecutor', () => {
return { state };
});

await executor(
const serializedAlerts = await executor(
createDefaultAlertExecutorOptions({
alertId: 'TEST_ALERT_0',
params: {},
Expand Down Expand Up @@ -1228,17 +1265,55 @@ describe('createLifecycleExecutor', () => {
})
);

expect(serializedAlerts.state.trackedAlerts).toEqual({
TEST_ALERT_2: {
alertId: 'TEST_ALERT_2',
alertUuid: 'TEST_ALERT_2_UUID',
flapping: true,
flappingHistory: [true, true, true],
pendingRecoveredCount: 1,
started: '2020-01-02T12:00:00.000Z',
},
});

expect(serializedAlerts.state.trackedAlertsRecovered).toEqual({
TEST_ALERT_0: {
alertId: 'TEST_ALERT_0',
alertUuid: 'TEST_ALERT_0_UUID',
flapping: true,
flappingHistory: [true, true, true, true, true],
pendingRecoveredCount: 0,
started: '2020-01-01T12:00:00.000Z',
},
TEST_ALERT_1: {
alertId: 'TEST_ALERT_1',
alertUuid: 'TEST_ALERT_1_UUID',
flapping: false,
flappingHistory: notFlapping.slice(0, notFlapping.length - 1).concat([true]),
pendingRecoveredCount: 0,
started: '2020-01-02T12:00:00.000Z',
},
TEST_ALERT_3: {
alertId: 'TEST_ALERT_3',
alertUuid: 'TEST_ALERT_3_UUID',
flapping: false,
flappingHistory: notFlapping.slice(0, notFlapping.length - 1).concat([true]),
pendingRecoveredCount: 0,
started: '2020-01-02T12:00:00.000Z',
},
});

expect((await ruleDataClientMock.getWriter()).bulk).toHaveBeenCalledWith(
expect.objectContaining({
body: expect.arrayContaining([
// alert document
{ index: { _id: 'TEST_ALERT_0_UUID' } },
expect.objectContaining({
[ALERT_INSTANCE_ID]: 'TEST_ALERT_0',
[ALERT_STATUS]: ALERT_STATUS_ACTIVE,
[EVENT_ACTION]: 'active',
[ALERT_STATUS]: ALERT_STATUS_RECOVERED,
[EVENT_ACTION]: 'close',
[EVENT_KIND]: 'signal',
[ALERT_FLAPPING]: true,
[ALERT_FLAPPING]: false,
}),
{ index: { _id: 'TEST_ALERT_1_UUID' } },
expect.objectContaining({
Expand Down
15 changes: 5 additions & 10 deletions x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,12 +278,7 @@ export const createLifecycleExecutor =
trackedAlertRecoveredIds
);

const {
alertUuid,
started,
flapping: isCurrentlyFlapping,
pendingRecoveredCount,
} = !isNew
const { alertUuid, started, flapping, pendingRecoveredCount } = !isNew
? state.trackedAlerts[alertId]
: {
alertUuid: lifecycleAlertServices.getAlertUuid(alertId),
Expand All @@ -294,8 +289,6 @@ export const createLifecycleExecutor =
pendingRecoveredCount: 0,
};

const flapping = isFlapping(flappingSettings, flappingHistory, isCurrentlyFlapping);

const event: ParsedTechnicalFields & ParsedExperimentalFields = {
...alertData?.fields,
...commonRuleFields,
Expand Down Expand Up @@ -366,10 +359,11 @@ export const createLifecycleExecutor =
const nextTrackedAlerts = Object.fromEntries(
allEventsToIndex
.filter(({ event }) => event[ALERT_STATUS] !== ALERT_STATUS_RECOVERED)
.map(({ event, flappingHistory, flapping, pendingRecoveredCount }) => {
.map(({ event, flappingHistory, flapping: isCurrentlyFlapping, pendingRecoveredCount }) => {
const alertId = event[ALERT_INSTANCE_ID]!;
const alertUuid = event[ALERT_UUID]!;
const started = new Date(event[ALERT_START]!).toISOString();
const flapping = isFlapping(flappingSettings, flappingHistory, isCurrentlyFlapping);
return [
alertId,
{ alertId, alertUuid, started, flappingHistory, flapping, pendingRecoveredCount },
Expand All @@ -387,10 +381,11 @@ export const createLifecycleExecutor =
event[ALERT_STATUS] === ALERT_STATUS_RECOVERED &&
(flapping || flappingHistory.filter((f: boolean) => f).length > 0)
)
.map(({ event, flappingHistory, flapping, pendingRecoveredCount }) => {
.map(({ event, flappingHistory, flapping: isCurrentlyFlapping, pendingRecoveredCount }) => {
const alertId = event[ALERT_INSTANCE_ID]!;
const alertUuid = event[ALERT_UUID]!;
const started = new Date(event[ALERT_START]!).toISOString();
const flapping = isFlapping(flappingSettings, flappingHistory, isCurrentlyFlapping);
return [
alertId,
{ alertId, alertUuid, started, flappingHistory, flapping, pendingRecoveredCount },
Expand Down
Loading