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

[DOC] Add alert query structure #6628

Open
1 of 4 tasks
hdhalter opened this issue Mar 7, 2024 · 5 comments
Open
1 of 4 tasks

[DOC] Add alert query structure #6628

hdhalter opened this issue Mar 7, 2024 · 5 comments
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. alerting benchmark-study

Comments

@hdhalter
Copy link
Contributor

hdhalter commented Mar 7, 2024

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
Address the documentation gaps on syntax, configuration, and best practices for alerts, monitoring, metrics.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
Provide more information when configuring the alerts within OpenSearch Dashboard. There is a prompt for the user to define alerts by configuring their own queries. The documentation related to alerts does not cover what the structure for that query should look like or provide examples. Users do not use the same queries they use to explore information as they do to build alerts.

This is feedback from the benchmark study conducted in Q1-24.

@vagimeli
Copy link
Collaborator

@hdhalter I'll reach out to the the alerting devs and ask for their support on this topic. Are we updating the Alerting dashboards documentation? https://opensearch.org/docs/latest/observing-your-data/alerting/dashboards-alerting/

@hdhalter
Copy link
Contributor Author

@hdhalter I'll reach out to the the alerting devs and ask for their support on this topic. Are we updating the Alerting dashboards documentation? https://opensearch.org/docs/latest/observing-your-data/alerting/dashboards-alerting/

Sounds right, but the devs would have to confirm.

@vagimeli
Copy link
Collaborator

vagimeli commented Apr 8, 2024

Suggestions for improvement:

  1. Provide examples of query structures.
  2. Provide more detailed information on permissions and access control for alerting dashboards and visualizations.
  3. Include a section on best practices or guidelines for creating effective alerting visualizations.
  4. Add a troubleshooting section covering common issues, error messages, and their resolutions.
  5. Consider using animated GIFs or videos to better illustrate the step-by-step processes.

@vagimeli
Copy link
Collaborator

@anirudha Do you have a developer point of contact I can work with to address this feedback? We'll need a dev to take a first pass of the content. I'll provide the writing support. Thank you.

@vagimeli
Copy link
Collaborator

vagimeli commented Apr 18, 2024

@praveensameneni Does this PR topic fall under your team? If so, who is the developer I can work with for technical information? Thank you.

@hdhalter hdhalter added the 2 - In progress Issue/PR: The issue or PR is in progress. label Apr 25, 2024
@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress 2 - In progress Issue/PR: The issue or PR is in progress. and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Apr 25, 2024
@hdhalter hdhalter removed the 3 - Tech review PR: Tech review in progress label Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. alerting benchmark-study
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants