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

[event log] populate rule.* ECS fields for alert events #94137

Closed
pmuellr opened this issue Mar 9, 2021 · 0 comments · Fixed by #101132
Closed

[event log] populate rule.* ECS fields for alert events #94137

pmuellr opened this issue Mar 9, 2021 · 0 comments · Fixed by #101132
Assignees
Labels
discuss Feature:EventLog Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@pmuellr
Copy link
Member

pmuellr commented Mar 9, 2021

ECS defines a top-level rule object property, with a number of fields that correspond to Kibana alerting rules:

  • rule.author - the rule updatedBy field
  • rule.id - the rule saved object id
  • rule.license - alert type license, basic, gold, etc
  • rule.name - the rule name field
  • rule.reference - url to the help page for the alert type

Some are less clear how they would relate:

  • rule.description
  • rule.category - could be producer, perhaps
  • rule.ruleset - could be producer, perhaps
  • rule.uuid - maybe this would be spaceId + id, or switch the values with rule.id (it would have spaceId)
  • rule.version - could be stack version, and could perhaps also be a constant_keyword in our event log indices since we create new indices for every stack version

The one missing bit of info is the spaceId, which we could perhaps force into rule.ruleset or rule.category, but those aren't great fits. We'd probably want something like a rule.namespace: keyword sort of field added.

As a secondary item, there is a event.kind field that we can populate with alert - https://www.elastic.co/guide/en/ecs/current/ecs-event.html#field-event-kind . Related is event.category - almost smells like this could be the producer value to me.

FWIW, at the time we created the event log, I don't believe the rule properties existed, and the valid values for event.kind, and it's relation to event.category (secondary to event.kind) had been specified.

@pmuellr pmuellr added discuss Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:EventLog labels Mar 9, 2021
@YulNaumenko YulNaumenko self-assigned this May 27, 2021
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Feature:EventLog Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants