PingGopher πΉπ‘
Modern, High-Performance Uptime & Synthetic Monitoring SaaS powered by gopher-queue

PingGopher is a standalone, full-stack Uptime & Synthetic Monitoring SaaS built with Go and powered by the distributed task engine gopher-queue. Engineered with a Modular Monolith ("Deploy Any Role") architecture, PingGopher can run as an all-in-one process or scale horizontally by deploying dedicated API, Worker, and Scheduler roles from a single binary.
πΈ Screenshots & Product Previews
1. Main Web Dashboard (/)

2. Probe Response Latency & Execution Logs Modal

3. Hosted Public Status Page (/status.html)

π Project Structure
ping-gopher/
βββ .github/workflows/ # Automated CI/CD build & test workflows
βββ .agents/ # Workspace rules & agent instructions
βββ assets/ # Repository preview screenshots & media assets
βββ bin/ # Pre-compiled cross-platform static binaries
βββ cmd/
β βββ pinggopher/ # Main server binary entrypoint & multi-role launcher
β βββ pinggopher-cli/ # Official CLI tool client (terminal control)
βββ internal/
β βββ api/ # REST API handlers, router & middleware
β βββ auth/ # Password security (Bcrypt) & JWT token engine
β βββ config/ # Environment variables & CLI flags parser
β βββ db/ # GORM database layer, models & migrations
β βββ notifier/ # Webhook & multi-channel alert pipeline
β βββ scheduler/ # Background monitor check promoter loop
β βββ worker/ # Synthetic probe execution engine (HTTP/SSL)
βββ web/ # Glassmorphic SPA frontend & Go static embedder
βββ Dockerfile # Multi-stage production container build
βββ docker-compose.yml # Multi-container orchestration (PingGopher + Redis)
βββ Makefile # Development build & execution shortcuts
βββ README.md # Master project documentation
ποΈ Architecture & System Design
PingGopher uses a Modular Monolith pattern with decoupling between domain packages (internal/db, internal/config, internal/api, internal/worker, internal/notifier).
+------------------------------------+
| REST API / Web Dashboard Client |
+------------------------------------+
|
v
+------------------------------------+
| pinggopher (--role=api) |
+------------------------------------+
|
v
+------------------------------------------------------------------+
| Database Layer (SQLite / PostgreSQL) |
| Users | Monitors | PingLogs | Incidents |
+------------------------------------------------------------------+
^
|
+---------------------------------+---------------------------------+
| |
v v
+------------------------------------+ +------------------------------------+
| pinggopher (--role=scheduler) | | pinggopher (--role=worker) |
| Enqueues Monitor Probes | | Executes Probes via |
| into gopher-queue | | gopher-queue Task Pools |
+------------------------------------+ +------------------------------------+
\ /
\ /
+-----------------------------------------------+
| gopher-queue Broker (Redis 7.0+) |
| Atomic Leasing, Retries, Watchdog, DLQ |
+-----------------------------------------------+
π Deploy Any Role Strategy
Run any node type using runtime CLI flags or environment variables:
pinggopher --role=all: All-in-one development node running API, Scheduler, and Worker.
pinggopher --role=api: Dedicated HTTP REST API & Web Dashboard node.
pinggopher --role=worker: Dedicated background probe execution worker.
pinggopher --role=scheduler: Dedicated monitor promoter loop enqueuing jobs to gopher-queue.
β¨ Key Features
- π External Synthetic Uptime Monitoring: Measures HTTP response codes, latency (ms), and SSL certificate expiration.
- β‘ Powered by
gopher-queue: Leverages server-side Redis Lua scripts, atomic leasing, watchdog supervisor failover, and exponential retries.
- π‘οΈ Anti-Alert Fatigue: Smart escalation logic using retry windows before dispatching alerts.
- π Multi-Tenant Data Models: Built-in GORM schema for Users, Monitors, Latency Logs, and Outage Incidents.
- π Zero-Dependency Local Storage: Runs out of the box with embedded CGO-free SQLite for local development and PostgreSQL support for production.
PingGopher includes an official command-line client for terminal-based tenant authentication, monitor CRUD management, public status checking, and probe latency inspection.
π₯ Installation via go install
go install github.com/SirZeck/ping-gopher/cmd/pinggopher-cli@latest
β‘ Terminal Usage Examples
# 1. Register a new tenant account and save session token
pinggopher-cli signup --url http://localhost:8080 --email newuser@pinggopher.io --password SecretPassword123!
# 2. Or authenticate an existing account
pinggopher-cli login --url http://localhost:8080 --email admin@pinggopher.io --password SecretPassword123!
# 2. View public system operational health status
pinggopher-cli status
# 3. List active monitor targets in formatted ASCII table
pinggopher-cli monitor list
# 4. Add a new target monitor directly from the terminal
pinggopher-cli monitor add --name "Production API" --url "https://api.example.com/health" --interval 30
# 5. Inspect probe latency response history logs
pinggopher-cli logs --id <MONITOR_ID> --limit 20
Read the full cmd/pinggopher-cli/README.md for detailed CLI documentation.
π Quickstart
1. Run via Docker Compose (Recommended)
Launch PingGopher and Redis broker with a single command:
docker compose up -d --build
Verify application status:
docker compose logs -f pinggopher
2. Build & Run Locally
Prerequisites
- Go 1.22+
- Redis 7.0+ running on
localhost:6379 (required for gopher-queue worker pool)
Build Binary
make build
# Produces bin/pinggopher.exe
Run All-in-One Node
make run-all
# Or run manually:
./bin/pinggopher.exe --role=all
βοΈ Configuration
Configurations can be set via command-line flags or environment variables:
| Flag |
Environment Variable |
Default |
Description |
--role |
ROLE |
all |
Service role (all, api, worker, scheduler) |
--port |
PORT |
8080 |
HTTP API server port |
--db |
DB_PATH |
pinggopher.db |
SQLite database file path or Postgres DSN |
--redis |
REDIS_ADDR |
localhost:6379 |
Redis broker address for gopher-queue |
--jwt-secret |
JWT_SECRET |
pinggopher-secret... |
Secret key for JWT token signing |
π€ Contributing
Contributions are welcome! Please check our Contributing Guide for setup steps and pull request guidelines.
π License
Distributed under the MIT License. See LICENSE for details.