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

[AO] Add testing action variables to the Custom threshold rule API integration tests #167757

Merged
merged 7 commits into from
Oct 4, 2023
Merged

[AO] Add testing action variables to the Custom threshold rule API integration tests #167757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d88c6d5
Add action variables
maryam-saeidi Oct 2, 2023
41bd2b0
Merge branch 'main' into 162950-test-action-variables
maryam-saeidi Oct 2, 2023
dcc6cfb
Merge branch 'main' into 162950-test-action-variables
maryam-saeidi Oct 3, 2023
e5f67cd
Merge branch 'main' into 162950-test-action-variables
maryam-saeidi Oct 3, 2023
d4b5b03
Merge branch 'main' into 162950-test-action-variables
maryam-saeidi Oct 3, 2023
edff1e0
Merge branch 'main' into 162950-test-action-variables
maryam-saeidi Oct 3, 2023
86fb6b7
Merge branch 'main' into 162950-test-action-variables
maryam-saeidi Oct 4, 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
4 changes: 2 additions & 2 deletions x-pack/packages/kbn-infra-forge/src/data_sources/fake_hosts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ export const generateEvent = (index: number, timestamp: Moment, interval: number
},
},
user: {
pct: randomBetween(1, 4),
pct: 2.5,
},
system: {
pct: randomBetween(1, 4),
pct: 3,
},
},
},
Expand Down
33 changes: 32 additions & 1 deletion x-pack/test/alerting_api_integration/observability/custom_threshold_rule/avg_pct_fired.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import moment from 'moment';
import { cleanup, generate } from '@kbn/infra-forge';
import {
Aggregators,
Expand All @@ -15,8 +16,13 @@ import expect from '@kbn/expect';
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils';
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 {
waitForAlertInIndex,
waitForDocumentInIndex,
waitForRuleStatus,
} from '../helpers/alerting_wait_for_helpers';
import { FtrProviderContext } from '../../common/ftr_provider_context';
import { ActionDocument } from './typings';

// eslint-disable-next-line import/no-default-export
export default function ({ getService }: FtrProviderContext) {
Expand All @@ -35,6 +41,8 @@ export default function ({ getService }: FtrProviderContext) {
let infraDataIndex: string;
let actionId: string;
let ruleId: string;
let alertId: string;
let startedAt: string;

before(async () => {
infraDataIndex = await generate({ esClient, lookback: 'now-15m', logger });
Expand Down Expand Up @@ -110,6 +118,10 @@ export default function ({ getService }: FtrProviderContext) {
documents: [
{
ruleType: '{{rule.type}}',
alertDetailsUrl: '{{context.alertDetailsUrl}}',
reason: '{{context.reason}}',
value: '{{context.value}}',
host: '{{context.host}}',
},
],
},
Expand Down Expand Up @@ -140,6 +152,8 @@ export default function ({ getService }: FtrProviderContext) {
indexName: CUSTOM_THRESHOLD_RULE_ALERT_INDEX,
ruleId,
});
alertId = (resp.hits.hits[0]._source as any)['kibana.alert.uuid'];
startedAt = (resp.hits.hits[0]._source as any)['kibana.alert.start'];

expect(resp.hits.hits[0]._source).property(
'kibana.alert.rule.category',
Expand Down Expand Up @@ -186,6 +200,23 @@ export default function ({ getService }: FtrProviderContext) {
searchConfiguration: { index: 'data-view-id', query: { query: '', language: 'kuery' } },
});
});

it('should set correct action variables', async () => {
const rangeFrom = moment(startedAt).subtract('5', 'minute').toISOString();
const resp = await waitForDocumentInIndex<ActionDocument>({
esClient,
indexName: ALERT_ACTION_INDEX,
});

expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold');
expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql(
`https://localhost:5601/app/observability/alerts?_a=(kuery:%27kibana.alert.uuid:%20%22${alertId}%22%27%2CrangeFrom:%27${rangeFrom}%27%2CrangeTo:now%2Cstatus:all)`
);
expect(resp.hits.hits[0]._source?.reason).eql(
'Custom equation is 2.5 in the last 5 mins. Alert when > 0.5.'
);
expect(resp.hits.hits[0]._source?.value).eql('2.5');
});
});
});
}
38 changes: 35 additions & 3 deletions x-pack/test/alerting_api_integration/observability/custom_threshold_rule/avg_pct_no_data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,39 @@
* 2.0.
*/

import moment from 'moment';
import {
Aggregators,
Comparator,
} from '@kbn/observability-plugin/common/custom_threshold_rule/types';
import { FIRED_ACTIONS_ID } from '@kbn/observability-plugin/server/lib/rules/custom_threshold/custom_threshold_executor';
import { NO_DATA_ACTIONS_ID } from '@kbn/observability-plugin/server/lib/rules/custom_threshold/custom_threshold_executor';
import expect from '@kbn/expect';
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils';

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 {
waitForAlertInIndex,
waitForDocumentInIndex,
waitForRuleStatus,
} from '../helpers/alerting_wait_for_helpers';
import { FtrProviderContext } from '../../common/ftr_provider_context';
import { ActionDocument } from './typings';

// 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');

describe('Custom Threshold rule - AVG - PCT - NoData', () => {
const CUSTOM_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;
let alertId: string;
let startedAt: string;

before(async () => {
await createDataView({
Expand All @@ -54,6 +63,7 @@ export default function ({ getService }: FtrProviderContext) {
supertest,
id: DATA_VIEW_ID,
});
await esDeleteAllIndices([ALERT_ACTION_INDEX]);
});

describe('Rule creation', () => {
Expand Down Expand Up @@ -95,12 +105,15 @@ export default function ({ getService }: FtrProviderContext) {
},
actions: [
{
group: FIRED_ACTIONS_ID,
group: NO_DATA_ACTIONS_ID,
id: actionId,
params: {
documents: [
{
ruleType: '{{rule.type}}',
alertDetailsUrl: '{{context.alertDetailsUrl}}',
reason: '{{context.reason}}',
value: '{{context.value}}',
},
],
},
Expand Down Expand Up @@ -131,6 +144,8 @@ export default function ({ getService }: FtrProviderContext) {
indexName: CUSTOM_THRESHOLD_RULE_ALERT_INDEX,
ruleId,
});
alertId = (resp.hits.hits[0]._source as any)['kibana.alert.uuid'];
startedAt = (resp.hits.hits[0]._source as any)['kibana.alert.start'];

expect(resp.hits.hits[0]._source).property(
'kibana.alert.rule.category',
Expand Down Expand Up @@ -180,6 +195,23 @@ export default function ({ getService }: FtrProviderContext) {
},
});
});

it('should set correct action variables', async () => {
const rangeFrom = moment(startedAt).subtract('5', 'minute').toISOString();
const resp = await waitForDocumentInIndex<ActionDocument>({
esClient,
indexName: ALERT_ACTION_INDEX,
});

expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold');
expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql(
`https://localhost:5601/app/observability/alerts?_a=(kuery:%27kibana.alert.uuid:%20%22${alertId}%22%27%2CrangeFrom:%27${rangeFrom}%27%2CrangeTo:now%2Cstatus:all)`
);
expect(resp.hits.hits[0]._source?.reason).eql(
'Custom equation reported no data in the last 5m'
);
expect(resp.hits.hits[0]._source?.value).eql('[NO DATA]');
});
});
});
}
8 changes: 2 additions & 6 deletions x-pack/test/alerting_api_integration/observability/custom_threshold_rule/avg_us_fired.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
waitForDocumentInIndex,
waitForRuleStatus,
} from '../helpers/alerting_wait_for_helpers';
import { ActionDocument } from './typings';

