[![Unit tests](https://github.com/opensearch-project/alerting-dashboards-plugin/workflows/Unit%20tests%20workflow/badge.svg)](https://github.com/opensearch-project/alerting-dashboards-plugin/actions?query=workflow%3A%22Unit+tests+workflow%22) [![Integration tests](https://github.com/opensearch-project/alerting-dashboards-plugin/workflows/E2E%20Cypress%20tests/badge.svg)](https://github.com/opensearch-project/alerting-dashboards-plugin/actions?query=workflow%3A%22E2E+Cypress+tests%22) [![codecov](https://codecov.io/gh/opensearch-project/alerting-dashboards-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/alerting-dashboards-plugin) [![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://opensearch.org/docs/monitoring-plugins/alerting/index/) [![Forum](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/Use-this-category-for-all-questions-around-machine-learning-plugins) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success) - [OpenSearch Alerting Dashboards](#opensearch-alerting-dashboards) - [Highlights](#highlights) - [Documentation](#documentation) - [Contributing](#contributing) - [Code of Conduct](#code-of-conduct) - [Security](#security) - [License](#license) - [Copyright](#copyright) # OpenSearch Alerting Dashboards The OpenSearch Alerting Dashboards plugin lets you manage your [OpenSearch Alerting plugin](https://github.com/opensearch-project/alerting) to monitor your data and send notifications when certain criteria are met---all from OpenSearch Dashboards. ## Highlights - Create and schedule *monitors*, which run period queries against data in Opensearch. - Evaluate query results against *triggers* to see if they meet certain criteria. - If trigger criteria are met, generate *alerts* and perform *actions* (e.g. post a message in a Slack channel). ## Documentation Please see our [documentation](https://docs-beta.opensearch.org/monitoring-plugins/alerting/index/). ## Contributing See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). ## Code of Conduct This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. ## Security If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## License This project is licensed under the [Apache v2.0 License](LICENSE). ## Copyright Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.