English | Español | Mandarin

ADC Checker Tool

This ADC Checker tool monitors Application Delivery Controller (ADC) endpoints, ensuring they are reachable, performing latency checks, validating SSL/TLS certificates, and checking the health of load-balanced services. It alerts the user via email if any issues are detected.

Features

Availability Monitoring: Checks if the ADC endpoint is accessible.
Latency Check: Measures response time.
Health Endpoint Check: Ensures load-balanced services are responsive.
SSL/TLS Validation: Verifies SSL certificate status.
Alerting: Sends alerts if any issues are detected.

Prerequisites

Python 3.8 or higher
Pip for package management
A working internet connection

Installation

Step 1: Clone the Repository

In your terminal or command prompt, navigate to the desired directory and run:

git clone https://github.com/osiristape/ADC-Checker-tool.git
cd ADC-Checker-tool

Step 2: Install Dependencies

Install required Python packages with:

pip install -r requirements.txt

Configuration

Edit config.py to add your ADC endpoints and configure alert settings:

ADC_ENDPOINTS: List of ADC endpoints to monitor.
ALERT_THRESHOLD: Threshold for latency in milliseconds.
ALERT_EMAIL: Email address where alerts will be sent.
SMTP_SERVER: SMTP server for email alerts.
SMTP_PORT: SMTP server port.
SMTP_USER and SMTP_PASSWORD: SMTP server login credentials.

Example config.py:

ADC_ENDPOINTS = [
    'https://example-adc1.com',
    'https://example-adc2.com'
]

ALERT_THRESHOLD = {
    'latency': 300
}

ALERT_EMAIL = "alert@example.com"
SMTP_SERVER = "smtp.example.com"
SMTP_PORT = 587
SMTP_USER = "user@example.com"
SMTP_PASSWORD = "password"

Usage

Run the ADC Checker

Open a terminal or command prompt in the ADC-Checker-tool directory.
Run the following command:

On Windows:
```
python adc_checker.py
```
On Linux:
```
python3 adc_checker.py
```
The tool will:
- Perform checks on each endpoint.
- Log results in logs/adc_checker.log.
- Send an email alert if any checks fail.

Scheduling (Optional)

To automate the checks, you can schedule the script to run periodically:

Windows

Open Task Scheduler.
Create a new task.
Set the "Program/script" to
```
python
```
Set the "Add arguments" field to:
```
adc_checker.py
```
Set the "Start in" field to the directory where adc_checker.py is located.

Linux

To run the script at a regular interval (e.g., every hour), you can use cron:

Open the cron table:

   crontab -e

Add an entry to run the script every hour:

   0 * * * * /usr/bin/python3/path/to/ADC-Checker-tool/adc_checker.py

Logging

Logs are saved in logs/adc_checker.log. Review this file for detailed information about each check and any errors.

Troubleshooting

Email Alerts Not Sending: Ensure SMTP settings are correct in config.py.
SSL/TLS Certificate Errors: Ensure the endpoints use HTTPS.
Missing Dependencies: Run pip install -r requirements.txt to reinstall dependencies.

License

This project is licensed under the MIT License.

This README covers installation, setup, configuration, usage, scheduling, and troubleshooting for both Windows and Linux environments. Let me know if you'd like additional customization!