Skip to content

Trendyol/es-alert-cli

Repository files navigation

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:

    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:

    ./es-alert-cli upsert -c <your_cluster_ip> -n <your_monitoring_file_name>

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

./es-alert-cli upsert -c <your_cluster_ip> -n <your_monitoring_file_name>

Code of Conduct

Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Libraries Used For This Project

Contribution

Contributions are welcome! Feel free to open issues, submit pull requests, or provide feedback.

License

This project is licensed under the MIT License.

Acknowledgments

  • Thanks to Trendyol for inspiration and collaboration.