-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[AO] Add API integration test scenarios to the Threshold rule (#162501)
## Summary It fixes #162491
- Loading branch information
Showing
8 changed files
with
986 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
182 changes: 182 additions & 0 deletions
182
x-pack/test/alerting_api_integration/observability/threshold_rule/avg_pct_fired.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,182 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
import { cleanup, generate } from '@kbn/infra-forge'; | ||
import { Aggregators, Comparator } from '@kbn/observability-plugin/common/threshold_rule/types'; | ||
import { FIRED_ACTIONS_ID } from '@kbn/observability-plugin/server/lib/rules/threshold/threshold_executor'; | ||
import expect from '@kbn/expect'; | ||
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/observability-plugin/common/constants'; | ||
import { createIndexConnector, createRule } from '../helpers/alerting_api_helper'; | ||
import { createDataView, deleteDataView } from '../helpers/data_view'; | ||
import { waitForAlertInIndex, waitForRuleStatus } from '../helpers/alerting_wait_for_helpers'; | ||
import { FtrProviderContext } from '../../common/ftr_provider_context'; | ||
|
||
// eslint-disable-next-line import/no-default-export | ||
export default function ({ getService }: FtrProviderContext) { | ||
const esClient = getService('es'); | ||
const supertest = getService('supertest'); | ||
const esDeleteAllIndices = getService('esDeleteAllIndices'); | ||
const logger = getService('log'); | ||
|
||
describe('Threshold rule - AVG - PCT - FIRED', () => { | ||
const THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; | ||
const ALERT_ACTION_INDEX = 'alert-action-threshold'; | ||
const DATA_VIEW_ID = 'data-view-id'; | ||
let infraDataIndex: string; | ||
let actionId: string; | ||
let ruleId: string; | ||
|
||
before(async () => { | ||
infraDataIndex = await generate({ esClient, lookback: 'now-15m', logger }); | ||
await createDataView({ | ||
supertest, | ||
name: 'metrics-fake_hosts', | ||
id: DATA_VIEW_ID, | ||
title: 'metrics-fake_hosts', | ||
}); | ||
}); | ||
|
||
after(async () => { | ||
await supertest.delete(`/api/alerting/rule/${ruleId}`).set('kbn-xsrf', 'foo'); | ||
await supertest.delete(`/api/actions/connector/${actionId}`).set('kbn-xsrf', 'foo'); | ||
await esClient.deleteByQuery({ | ||
index: THRESHOLD_RULE_ALERT_INDEX, | ||
query: { term: { 'kibana.alert.rule.uuid': ruleId } }, | ||
}); | ||
await esClient.deleteByQuery({ | ||
index: '.kibana-event-log-*', | ||
query: { term: { 'kibana.alert.rule.consumer': 'alerts' } }, | ||
}); | ||
await deleteDataView({ | ||
supertest, | ||
id: DATA_VIEW_ID, | ||
}); | ||
await esDeleteAllIndices([ALERT_ACTION_INDEX, infraDataIndex]); | ||
await cleanup({ esClient, logger }); | ||
}); | ||
|
||
describe('Rule creation', () => { | ||
it('creates rule successfully', async () => { | ||
actionId = await createIndexConnector({ | ||
supertest, | ||
name: 'Index Connector: Threshold API test', | ||
indexName: ALERT_ACTION_INDEX, | ||
}); | ||
|
||
const createdRule = await createRule({ | ||
supertest, | ||
tags: ['observability'], | ||
consumer: 'alerts', | ||
name: 'Threshold rule', | ||
ruleTypeId: OBSERVABILITY_THRESHOLD_RULE_TYPE_ID, | ||
params: { | ||
criteria: [ | ||
{ | ||
aggType: Aggregators.CUSTOM, | ||
comparator: Comparator.GT, | ||
threshold: [0.5], | ||
timeSize: 5, | ||
timeUnit: 'm', | ||
customMetrics: [ | ||
{ name: 'A', field: 'system.cpu.user.pct', aggType: Aggregators.AVERAGE }, | ||
], | ||
}, | ||
], | ||
alertOnNoData: true, | ||
alertOnGroupDisappear: true, | ||
searchConfiguration: { | ||
query: { | ||
query: '', | ||
language: 'kuery', | ||
}, | ||
index: DATA_VIEW_ID, | ||
}, | ||
}, | ||
actions: [ | ||
{ | ||
group: FIRED_ACTIONS_ID, | ||
id: actionId, | ||
params: { | ||
documents: [ | ||
{ | ||
ruleType: '{{rule.type}}', | ||
}, | ||
], | ||
}, | ||
frequency: { | ||
notify_when: 'onActionGroupChange', | ||
throttle: null, | ||
summary: false, | ||
}, | ||
}, | ||
], | ||
}); | ||
ruleId = createdRule.id; | ||
expect(ruleId).not.to.be(undefined); | ||
}); | ||
|
||
it('should be active', async () => { | ||
const executionStatus = await waitForRuleStatus({ | ||
id: ruleId, | ||
expectedStatus: 'active', | ||
supertest, | ||
}); | ||
expect(executionStatus.status).to.be('active'); | ||
}); | ||
|
||
it('should set correct information in the alert document', async () => { | ||
const resp = await waitForAlertInIndex({ | ||
esClient, | ||
indexName: THRESHOLD_RULE_ALERT_INDEX, | ||
ruleId, | ||
}); | ||
|
||
expect(resp.hits.hits[0]._source).property( | ||
'kibana.alert.rule.category', | ||
'Threshold (Technical Preview)' | ||
); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.consumer', 'alerts'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.name', 'Threshold rule'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.producer', 'observability'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.revision', 0); | ||
expect(resp.hits.hits[0]._source).property( | ||
'kibana.alert.rule.rule_type_id', | ||
'observability.rules.threshold' | ||
); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.uuid', ruleId); | ||
expect(resp.hits.hits[0]._source).property('kibana.space_ids').contain('default'); | ||
expect(resp.hits.hits[0]._source) | ||
.property('kibana.alert.rule.tags') | ||
.contain('observability'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.action_group', 'threshold.fired'); | ||
expect(resp.hits.hits[0]._source).property('tags').contain('observability'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.instance.id', '*'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.workflow_status', 'open'); | ||
expect(resp.hits.hits[0]._source).property('event.kind', 'signal'); | ||
expect(resp.hits.hits[0]._source).property('event.action', 'open'); | ||
|
||
expect(resp.hits.hits[0]._source) | ||
.property('kibana.alert.rule.parameters') | ||
.eql({ | ||
criteria: [ | ||
{ | ||
aggType: 'custom', | ||
comparator: '>', | ||
threshold: [0.5], | ||
timeSize: 5, | ||
timeUnit: 'm', | ||
customMetrics: [{ name: 'A', field: 'system.cpu.user.pct', aggType: 'avg' }], | ||
}, | ||
], | ||
alertOnNoData: true, | ||
alertOnGroupDisappear: true, | ||
searchConfiguration: { index: 'data-view-id', query: { query: '', language: 'kuery' } }, | ||
}); | ||
}); | ||
}); | ||
}); | ||
} |
179 changes: 179 additions & 0 deletions
179
x-pack/test/alerting_api_integration/observability/threshold_rule/avg_pct_no_data.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
import { Aggregators, Comparator } from '@kbn/observability-plugin/common/threshold_rule/types'; | ||
import { FIRED_ACTIONS_ID } from '@kbn/observability-plugin/server/lib/rules/threshold/threshold_executor'; | ||
import expect from '@kbn/expect'; | ||
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/observability-plugin/common/constants'; | ||
|
||
import { createIndexConnector, createRule } from '../helpers/alerting_api_helper'; | ||
import { createDataView, deleteDataView } from '../helpers/data_view'; | ||
import { waitForAlertInIndex, waitForRuleStatus } from '../helpers/alerting_wait_for_helpers'; | ||
import { FtrProviderContext } from '../../common/ftr_provider_context'; | ||
|
||
// eslint-disable-next-line import/no-default-export | ||
export default function ({ getService }: FtrProviderContext) { | ||
const esClient = getService('es'); | ||
const supertest = getService('supertest'); | ||
|
||
describe('Threshold rule - AVG - PCT - NoData', () => { | ||
const THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; | ||
const ALERT_ACTION_INDEX = 'alert-action-threshold'; | ||
const DATA_VIEW_ID = 'data-view-id-no-data'; | ||
let actionId: string; | ||
let ruleId: string; | ||
|
||
before(async () => { | ||
await createDataView({ | ||
supertest, | ||
name: 'no-data-pattern', | ||
id: DATA_VIEW_ID, | ||
title: 'no-data-pattern', | ||
}); | ||
}); | ||
|
||
after(async () => { | ||
await supertest.delete(`/api/alerting/rule/${ruleId}`).set('kbn-xsrf', 'foo'); | ||
await supertest.delete(`/api/actions/connector/${actionId}`).set('kbn-xsrf', 'foo'); | ||
await esClient.deleteByQuery({ | ||
index: THRESHOLD_RULE_ALERT_INDEX, | ||
query: { term: { 'kibana.alert.rule.uuid': ruleId } }, | ||
}); | ||
await esClient.deleteByQuery({ | ||
index: '.kibana-event-log-*', | ||
query: { term: { 'kibana.alert.rule.consumer': 'alerts' } }, | ||
}); | ||
await deleteDataView({ | ||
supertest, | ||
id: DATA_VIEW_ID, | ||
}); | ||
}); | ||
|
||
describe('Rule creation', () => { | ||
it('creates rule successfully', async () => { | ||
actionId = await createIndexConnector({ | ||
supertest, | ||
name: 'Index Connector: Threshold API test', | ||
indexName: ALERT_ACTION_INDEX, | ||
}); | ||
|
||
const createdRule = await createRule({ | ||
supertest, | ||
tags: ['observability'], | ||
consumer: 'alerts', | ||
name: 'Threshold rule', | ||
ruleTypeId: OBSERVABILITY_THRESHOLD_RULE_TYPE_ID, | ||
params: { | ||
criteria: [ | ||
{ | ||
aggType: Aggregators.CUSTOM, | ||
comparator: Comparator.GT, | ||
threshold: [0.5], | ||
timeSize: 5, | ||
timeUnit: 'm', | ||
customMetrics: [ | ||
{ name: 'A', field: 'system.cpu.user.pct', aggType: Aggregators.AVERAGE }, | ||
], | ||
}, | ||
], | ||
alertOnNoData: true, | ||
alertOnGroupDisappear: true, | ||
searchConfiguration: { | ||
query: { | ||
query: '', | ||
language: 'kuery', | ||
}, | ||
index: DATA_VIEW_ID, | ||
}, | ||
}, | ||
actions: [ | ||
{ | ||
group: FIRED_ACTIONS_ID, | ||
id: actionId, | ||
params: { | ||
documents: [ | ||
{ | ||
ruleType: '{{rule.type}}', | ||
}, | ||
], | ||
}, | ||
frequency: { | ||
notify_when: 'onActionGroupChange', | ||
throttle: null, | ||
summary: false, | ||
}, | ||
}, | ||
], | ||
}); | ||
ruleId = createdRule.id; | ||
expect(ruleId).not.to.be(undefined); | ||
}); | ||
|
||
it('should be active', async () => { | ||
const executionStatus = await waitForRuleStatus({ | ||
id: ruleId, | ||
expectedStatus: 'active', | ||
supertest, | ||
}); | ||
expect(executionStatus.status).to.be('active'); | ||
}); | ||
|
||
it('should set correct information in the alert document', async () => { | ||
const resp = await waitForAlertInIndex({ | ||
esClient, | ||
indexName: THRESHOLD_RULE_ALERT_INDEX, | ||
ruleId, | ||
}); | ||
|
||
expect(resp.hits.hits[0]._source).property( | ||
'kibana.alert.rule.category', | ||
'Threshold (Technical Preview)' | ||
); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.consumer', 'alerts'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.name', 'Threshold rule'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.producer', 'observability'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.revision', 0); | ||
expect(resp.hits.hits[0]._source).property( | ||
'kibana.alert.rule.rule_type_id', | ||
'observability.rules.threshold' | ||
); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.rule.uuid', ruleId); | ||
expect(resp.hits.hits[0]._source).property('kibana.space_ids').contain('default'); | ||
expect(resp.hits.hits[0]._source) | ||
.property('kibana.alert.rule.tags') | ||
.contain('observability'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.action_group', 'threshold.nodata'); | ||
expect(resp.hits.hits[0]._source).property('tags').contain('observability'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.instance.id', '*'); | ||
expect(resp.hits.hits[0]._source).property('kibana.alert.workflow_status', 'open'); | ||
expect(resp.hits.hits[0]._source).property('event.kind', 'signal'); | ||
expect(resp.hits.hits[0]._source).property('event.action', 'open'); | ||
|
||
expect(resp.hits.hits[0]._source) | ||
.property('kibana.alert.rule.parameters') | ||
.eql({ | ||
criteria: [ | ||
{ | ||
aggType: 'custom', | ||
comparator: '>', | ||
threshold: [0.5], | ||
timeSize: 5, | ||
timeUnit: 'm', | ||
customMetrics: [{ name: 'A', field: 'system.cpu.user.pct', aggType: 'avg' }], | ||
}, | ||
], | ||
alertOnNoData: true, | ||
alertOnGroupDisappear: true, | ||
searchConfiguration: { | ||
index: 'data-view-id-no-data', | ||
query: { query: '', language: 'kuery' }, | ||
}, | ||
}); | ||
}); | ||
}); | ||
}); | ||
} |
Oops, something went wrong.