-
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
Merged
YulNaumenko
merged 15 commits into
elastic:master
from
YulNaumenko:alerting-docs-alert-types-refs
Feb 23, 2021
Merged
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
1f4da90
[Alerts][Docs] Alert types doc update. Added refs to applications spe…
YulNaumenko 9ac28bf
fixed ci
YulNaumenko 7f5af6f
fixed ci
YulNaumenko ca27579
fixed ci
YulNaumenko 3b9fc72
fixed ci
YulNaumenko 6f08ff9
fixed alignment of pages
YulNaumenko 5674bcd
fixed addtional links
YulNaumenko a8c2784
fixed titles
YulNaumenko abe8b85
Apply suggestions from code review
YulNaumenko 5a937a2
Update docs/management/alerting/alert-management.asciidoc
YulNaumenko ff64031
renamed titles
YulNaumenko 125e4e8
moved maps to own folder
YulNaumenko a8bdeca
Merge remote-tracking branch upstream/master
YulNaumenko c8803ce
renamed titles
YulNaumenko 14839ed
removed mistake file
YulNaumenko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,159 +1,35 @@ | ||
| [role="xpack"] | ||
| [[alert-types]] | ||
| == Standard stack alert types | ||
| == Alerts | ||
|
|
||
| {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*>>. | ||
| Kibana provides two types of alerts: | ||
|
|
||
| This section covers stack alerts. For domain-specific alert types, refer to the documentation for that app. | ||
| Users will need `all` access to the *Stack Alerts* feature to be able to create and edit any of the alerts listed below. | ||
| See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to this feature. | ||
|
|
||
| Currently {kib} provides two stack alerts: <<alert-type-index-threshold>> and <<alert-type-es-query>>. | ||
|
|
||
| [float] | ||
| [[alert-type-index-threshold]] | ||
| === Index threshold | ||
|
|
||
| The index threshold alert type is designed to run an {es} query over indices, aggregating field values from documents, comparing them to threshold values, and scheduling actions to run when the thresholds are met. | ||
|
|
||
| [float] | ||
| ==== Creating the alert | ||
|
|
||
| An index threshold 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 *Index Threshold*. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-select.png[Choosing an index threshold alert type] | ||
|
|
||
| [float] | ||
| ==== Defining the conditions | ||
|
|
||
| The index threshold has 5 clauses that define the condition to detect. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-conditions.png[Five 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*. | ||
| When:: This clause specifies how the value to be compared to the threshold is calculated. The value is calculated by aggregating a numeric field a the *time window*. The aggregation options are: `count`, `average`, `sum`, `min`, and `max`. When using `count` the document count is used, and an aggregation field is not necessary. | ||
| Over/Grouped Over:: This clause lets you configure whether the aggregation is applied over all documents, or should be split into groups using a grouping field. If grouping is used, an <<alerting-concepts-alert-instances, alert instance>> will be created for each group when it exceeds the threshold. To limit the number of instances on high cardinality fields, you must specify the number of groups to check against the threshold. Only the *top* groups are checked. | ||
| Threshold:: This clause defines a threshold value and a comparison operator (one of `is above`, `is above or equals`, `is below`, `is below or equals`, or `is between`). The result of the aggregation 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 to a value higher than the *check every* value in the <<defining-alerts-general-details, general alert details>>, to avoid gaps in detection. | ||
|
|
||
| If data is available and all clauses have been defined, a preview chart will render the threshold value and display a line chart showing the value for the last 30 intervals. This can provide an indication of recent values and their proximity to the threshold, and help you tune the clauses. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-preview.png[Five clauses define the condition to detect] | ||
|
|
||
| [float] | ||
| === Example | ||
|
|
||
| In this section, you will use the {kib} <<add-sample-data, weblog sample dataset>> to setup and tune the conditions on an index threshold alert. For this example, we want to detect when any of our top three sites have served more than 420,000 bytes over a 24 hour period. | ||
|
|
||
| From the <<alert-management, alert management UI>>, create a new alert, and fill in the <<defining-alerts-general-details, general alert details>>. This alert will be checked every 4 hours, and will not execute actions more than once per day. Choose the index threshold alert type. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-select.png[Choosing an index threshold alert type] | ||
|
|
||
| Click on each clause to open a control that helps you set the value: | ||
|
|
||
| [float] | ||
| ==== Index clause | ||
| The index clause control will list and allow you to search for available indices. Choose *kibana_sample_data_logs* | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-index.png[Choosing an index] | ||
|
|
||
| Once an index is selected, the list of time fields for that index will be available to select. Choose *@timestamp*. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-timefield.png[Choosing a time field] | ||
|
|
||
| [float] | ||
| ==== When clause | ||
|
|
||
| We want to detect the number of bytes served during the time window, so we select `sum` as the aggregation, and `bytes` as the field to aggregate. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-aggregation.png[Choosing the aggregation] | ||
|
|
||
| [float] | ||
| ==== Over/Grouped over clause | ||
|
|
||
| We want to alert on the three sites that have the most traffic, so we'll group the sum of bytes by the `host.keyword` field and take the top 3 values. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-grouping.png[Choosing the groups] | ||
|
|
||
| [float] | ||
| ==== Threshold clause | ||
|
|
||
| We want to alert when any site exceeds 420,000 bytes over a 24 hour period, so we'll set the threshold to 420,000 and use the `is above` comparison. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-threshold.png[Setting the threshold] | ||
|
|
||
| [float] | ||
| ==== Time window clause | ||
|
|
||
| Finally, set the time window to 24 hours to complete the alert configuration. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-window.png[Setting the time window] | ||
|
|
||
| The preview chart will render showing the 24 hour sum of bytes at 4 hours intervals (the *check every* interval) for the past 120 hours (the last 30 intervals). | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-preview.png[Setting the time window] | ||
|
|
||
| [float] | ||
| ==== Comparing time windows | ||
|
|
||
| You can interactively change the time window and observe the effect it has on the chart. Compare a 24 window to a 12 hour window. Notice the variability in the sum of bytes, due to different traffic levels during the day compared to at night. This variability would result in noisy alerts, so the 24 hour window is better. The preview chart can help you find the right values for your alert. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-index-threshold-example-comparison.png[Comparing two time windows] | ||
|
|
||
| [float] | ||
| [[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. | ||
| * Stack alerts, which are built into {kib} | ||
| * Domain-specific alerts, which are registered by {kib} apps. | ||
|
|
||
| [float] | ||
| ==== Creating the alert | ||
| ==== Standard stack alerts | ||
|
|
||
| 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*. | ||
| Users require the `all` privilege to access to the *Stack Alerts* feature and create and edit alerts. . | ||
| See <<kibana-feature-privileges, feature privileges>> for more information. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-es-query-select.png[Choosing an ES query alert type] | ||
|
|
||
| [float] | ||
| ==== Defining the conditions | ||
| {kib} provides two stack alerts: | ||
|
|
||
| The ES query alert has 5 clauses that define the condition to detect. | ||
| * <<alert-type-index-threshold>> | ||
| * <<alert-type-es-query>> | ||
|
|
||
| [role="screenshot"] | ||
| image::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. | ||
| ==== Domain-specific alerts | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-es-query-valid.png[Test ES query returns number of matches when valid] | ||
| For domain-specific alerts, refer to the documentation for that app. | ||
| {kib} supports these alerts: | ||
|
|
||
| When your query is invalid:: An error message is shown if the query is invalid. | ||
| * {observability-guide}/create-alerts.html[Observability alerts] | ||
| * {security-guide}/prebuilt-rules.html[Security alerts] | ||
| * <<geo-alerting, Maps alerts>> | ||
| * <<xpack-ml, ML alerts>> | ||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-types-es-query-invalid.png[Test ES query shows error when invalid] | ||
| include::stack-alerts/index-threshold.asciidoc[] | ||
| include::stack-alerts/es-query.asciidoc[] | ||
| include::maps-alerts/geo-alert-types.asciidoc[] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.