Setting up Uptime Kuma monitoring
GlanceWatch provides HTTP endpoints that Uptime Kuma can monitor to track your system's health. When resource usage exceeds your configured thresholds, GlanceWatch returns an HTTP 503 status code, triggering alerts in Uptime Kuma.
GlanceWatch provides several monitoring endpoints. Use these URLs when adding monitors to Uptime Kuma:
http://localhost:8000/status
Monitors all system metrics (RAM, CPU, and Disk). Returns HTTP 503 if any threshold is exceeded.
http://localhost:8000/ram
Monitors RAM usage only. Returns HTTP 503 if RAM threshold is exceeded.
http://localhost:8000/cpu
Monitors CPU usage only. Returns HTTP 503 if CPU threshold is exceeded.
http://localhost:8000/disk
Monitors disk usage only. Returns HTTP 503 if disk threshold is exceeded.
http://localhost:8000/health
Basic health check. Always returns HTTP 200 when the service is running.
All endpoints return JSON responses. Example from /status:
{
"ok": false,
"ram": {
"ok": false,
"value": 85.2,
"threshold": 80
},
"cpu": {
"ok": true,
"value": 45.3,
"threshold": 80
},
"disk": {
"ok": true,
"threshold": 85,
"disks": [...]
},
"last_check": "2025-11-12T10:30:45.123456"
}Follow these steps to add GlanceWatch monitoring to Uptime Kuma:
Open Uptime Kuma in your browser:
http://localhost:3001Log in with your credentials.
Click the "Add New Monitor" button (usually a + icon in the top right).
Select "HTTP(s)" as the monitor type.
| Field | Value | Description |
|---|---|---|
| Friendly Name | System Resources | Display name for the monitor |
| URL | http://localhost:8000/status |
The GlanceWatch endpoint to monitor |
| Heartbeat Interval | 60 seconds | How often to check (recommended: 60s) |
| Retries | 2 | Number of retries before marking as down |
| HTTP Method | GET | Default HTTP method |
| Expected Status Code | 200-299 | Any 2xx status = healthy |
Scroll down to the "Notifications" section and select how you want to be alerted:
Click "Save" at the bottom of the form. Uptime Kuma will immediately start monitoring your endpoint.
Instead of monitoring all resources with /status, you can create separate monitors for each metric:
http://localhost:8000/ramhttp://localhost:8000/cpuhttp://localhost:8000/diskThis gives you more granular control and separate alerts for each resource type.
For production systems:
If GlanceWatch is running on a remote server, replace localhost with the server's IP address or hostname:
http://192.168.1.100:8000/status
http://monitoring.example.com:8000/statusps aux | grep glancewatchcurl http://localhost:8000/statusps aux | grep glances0.0.0.0 not 127.0.0.1For complete API documentation, visit:
| Status Code | Meaning | When It Occurs |
|---|---|---|
| 200 OK | All systems normal | All metrics below thresholds |
| 503 Service Unavailable | Threshold exceeded | One or more metrics above threshold |
| 500 Internal Server Error | Server error | Configuration or connection issues |
We welcome contributions from the community! GlanceWatch is open source and we'd love your help making it better.
Visit github.com/collinsKemboi/glanceswatch and click "Fork"
git checkout -b feature/your-feature-nameImplement your feature, fix, or documentation improvement. Follow the existing code style and patterns.
If you're adding functionality, include tests to verify it works correctly.
pytest tests/Push your changes and create a PR with a clear description of what you've changed and why.
# Clone your fork
git clone https://github.com/YOUR_USERNAME/glanceswatch.git
cd glanceswatch
# Install development dependencies
pip install -r requirements-dev.txt
# Run tests
pytest
# Run with auto-reload for development
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000Questions? Ideas? Connect with us:
GlanceWatch is open source software licensed under the MIT License. See the LICENSE file for details.
965+ downloads in the last month on PyPI
⭐ Give us a star on GitHub if you find GlanceWatch useful!
GlanceWatch v1.0.10 • Back to Dashboard
Made with ❤️ by the open source community