a7c9d3f1e0
* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
39 lines
1.4 KiB
Plaintext
39 lines
1.4 KiB
Plaintext
[[rule-type-<RULE TYPE>]]
|
|
=== <RULE TYPE>
|
|
|
|
Include a short description of the rule type.
|
|
|
|
[float]
|
|
==== Create the rule
|
|
|
|
Fill in the <<defining-alerts-general-details, rule details>>, then select *<RULE TYPE>*.
|
|
|
|
[float]
|
|
==== Define the conditions
|
|
|
|
Define properties to detect the condition.
|
|
|
|
////
|
|
Optional, include a screenshot
|
|
[role="screenshot"]
|
|
image::user/alerting/images/rule-types-<RULE TYPE>-conditions.png[Conditions for <RULE TYPE> rule type]
|
|
////
|
|
|
|
Condition1:: This is a condition the user must define.
|
|
Condition2:: This is another condition the user must define.
|
|
|
|
[float]
|
|
==== Add action variables
|
|
|
|
<<defining-alerts-actions-details, Add an action>> to run when the rule condition is met. The following variables are specific to the <RULE TYPE> rule. You can also specify <<defining-alerts-actions-variables, variables common to all rules>>.
|
|
|
|
`context.variableA`:: A short description of the context variable defined by the rule type.
|
|
`context.variableB`:: A short description of the context variable defined by the rule type with an example. Example: `this is what variableB outputs`.
|
|
|
|
////
|
|
Optional, include a step-by-step example for creating this rule
|
|
[float]
|
|
==== Example
|
|
|
|
In this section, you will use the {kib} <<add-sample-data, weblog sample dataset>> to setup and tune the conditions on an <RULE TYPE> rule. For this example, we want to detect when <DESCRIBE THE CONDITIONS>.
|
|
//// |