https://github.com/opensearch-project/alerting

📟 Get notified when your data meets certain conditions by setting up monitors, alerts, and notifications
https://github.com/opensearch-project/alerting

Last synced: 3 months ago
JSON representation

📟 Get notified when your data meets certain conditions by setting up monitors, alerts, and notifications

• Host: GitHub
• URL: https://github.com/opensearch-project/alerting
• Owner: opensearch-project
• License: apache-2.0
• Created: 2021-04-06T02:41:51.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T00:09:01.000Z (8 months ago)
• Last Synced: 2024-10-30T02:48:09.728Z (8 months ago)
• Language: Kotlin
• Homepage: https://opensearch.org/docs/latest/monitoring-plugins/alerting/index/
• Size: 72 MB
• Stars: 61
• Watchers: 17
• Forks: 102
• Open Issues: 246
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Test Workflow](https://github.com/opensearch-project/alerting/workflows/Test%20Workflow/badge.svg)](https://github.com/opensearch-project/alerting/actions)

[![codecov](https://codecov.io/gh/opensearch-project/alerting/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/alerting)

[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://opensearch.org/docs/latest/monitoring-plugins/alerting/api/)

[![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://forum.opensearch.org/c/plugins/alerting/7)

![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)



- [OpenSearch Alerting](#opensearch-alerting)

- [Highlights](#highlights)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Code of Conduct](#code-of-conduct)

- [Security](#security)

- [License](#license)

- [Copyright](#copyright)

# OpenSearch Alerting

The OpenSearch Alerting enables you to monitor your data and send alert notifications automatically to your stakeholders. With an intuitive OpenSearch Dashboards interface and a powerful API, it is easy to set up, manage, and monitor your alerts. Craft highly specific alert conditions using Elasticsearch's full query language and scripting capabilities.

## Highlights

Scheduled searches use [cron expressions](https://en.wikipedia.org/wiki/Cron) or intervals (e.g. every five minutes) and the Elasticsearch query DSL.

To define trigger conditions, use the Painless scripting language or simple thresholds (e.g. count > 100).

When trigger conditions are met, you can publish messages to the following destinations:

* [Slack](https://slack.com/)

* Custom webhook

* [Amazon Chime](https://aws.amazon.com/chime/)

* Email

Messages can be static strings, or you can use the [Mustache](https://mustache.github.io/mustache.5.html) templates to include contextual information.

## 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 [[email protected]](mailto:[email protected]) 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.txt).

## Copyright

Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.