search

opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
69 stars 473 forks source link

[DOC] Add alert query structure #6628

Open hdhalter opened 7 months ago

hdhalter commented 7 months ago

What do you want to do?

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 commented 6 months ago

@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 commented 6 months ago

@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 commented 5 months ago

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 commented 5 months ago

@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 commented 5 months ago

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