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

Semantic conventions for alerts #1081

Open
thompson-tomo opened this issue May 28, 2024 · 0 comments
Open

Semantic conventions for alerts #1081

thompson-tomo opened this issue May 28, 2024 · 0 comments
Assignees
Labels
area:new enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve triage:needs-triage

Comments

@thompson-tomo
Copy link

thompson-tomo commented May 28, 2024

Area(s)

area:new

Is your change request related to a problem? Please describe.

I want to be able to describe & capture alerts as events in my OPEN Telemetry data just like I can do with ECS and is also described in the CDEvents spec which is also attached.

Describe the solution you'd like

Clear guidance on what the conventions are for describing an alert. Suggestions would be to include:

  • rule.category -> A categorization value keyword used by the entity using the rule for detection of this event.

  • rule.name -> The name of the rule or signature generating the event.

  • rule.description -> The description of the rule generating the event.

  • rule.version -> The version / revision of the rule being used for analysis.

  • alert.type -> strongly typed option of raise, notify & clear

  • alert.message -> user defined message to show in the alert

  • alert.severity -> the severity of the alert which is just like log levels

Describe alternatives you've considered

No response

Additional context

https://www.elastic.co/guide/en/ecs/current/ecs-rule.html

https://github.com/cdevents/spec/blob/v0.4.1/continuous-operations.md#ticket

@thompson-tomo thompson-tomo added enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve triage:needs-triage labels May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:new enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve triage:needs-triage
Projects
None yet
Development

No branches or pull requests

2 participants