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

[Request]: Document alert data for observability rule types #4568

Open
maryam-saeidi opened this issue Nov 22, 2024 · 2 comments
Open

[Request]: Document alert data for observability rule types #4568

maryam-saeidi opened this issue Nov 22, 2024 · 2 comments

Comments

@maryam-saeidi
Copy link
Member

Description

🍒 Summary

We save different alert information for different observability rule types. This information can be used in multiple features such as maintenance window and conditional actions:

We would like to document the alert data available in all the observability rules and the differences between rules so that our users can get an idea of how to filter their alerts for the above-mentioned features.

Resources

Here is a list of fields that I am preparing based on fields that we define in code such as default_alert_as_data.

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

No difference

What release is this request related to?

N/A

Collaboration model

The documentation team

Point of contact.

Main contact: @maryam-saeidi

Stakeholders: @jasonrhodes, @drewpost

@jasonrhodes
Copy link
Member

I assume we should be engaging @dedemorton for (part of) this?

@maryam-saeidi
Copy link
Member Author

Yes! I had a chat with @dedemorton about this topic, and she proposed some places where we can start including this information; we just need to first prepare a list of fields and their description, possibly with an example, that we want to include in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants