[Feature]: Add Service Monitoring Using Uptime Kuma

[wizaye]

---

Note

You can now preview the latest updates and improvements every 2–3 days at the following link:
👉 Helixque-Changes

Describe the feature you'd like
Add a self-hosted uptime and incident monitoring stack using Uptime Kuma to track the availability and latency of Helixque’s core services, publish a public status page, and send real-time alerts to the team’s Discord.​
Monitors should cover the web app, API, signaling service, realtime gateways, DNS, certificates, and network reachability using supported HTTP(S), TCP, Ping, DNS, keyword, and JSON-query checks at short intervals.​

Describe alternatives you've considered

• Upptime (GitHub Actions based): free, Git-only status site and incident automation with 5-minute checks and GitHub Pages status page.​
• Grafana + Prometheus Blackbox Exporter: flexible blackbox probing and dashboards, but requires Prometheus and Grafana management.​
• Better Stack (Better Uptime): hosted monitoring and status pages with incident workflows and rapid setup.​

Additional context
Uptime Kuma supports multiple monitor types, notification channels including Discord, and multiple status pages, making it well-suited for a self-hosted SRE-first setup.​
A Docker-based deployment exposes a web console for configuring checks, notifications, SSL monitoring, and public status pages with minimal operational overhead.

---

Prerequisite Checklist

• ⭐ Starred Helixque Repo
• ⭐ Starred Helixque Landing Repo
• 📘 Read and understood Contributing Guidelines
• 💬 Joined Discord Channel
• 🌐 Explored and signed up on helixque.netlify.app

---

✅ Issues will be assigned once all checklist prerequisites are verified.

Important

🛑 Contribution Guidelines — Please Read Before Proceeding

• Any PR raised for an unassigned issue (even if the issue number is mentioned in the PR) will not be merged and will be closed automatically.
• If your issue is valid but not yet assigned, please ping the Project Maintainers in the Discord Channel to get it assigned before starting work or submitting a PR.
• Only Code Owners or Project Maintainers have the authority to verify, approve, and assign issues.
• Do not self-assign issues — any self-assigned issue will be reviewed, and the final decision will rest with the Code Owners.

Thank you for helping shape HelixQue’s future this Hacktoberfest 🙌

Note

You can now preview the latest updates and improvements every 2–3 days at the following link:
👉 Helixque-Changes

[enabasal]

hey @wizaye

can you assign me i'd love to work on this issue!

[wizaye]

@enabasal sure, did you complete the steps mentioned in contributing guidelines?

[enabasal]

@wizaye yes,why?

[javatcoding1]

hi @enabasal
Thank you for your interest

Star our repos
https://github.com/HXQLabs/Helixque/
https://github.com/HXQLabs/helixque-landing/

Go through our contributing guidelines

Join our Discord channel for updates
https://discord.com/invite/dQUh6SY9Uk

Thank you for your patience and support! 🙌
we will assigne the issue after this steps

[MrGamePLAY1]

Hey @javatcoding1 id love to contribute here, I am awaiting discord join

[javatcoding1]

@MrGamePLAY1 could you please share your server name?

[MrGamePLAY1]

mr_gameplay

[MrGamePLAY1]

Thanks man!

[wizaye]

@wizaye yes,why?

@javatcoding1 check and assign to @enabasal

[MrGamePLAY1]

Added PR for review

[durdana3105]

Hi @javatcoding1 and team! 👋

I'm excited to contribute to this feature and implement a self-hosted uptime and incident monitoring stack using Uptime Kuma for Helixque. I'd like to be assigned to this issue to get started!

🎯 Features I'll Implement:

Uptime Kuma Deployment

Set up Docker-based Uptime Kuma deployment with persistent storage

Configure initial Kuma admin credentials and secure setup

Implement health checks and auto-recovery mechanisms

Document deployment process and configuration steps

Comprehensive Monitoring Coverage
I'll create monitors for all critical Helixque services:

Web Application: HTTP(S) endpoint checks with keyword validation

API Service: REST API endpoint checks with JSON-query response validation

Signaling Service: TCP/WebSocket connectivity checks

Realtime Gateways: Latency and availability monitoring

DNS Resolution: DNS query checks for domain resolution

SSL Certificates: Certificate expiration monitoring and alerts

Network Reachability: PING checks for network connectivity

Monitor Configuration

Set short interval checks (30-60 seconds) for rapid detection

Multiple check methods:

HTTP(S) checks with status code validation

TCP port connectivity checks

Ping/ICMP checks for network health

DNS resolution checks

Keyword checks for response content validation

JSON-query checks for API response verification

Custom timeout and retry configurations

Discord Integration & Real-Time Alerts

Configure Uptime Kuma Discord webhook notifications

Set up alert channels for:

Service outages (immediate notifications)

Recovery notifications

Certificate expiration warnings (7 days prior)

Degraded performance alerts

Custom notification templates with service details and status links

Public Status Page

Create a public-facing status page accessible via subdomain

Display real-time status of all monitored services

Show uptime percentages and incident history

Implement status page customization (theme, logo, branding)

Display maintenance windows and scheduled downtime

Documentation & Deployment Guide

Docker Compose configuration for easy deployment

Setup guide for Uptime Kuma installation

Monitor configuration templates and examples

Discord webhook setup instructions

Troubleshooting and maintenance guide

📋 Implementation Plan:

Phase 1: Setup & Deployment

Create Docker Compose configuration for Uptime Kuma

Document installation and initial setup process

Set up persistence and backup mechanisms

Phase 2: Monitor Configuration

Create all service monitors with appropriate check types

Configure alert thresholds and retry policies

Test each monitor with manual triggering

Phase 3: Notification System

Integrate Discord webhook notifications

Configure notification channels and alert escalation

Create alert templates with useful context

Phase 4: Public Status Page

Configure and customize the public status page

Set up status page branding and customization

Ensure proper access controls

Phase 5: Documentation & Testing

Write comprehensive deployment documentation

Create runbooks for common scenarios

Document monitor configuration and maintenance

🔧 Technical Details:

Expected Deliverables:

docker-compose.yml - Uptime Kuma deployment configuration

uptime-kuma-setup.md - Complete setup and configuration guide

monitor-config.json - Monitor configurations and templates

discord-webhook-setup.md - Discord integration guide

status-page-config.md - Status page customization guide

Tech Stack:

Uptime Kuma (self-hosted)

Docker & Docker Compose

Discord Webhooks

Standard HTTP(S), TCP, DNS, and Ping protocols

✅ Prerequisites Completed:

Starred Helixque Repo

Starred Helixque Landing Repo

Read Contributing Guidelines

Joined Discord Channel

Explored helixque.netlify.app

📅 Timeline:
I'm ready to start immediately and aim to complete this within 5-7 days with regular progress updates in the Discord channel.

Could you please assign this issue to me? I'm committed to delivering a production-ready monitoring solution that will help keep Helixque's services running smoothly! 🚀

Looking forward to your response!

P.S. I'll follow all contribution guidelines and ensure the PR is submitted only after assignment. I'm also available in the Discord channel for any clarifications or discussions.