-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:elastic/kibana into update-alert-…
…documents
- Loading branch information
Showing
628 changed files
with
16,190 additions
and
12,021 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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
11 changes: 11 additions & 0 deletions
11
...ugin-plugins-expressions-public.expressionfunctiondefinitions.overall_metric.md
This file contains 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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) > [ExpressionFunctionDefinitions](./kibana-plugin-plugins-expressions-public.expressionfunctiondefinitions.md) > [overall\_metric](./kibana-plugin-plugins-expressions-public.expressionfunctiondefinitions.overall_metric.md) | ||
|
||
## ExpressionFunctionDefinitions.overall\_metric property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
overall_metric: ExpressionFunctionOverallMetric; | ||
``` |
This file contains 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
11 changes: 11 additions & 0 deletions
11
...ugin-plugins-expressions-server.expressionfunctiondefinitions.overall_metric.md
This file contains 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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) > [ExpressionFunctionDefinitions](./kibana-plugin-plugins-expressions-server.expressionfunctiondefinitions.md) > [overall\_metric](./kibana-plugin-plugins-expressions-server.expressionfunctiondefinitions.overall_metric.md) | ||
|
||
## ExpressionFunctionDefinitions.overall\_metric property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
overall_metric: ExpressionFunctionOverallMetric; | ||
``` |
This file contains 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 was deleted.
Oops, something went wrong.
This file contains 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 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,56 @@ | ||
[role="xpack"] | ||
[[rule-types]] | ||
== Rule types | ||
|
||
A rule is a set of <<alerting-concepts-conditions, conditions>>, <<alerting-concepts-scheduling, schedules>>, and <<alerting-concepts-actions, actions>> that enable notifications. {kib} provides two types of rules: rules specific to the Elastic Stack and rules specific to a domain. | ||
|
||
[NOTE] | ||
============================================== | ||
Some rule types are subscription features, while others are free features. | ||
For a comparison of the Elastic subscription levels, | ||
see {subscriptions}[the subscription page]. | ||
============================================== | ||
|
||
[float] | ||
[[stack-rules]] | ||
=== Stack rules | ||
|
||
<<alert-management, Stack rules>> are built into {kib}. To access the *Stack Rules* feature and create and edit rules, users require the `all` privilege. See <<kibana-feature-privileges, feature privileges>> for more information. | ||
|
||
[cols="2*<"] | ||
|=== | ||
|
||
| <<rule-type-index-threshold>> | ||
| Aggregate field values from documents using {es} queries, compare them to threshold values, and schedule actions to run when the thresholds are met. | ||
|
||
| <<rule-type-es-query>> | ||
| Run a user-configured {es} query, compare the number of matches to a configured threshold, and schedule actions to run when the threshold condition is met. | ||
|
||
|=== | ||
|
||
[float] | ||
[[domain-specific-rules]] | ||
=== Domain rules | ||
|
||
Domain rules are registered by *Observability*, *Security*, <<maps, Maps>> and <<xpack-ml, Machine Learning>>. | ||
|
||
[cols="2*<"] | ||
|=== | ||
|
||
| {observability-guide}/create-alerts.html[Observability rules] | ||
| Detect complex conditions in the *Logs*, *Metrics*, and *Uptime* apps. | ||
|
||
| {security-guide}/prebuilt-rules.html[Security rules] | ||
| Detect suspicous source events with pre-built or custom rules and create alerts when a rule’s conditions are met. | ||
|
||
| <<geo-alerting, Maps rules>> | ||
| Run an {es} query to determine if any documents are currently contained in any boundaries from a specified boundary index and generate alerts when a rule's conditions are met. | ||
|
||
| {ml-docs}/ml-configuring-alerts.html[{ml-cap} rules] beta:[] | ||
| Run scheduled checks on an anomaly detection job to detect anomalies with certain conditions. If an anomaly meets the conditions, an alert is created and the associated action is triggered. | ||
|
||
|=== | ||
|
||
include::rule-types/index-threshold.asciidoc[] | ||
include::rule-types/es-query.asciidoc[] | ||
include::rule-types/geo-rule-types.asciidoc[] |
File renamed without changes.
Oops, something went wrong.