Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs]Detections and Alerts UI #73

Merged
merged 30 commits into from
Aug 4, 2020

Conversation

benskelker
Copy link
Contributor

@benskelker benskelker commented Jul 26, 2020

Updates the docs with new Detection rules and alerts functionality.

Detections preview

Please ignore all the BEN placeholders for links and any old screenshots. Thanks

@benskelker benskelker added the v7.9.0 Features in the 7.9 Release label Jul 26, 2020
@benskelker benskelker linked an issue Jul 26, 2020 that may be closed by this pull request
@benskelker benskelker linked an issue Jul 26, 2020 that may be closed by this pull request
@benskelker benskelker marked this pull request as ready for review July 30, 2020 15:23
@benskelker benskelker changed the title [Doc]Detections and Alerts UI [Docs]Detections and Alerts UI Jul 30, 2020
Copy link
Contributor

@rylnd rylnd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gave this a once-over with extra attention to the value lists stuff. This is looking great! I just had a few questions/comments.

Comment on lines +51 to +62
// * `host.name`
// * `host.hostname`
// * `host.domain`
// * `host.id`
// * `host.ip`
// * `client.ip`
// * `destination.ip`
// * `server.ip`
// * `source.ip`
// * `network.community_id`
// * `user.name`
// * `process.name`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these comments placeholders for something, or can they be removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think they can be removed but I need to check with @XavierM. Worst case, I'll remove them in a separate PR.

Comment on lines +5 to +11
Create building-block rules when you do not want to see their generated alerts
in the UI. This is useful when you want:

* A record of low-risk alerts without producing noise in the Alerts table.
* Rules that execute on the alert indices (`.siem-signals-<kibana space>-*`).
You can then use building-block rules to create hidden alerts that act as a
basis for an 'ordinary' rule to generate visible alerts.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect description @benskelker! 🙂

I've been curious what to call non-building-block detection rules, and I think ordinary in this context fits the bill. 👍

Copy link
Contributor

@narcher7 narcher7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small suggestions, other LGTM.


*Example*

The Timeline template used in the rule has this dropzone query:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to, "This Timeline template example uses the host.name: Linux-LivepoolFC dropzone query in the rule.

[[alerts-to-resolver]]
=== Visually analyze process relationships.

For process events received from the Elastic Endpoint agent, you can open a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might have to loop around and rename this the Elastic Security Endpoint integration. Technically speaking, the Elastic Endpoint Security agent in the legacy Endgame agent, whereas the Elastic agent ingested onto a device is configured with the Elastic Security Endpoint integration.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep - and we'll need to add the link as well.

. In the Alert table, select _Additional filters_ ->
_Include building-block alerts_.

NOTE: On a building-block Rule details page, the rule's alerts are displayed (by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does "Details" need to be capitalized as well if we're referring to the "Rule Details" page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No - sentence capitalisation

@@ -1,5 +1,5 @@
[[elastic-endpoint-prebuilt-rule]]
=== Elastic Endpoint
=== Elastic Endpoint Security
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may have to loop back around and change these post-merge. See my previous comment about Elastic Endpoint Security for an explanation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be OK as it refers to a prebuilt rule name that's already finalised (for 7.9 at least).

@benskelker benskelker merged commit 1afe89b into elastic:master Aug 4, 2020
@benskelker benskelker deleted the 7.9-detections-ui branch August 4, 2020 16:43
benskelker added a commit to benskelker/security-docs that referenced this pull request Aug 4, 2020
* dtections-ui-overview

* initial overview draft

* typo

* restructuring for dedicated alerts section

* rewording

* exceptions from alerts

* adds new rule options

* adds new action text placeholder

* restructer

* structure, exceptions and building-blocks

* minor edits

* adds exceptions

* exceptions cont

* exceptions correction

* more stuff

* proofing and whatnot

* terminology

* nested exception conditions

* typo

* typo - thanks Nate

* corrections - round 1

* add nested conditions example

* typo

* editing

* more proofing

* updates ex example

* adds promoted endpoint events

* typo

* corrections after review

* corrections
benskelker added a commit to benskelker/security-docs that referenced this pull request Aug 4, 2020
* dtections-ui-overview

* initial overview draft

* typo

* restructuring for dedicated alerts section

* rewording

* exceptions from alerts

* adds new rule options

* adds new action text placeholder

* restructer

* structure, exceptions and building-blocks

* minor edits

* adds exceptions

* exceptions cont

* exceptions correction

* more stuff

* proofing and whatnot

* terminology

* nested exception conditions

* typo

* typo - thanks Nate

* corrections - round 1

* add nested conditions example

* typo

* editing

* more proofing

* updates ex example

* adds promoted endpoint events

* typo

* corrections after review

* corrections
benskelker added a commit that referenced this pull request Aug 4, 2020
* dtections-ui-overview

* initial overview draft

* typo

* restructuring for dedicated alerts section

* rewording

* exceptions from alerts

* adds new rule options

* adds new action text placeholder

* restructer

* structure, exceptions and building-blocks

* minor edits

* adds exceptions

* exceptions cont

* exceptions correction

* more stuff

* proofing and whatnot

* terminology

* nested exception conditions

* typo

* typo - thanks Nate

* corrections - round 1

* add nested conditions example

* typo

* editing

* more proofing

* updates ex example

* adds promoted endpoint events

* typo

* corrections after review

* corrections
benskelker added a commit that referenced this pull request Aug 4, 2020
* dtections-ui-overview

* initial overview draft

* typo

* restructuring for dedicated alerts section

* rewording

* exceptions from alerts

* adds new rule options

* adds new action text placeholder

* restructer

* structure, exceptions and building-blocks

* minor edits

* adds exceptions

* exceptions cont

* exceptions correction

* more stuff

* proofing and whatnot

* terminology

* nested exception conditions

* typo

* typo - thanks Nate

* corrections - round 1

* add nested conditions example

* typo

* editing

* more proofing

* updates ex example

* adds promoted endpoint events

* typo

* corrections after review

* corrections
joepeeples pushed a commit that referenced this pull request Mar 13, 2024
Install and configure Elastic Defend cleanup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v7.9.0 Features in the 7.9 Release
Projects
None yet
6 participants