// eslint-disable-next-line import/no-default-export
export default function ({ getService }: FtrProviderContext) {
Expand Down Expand Up @@ -206,12 +207,7 @@ export default function ({ getService }: FtrProviderContext) {

it('should set correct action parameter: ruleType', async () => {
const rangeFrom = moment(startedAt).subtract('5', 'minute').toISOString();
const resp = await waitForDocumentInIndex<{
ruleType: string;
alertDetailsUrl: string;
reason: string;
value: string;
}>({
const resp = await waitForDocumentInIndex<ActionDocument>({
esClient,
indexName: ALERT_ACTION_INDEX,
});
Expand Down
32 changes: 31 additions & 1 deletion ...alerting_api_integration/observability/custom_threshold_rule/custom_eq_avg_bytes_fired.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* 2.0.
*/

import moment from 'moment';
import { cleanup, generate } from '@kbn/infra-forge';
import {
Aggregators,
Expand All @@ -21,8 +22,13 @@ import expect from '@kbn/expect';
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils';
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 {
waitForAlertInIndex,
waitForDocumentInIndex,
waitForRuleStatus,
} from '../helpers/alerting_wait_for_helpers';
import { FtrProviderContext } from '../../common/ftr_provider_context';
import { ActionDocument } from './typings';

// eslint-disable-next-line import/no-default-export
export default function ({ getService }: FtrProviderContext) {
Expand All @@ -41,6 +47,8 @@ export default function ({ getService }: FtrProviderContext) {
let infraDataIndex: string;
let actionId: string;
let ruleId: string;
let alertId: string;
let startedAt: string;

before(async () => {
infraDataIndex = await generate({ esClient, lookback: 'now-15m', logger });
Expand Down Expand Up @@ -118,6 +126,9 @@ export default function ({ getService }: FtrProviderContext) {
documents: [
{
ruleType: '{{rule.type}}',
alertDetailsUrl: '{{context.alertDetailsUrl}}',
reason: '{{context.reason}}',
value: '{{context.value}}',
},
],
},
Expand Down Expand Up @@ -148,6 +159,8 @@ export default function ({ getService }: FtrProviderContext) {
indexName: CUSTOM_THRESHOLD_RULE_ALERT_INDEX,
ruleId,
});
alertId = (resp.hits.hits[0]._source as any)['kibana.alert.uuid'];
startedAt = (resp.hits.hits[0]._source as any)['kibana.alert.start'];

expect(resp.hits.hits[0]._source).property(
'kibana.alert.rule.category',
Expand Down Expand Up @@ -198,6 +211,23 @@ export default function ({ getService }: FtrProviderContext) {
searchConfiguration: { index: 'data-view-id', query: { query: '', language: 'kuery' } },
});
});

it('should set correct action variables', async () => {
const rangeFrom = moment(startedAt).subtract('5', 'minute').toISOString();
const resp = await waitForDocumentInIndex<ActionDocument>({
esClient,
indexName: ALERT_ACTION_INDEX,
});

expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold');
expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql(
`https://localhost:5601/app/observability/alerts?_a=(kuery:%27kibana.alert.uuid:%20%22${alertId}%22%27%2CrangeFrom:%27${rangeFrom}%27%2CrangeTo:now%2Cstatus:all)`
);
expect(resp.hits.hits[0]._source?.reason).eql(
'Custom equation is 1 in the last 1 min. Alert when > 0.9.'
);
expect(resp.hits.hits[0]._source?.value).eql('1');
});
});
});
}
32 changes: 31 additions & 1 deletion ...est/alerting_api_integration/observability/custom_threshold_rule/documents_count_fired.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import moment from 'moment';
import { cleanup, generate } from '@kbn/infra-forge';
import {
Aggregators,
Expand All @@ -15,8 +16,13 @@ import expect from '@kbn/expect';
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils';
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 {
waitForAlertInIndex,
waitForDocumentInIndex,
waitForRuleStatus,
} from '../helpers/alerting_wait_for_helpers';
import { FtrProviderContext } from '../../common/ftr_provider_context';
import { ActionDocument } from './typings';

// eslint-disable-next-line import/no-default-export
export default function ({ getService }: FtrProviderContext) {
Expand All @@ -35,6 +41,8 @@ export default function ({ getService }: FtrProviderContext) {
let infraDataIndex: string;
let actionId: string;
let ruleId: string;
let alertId: string;
let startedAt: string;

before(async () => {
infraDataIndex = await generate({ esClient, lookback: 'now-15m', logger });
Expand Down Expand Up @@ -108,6 +116,9 @@ export default function ({ getService }: FtrProviderContext) {
documents: [
{
ruleType: '{{rule.type}}',
alertDetailsUrl: '{{context.alertDetailsUrl}}',
reason: '{{context.reason}}',
value: '{{context.value}}',
},
],
},
Expand Down Expand Up @@ -138,6 +149,8 @@ export default function ({ getService }: FtrProviderContext) {
indexName: CUSTOM_THRESHOLD_RULE_ALERT_INDEX,
ruleId,
});
alertId = (resp.hits.hits[0]._source as any)['kibana.alert.uuid'];
startedAt = (resp.hits.hits[0]._source as any)['kibana.alert.start'];

expect(resp.hits.hits[0]._source).property(
'kibana.alert.rule.category',
Expand Down Expand Up @@ -186,6 +199,23 @@ export default function ({ getService }: FtrProviderContext) {
searchConfiguration: { index: 'data-view-id', query: { query: '', language: 'kuery' } },
});
});

it('should set correct action variables', async () => {
const rangeFrom = moment(startedAt).subtract('5', 'minute').toISOString();
const resp = await waitForDocumentInIndex<ActionDocument>({
esClient,
indexName: ALERT_ACTION_INDEX,
});

expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold');
expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql(
`https://localhost:5601/app/observability/alerts?_a=(kuery:%27kibana.alert.uuid:%20%22${alertId}%22%27%2CrangeFrom:%27${rangeFrom}%27%2CrangeTo:now%2Cstatus:all)`
);
expect(resp.hits.hits[0]._source?.reason).eql(
'Custom equation is 3 in the last 1 min. Alert when > 2.'
);
expect(resp.hits.hits[0]._source?.value).eql('3');
});
});
});
}
Loading
Loading