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

[OpenAPI][DOCS] Add descriptions for alerting rule flapping properties #200112

Merged
merged 2 commits into from
Nov 14, 2024
+168 −1
Merged

[OpenAPI][DOCS] Add descriptions for alerting rule flapping properties #200112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b280d71
[OpenAPI][DOCS] Add descriptions for flapping rule settings
lcawl Nov 14, 2024
b370316
Generate OpenAPI output
lcawl Nov 14, 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
18 changes: 18 additions & 0 deletions oas_docs/bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1304,14 +1304,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -2083,14 +2086,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -2484,14 +2490,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -3253,14 +3262,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -3647,14 +3659,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -5094,14 +5109,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down
18 changes: 18 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 @@ -1304,14 +1304,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -2083,14 +2086,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -2484,14 +2490,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -3253,14 +3262,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -3647,14 +3659,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down Expand Up @@ -5094,14 +5109,17 @@
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
"nullable": true,
"properties": {
"look_back_window": {
"description": "The minimum number of runs in which the threshold must be met.",
"maximum": 20,
"minimum": 2,
"type": "number"
},
"status_change_threshold": {
"description": "The minimum number of times an alert must switch states in the look back window.",
"maximum": 20,
"minimum": 2,
"type": "number"
Expand Down
60 changes: 60 additions & 0 deletions oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,14 +868,24 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
description: >-
When flapping detection is turned on, alerts that switch
quickly between active and recovered states are identified
as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
description: >-
The minimum number of runs in which the threshold must
be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
description: >-
The minimum number of times an alert must switch
states in the look back window.
maximum: 20
minimum: 2
type: number
Expand Down Expand Up @@ -1591,14 +1601,24 @@ paths:
type: boolean
flapping:
additionalProperties: false
description: >-
When flapping detection is turned on, alerts that switch
quickly between active and recovered states are identified
as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
description: >-
The minimum number of runs in which the threshold must
be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
description: >-
The minimum number of times an alert must switch states
in the look back window.
maximum: 20
minimum: 2
type: number
Expand Down Expand Up @@ -1991,14 +2011,24 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
description: >-
When flapping detection is turned on, alerts that switch
quickly between active and recovered states are identified
as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
description: >-
The minimum number of runs in which the threshold must
be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
description: >-
The minimum number of times an alert must switch
states in the look back window.
maximum: 20
minimum: 2
type: number
Expand Down Expand Up @@ -2693,14 +2723,24 @@ paths:
- active
flapping:
additionalProperties: false
description: >-
When flapping detection is turned on, alerts that switch
quickly between active and recovered states are identified
as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
description: >-
The minimum number of runs in which the threshold must
be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
description: >-
The minimum number of times an alert must switch states
in the look back window.
maximum: 20
minimum: 2
type: number
Expand Down Expand Up @@ -3085,14 +3125,24 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
description: >-
When flapping detection is turned on, alerts that switch
quickly between active and recovered states are identified
as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
description: >-
The minimum number of runs in which the threshold must
be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
description: >-
The minimum number of times an alert must switch
states in the look back window.
maximum: 20
minimum: 2
type: number
Expand Down Expand Up @@ -4271,14 +4321,24 @@ paths:
- last_execution_date
flapping:
additionalProperties: false
description: >-
When flapping detection is turned on, alerts that switch
quickly between active and recovered states are identified
as “flapping” and notifications are reduced.
nullable: true
type: object
properties:
look_back_window:
description: >-
The minimum number of runs in which the threshold must
be met.
maximum: 20
minimum: 2
type: number
status_change_threshold:
description: >-
The minimum number of times an alert must switch
states in the look back window.
maximum: 20
minimum: 2
type: number
Expand Down
Loading