Skip to content

SpectraEYEHQ/SpectraMonitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 

Repository files navigation

πŸ‘οΈβ€πŸ—¨οΈ SpectraMonitor - Uptime & Incident Management

SpectraMonitor (SpectraEYE Lite) is a powerful SaaS platform for uptime monitoring, incident management, and public status pages. It enables technical teams to detect downtime instanty and communicate transparency with customers.


πŸ“‘ Table of Contents

  1. About the Project
  2. Key Features
  3. Roles & Permissions
  4. Technology Stack
  5. System Architecture
  6. Project Structure
  7. Installation & Setup
  8. License

πŸš€ About the Project

SpectraMonitor minimizes downtime impact through rapid detection and coordinated response. Designed for DevOps teams, MSPs, and SaaS providers, it offers:

  • Real-time detection of service failures.
  • Automated alerts via multi-channel notifications.
  • Public Status Pages to keep customers informed.
  • Operational efficiency with on-call schedules.

✨ Key Features

Service Monitoring

  • Diverse Checks: HTTP, Ping, DNS, TCP/UDP, Heartbeat, and Playwright browser scenarios.
  • SSL/TLS Monitoring: Automatic alerts for expiring certificates.
  • Configurable Frequency: Custom check intervals and timeout settings.

Status Pages

  • Public Access: Dedicated pages reachable via custom slugs.
  • Subscriptions: Customers can subscribe to specific components for email updates.
  • Maintenance: Scheduled maintenance windows displayed on the timeline.

On-Call & Escalations

  • Global Schedules: Timezone-aware rotations and shift overrides.
  • Escalation Policies: Define rules to escalate alerts (e.g., if User A doesn't ack in 5m, notify User B).
  • Multi-Channel: Email, SMS, and Voice Call integrations.

Super Admin Console

  • Tenant Management: Manage organizations, licenses, and trial expirations.
  • Impersonation: Securely impersonate organization admins for support.
  • Global Maintenance: Set application-wide maintenance modes.

πŸ‘₯ Roles & Permissions

SpectraMonitor is a multi-tenant system with Role-Based Access Control (RBAC):

  • User: Access to monitors, incidents, and status pages.
  • Admin: Manage organization users, settings, and billing.

πŸ›  Technology Stack

Frontend

Backend

  • Runtime: Node.js + Express
  • Database: MySQL 8.x (Multi-tenant)
  • Auth: JWT + Reform Tokens + MFA (TOTP)
  • Services: SendGrid (Email), Twilio (SMS/Voice)

πŸ— System Architecture

System Context

flowchart LR
  User[(Browser)] --> FE[Frontend React/Vite]
  FE -->|REST /api| BE[Backend Express]
  BE --> DB[(MySQL)]
  BE --> Worker[Monitor Worker]
  Worker --> Targets[Monitored Services]
  BE --> SG[SendGrid Email]
  BE --> TW[Twilio SMS/Voice]
  BE --> Public[Public Status Pages]
Loading

Monitoring Flow

The lifecycle of a monitoring check.

sequenceDiagram
  participant W as Worker
  participant DB as MySQL
  participant T as Target
  participant N as Notification Service

  W->>DB: Fetch Eligible Monitors
  W->>T: Execute Check (HTTP/Ping/DNS)
  T-->>W: Status + Latency
  W->>DB: Save Event Result
  alt DOWN / FAILED
    W->>N: Trigger Alert (Email/SMS)
  end
Loading

Escalation Blueprint

flowchart TD
  Incident[Incident DOWN] --> Policy[Escalation Policy]
  Policy --> Rule1[Rule #1: Primary On-Call]
  Rule1 --> Notify1[Email/SMS/Call]
  Policy --> Rule2[Rule #2: Supervisor]
  Rule2 --> Notify2[Voice Call]
  Policy --> Resolved[Incident Acknowledged/Resolved]
Loading

πŸ“‚ Project Structure

SpectraMonitor/
β”œβ”€β”€ src/                 # Frontend Application (UI, Pages, Hooks)
β”œβ”€β”€ backend/             # Backend API & Workers
β”‚   β”œβ”€β”€ routes/          # REST Endpoints
β”‚   β”œβ”€β”€ workers/         # Monitoring Logic
β”‚   └── services/        # Third-party integrations
β”œβ”€β”€ public/              # Static Assets
└── export_SpectraMonitor_db.sql # Database Schema

⚑ Installation & Setup

Requirements

  • Node.js 18+
  • MySQL 8.x

πŸ“„ License

Distributed under the Proprietary License. See LICENSE for more information.


**Built with ❀️ by the SpectraEYE Team**

About

πŸ‘οΈβ€πŸ—¨οΈ SpectraMonitor - Uptime & Incident Management

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors