maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Revert "[Alerting] renames Resolved action group to Recovered (#84123)"

Browse source 
This reverts commit 7dcaff5ddd.
This commit is contained in:
Tyler Smalley 2020-12-01 07:10:09 -08:00
parent 920e4fa280
commit 0b5c55c597
19 changed files with 90 additions and 147 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
x-pack/plugins/alerts/common/builtin_action_groups.ts
View file

@ -6,13 +6,13 @@
import { i18n } from '@kbn/i18n'; import { i18n } from '@kbn/i18n';
import { ActionGroup } from './alert_type'; import { ActionGroup } from './alert_type';
export const RecoveredActionGroup: ActionGroup = { export const ResolvedActionGroup: ActionGroup = {
id: 'recovered', id: 'resolved',
name: i18n.translate('xpack.alerts.builtinActionGroups.recovered', { name: i18n.translate('xpack.alerts.builtinActionGroups.resolved', {
defaultMessage: 'Recovered', defaultMessage: 'Resolved',
}), }),
}; };
export function getBuiltinActionGroups(): ActionGroup[] { export function getBuiltinActionGroups(): ActionGroup[] {
return [RecoveredActionGroup]; return [ResolvedActionGroup];
} }

14
x-pack/plugins/alerts/server/alert_type_registry.test.ts
View file

@ -105,8 +105,8 @@ describe('register()', () => {
name: 'Default', name: 'Default',
}, },
{ {
id: 'recovered', id: 'resolved',
name: 'Recovered', name: 'Resolved',
}, },
], ],
defaultActionGroupId: 'default', defaultActionGroupId: 'default',
@ -117,7 +117,7 @@ describe('register()', () => {
expect(() => registry.register(alertType)).toThrowError( expect(() => registry.register(alertType)).toThrowError(
new Error( new Error(
`Alert type [id="${alertType.id}"] cannot be registered. Action groups [recovered] are reserved by the framework.` `Alert type [id="${alertType.id}"] cannot be registered. Action groups [resolved] are reserved by the framework.`
) )
); );
}); });
@ -229,8 +229,8 @@ describe('get()', () => {
"name": "Default", "name": "Default",
}, },
Object { Object {
"id": "recovered", "id": "resolved",
"name": "Recovered", "name": "Resolved",
}, },
], ],
"actionVariables": Object { "actionVariables": Object {
@ -287,8 +287,8 @@ describe('list()', () => {
"name": "Test Action Group", "name": "Test Action Group",
}, },
Object { Object {
"id": "recovered", "id": "resolved",
"name": "Recovered", "name": "Resolved",
}, },
], ],
"actionVariables": Object { "actionVariables": Object {

2
x-pack/plugins/alerts/server/alerts_client/tests/get_alert_instance_summary.test.ts
View file

@ -122,7 +122,7 @@ describe('getAlertInstanceSummary()', () => {
.addActiveInstance('instance-previously-active', 'action group B') .addActiveInstance('instance-previously-active', 'action group B')
.advanceTime(10000) .advanceTime(10000)
.addExecute() .addExecute()
.addRecoveredInstance('instance-previously-active') .addResolvedInstance('instance-previously-active')
.addActiveInstance('instance-currently-active', 'action group A') .addActiveInstance('instance-currently-active', 'action group A')
.getEvents(); .getEvents();
const eventsResult = { const eventsResult = {

62
x-pack/plugins/alerts/server/lib/alert_instance_summary_from_event_log.test.ts
View file

@ -6,7 +6,7 @@
import { SanitizedAlert, AlertInstanceSummary } from '../types'; import { SanitizedAlert, AlertInstanceSummary } from '../types';
import { IValidatedEvent } from '../../../event_log/server'; import { IValidatedEvent } from '../../../event_log/server';
import { EVENT_LOG_ACTIONS, EVENT_LOG_PROVIDER, LEGACY_EVENT_LOG_ACTIONS } from '../plugin'; import { EVENT_LOG_ACTIONS, EVENT_LOG_PROVIDER } from '../plugin';
import { alertInstanceSummaryFromEventLog } from './alert_instance_summary_from_event_log'; import { alertInstanceSummaryFromEventLog } from './alert_instance_summary_from_event_log';
const ONE_HOUR_IN_MILLIS = 60 * 60 * 1000; const ONE_HOUR_IN_MILLIS = 60 * 60 * 1000;
@ -189,43 +189,7 @@ describe('alertInstanceSummaryFromEventLog', () => {
.addActiveInstance('instance-1', 'action group A') .addActiveInstance('instance-1', 'action group A')
.advanceTime(10000) .advanceTime(10000)
.addExecute() .addExecute()
.addRecoveredInstance('instance-1') .addResolvedInstance('instance-1')
.getEvents();
const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({
alert,
events,
dateStart,
dateEnd,
});
const { lastRun, status, instances } = summary;
expect({ lastRun, status, instances }).toMatchInlineSnapshot(`
Object {
"instances": Object {
"instance-1": Object {
"actionGroupId": undefined,
"activeStartDate": undefined,
"muted": false,
"status": "OK",
},
},
"lastRun": "2020-06-18T00:00:10.000Z",
"status": "OK",
}
`);
});
test('legacy alert with currently inactive instance', async () => {
const alert = createAlert({});
const eventsFactory = new EventsFactory();
const events = eventsFactory
.addExecute()
.addNewInstance('instance-1')
.addActiveInstance('instance-1', 'action group A')
.advanceTime(10000)
.addExecute()
.addLegacyResolvedInstance('instance-1')
.getEvents(); .getEvents();
const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({ const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({
@ -260,7 +224,7 @@ describe('alertInstanceSummaryFromEventLog', () => {
.addActiveInstance('instance-1', 'action group A') .addActiveInstance('instance-1', 'action group A')
.advanceTime(10000) .advanceTime(10000)
.addExecute() .addExecute()
.addRecoveredInstance('instance-1') .addResolvedInstance('instance-1')
.getEvents(); .getEvents();
const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({ const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({
@ -442,7 +406,7 @@ describe('alertInstanceSummaryFromEventLog', () => {
.advanceTime(10000) .advanceTime(10000)
.addExecute() .addExecute()
.addActiveInstance('instance-1', 'action group A') .addActiveInstance('instance-1', 'action group A')
.addRecoveredInstance('instance-2') .addResolvedInstance('instance-2')
.getEvents(); .getEvents();
const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({ const summary: AlertInstanceSummary = alertInstanceSummaryFromEventLog({
@ -487,7 +451,7 @@ describe('alertInstanceSummaryFromEventLog', () => {
.advanceTime(10000) .advanceTime(10000)
.addExecute() .addExecute()
.addActiveInstance('instance-1', 'action group A') .addActiveInstance('instance-1', 'action group A')
.addRecoveredInstance('instance-2') .addResolvedInstance('instance-2')
.advanceTime(10000) .advanceTime(10000)
.addExecute() .addExecute()
.addActiveInstance('instance-1', 'action group B') .addActiveInstance('instance-1', 'action group B')
@ -597,24 +561,12 @@ export class EventsFactory {
return this; return this;
} }
addRecoveredInstance(instanceId: string): EventsFactory { addResolvedInstance(instanceId: string): EventsFactory {
this.events.push({ this.events.push({
'@timestamp': this.date, '@timestamp': this.date,
event: { event: {
provider: EVENT_LOG_PROVIDER, provider: EVENT_LOG_PROVIDER,
action: EVENT_LOG_ACTIONS.recoveredInstance, action: EVENT_LOG_ACTIONS.resolvedInstance,
},
kibana: { alerting: { instance_id: instanceId } },
});
return this;
}
addLegacyResolvedInstance(instanceId: string): EventsFactory {
this.events.push({
'@timestamp': this.date,
event: {
provider: EVENT_LOG_PROVIDER,
action: LEGACY_EVENT_LOG_ACTIONS.resolvedInstance,
}, },
kibana: { alerting: { instance_id: instanceId } }, kibana: { alerting: { instance_id: instanceId } },
}); });

5
x-pack/plugins/alerts/server/lib/alert_instance_summary_from_event_log.ts
View file

@ -6,7 +6,7 @@
import { SanitizedAlert, AlertInstanceSummary, AlertInstanceStatus } from '../types'; import { SanitizedAlert, AlertInstanceSummary, AlertInstanceStatus } from '../types';
import { IEvent } from '../../../event_log/server'; import { IEvent } from '../../../event_log/server';
import { EVENT_LOG_ACTIONS, EVENT_LOG_PROVIDER, LEGACY_EVENT_LOG_ACTIONS } from '../plugin'; import { EVENT_LOG_ACTIONS, EVENT_LOG_PROVIDER } from '../plugin';
export interface AlertInstanceSummaryFromEventLogParams { export interface AlertInstanceSummaryFromEventLogParams {
alert: SanitizedAlert; alert: SanitizedAlert;
@ -80,8 +80,7 @@ export function alertInstanceSummaryFromEventLog(
status.status = 'Active'; status.status = 'Active';
status.actionGroupId = event?.kibana?.alerting?.action_group_id; status.actionGroupId = event?.kibana?.alerting?.action_group_id;
break; break;
case LEGACY_EVENT_LOG_ACTIONS.resolvedInstance: case EVENT_LOG_ACTIONS.resolvedInstance:
case EVENT_LOG_ACTIONS.recoveredInstance:
status.status = 'OK'; status.status = 'OK';
status.activeStartDate = undefined; status.activeStartDate = undefined;
status.actionGroupId = undefined; status.actionGroupId = undefined;

5
x-pack/plugins/alerts/server/plugin.ts
View file

@ -82,11 +82,8 @@ export const EVENT_LOG_ACTIONS = {
execute: 'execute', execute: 'execute',
executeAction: 'execute-action', executeAction: 'execute-action',
newInstance: 'new-instance', newInstance: 'new-instance',
recoveredInstance: 'recovered-instance',
activeInstance: 'active-instance',
};
export const LEGACY_EVENT_LOG_ACTIONS = {
resolvedInstance: 'resolved-instance', resolvedInstance: 'resolved-instance',
activeInstance: 'active-instance',
}; };
export interface PluginSetupContract { export interface PluginSetupContract {

12
x-pack/plugins/alerts/server/task_runner/task_runner.test.ts
View file

@ -26,12 +26,12 @@ import { alertsMock, alertsClientMock } from '../mocks';
import { eventLoggerMock } from '../../../event_log/server/event_logger.mock'; import { eventLoggerMock } from '../../../event_log/server/event_logger.mock';
import { IEventLogger } from '../../../event_log/server'; import { IEventLogger } from '../../../event_log/server';
import { SavedObjectsErrorHelpers } from '../../../../../src/core/server'; import { SavedObjectsErrorHelpers } from '../../../../../src/core/server';
import { Alert, RecoveredActionGroup } from '../../common'; import { Alert, ResolvedActionGroup } from '../../common';
import { omit } from 'lodash'; import { omit } from 'lodash';
const alertType = { const alertType = {
id: 'test', id: 'test',
name: 'My test alert', name: 'My test alert',
actionGroups: [{ id: 'default', name: 'Default' }, RecoveredActionGroup], actionGroups: [{ id: 'default', name: 'Default' }, ResolvedActionGroup],
defaultActionGroupId: 'default', defaultActionGroupId: 'default',
executor: jest.fn(), executor: jest.fn(),
producer: 'alerts', producer: 'alerts',
@ -114,7 +114,7 @@ describe('Task Runner', () => {
}, },
}, },
{ {
group: RecoveredActionGroup.id, group: ResolvedActionGroup.id,
id: '2', id: '2',
actionTypeId: 'action', actionTypeId: 'action',
params: { params: {
@ -517,7 +517,7 @@ describe('Task Runner', () => {
`); `);
}); });
test('fire recovered actions for execution for the alertInstances which is in the recovered state', async () => { test('fire resolved actions for execution for the alertInstances which is in the resolved state', async () => {
taskRunnerFactoryInitializerParams.actionsPlugin.isActionTypeEnabled.mockReturnValue(true); taskRunnerFactoryInitializerParams.actionsPlugin.isActionTypeEnabled.mockReturnValue(true);
taskRunnerFactoryInitializerParams.actionsPlugin.isActionExecutable.mockReturnValue(true); taskRunnerFactoryInitializerParams.actionsPlugin.isActionExecutable.mockReturnValue(true);
@ -650,7 +650,7 @@ describe('Task Runner', () => {
Array [ Array [
Object { Object {
"event": Object { "event": Object {
"action": "recovered-instance", "action": "resolved-instance",
}, },
"kibana": Object { "kibana": Object {
"alerting": Object { "alerting": Object {
@ -666,7 +666,7 @@ describe('Task Runner', () => {
}, },
], ],
}, },
"message": "test:1: 'alert-name' instance '2' has recovered", "message": "test:1: 'alert-name' resolved instance: '2'",
}, },
], ],
Array [ Array [

32
x-pack/plugins/alerts/server/task_runner/task_runner.ts
View file

@ -39,7 +39,7 @@ import { IEvent, IEventLogger, SAVED_OBJECT_REL_PRIMARY } from '../../../event_l
import { isAlertSavedObjectNotFoundError } from '../lib/is_alert_not_found_error'; import { isAlertSavedObjectNotFoundError } from '../lib/is_alert_not_found_error';
import { AlertsClient } from '../alerts_client'; import { AlertsClient } from '../alerts_client';
import { partiallyUpdateAlert } from '../saved_objects'; import { partiallyUpdateAlert } from '../saved_objects';
import { RecoveredActionGroup } from '../../common'; import { ResolvedActionGroup } from '../../common';
const FALLBACK_RETRY_INTERVAL = '5m'; const FALLBACK_RETRY_INTERVAL = '5m';
@ -219,7 +219,7 @@ export class TaskRunner {
alertInstance.hasScheduledActions() alertInstance.hasScheduledActions()
); );
generateNewAndRecoveredInstanceEvents({ generateNewAndResolvedInstanceEvents({
eventLogger, eventLogger,
originalAlertInstances, originalAlertInstances,
currentAlertInstances: instancesWithScheduledActions, currentAlertInstances: instancesWithScheduledActions,
@ -229,7 +229,7 @@ export class TaskRunner {
}); });
if (!muteAll) { if (!muteAll) {
scheduleActionsForRecoveredInstances( scheduleActionsForResolvedInstances(
alertInstances, alertInstances,
executionHandler, executionHandler,
originalAlertInstances, originalAlertInstances,
@ -436,7 +436,7 @@ export class TaskRunner {
} }
} }
interface GenerateNewAndRecoveredInstanceEventsParams { interface GenerateNewAndResolvedInstanceEventsParams {
eventLogger: IEventLogger; eventLogger: IEventLogger;
originalAlertInstances: Dictionary<AlertInstance>; originalAlertInstances: Dictionary<AlertInstance>;
currentAlertInstances: Dictionary<AlertInstance>; currentAlertInstances: Dictionary<AlertInstance>;
@ -445,20 +445,18 @@ interface GenerateNewAndRecoveredInstanceEventsParams {
namespace: string | undefined; namespace: string | undefined;
} }
function generateNewAndRecoveredInstanceEvents( function generateNewAndResolvedInstanceEvents(params: GenerateNewAndResolvedInstanceEventsParams) {
params: GenerateNewAndRecoveredInstanceEventsParams
) {
const { eventLogger, alertId, namespace, currentAlertInstances, originalAlertInstances } = params; const { eventLogger, alertId, namespace, currentAlertInstances, originalAlertInstances } = params;
const originalAlertInstanceIds = Object.keys(originalAlertInstances); const originalAlertInstanceIds = Object.keys(originalAlertInstances);
const currentAlertInstanceIds = Object.keys(currentAlertInstances); const currentAlertInstanceIds = Object.keys(currentAlertInstances);
const newIds = without(currentAlertInstanceIds, ...originalAlertInstanceIds); const newIds = without(currentAlertInstanceIds, ...originalAlertInstanceIds);
const recoveredIds = without(originalAlertInstanceIds, ...currentAlertInstanceIds); const resolvedIds = without(originalAlertInstanceIds, ...currentAlertInstanceIds);
for (const id of recoveredIds) { for (const id of resolvedIds) {
const actionGroup = originalAlertInstances[id].getLastScheduledActions()?.group; const actionGroup = originalAlertInstances[id].getLastScheduledActions()?.group;
const message = `${params.alertLabel} instance '${id}' has recovered`; const message = `${params.alertLabel} resolved instance: '${id}'`;
logInstanceEvent(id, EVENT_LOG_ACTIONS.recoveredInstance, message, actionGroup); logInstanceEvent(id, EVENT_LOG_ACTIONS.resolvedInstance, message, actionGroup);
} }
for (const id of newIds) { for (const id of newIds) {
@ -498,7 +496,7 @@ function generateNewAndRecoveredInstanceEvents(
} }
} }
function scheduleActionsForRecoveredInstances( function scheduleActionsForResolvedInstances(
alertInstancesMap: Record<string, AlertInstance>, alertInstancesMap: Record<string, AlertInstance>,
executionHandler: ReturnType<typeof createExecutionHandler>, executionHandler: ReturnType<typeof createExecutionHandler>,
originalAlertInstances: Record<string, AlertInstance>, originalAlertInstances: Record<string, AlertInstance>,
@ -507,22 +505,22 @@ function scheduleActionsForRecoveredInstances(
) { ) {
const currentAlertInstanceIds = Object.keys(currentAlertInstances); const currentAlertInstanceIds = Object.keys(currentAlertInstances);
const originalAlertInstanceIds = Object.keys(originalAlertInstances); const originalAlertInstanceIds = Object.keys(originalAlertInstances);
const recoveredIds = without( const resolvedIds = without(
originalAlertInstanceIds, originalAlertInstanceIds,
...currentAlertInstanceIds, ...currentAlertInstanceIds,
...mutedInstanceIds ...mutedInstanceIds
); );
for (const id of recoveredIds) { for (const id of resolvedIds) {
const instance = alertInstancesMap[id]; const instance = alertInstancesMap[id];
instance.updateLastScheduledActions(RecoveredActionGroup.id); instance.updateLastScheduledActions(ResolvedActionGroup.id);
instance.unscheduleActions(); instance.unscheduleActions();
executionHandler({ executionHandler({
actionGroup: RecoveredActionGroup.id, actionGroup: ResolvedActionGroup.id,
context: {}, context: {},
state: {}, state: {},
alertInstanceId: id, alertInstanceId: id,
}); });
instance.scheduleActions(RecoveredActionGroup.id); instance.scheduleActions(ResolvedActionGroup.id);
} }
} }

4
x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts
View file

@ -9,7 +9,7 @@ import moment from 'moment';
import { getCustomMetricLabel } from '../../../../common/formatters/get_custom_metric_label'; import { getCustomMetricLabel } from '../../../../common/formatters/get_custom_metric_label';
import { toMetricOpt } from '../../../../common/snapshot_metric_i18n'; import { toMetricOpt } from '../../../../common/snapshot_metric_i18n';
import { AlertStates, InventoryMetricConditions } from './types'; import { AlertStates, InventoryMetricConditions } from './types';
import { RecoveredActionGroup } from '../../../../../alerts/common'; import { ResolvedActionGroup } from '../../../../../alerts/common';
import { AlertExecutorOptions } from '../../../../../alerts/server'; import { AlertExecutorOptions } from '../../../../../alerts/server';
import { InventoryItemType, SnapshotMetricType } from '../../../../common/inventory_models/types'; import { InventoryItemType, SnapshotMetricType } from '../../../../common/inventory_models/types';
import { InfraBackendLibs } from '../../infra_types'; import { InfraBackendLibs } from '../../infra_types';
@ -103,7 +103,7 @@ export const createInventoryMetricThresholdExecutor = (libs: InfraBackendLibs) =
} }
if (reason) { if (reason) {
const actionGroupId = const actionGroupId =
nextState === AlertStates.OK ? RecoveredActionGroup.id : FIRED_ACTIONS.id; nextState === AlertStates.OK ? ResolvedActionGroup.id : FIRED_ACTIONS.id;
alertInstance.scheduleActions(actionGroupId, { alertInstance.scheduleActions(actionGroupId, {
group: item, group: item,
alertState: stateToAlertMessage[nextState], alertState: stateToAlertMessage[nextState],

6
x-pack/plugins/infra/server/lib/alerting/metric_threshold/metric_threshold_executor.test.ts
View file

@ -6,7 +6,7 @@
import { createMetricThresholdExecutor, FIRED_ACTIONS } from './metric_threshold_executor'; import { createMetricThresholdExecutor, FIRED_ACTIONS } from './metric_threshold_executor';
import { Comparator, AlertStates } from './types'; import { Comparator, AlertStates } from './types';
import * as mocks from './test_mocks'; import * as mocks from './test_mocks';
import { RecoveredActionGroup } from '../../../../../alerts/common'; import { ResolvedActionGroup } from '../../../../../alerts/common';
import { AlertExecutorOptions } from '../../../../../alerts/server'; import { AlertExecutorOptions } from '../../../../../alerts/server';
import { import {
alertsMock, alertsMock,
@ -367,7 +367,7 @@ describe('The metric threshold alert type', () => {
expect(mostRecentAction(instanceID).id).toBe(FIRED_ACTIONS.id); expect(mostRecentAction(instanceID).id).toBe(FIRED_ACTIONS.id);
expect(getState(instanceID).alertState).toBe(AlertStates.ALERT); expect(getState(instanceID).alertState).toBe(AlertStates.ALERT);
await execute([2]); await execute([2]);
expect(mostRecentAction(instanceID).id).toBe(RecoveredActionGroup.id); expect(mostRecentAction(instanceID).id).toBe(ResolvedActionGroup.id);
expect(getState(instanceID).alertState).toBe(AlertStates.OK); expect(getState(instanceID).alertState).toBe(AlertStates.OK);
}); });
test('does not continue to send a recovery alert if the metric is still OK', async () => { test('does not continue to send a recovery alert if the metric is still OK', async () => {
@ -383,7 +383,7 @@ describe('The metric threshold alert type', () => {
expect(mostRecentAction(instanceID).id).toBe(FIRED_ACTIONS.id); expect(mostRecentAction(instanceID).id).toBe(FIRED_ACTIONS.id);
expect(getState(instanceID).alertState).toBe(AlertStates.ALERT); expect(getState(instanceID).alertState).toBe(AlertStates.ALERT);
await execute([2]); await execute([2]);
expect(mostRecentAction(instanceID).id).toBe(RecoveredActionGroup.id); expect(mostRecentAction(instanceID).id).toBe(ResolvedActionGroup.id);
expect(getState(instanceID).alertState).toBe(AlertStates.OK); expect(getState(instanceID).alertState).toBe(AlertStates.OK);
}); });
}); });

4
x-pack/plugins/infra/server/lib/alerting/metric_threshold/metric_threshold_executor.ts
View file

@ -6,7 +6,7 @@
import { first, last } from 'lodash'; import { first, last } from 'lodash';
import { i18n } from '@kbn/i18n'; import { i18n } from '@kbn/i18n';
import moment from 'moment'; import moment from 'moment';
import { RecoveredActionGroup } from '../../../../../alerts/common'; import { ResolvedActionGroup } from '../../../../../alerts/common';
import { AlertExecutorOptions } from '../../../../../alerts/server'; import { AlertExecutorOptions } from '../../../../../alerts/server';
import { InfraBackendLibs } from '../../infra_types'; import { InfraBackendLibs } from '../../infra_types';
import { import {
@ -89,7 +89,7 @@ export const createMetricThresholdExecutor = (libs: InfraBackendLibs) =>
const firstResult = first(alertResults); const firstResult = first(alertResults);
const timestamp = (firstResult && firstResult[group].timestamp) ?? moment().toISOString(); const timestamp = (firstResult && firstResult[group].timestamp) ?? moment().toISOString();
const actionGroupId = const actionGroupId =
nextState === AlertStates.OK ? RecoveredActionGroup.id : FIRED_ACTIONS.id; nextState === AlertStates.OK ? ResolvedActionGroup.id : FIRED_ACTIONS.id;
alertInstance.scheduleActions(actionGroupId, { alertInstance.scheduleActions(actionGroupId, {
group, group,
alertState: stateToAlertMessage[nextState], alertState: stateToAlertMessage[nextState],

6
x-pack/plugins/triggers_actions_ui/public/application/constants/index.ts
View file

@ -16,10 +16,10 @@ export const routeToConnectors = `/connectors`;
export const routeToAlerts = `/alerts`; export const routeToAlerts = `/alerts`;
export const routeToAlertDetails = `/alert/:alertId`; export const routeToAlertDetails = `/alert/:alertId`;
export const recoveredActionGroupMessage = i18n.translate( export const resolvedActionGroupMessage = i18n.translate(
'xpack.triggersActionsUI.sections.actionForm.RecoveredMessage', 'xpack.triggersActionsUI.sections.actionForm.ResolvedMessage',
{ {
defaultMessage: 'Recovered', defaultMessage: 'Resolved',
} }
); );

27
x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/action_form.test.tsx
View file

@ -10,9 +10,8 @@ import { act } from 'react-dom/test-utils';
import { actionTypeRegistryMock } from '../../action_type_registry.mock'; import { actionTypeRegistryMock } from '../../action_type_registry.mock';
import { ValidationResult, Alert, AlertAction } from '../../../types'; import { ValidationResult, Alert, AlertAction } from '../../../types';
import ActionForm from './action_form'; import ActionForm from './action_form';
import { RecoveredActionGroup } from '../../../../../alerts/common'; import { ResolvedActionGroup } from '../../../../../alerts/common';
import { useKibana } from '../../../common/lib/kibana'; import { useKibana } from '../../../common/lib/kibana';
import { EuiScreenReaderOnly } from '@elastic/eui';
jest.mock('../../../common/lib/kibana'); jest.mock('../../../common/lib/kibana');
jest.mock('../../lib/action_connector_api', () => ({ jest.mock('../../lib/action_connector_api', () => ({
loadAllActions: jest.fn(), loadAllActions: jest.fn(),
@ -229,7 +228,7 @@ describe('action_form', () => {
}} }}
actionGroups={[ actionGroups={[
{ id: 'default', name: 'Default' }, { id: 'default', name: 'Default' },
{ id: 'recovered', name: 'Recovered' }, { id: 'resolved', name: 'Resolved' },
]} ]}
setActionGroupIdByIndex={(group: string, index: number) => { setActionGroupIdByIndex={(group: string, index: number) => {
initialAlert.actions[index].group = group; initialAlert.actions[index].group = group;
@ -348,18 +347,18 @@ describe('action_form', () => {
"value": "default", "value": "default",
}, },
Object { Object {
"data-test-subj": "addNewActionConnectorActionGroup-0-option-recovered", "data-test-subj": "addNewActionConnectorActionGroup-0-option-resolved",
"inputDisplay": "Recovered", "inputDisplay": "Resolved",
"value": "recovered", "value": "resolved",
}, },
] ]
`); `);
}); });
it('renders selected Recovered action group', async () => { it('renders selected Resolved action group', async () => {
const wrapper = await setup([ const wrapper = await setup([
{ {
group: RecoveredActionGroup.id, group: ResolvedActionGroup.id,
id: 'test', id: 'test',
actionTypeId: actionType.id, actionTypeId: actionType.id,
params: { params: {
@ -382,17 +381,15 @@ describe('action_form', () => {
"value": "default", "value": "default",
}, },
Object { Object {
"data-test-subj": "addNewActionConnectorActionGroup-0-option-recovered", "data-test-subj": "addNewActionConnectorActionGroup-0-option-resolved",
"inputDisplay": "Recovered", "inputDisplay": "Resolved",
"value": "recovered", "value": "resolved",
}, },
] ]
`); `);
expect(actionGroupsSelect.first().text()).toEqual(
expect(actionGroupsSelect.first().find(EuiScreenReaderOnly).text()).toEqual( 'Select an option: Resolved, is selectedResolved'
'Select an option: Recovered, is selected'
); );
expect(actionGroupsSelect.first().find('button').first().text()).toEqual('Recovered');
}); });
it('renders available connectors for the selected action type', async () => { it('renders available connectors for the selected action type', async () => {

10
x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/action_type_form.tsx
View file

@ -26,7 +26,7 @@ import {
EuiBadge, EuiBadge,
EuiErrorBoundary, EuiErrorBoundary,
} from '@elastic/eui'; } from '@elastic/eui';
import { AlertActionParam, RecoveredActionGroup } from '../../../../../alerts/common'; import { AlertActionParam, ResolvedActionGroup } from '../../../../../alerts/common';
import { import {
IErrorObject, IErrorObject,
AlertAction, AlertAction,
@ -40,7 +40,7 @@ import { checkActionFormActionTypeEnabled } from '../../lib/check_action_type_en
import { hasSaveActionsCapability } from '../../lib/capabilities'; import { hasSaveActionsCapability } from '../../lib/capabilities';
import { ActionAccordionFormProps } from './action_form'; import { ActionAccordionFormProps } from './action_form';
import { transformActionVariables } from '../../lib/action_variables'; import { transformActionVariables } from '../../lib/action_variables';
import { recoveredActionGroupMessage } from '../../constants'; import { resolvedActionGroupMessage } from '../../constants';
import { useKibana } from '../../../common/lib/kibana'; import { useKibana } from '../../../common/lib/kibana';
import { getDefaultsForActionParams } from '../../lib/get_defaults_for_action_params'; import { getDefaultsForActionParams } from '../../lib/get_defaults_for_action_params';
@ -105,8 +105,8 @@ export const ActionTypeForm = ({
useEffect(() => { useEffect(() => {
setAvailableActionVariables(getAvailableActionVariables(messageVariables, actionItem.group)); setAvailableActionVariables(getAvailableActionVariables(messageVariables, actionItem.group));
const res = const res =
actionItem.group === RecoveredActionGroup.id actionItem.group === ResolvedActionGroup.id
? recoveredActionGroupMessage ? resolvedActionGroupMessage
: defaultActionMessage; : defaultActionMessage;
setAvailableDefaultActionMessage(res); setAvailableDefaultActionMessage(res);
const paramsDefaults = getDefaultsForActionParams(actionItem.actionTypeId, actionItem.group); const paramsDefaults = getDefaultsForActionParams(actionItem.actionTypeId, actionItem.group);
@ -374,7 +374,7 @@ function getAvailableActionVariables(
return []; return [];
} }
const filteredActionVariables = const filteredActionVariables =
actionGroup === RecoveredActionGroup.id actionGroup === ResolvedActionGroup.id
? { params: actionVariables.params, state: actionVariables.state } ? { params: actionVariables.params, state: actionVariables.state }
: actionVariables; : actionVariables;

4
x-pack/test/alerting_api_integration/security_and_spaces/tests/alerting/list_alert_types.ts
View file

@ -17,7 +17,7 @@ export default function listAlertTypes({ getService }: FtrProviderContext) {
const expectedNoOpType = { const expectedNoOpType = {
actionGroups: [ actionGroups: [
{ id: 'default', name: 'Default' }, { id: 'default', name: 'Default' },
{ id: 'recovered', name: 'Recovered' }, { id: 'resolved', name: 'Resolved' },
], ],
defaultActionGroupId: 'default', defaultActionGroupId: 'default',
id: 'test.noop', id: 'test.noop',
@ -33,7 +33,7 @@ export default function listAlertTypes({ getService }: FtrProviderContext) {
const expectedRestrictedNoOpType = { const expectedRestrictedNoOpType = {
actionGroups: [ actionGroups: [
{ id: 'default', name: 'Default' }, { id: 'default', name: 'Default' },
{ id: 'recovered', name: 'Recovered' }, { id: 'resolved', name: 'Resolved' },
], ],
defaultActionGroupId: 'default', defaultActionGroupId: 'default',
id: 'test.restricted-noop', id: 'test.restricted-noop',

16
x-pack/test/alerting_api_integration/spaces_only/tests/alerting/alerts_base.ts
View file

@ -6,7 +6,7 @@
import expect from '@kbn/expect'; import expect from '@kbn/expect';
import { Response as SupertestResponse } from 'supertest'; import { Response as SupertestResponse } from 'supertest';
import { RecoveredActionGroup } from '../../../../../plugins/alerts/common'; import { ResolvedActionGroup } from '../../../../../plugins/alerts/common';
import { Space } from '../../../common/types'; import { Space } from '../../../common/types';
import { FtrProviderContext } from '../../../common/ftr_provider_context'; import { FtrProviderContext } from '../../../common/ftr_provider_context';
import { import {
@ -137,7 +137,7 @@ instanceStateValue: true
await taskManagerUtils.waitForActionTaskParamsToBeCleanedUp(testStart); await taskManagerUtils.waitForActionTaskParamsToBeCleanedUp(testStart);
}); });
it('should fire actions when an alert instance is recovered', async () => { it('should fire actions when an alert instance is resolved', async () => {
const reference = alertUtils.generateReference(); const reference = alertUtils.generateReference();
const { body: createdAction } = await supertestWithoutAuth const { body: createdAction } = await supertestWithoutAuth
@ -174,12 +174,12 @@ instanceStateValue: true
params: {}, params: {},
}, },
{ {
group: RecoveredActionGroup.id, group: ResolvedActionGroup.id,
id: indexRecordActionId, id: indexRecordActionId,
params: { params: {
index: ES_TEST_INDEX_NAME, index: ES_TEST_INDEX_NAME,
reference, reference,
message: 'Recovered message', message: 'Resolved message',
}, },
}, },
], ],
@ -194,10 +194,10 @@ instanceStateValue: true
await esTestIndexTool.waitForDocs('action:test.index-record', reference) await esTestIndexTool.waitForDocs('action:test.index-record', reference)
)[0]; )[0];
expect(actionTestRecord._source.params.message).to.eql('Recovered message'); expect(actionTestRecord._source.params.message).to.eql('Resolved message');
}); });
it('should not fire actions when an alert instance is recovered, but alert is muted', async () => { it('should not fire actions when an alert instance is resolved, but alert is muted', async () => {
const testStart = new Date(); const testStart = new Date();
const reference = alertUtils.generateReference(); const reference = alertUtils.generateReference();
@ -237,12 +237,12 @@ instanceStateValue: true
params: {}, params: {},
}, },
{ {
group: RecoveredActionGroup.id, group: ResolvedActionGroup.id,
id: indexRecordActionId, id: indexRecordActionId,
params: { params: {
index: ES_TEST_INDEX_NAME, index: ES_TEST_INDEX_NAME,
reference, reference,
message: 'Recovered message', message: 'Resolved message',
}, },
}, },
], ],

14
x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log.ts
View file

@ -78,7 +78,7 @@ export default function eventLogTests({ getService }: FtrProviderContext) {
'execute-action', 'execute-action',
'new-instance', 'new-instance',
'active-instance', 'active-instance',
'recovered-instance', 'resolved-instance',
], ],
}); });
}); });
@ -87,25 +87,25 @@ export default function eventLogTests({ getService }: FtrProviderContext) {
const executeEvents = getEventsByAction(events, 'execute'); const executeEvents = getEventsByAction(events, 'execute');
const executeActionEvents = getEventsByAction(events, 'execute-action'); const executeActionEvents = getEventsByAction(events, 'execute-action');
const newInstanceEvents = getEventsByAction(events, 'new-instance'); const newInstanceEvents = getEventsByAction(events, 'new-instance');
const recoveredInstanceEvents = getEventsByAction(events, 'recovered-instance'); const resolvedInstanceEvents = getEventsByAction(events, 'resolved-instance');
expect(executeEvents.length >= 4).to.be(true); expect(executeEvents.length >= 4).to.be(true);
expect(executeActionEvents.length).to.be(2); expect(executeActionEvents.length).to.be(2);
expect(newInstanceEvents.length).to.be(1); expect(newInstanceEvents.length).to.be(1);
expect(recoveredInstanceEvents.length).to.be(1); expect(resolvedInstanceEvents.length).to.be(1);
// make sure the events are in the right temporal order // make sure the events are in the right temporal order
const executeTimes = getTimestamps(executeEvents); const executeTimes = getTimestamps(executeEvents);
const executeActionTimes = getTimestamps(executeActionEvents); const executeActionTimes = getTimestamps(executeActionEvents);
const newInstanceTimes = getTimestamps(newInstanceEvents); const newInstanceTimes = getTimestamps(newInstanceEvents);
const recoveredInstanceTimes = getTimestamps(recoveredInstanceEvents); const resolvedInstanceTimes = getTimestamps(resolvedInstanceEvents);
expect(executeTimes[0] < newInstanceTimes[0]).to.be(true); expect(executeTimes[0] < newInstanceTimes[0]).to.be(true);
expect(executeTimes[1] <= newInstanceTimes[0]).to.be(true); expect(executeTimes[1] <= newInstanceTimes[0]).to.be(true);
expect(executeTimes[2] > newInstanceTimes[0]).to.be(true); expect(executeTimes[2] > newInstanceTimes[0]).to.be(true);
expect(executeTimes[1] <= executeActionTimes[0]).to.be(true); expect(executeTimes[1] <= executeActionTimes[0]).to.be(true);
expect(executeTimes[2] > executeActionTimes[0]).to.be(true); expect(executeTimes[2] > executeActionTimes[0]).to.be(true);
expect(recoveredInstanceTimes[0] > newInstanceTimes[0]).to.be(true); expect(resolvedInstanceTimes[0] > newInstanceTimes[0]).to.be(true);
// validate each event // validate each event
let executeCount = 0; let executeCount = 0;
@ -136,8 +136,8 @@ export default function eventLogTests({ getService }: FtrProviderContext) {
case 'new-instance': case 'new-instance':
validateInstanceEvent(event, `created new instance: 'instance'`); validateInstanceEvent(event, `created new instance: 'instance'`);
break; break;
case 'recovered-instance': case 'resolved-instance':
validateInstanceEvent(event, `recovered instance: 'instance'`); validateInstanceEvent(event, `resolved instance: 'instance'`);
break; break;
case 'active-instance': case 'active-instance':
validateInstanceEvent(event, `active instance: 'instance' in actionGroup: 'default'`); validateInstanceEvent(event, `active instance: 'instance' in actionGroup: 'default'`);

2
x-pack/test/alerting_api_integration/spaces_only/tests/alerting/get_alert_instance_summary.ts
View file

@ -216,7 +216,7 @@ export default function createGetAlertInstanceSummaryTests({ getService }: FtrPr
await alertUtils.muteInstance(createdAlert.id, 'instanceC'); await alertUtils.muteInstance(createdAlert.id, 'instanceC');
await alertUtils.muteInstance(createdAlert.id, 'instanceD'); await alertUtils.muteInstance(createdAlert.id, 'instanceD');
await waitForEvents(createdAlert.id, ['new-instance', 'recovered-instance']); await waitForEvents(createdAlert.id, ['new-instance', 'resolved-instance']);
const response = await supertest.get( const response = await supertest.get(
`${getUrlPrefix(Spaces.space1.id)}/api/alerts/alert/${createdAlert.id}/_instance_summary` `${getUrlPrefix(Spaces.space1.id)}/api/alerts/alert/${createdAlert.id}/_instance_summary`
); );

2
x-pack/test/alerting_api_integration/spaces_only/tests/alerting/list_alert_types.ts
View file

@ -25,7 +25,7 @@ export default function listAlertTypes({ getService }: FtrProviderContext) {
expect(fixtureAlertType).to.eql({ expect(fixtureAlertType).to.eql({
actionGroups: [ actionGroups: [
{ id: 'default', name: 'Default' }, { id: 'default', name: 'Default' },
{ id: 'recovered', name: 'Recovered' }, { id: 'resolved', name: 'Resolved' },
], ],
defaultActionGroupId: 'default', defaultActionGroupId: 'default',
id: 'test.noop', id: 'test.noop',