network-check-tool 0.0.2

A network monitoring tool with ping tracking and dashboard visualization

Network Check Tool

A comprehensive network monitoring tool that performs periodic ping tests to monitor host availability and response times, with a web-based dashboard for visualization.

🚀 Quick Start

Installation from PyPI (Recommended)

Install the package directly from PyPI:

pip install network-check-tool

Installation from Source

If you want to contribute or modify the code:

# Clone the repository
git clone https://github.com/hardwork9047/network-check-tool.git
cd network-check-tool

# Install with Poetry (recommended for development)
poetry install

# Or install with pip
pip install -e .

First Steps

1. Initialize the database:

network-checker init

2. Test a single host:

network-checker ping google.com

3. Start the web dashboard:

network-checker run-server

Then open http://localhost:9991 in your browser.

📖 What is Network Check Tool?

Network Check Tool is a Python application designed for continuous network monitoring. It helps you:

• Monitor network connectivity to multiple hosts simultaneously
• Track response times and packet loss over time
• Visualize network performance through an interactive web dashboard
• Set up automated monitoring with customizable intervals
• Access historical data through CLI commands or REST API

Perfect for system administrators, DevOps engineers, and anyone who needs to monitor network reliability.

✨ Features

🎯 Core Functionality

• Periodic Ping Monitoring: Automated ping tests at configurable intervals
• SQLite Database: Persistent storage of ping results with timestamps
• Web Dashboard: Interactive visualization using Plotly charts
• CLI Interface: Comprehensive command-line tools for management
• RESTful API: JSON endpoints for data access and integration

📊 Dashboard Features

• Real-time response time charts
• Packet loss visualization
• Success rate statistics
• Multiple host monitoring
• Time range filtering (1 hour to 1 week)
• Auto-refresh every 30 seconds

⚡ Advanced Features

• Background scheduling with APScheduler
• Configurable ping timeouts and intervals
• Database indexing for performance
• Error handling and logging
• Development and production configurations

🛠️ Usage Examples

Basic Monitoring

# Monitor a single host
network-checker ping google.com --count 5

# Start continuous monitoring of multiple hosts
network-checker start-monitoring google.com cloudflare.com 8.8.8.8 --interval 30

# Check recent results
network-checker status --host google.com --limit 10

Web Dashboard

# Start the web server (default: http://localhost:9991)
network-checker run-server

# Run on different host/port
network-checker run-server --host 0.0.0.0 --port 8080

Data Management

# View all monitored hosts
network-checker status

# Clear all data (with confirmation)
network-checker clear

📋 CLI Commands Reference

Command	Description	Example
network-checker ping <host>	Send ping tests to a specific host	network-checker ping example.com --count 4
network-checker start-monitoring <hosts>	Start continuous monitoring	network-checker start-monitoring google.com --interval 60
network-checker run-server	Start the web dashboard server	network-checker run-server --port 9991
network-checker status	Display recent ping results	network-checker status --host google.com
network-checker init	Initialize the database	network-checker init
network-checker clear	Clear all ping data	network-checker clear

🌐 Web Dashboard

After starting the server with network-checker run-server, access the dashboard at http://localhost:9991.

Dashboard Features

• Host Selection: Choose from monitored hosts
• Time Range: View data from 1 hour to 1 week
• Statistics Cards: Total pings, success rate, average response time, packet loss rate
• Interactive Charts: Response time trends with packet loss indicators
• Auto-refresh: Updates every 30 seconds

🔌 API Endpoints

The tool provides a REST API for integration with other tools:

GET /api/hosts

Get list of monitored hosts

curl http://localhost:9991/api/hosts
# Returns: ["google.com", "cloudflare.com"]

GET /api/stats?host=<host>&hours=<hours>

Get statistics for a specific host

curl "http://localhost:9991/api/stats?host=google.com&hours=24"

GET /api/ping_data?host=<host>&hours=<hours>

Get raw ping data for visualization

curl "http://localhost:9991/api/ping_data?host=google.com&hours=1"

⚙️ Configuration

Environment Variables

Customize behavior with environment variables:

# Database configuration
DATABASE_URL=sqlite:///network_check_tool.db

# Ping settings
PING_TIMEOUT=4.0
DEFAULT_PING_INTERVAL=60

# Default hosts to monitor
DEFAULT_HOSTS=google.com,cloudflare.com

# Flask configuration
SECRET_KEY=your-secret-key

Configuration Profiles

The application supports different configuration profiles:

• Development: Debug mode enabled, SQL logging
• Production: Optimized for production deployment

🏗️ Project Structure

network_check_tool/
├── __init__.py              # Package initialization
├── app.py                   # Flask application factory
├── cli.py                   # Command-line interface
├── models/
│   ├── __init__.py
│   └── ping_result.py       # SQLAlchemy model
├── services/
│   ├── __init__.py
│   ├── ping_service.py      # Ping execution service
│   └── scheduler_service.py # Background scheduling
├── views/
│   ├── __init__.py
│   └── dashboard.py         # Web API endpoints
├── templates/
│   └── dashboard.html       # Web dashboard UI
└── config/
    ├── __init__.py
    └── config.py            # Application configuration

📊 Database Schema

ping_results table

• id: Primary key (INTEGER)
• target_host: Target hostname (VARCHAR(255), indexed)
• timestamp: Ping timestamp (DATETIME, indexed)
• response_time: Response time in milliseconds (FLOAT, nullable)
• packet_loss: Boolean indicating packet loss (BOOLEAN)
• error_message: Error details if ping failed (TEXT, nullable)

🔧 Development

Development Setup

# Clone the repository
git clone https://github.com/hardwork9047/network-check-tool.git
cd network-check-tool

# Install with Poetry (recommended)
poetry install

# Or create a virtual environment and install with pip
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .

Running Tests

poetry run pytest
# or
python -m pytest

Code Formatting

poetry run black network_check_tool/
# or
black network_check_tool/

Development Server

# Run with auto-reload for development
poetry run network-checker run-server --debug

🚀 Production Deployment

With Docker (Recommended)

# Dockerfile example
FROM python:3.10-slim
WORKDIR /app
COPY . .
RUN pip install network-check-tool
EXPOSE 9991
CMD ["network-checker", "run-server", "--host", "0.0.0.0", "--port", "9991"]

docker build -t network-check-tool .
docker run -p 9991:9991 network-check-tool

Manual Deployment

# Install the package
pip install network-check-tool

# Initialize database
network-checker init

# Run with a production WSGI server
pip install gunicorn
gunicorn -w 4 -b 0.0.0.0:9991 "network_check_tool.app:create_app('production')"

📦 Dependencies

Runtime Dependencies:

• flask - Web framework
• flask-sqlalchemy - Database ORM
• ping3 - Ping functionality
• apscheduler - Background scheduling
• plotly - Data visualization
• pandas - Data manipulation
• flask-cors - CORS support
• click - CLI framework
• toml - Configuration parsing

Development Dependencies:

• pytest - Testing framework
• black - Code formatting

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (pytest)
5. Format code (black .)
6. Commit your changes (git commit -m 'Add amazing feature')
7. Push to the branch (git push origin feature/amazing-feature)
8. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

🌟 Why Network Check Tool?

• Easy to Use: Simple CLI commands and intuitive web interface
• Lightweight: Minimal resource usage with SQLite database
• Flexible: Configurable monitoring intervals and multiple output formats
• Reliable: Robust error handling and comprehensive logging
• Open Source: MIT licensed and community-driven

---

Network Check Tool - Keep your network monitoring simple and effective! 🚀