mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
[DOCS] Add missing descriptions for metrics.alert.threshold rule (#213181)
This commit is contained in:
Lisa Cawley
GitHub
parent
f021985373
commit
22b9669d34
4 changed files with 198 additions and 9 deletions
|
|
@ -73015,6 +73015,8 @@ components:
|
|||
type: array
|
||||
items:
|
||||
type: number
|
||||
description: |
|
||||
The threshold value that is used with the `comparator`. If the `comparator` is `between`, you must specify the boundary values.
|
||||
comparator:
|
||||
type: string
|
||||
enum:
|
||||
|
|
@ -73024,14 +73026,27 @@ components:
|
|||
- '>='
|
||||
- between
|
||||
- outside
|
||||
description: |
|
||||
The comparison function for the threshold. For example, "is above", "is above or equals", "is below", "is below or equals", "is between", and "outside".
|
||||
timeUnit:
|
||||
type: string
|
||||
enum:
|
||||
- s
|
||||
- m
|
||||
- h
|
||||
- d
|
||||
description: |
|
||||
The type of units for the time window: seconds, minutes, hours, or days.
|
||||
timeSize:
|
||||
type: number
|
||||
description: |
|
||||
The size of the time window (in `timeUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
|
||||
warningThreshold:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
description: |
|
||||
The threshold value that is used with the `warningComparator`. If the `warningComparator` is `between`, you must specify the boundary values.
|
||||
warningComparator:
|
||||
type: string
|
||||
enum:
|
||||
|
|
@ -73074,8 +73089,17 @@ components:
|
|||
- outside
|
||||
timeUnit:
|
||||
type: string
|
||||
enum:
|
||||
- s
|
||||
- m
|
||||
- h
|
||||
- d
|
||||
description: |
|
||||
The type of units for the time window: seconds, minutes, hours, or days.
|
||||
timeSize:
|
||||
type: number
|
||||
description: |
|
||||
The size of the time window (in `timeUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
|
||||
warningThreshold:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -73111,8 +73135,17 @@ components:
|
|||
- outside
|
||||
timeUnit:
|
||||
type: string
|
||||
enum:
|
||||
- s
|
||||
- m
|
||||
- h
|
||||
- d
|
||||
description: |
|
||||
The type of units for the time window: seconds, minutes, hours, or days.
|
||||
timeSize:
|
||||
type: number
|
||||
description: |
|
||||
The size of the time window (in `timeUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
|
||||
warningThreshold:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -73146,6 +73179,8 @@ components:
|
|||
- max
|
||||
- min
|
||||
- cardinality
|
||||
description: |
|
||||
An aggregation to gather data for the rule. For example, find the average, highest or lowest value of a numeric field. Or use a cardinality aggregation to find the approximate number of unique values in a field.
|
||||
field:
|
||||
type: string
|
||||
- type: object
|
||||
|
|
@ -73168,14 +73203,22 @@ components:
|
|||
- type: array
|
||||
items:
|
||||
type: string
|
||||
description: |
|
||||
Create an alert for every unique value of the specified fields. For example, you can create a rule per host or every mount point of each host.
|
||||
IMPORTANT: If you include the same field in both the `filterQuery` and `groupBy`, you might receive fewer results than you expect. For example, if you filter by `cloud.region: us-east`, grouping by `cloud.region` will have no effect because the filter query can match only one region.
|
||||
filterQuery:
|
||||
type: string
|
||||
description: |
|
||||
A query that limits the scope of the rule. The rule evaluates only metric data that matches the query.
|
||||
sourceId:
|
||||
type: string
|
||||
alertOnNoData:
|
||||
type: boolean
|
||||
description: If true, an alert occurs if the metrics do not report any data over the expected period or if the query fails.
|
||||
alertOnGroupDisappear:
|
||||
type: boolean
|
||||
description: |
|
||||
If true, an alert occurs if a group that previously reported metrics does not report them again over the expected time period. This check is not recommended for dynamically scaling infrastructures that might rapidly start and stop nodes automatically.
|
||||
params_property_slo_burn_rate:
|
||||
properties:
|
||||
sloId:
|
||||
|
|
|
|||
|
|
@ -82922,6 +82922,8 @@ components:
|
|||
type: array
|
||||
items:
|
||||
type: number
|
||||
description: |
|
||||
The threshold value that is used with the `comparator`. If the `comparator` is `between`, you must specify the boundary values.
|
||||
comparator:
|
||||
type: string
|
||||
enum:
|
||||
|
|
@ -82931,14 +82933,27 @@ components:
|
|||
- '>='
|
||||
- between
|
||||
- outside
|
||||
description: |
|
||||
The comparison function for the threshold. For example, "is above", "is above or equals", "is below", "is below or equals", "is between", and "outside".
|
||||
timeUnit:
|
||||
type: string
|
||||
enum:
|
||||
- s
|
||||
- m
|
||||
- h
|
||||
- d
|
||||
description: |
|
||||
The type of units for the time window: seconds, minutes, hours, or days.
|
||||
timeSize:
|
||||
type: number
|
||||
description: |
|
||||
The size of the time window (in `timeUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
|
||||
warningThreshold:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
description: |
|
||||
The threshold value that is used with the `warningComparator`. If the `warningComparator` is `between`, you must specify the boundary values.
|
||||
warningComparator:
|
||||
type: string
|
||||
enum:
|
||||
|
|
@ -82981,8 +82996,17 @@ components:
|
|||
- outside
|
||||
timeUnit:
|
||||
type: string
|
||||
enum:
|
||||
- s
|
||||
- m
|
||||
- h
|
||||
- d
|
||||
description: |
|
||||
The type of units for the time window: seconds, minutes, hours, or days.
|
||||
timeSize:
|
||||
type: number
|
||||
description: |
|
||||
The size of the time window (in `timeUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
|
||||
warningThreshold:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -83018,8 +83042,17 @@ components:
|
|||
- outside
|
||||
timeUnit:
|
||||
type: string
|
||||
enum:
|
||||
- s
|
||||
- m
|
||||
- h
|
||||
- d
|
||||
description: |
|
||||
The type of units for the time window: seconds, minutes, hours, or days.
|
||||
timeSize:
|
||||
type: number
|
||||
description: |
|
||||
The size of the time window (in `timeUnit` units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
|
||||
warningThreshold:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -83053,6 +83086,8 @@ components:
|
|||
- max
|
||||
- min
|
||||
- cardinality
|
||||
description: |
|
||||
An aggregation to gather data for the rule. For example, find the average, highest or lowest value of a numeric field. Or use a cardinality aggregation to find the approximate number of unique values in a field.
|
||||
field:
|
||||
type: string
|
||||
- type: object
|
||||
|
|
@ -83075,14 +83110,22 @@ components:
|
|||
- type: array
|
||||
items:
|
||||
type: string
|
||||
description: |
|
||||
Create an alert for every unique value of the specified fields. For example, you can create a rule per host or every mount point of each host.
|
||||
IMPORTANT: If you include the same field in both the `filterQuery` and `groupBy`, you might receive fewer results than you expect. For example, if you filter by `cloud.region: us-east`, grouping by `cloud.region` will have no effect because the filter query can match only one region.
|
||||
filterQuery:
|
||||
type: string
|
||||
description: |
|
||||
A query that limits the scope of the rule. The rule evaluates only metric data that matches the query.
|
||||
sourceId:
|
||||
type: string
|
||||
alertOnNoData:
|
||||
type: boolean
|
||||
description: If true, an alert occurs if the metrics do not report any data over the expected period or if the query fails.
|
||||
alertOnGroupDisappear:
|
||||
type: boolean
|
||||
description: |
|
||||
If true, an alert occurs if a group that previously reported metrics does not report them again over the expected time period. This check is not recommended for dynamically scaling infrastructures that might rapidly start and stop nodes automatically.
|
||||
params_property_slo_burn_rate:
|
||||
properties:
|
||||
sloId:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue