Skip to content

Commit

Permalink
Add new step to all rule types
Browse files Browse the repository at this point in the history
  • Loading branch information
joepeeples committed May 1, 2024
1 parent 0d835e1 commit 708d737
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions docs/detections/rules-ui-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ then select:
+
NOTE: If a required job isn't currently running, it will automatically start when you finish configuring and enable the rule.
.. The anomaly score threshold above which alerts are created.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click **Continue** to <<rule-ui-basic-params, configure basic rule settings>>.

[discrete]
Expand Down Expand Up @@ -82,6 +92,15 @@ When you use a saved query, the *Load saved query "_query name_" dynamically on
* Deselect this to load the saved query as a one-time way of populating the rule's *Custom query* field and filters. This copies the settings from the saved query to the rule, so you can then further adjust the rule's query and filters as needed. If the saved query is later changed, the rule will not inherit those changes.

. (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Use *Suppress alerts by* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click **Continue** to <<rule-ui-basic-params, configure basic rule settings>>.

Expand Down Expand Up @@ -109,6 +128,15 @@ You can also leave the *Group by* field undefined. The rule then creates an aler
IMPORTANT: Alerts created by threshold rules are synthetic alerts that do not resemble the source documents. The alert itself only contains data about the fields that were aggregated over (the *Group by* fields). Other fields are omitted, because they can vary across all source documents that were counted toward the threshold. Additionally, you can reference the actual count of documents that exceeded the threshold from the `kibana.alert.threshold_result.count` field.

. preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Select *Suppress alerts* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click *Continue* to <<rule-ui-basic-params, configure basic rule settings>>.

Expand Down Expand Up @@ -159,6 +187,15 @@ NOTE: For sequence events, the {security-app} generates a single alert when all
+

. preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Use *Suppress alerts by* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click *Continue* to <<rule-ui-basic-params, configure basic rule settings>>.

Expand Down Expand Up @@ -213,6 +250,15 @@ in the Timeline, Timeline query values are replaced with their corresponding ale
field values.
+
. preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Select *Suppress alerts* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click *Continue* to <<rule-ui-basic-params, configure basic rule settings>>.

Expand Down Expand Up @@ -259,6 +305,15 @@ IMPORTANT: When checking multiple fields, each unique combination of values from
For example, if a rule has an interval of 5 minutes, no additional look-back time, and a history window size of 7 days, a term will be considered new only if the time it appears within the last 7 days is also within the last 5 minutes. Configure the rule interval and additional look-back time when you <<rule-schedule, set the rule's schedule>>.

. preview:[] (Optional, https://www.elastic.co/pricing[Platinum or higher subscription] required) Use *Suppress alerts by* to reduce the number of repeated or duplicate alerts created by the rule. Refer to <<alert-suppression>> for more information.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click *Continue* to <<rule-ui-basic-params, configure basic rule settings>>.

Expand All @@ -279,6 +334,15 @@ NOTE: Refer to the sections below to learn more about <<esql-rule-query-types,{e
+
TIP: Click the help icon (image:images/esql-ref-button.png[Click the ES|QL help icon,20,20]) to open the in-product reference documentation for all {esql} commands and functions.
+

////
The following step is repeated across all rule types. If you change anything
in the step or its sub-steps, apply the change to the other rule types, too.
////
. (Optional) To associate the rule with one or more {integrations-docs}[Elastic integrations], click *Add integration* under *Related integrations*, then:
.. Select an integration from the list.
.. Enter the version of the integration you want associated with the rule, using https://semver.org[semantic versioning]. For version ranges, you must use tilde or caret syntax. For example, `~1.2.3` is from 1.2.3 to any patch version less than 1.3.0, and `^1.2.3` is from 1.2.3 to any minor and patch version less than 2.0.0.

. Click *Continue* to <<rule-ui-basic-params, configure basic rule settings>>.

[float]
Expand Down

0 comments on commit 708d737

Please sign in to comment.