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

Update event.kind allowed value descriptions to clarify usage of "alert" and "signal" #1548

Merged
merged 4 commits into from Aug 3, 2021

Conversation

MikePaquette
Copy link
Contributor

We have received questions from community members about when to use event.kind:alert vs. event.kind:signal

These allowed values can cause confusion, since documents that contain event.kind:signal are often referred to as "alerts."

As background, the overloading of the term "alerts" is a longstanding issue in security information and event management, where there was frequently confusion between external alerts generated by some external system and alerts generated by the SIEM itself. Any usage of the unmodified "alerts" was thus ambiguous.

The proposed language attempts to provide clear guidance:

  • If the alert is created by a system external to the Elastic Stack, use event.kind:alert
  • If the alert is created by the Elastic Stack/solution, use event.kind:signal

Copy link
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Thanks for updating these descriptions, @MikePaquette!

Since these are minor doc updates, let's include these changes into 1.11. I'll handle the backporting.

@ebeahan ebeahan merged commit ea23096 into elastic:master Aug 3, 2021
ebeahan added a commit to ebeahan/ecs that referenced this pull request Aug 3, 2021
…rt" and "signal" (elastic#1548)

* update event.kind allowed values

* make update event.kind allowed values

* add changelog entry

Co-authored-by: Eric Beahan <eric.beahan@elastic.co>
ebeahan added a commit to ebeahan/ecs that referenced this pull request Aug 3, 2021
…rt" and "signal" (elastic#1548)

* update event.kind allowed values

* make update event.kind allowed values

* add changelog entry

Co-authored-by: Eric Beahan <eric.beahan@elastic.co>
ebeahan added a commit that referenced this pull request Aug 3, 2021
…rt" and "signal" (#1548) (#1551)

* update event.kind allowed values

* make update event.kind allowed values

* add changelog entry

Co-authored-by: Eric Beahan <eric.beahan@elastic.co>

Co-authored-by: Mike Paquette <mpaquette@elastic.co>
ebeahan added a commit that referenced this pull request Aug 3, 2021
…rt" and "signal" (#1548) (#1550)

* update event.kind allowed values

* make update event.kind allowed values

* add changelog entry

Co-authored-by: Eric Beahan <eric.beahan@elastic.co>

Co-authored-by: Mike Paquette <mpaquette@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants