-
Notifications
You must be signed in to change notification settings - Fork 8.5k
[Alerts][Docs] Alert types doc update. Added refs to applications specific alerts groups. #91787
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.
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
Changes from 7 commits
1f4da90
9ac28bf
7f5af6f
ca27579
3b9fc72
6f08ff9
5674bcd
a8c2784
abe8b85
5a937a2
ff64031
125e4e8
a8bdeca
c8803ce
14839ed
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,159 +1,28 @@ | ||||||||||||||
| [role="xpack"] | ||||||||||||||
| [[alert-types]] | ||||||||||||||
| == Standard stack alert types | ||||||||||||||
| == Alert types | ||||||||||||||
|
||||||||||||||
|
|
||||||||||||||
| {kib} supplies alert types in two ways: some are built into {kib} (these are known as stack alerts), while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<xpack-ml,*{ml-cap}*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>. | ||||||||||||||
| {kib} supplies alert types in two ways: some are built into {kib} (these are known as stack alerts), while domain-specific alert types are registered by {kib} apps. | ||||||||||||||
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
|
|
||||||||||||||
| This section covers stack alerts. For domain-specific alert types, refer to the documentation for that app. | ||||||||||||||
| [float] | ||||||||||||||
| ==== Standard stack alert types | ||||||||||||||
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
|
|
||||||||||||||
| This section covers stack alerts. | ||||||||||||||
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
| Users will need `all` access to the *Stack Alerts* feature to be able to create and edit any of the alerts listed below. | ||||||||||||||
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
| See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to this feature. | ||||||||||||||
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
|
|
||||||||||||||
| Currently {kib} provides two stack alerts: <<alert-type-index-threshold>> and <<alert-type-es-query>>. | ||||||||||||||
|
||||||||||||||
| Currently {kib} provides two stack alerts: <<alert-type-index-threshold>> and <<alert-type-es-query>>. | |
| {kib} provides two stack alerts: | |
| * <<alert-type-index-threshold>> | |
| * <<alert-type-es-query>> | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the geo alert be added to this list?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, I spoke with Maps team and they want it to be separately, because they are planning more alerts types for Maps.
(cc @aaronjcaldwell )
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this was awkward when I was doing the docs from the geo side too. On one hand, Geo Containment is a stack alert and I expect the next one, Geo Proximity, will be one too. It's possible we'll do more beyond this but that's TBD. They're distinct from other stack alerts in that they're geo-specific and require a Gold+ license, however I'm aware that's not something we need to distinguish in the docs. I guess I'm flexible in where and how we list them. @gchaps you probably have the best bird's eye view on docs. Any recommendations here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's get this PR out and then review the placement of the geo alert at a later date.
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
YulNaumenko marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
YulNaumenko marked this conversation as resolved.
Show resolved
Hide resolved
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| [role="xpack"] | ||
| [[alert-type-es-query]] | ||
| == ES query | ||
|
|
||
| The ES query alert type is designed to run a user-configured {es} query over indices, compare the number of matches to a configured threshold, and schedule | ||
| actions to run when the threshold condition is met. | ||
|
|
||
| [float] | ||
| === Creating the alert | ||
|
|
||
| An ES query alert can be created from the *Create* button in the <<alert-management, alert management UI>>. Fill in the <<defining-alerts-general-details, general alert details>>, then select *ES query*. | ||
|
|
||
| [role="screenshot"] | ||
| image::user/alerting/images/alert-types-es-query-select.png[Choosing an ES query alert type] | ||
|
|
||
| [float] | ||
| === Defining the conditions | ||
|
|
||
| The ES query alert has 5 clauses that define the condition to detect. | ||
|
|
||
| [role="screenshot"] | ||
| image::user/alerting/images/alert-types-es-query-conditions.png[Four clauses define the condition to detect] | ||
|
|
||
| Index:: This clause requires an *index or index pattern* and a *time field* that will be used for the *time window*. | ||
| Size:: This clause specifies the number of documents to pass to the configured actions when the the threshold condition is met. | ||
| ES query:: This clause specifies the ES DSL query to execute. The number of documents that match this query will be evaulated against the threshold | ||
| condition. Aggregations are not supported at this time. | ||
| Threshold:: This clause defines a threshold value and a comparison operator (`is above`, `is above or equals`, `is below`, `is below or equals`, or `is between`). The number of documents that match the specified query is compared to this threshold. | ||
| Time window:: This clause determines how far back to search for documents, using the *time field* set in the *index* clause. Generally this value should be set to a value higher than the *check every* value in the <<defining-alerts-general-details, general alert details>>, to avoid gaps in detection. | ||
|
|
||
| [float] | ||
| === Testing your query | ||
|
|
||
| Use the *Test query* feature to verify that your query DSL is valid. | ||
|
|
||
| When your query is valid:: Valid queries will be executed against the configured *index* using the configured *time window*. The number of documents that | ||
| match the query will be displayed. | ||
|
|
||
| [role="screenshot"] | ||
| image::user/alerting/images/alert-types-es-query-valid.png[Test ES query returns number of matches when valid] | ||
|
|
||
| When your query is invalid:: An error message is shown if the query is invalid. | ||
|
|
||
| [role="screenshot"] | ||
| image::user/alerting/images/alert-types-es-query-invalid.png[Test ES query shows error when invalid] |
Uh oh!
There was an error while loading. Please reload this page.