Skip to content

[Response Ops][Flapping] Rule Specific Flapping - Create/Update API changes #190019

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

Merged
JiaweiWu merged 26 commits into from
Oct 9, 2024
Merged

[Response Ops][Flapping] Rule Specific Flapping - Create/Update API changes #190019

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
10b9770
Implement rule specific flapping for update and create
JiaweiWu Aug 7, 2024
b33f2c4
Add task runner portion
JiaweiWu Aug 13, 2024
79069a4
Merge branch 'main' into issue-190018-rule-specific-flapping-create-u…
elasticmachine Aug 13, 2024
e069e44
Fix bundle size
JiaweiWu Aug 14, 2024
d40c6f5
Improve validate logic
JiaweiWu Aug 14, 2024
ca3663b
Add more tests
JiaweiWu Aug 16, 2024
5db9580
Fix conflicts
JiaweiWu Aug 23, 2024
e6bd0ca
Integrate backend with frontend
JiaweiWu Aug 23, 2024
03d4fbe
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Aug 23, 2024
b5dec2b
Merge branch 'main' into issue-190018-rule-specific-flapping-create-u…
elasticmachine Aug 26, 2024
6521b98
Clean up flapping test after it has ran
JiaweiWu Aug 27, 2024
99f0926
Add new model schema version
JiaweiWu Aug 28, 2024
c80deab
[CI] Auto-commit changed files from 'node scripts/jest_integration -u…
kibanamachine Aug 28, 2024
ffe5f33
Merge branch 'main' into issue-190018-rule-specific-flapping-create-u…
JiaweiWu Sep 9, 2024
c226f51
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Sep 10, 2024
2ae41a5
Address comments
JiaweiWu Sep 10, 2024
c041027
Merge branch 'main' into issue-190018-rule-specific-flapping-create-u…
elasticmachine Sep 10, 2024
60b6776
Address comments
JiaweiWu Sep 16, 2024
2c6f4fa
Fix merge conflicts and address comments
JiaweiWu Sep 16, 2024
f13b052
[CI] Auto-commit changed files from 'node scripts/jest_integration -u…
kibanamachine Sep 16, 2024
a59f28a
Fix merge conflict
JiaweiWu Oct 8, 2024
0649f68
[CI] Auto-commit changed files from 'node scripts/jest_integration -u…
kibanamachine Oct 8, 2024
91c531a
[CI] Auto-commit changed files from 'make api-docs && make api-docs-s…
kibanamachine Oct 8, 2024
ad98c68
Merge branch 'main' into issue-190018-rule-specific-flapping-create-u…
elasticmachine Oct 8, 2024
55e75a1
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Oct 8, 2024
d762519
Merge branch 'main' into issue-190018-rule-specific-flapping-create-u…
elasticmachine Oct 8, 2024
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
126 changes: 126 additions & 0 deletions oas_docs/bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,6 +732,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down Expand Up @@ -1539,6 +1560,27 @@
"description": "Indicates whether you want to run the rule on an interval basis after it is created.",
"type": "boolean"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"name": {
"description": "The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.",
"type": "string"
Expand Down Expand Up @@ -1919,6 +1961,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down Expand Up @@ -2716,6 +2779,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"name": {
"description": "The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.",
"type": "string"
Expand Down Expand Up @@ -3089,6 +3173,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down Expand Up @@ -4495,6 +4600,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down
126 changes: 126 additions & 0 deletions oas_docs/bundle.serverless.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,6 +732,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down Expand Up @@ -1539,6 +1560,27 @@
"description": "Indicates whether you want to run the rule on an interval basis after it is created.",
"type": "boolean"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"name": {
"description": "The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.",
"type": "string"
Expand Down Expand Up @@ -1919,6 +1961,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down Expand Up @@ -2716,6 +2779,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"name": {
"description": "The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.",
"type": "string"
Expand Down Expand Up @@ -3089,6 +3173,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down Expand Up @@ -4495,6 +4600,27 @@
],
"type": "object"
},
"flapping": {
"additionalProperties": false,
"nullable": true,
"properties": {
"look_back_window": {
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"maximum": 20,
"minimum": 2,
"type": "number"
}
},
"required": [
"look_back_window",
"status_change_threshold"
],
"type": "object"
},
"id": {
"description": "The identifier for the rule.",
"type": "string"
Expand Down
9 changes: 9 additions & 0 deletions packages/kbn-alerting-types/flapping/latest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

export * from './v1';
0 packages/kbn-alerting-types/rule_flapping.ts → packages/kbn-alerting-types/flapping/v1.ts
View file
Open in desktop
File renamed without changes.
1 change: 0 additions & 1 deletion packages/kbn-alerting-types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,4 @@ export * from './r_rule_types';
export * from './rule_notify_when_type';
export * from './rule_type_types';
export * from './rule_types';
export * from './rule_flapping';
export * from './search_strategy_types';
10 changes: 6 additions & 4 deletions packages/kbn-alerting-types/rule_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,11 @@ export type SanitizedRuleAction = Omit<RuleAction, 'alertsFilter'> & {
alertsFilter?: SanitizedAlertsFilter;
};

export interface Flapping extends SavedObjectAttributes {

@cnasikas cnasikas Sep 5, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the reason for extending with SavedObjectAttributes?

@JiaweiWu JiaweiWu Sep 10, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parent object extends it so all of its properties need to as well, these types should be deprecated in favor of the rule attribute types

@cnasikas cnasikas Sep 11, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it and I did not get a type error. I am not sure I understand how the parent affects the children's properties. Probably I miss something.

@JiaweiWu JiaweiWu Sep 11, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, then i'll remove it

@JiaweiWu JiaweiWu Sep 16, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I tried running the node scripts/type_check.js --project=x-pack/plugins/triggers_actions_ui/tsconfig.json command with this removed and I am receiving a lot of errors, I think I need to leave it in there.

@cnasikas cnasikas Sep 17, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok! Weird that is happening. Thanks!

lookBackWindow: number;
statusChangeThreshold: number;
}

export interface Rule<Params extends RuleTypeParams = never> {
id: string;
enabled: boolean;
Expand Down Expand Up @@ -239,10 +244,7 @@ export interface Rule<Params extends RuleTypeParams = never> {
running?: boolean | null;
viewInAppRelativeUrl?: string;
alertDelay?: AlertDelay | null;
flapping?: {
lookBackWindow: number;
statusChangeThreshold: number;
};
flapping?: Flapping | null;
}

export type SanitizedRule<Params extends RuleTypeParams = never> = Omit<
Expand Down
8 changes: 3 additions & 5 deletions packages/kbn-alerts-ui-shared/src/common/apis/create_rule/transform_create_rule_body.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@ const transformCreateRuleFlapping = (flapping: Rule['flapping']) => {
}

return {
flapping: {
look_back_window: flapping.lookBackWindow,
status_change_threshold: flapping.statusChangeThreshold,
},
look_back_window: flapping.lookBackWindow,
status_change_threshold: flapping.statusChangeThreshold,
};
};

Expand Down Expand Up @@ -59,5 +57,5 @@ export const transformCreateRuleBody: RewriteResponseCase<CreateRuleBody> = ({
};
}),
...(alertDelay ? { alert_delay: alertDelay } : {}),
...(flapping !== undefined ? transformCreateRuleFlapping(flapping) : {}),
...(flapping !== undefined ? { flapping: transformCreateRuleFlapping(flapping) } : {}),
});
Loading