fda67adb9f
* Alert type template * Action type template * Cleanup * Cleanup * Removing callout list * Cleanup * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Adding title to actions page * PR fixes * PR fixes * PR fixes * PR fixes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
39 lines
1.4 KiB
Plaintext
39 lines
1.4 KiB
Plaintext
[[alert-type-<ALERT TYPE>]]
|
|
=== <ALERT TYPE>
|
|
|
|
Include a short description of the alert type.
|
|
|
|
[float]
|
|
==== Create the alert
|
|
|
|
Fill in the <<defining-alerts-general-details, alert details>>, then select *<ALERT TYPE>*.
|
|
|
|
[float]
|
|
==== Define the conditions
|
|
|
|
Define properties to detect the condition.
|
|
|
|
////
|
|
Optional, include a screenshot
|
|
[role="screenshot"]
|
|
image::user/alerting/images/alert-types-<ALERT TYPE>-conditions.png[Conditions for <ALERT TYPE> alert 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 alert condition is met. The following variables are specific to the <ALERT TYPE> alert. You can also specify <<defining-alerts-actions-variables, variables common to all alerts>>.
|
|
|
|
`context.variableA`:: A short description of the context variable defined by the alert type.
|
|
`context.variableB`:: A short description of the context variable defined by the alert type with an example. Example: `this is what variableB outputs`.
|
|
|
|
////
|
|
Optional, include a step-by-step example for creating this alert
|
|
[float]
|
|
==== Example
|
|
|
|
In this section, you will use the {kib} <<add-sample-data, weblog sample dataset>> to setup and tune the conditions on an <ALERT TYPE> alert. For this example, we want to detect when <DESCRIBE THE CONDITIONS>.
|
|
//// |