Skip to content

Commit b0be061

Browse files
[DOCS] Explain requirement to create Endpoint exception (#1428) (#1451)
* First draft * Second draft * Tighten up procedure * Update detections-ui-exceptions.asciidoc * Update detections-ui-exceptions.asciidoc * Apply suggestions from Ben's review Co-authored-by: benironside <[email protected]> * Restructure procedure syntax * Update docs/detections/detections-ui-exceptions.asciidoc Co-authored-by: Janeen Mikell-Straughn <[email protected]> Co-authored-by: benironside <[email protected]> Co-authored-by: Janeen Mikell-Straughn <[email protected]> (cherry picked from commit 4491fc5) Co-authored-by: Joe Peeples <[email protected]>
1 parent 62d1fd2 commit b0be061

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

docs/detections/detections-ui-exceptions.asciidoc

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -152,55 +152,53 @@ Closes all alerts that match the exception's conditions and were generated only
152152

153153
[float]
154154
[[endpoint-rule-exceptions]]
155-
=== Add Elastic Endpoint Security exceptions
155+
=== Add Elastic {endpoint-sec} exceptions
156156

157-
Like detection rule exceptions, you can add Endpoint agent exceptions via both
158-
the Elastic Endpoint Security rule and its generated alerts. Alerts generated
159-
from the Elastic Endpoint Security rule have the following fields:
157+
Like detection rule exceptions, you can add Endpoint agent exceptions either by editing Elastic {endpoint-sec} rules or by adding them as an action on alerts generated by {endpoint-sec} rules. Elastic {endpoint-sec} alerts have the following fields:
160158

161159
* `signal.original_event.module determined:endpoint`
162160
* `signal.original_event.kind:alert`
163161

164-
Additionally, you can add Endpoint exceptions via rules that are associated
165-
with Elastic endpoint rule exceptions. To associate rules, when creating or
166-
editing a rule select the
167-
<<rule-ui-advanced-params, _Elastic endpoint exceptions_>> option.
162+
You can also add Endpoint exceptions to rules that are associated with {elastic-endpoint} rule exceptions. To associate rules, when creating or editing a rule, select the <<rule-ui-advanced-params, *{elastic-endpoint} exceptions*>> option.
168163

169164
[IMPORTANT]
170165
=============
171-
Exceptions added to the Elastic Endpoint Security rule affect all alerts sent
166+
Exceptions added to the Elastic {endpoint-sec} rule affect all alerts sent
172167
from the Endpoint agent. Be careful not to unintentionally prevent some Endpoint
173168
alerts.
169+
170+
Additionally, to add an Endpoint exception to the Elastic {endpoint-sec} rule, there must be at least one {endpoint-sec} alert generated in the system. For non-production use, if no alerts exist, you can trigger a test alert using malware emulation techniques or tools such as the Anti Malware Testfile from the https://www.eicar.org/[European Institute for Computer Anti-Virus Research (EICAR)].
174171
=============
175172

176-
. To add an Endpoint exception via the rule details page:
173+
. Do one of the following:
174+
+
175+
--
176+
* To add an Endpoint exception from the rule details page:
177177
.. Go to the rule details page (*Detect* -> *Rules*), and then search for and select the Elastic *Security Endpoint* rule.
178178
.. Scroll down to the *Trend* histogram and select the *Exceptions* tab.
179179
.. Click *Add new exception* -> *Add Endpoint exception*.
180-
. To add an exception via the Alerts table:
180+
* To add an Endpoint exception from the Alerts table:
181181
.. Go to *Detect* -> *Alerts*.
182182
.. Scroll down to the Alerts table, and from an Elastic Security Endpoint
183183
alert, click the *More actions* button (*...*), then select *Add Endpoint exception*.
184+
--
184185
+
185-
The *Add Endpoint Exception* window opens (via the Alerts table).
186+
The *Add Endpoint Exception* window opens, from either the rule details page or the Alerts table.
186187
+
187188
[role="screenshot"]
188189
image::images/endpoint-add-exp.png[]
189190
. If required, modify the conditions.
190191
+
191-
NOTE: <<ex-nested-conditions>> describes when nested conditions are required.
192+
NOTE: See <<ex-nested-conditions>> for more information on when nested conditions are required.
192193

193194
. You can select any of the following:
194195

195196
* *Close this alert*: Closes the alert when the exception is added. This option
196-
is only available when adding exceptions via the Alerts table.
197-
* *Close all alerts that match this exception, including alerts generated by other rules*:
197+
is only available when adding exceptions from the Alerts table.
198+
* *Close all alerts that match this exception and were generated by this rule*:
198199
Closes all alerts that match the exception's conditions.
199200

200-
. Click *Add Exception*.
201-
+
202-
An exception is created for both the detection rule *and* the Elastic Endpoint
203-
agent.
201+
. Click *Add Endpoint Exception*. An exception is created for both the detection rule and the {elastic-endpoint}.
204202

205203
[float]
206204
[[ex-nested-conditions]]

0 commit comments

Comments
 (0)