https://github.com/hyperjumptech/monika-alert-simulator
APIs for Monika to trigger incidents and recovery alerts based on the user-provided thresholds
https://github.com/hyperjumptech/monika-alert-simulator
Last synced: 9 months ago
JSON representation
APIs for Monika to trigger incidents and recovery alerts based on the user-provided thresholds
- Host: GitHub
- URL: https://github.com/hyperjumptech/monika-alert-simulator
- Owner: hyperjumptech
- License: mit
- Created: 2023-08-01T07:37:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T04:33:07.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T06:33:02.794Z (over 1 year ago)
- Language: TypeScript
- Size: 44.9 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Monika Alert Simulator
Monika Alert Simulator is a utility tool for Monika, developed to simulate incidents and recovery alerts based on the user-provided thresholds. The tool is designed to help you test and understand how Monika handle different alert scenarios, enhancing your ability to manage and resolve incidents.
Written in NodeJS, the Monika Alert Simulator offers a set of APIs that interact with Monika to trigger specific conditions.
## How to Use
1. **Clone the Repository**
```bash
git clone https://github.com/hyperjumptech/monika-alert-simulator.git
```
2. Navigate to the Project Directory
```bash
cd monika-alert-simulator
```
3. Install Dependencies
```bash
npm install
```
4. Run the Simulator
```bash
npm start
```
5. Open http://localhost:8000
## API Documentations
After you run the simulator, you can access the Swagger API Documentations by visiting http://localhost:8000/docs
## Examples
To test how the API works, there are Monika configuration examples in the `examples` folder.
1. Testing the delayed response: `examples/monika-sample-1-delay.yml`
2. Testing the incorrect status code: `examples/monika-sample-1-status.yml`
3. Testing multiple probes: `examples/monika-sample-2.yml`
4. Testing the chaining request feature: `examples/monika-sample-3.yml`
5. Testing the incorrect response body: `examples/monika-sample-4-error.yml`
You can run the configurations above by running `monika -c