github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Lisa Cawley 2024-11-14 07:54:51 -08:00 • committed by GitHub
parent f3e773552d
commit 50f0016cd7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 168 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
oas_docs/bundle.json
View file

@ -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"
@ -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"
@ -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"
@ -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"
@ -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"
@ -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"

18
oas_docs/bundle.serverless.json
View file

@ -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"
@ -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"
@ -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"
@ -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"
@ -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"
@ -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"

60
oas_docs/output/kibana.serverless.yaml
View file

@ -1018,14 +1018,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
@ -1600,14 +1610,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
@ -1925,14 +1945,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
@ -2510,14 +2540,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
@ -2807,14 +2847,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
@ -3852,14 +3902,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

60
oas_docs/output/kibana.yaml
View file

@ -1367,14 +1367,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
@ -1948,14 +1958,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
@ -2273,14 +2293,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
@ -2857,14 +2887,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
@ -3154,14 +3194,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
@ -4191,14 +4241,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

13
x-pack/plugins/alerting/common/routes/rule/common/flapping/schemas/v1.ts
View file

@ -17,13 +17,24 @@ import { validateFlapping as validateFlappingV1 } from '../../../validation/vali
export const flappingSchema = schema.object(
{
look_back_window: schema.number({
meta: { description: 'The minimum number of runs in which the threshold must be met.' },
min: MIN_LOOK_BACK_WINDOW_V1,
max: MAX_LOOK_BACK_WINDOW_V1,
}),
status_change_threshold: schema.number({
meta: {
description:
'The minimum number of times an alert must switch states in the look back window.',
},
min: MIN_STATUS_CHANGE_THRESHOLD_V1,
max: MAX_STATUS_CHANGE_THRESHOLD_V1,
}),
},
{ validate: validateFlappingV1 }
{
validate: validateFlappingV1,
meta: {
description:
'When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.',
},
}
);