Skip to content

Commit

Permalink
[OpenAPI][DOCS] Add descriptions for alerting rule flapping properties (
Browse files Browse the repository at this point in the history 
elastic#200112)
  • Loading branch information
@lcawl @wayneseymour
lcawl authored and wayneseymour committed Nov 18, 2024
1 parent 96b48ba commit 1ebb244
Show file tree
Hide file tree
Showing 5 changed files with 168 additions and 1 deletion.
18 changes: 18 additions & 0 deletions oas_docs/bundle.json
View file
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
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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 1ebb244

Please sign in to comment.