https://github.com/trendyol/es-alert-cli
ES Alert as a Code CLI
https://github.com/trendyol/es-alert-cli
Last synced: 7 months ago
JSON representation
ES Alert as a Code CLI
- Host: GitHub
- URL: https://github.com/trendyol/es-alert-cli
- Owner: Trendyol
- License: mit
- Created: 2023-10-20T11:56:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T11:23:57.000Z (11 months ago)
- Last Synced: 2025-05-12T08:38:33.553Z (8 months ago)
- Language: Go
- Size: 156 KB
- Stars: 3
- Watchers: 12
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# ES ALERT CLI
## Description
ES ALERT CLI is an open-source project that facilitates the management of Elasticsearch monitoring configurations. The tool provides a CLI interface to upsert alerts, ensuring synchronization of your monitoring YAML with a remote Elasticsearch cluster.
## Getting Started
To use this tool, follow the steps below:
1. Install the binary by running:
```bash
curl -sL "https://github.com/Trendyol/es-alert-cli/releases/download/0.5.0/es-alert-cli"
```
2. Run the tool with the `-c` and `-n` flags, providing your cluster IP and monitoring file name:
```bash
./es-alert-cli upsert -c -n
```
#### NOTE
If you have problems with permissions on your computer, you may need to give a permission such as `chmod +x` to the binary file. You can find something similar in the example directory.
## Command-Line Options
- `-c, --cluster`: Specify the cluster IP to update.
- `-n, --filename`: Specify the monitoring file name.
## Features
- Upsert command: Updates your monitoring YAML to the remote if any changes exist.
- Synchronization of local and remote monitors.
- Creation and update of monitors based on changes.
## Usage
```bash
./es-alert-cli upsert -c -n
```
## Code of Conduct
[Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
## Libraries Used For This Project
- [github.com/deckarep/golang-set](https://github.com/deckarep/golang-set)
- [github.com/sergi/go-diff/diffmatchpatch](https://github.com/sergi/go-diff/diffmatchpatch)
## Contribution
Contributions are welcome! Feel free to open issues, submit pull requests, or provide feedback.
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgments
- Thanks to [Trendyol](https://github.com/Trendyol) for inspiration and collaboration.