-
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 implement/ts-…
…optimizer-limits-config-path
- Loading branch information
Showing
345 changed files
with
11,694 additions
and
3,590 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
[[<ACTION-TYPE>-action-type]] | ||
=== <ACTION-TYPE> action | ||
++++ | ||
<titleabbrev><ACTION-TYPE></titleabbrev> | ||
++++ | ||
|
||
Include a short description of the action type. | ||
|
||
[float] | ||
[[<ACTION-TYPE>-connector-configuration]] | ||
==== Connector configuration | ||
|
||
<ACTION-TYPE> connectors have the following configuration properties. | ||
|
||
//// | ||
List of user-facing connector configurations. This should align with the fields available in the Create connector flyout form for this action type. | ||
//// | ||
|
||
Property1:: A short description of this property. | ||
Property2:: A short description of this property with format hints. This can be specified in `this specific format`. | ||
|
||
[float] | ||
[[Preconfigured-<ACTION-TYPE>-configuration]] | ||
==== Preconfigured action type | ||
|
||
//// | ||
Example preconfigured format for this action type | ||
//// | ||
|
||
[source,text] | ||
-- | ||
my-<ACTION-TYPE>: | ||
name: preconfigured-<ACTION-TYPE>-action-type | ||
actionTypeId: .<ACTION-TYPE> | ||
config: | ||
property1: value1 | ||
property2: value2 | ||
secrets: | ||
property3: value3 | ||
-- | ||
|
||
[float] | ||
[[<ACTION-TYPE>-connector-config-properties]] | ||
//// | ||
List of properties from the ConfigSchema and SecretsSchema for this action type. | ||
//// | ||
Config defines information for the action type. | ||
|
||
`property1`:: A short description of this property. | ||
`property2`:: A short descriptionn of this property. | ||
|
||
Secrets defines sensitive information for the action type. | ||
|
||
`property3`:: A short descriptionn of this property. | ||
|
||
[float] | ||
[[<ACTION-TYPE>-action-configuration]] | ||
==== Action configuration | ||
|
||
<ACTION-TYPE> actions have the following configuration properties. | ||
|
||
//// | ||
List of user-facing action configurations. This should align with the fields available in the Action section of the Create/Update alert flyout. | ||
//// | ||
|
||
Property1:: A short description of this property. | ||
Property2:: A short description of this property with format hints. This can be specified in `this specific format`. | ||
|
||
//// | ||
Optional - additional configuration details here | ||
[[configuring-<ACTION-TYPE>]] | ||
==== Configure <ACTION-TYPE> | ||
//// |
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,39 @@ | ||
[[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>. | ||
//// |
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
Oops, something went wrong.