upptime/upptime
Upptime
Upptime is a monitoring system that uses GitHub Actions to check endpoint availability and track response times. It functions as an HTTP availability checker and a static status page generator, converting uptime data into a branded website hosted on GitHub Pages.
The project integrates a GitHub Issues incident manager to automatically create and close tracking tickets for service outages and recovery. It provides a JSON status badge provider to expose uptime percentages and response times for use in external visual badges.
The system covers website uptime monitoring and service performance tracking, including the generation of performance graphs and the scheduling of maintenance windows. It handles infrastructure alerting via chat notifications, email, and SMS, and supports custom status detection based on specific text strings. Status page management includes brand identity customization, custom domain integration, and the injection of external web assets.
Configuration is managed through a structured JSON file, and sensitive credentials can be handled via credential encryption.
Features
- Endpoint Health Monitoring - Performs periodic network requests to endpoints to verify online status and trigger outage notifications.
- Public Status Pages - Creates and publishes a branded static website that displays real-time service health and historical incident data to users.
- Status Pages - Generates a public website displaying real-time service availability, historical incident data, and performance graphs.
- Incident Management Automations - Automatically creates and closes GitHub issues to track service outages and recovery.
- Static Status Page Generators - Converts uptime data into a branded static website hosted on GitHub Pages for public status reporting.
- Incident Tracking - Automatically creates and closes GitHub issues to document service outages and recovery events.
- State Storage - Persists all monitoring data and system configurations directly within a Git repository to serve as the source of truth.
- Alerting Services - Immediately alerts external services when a monitored endpoint becomes unavailable.
- GitHub Actions - Uses GitHub Actions as the primary execution engine to perform periodic health checks and update the system state.
- JSON Workflow Specifications - Defines monitored endpoints and system settings using a structured JSON configuration file that drives workflow logic.
- Alerting and Incident Management - Automatically creates and closes tracking tickets and assigns owners when services experience downtime or recovery.
- Endpoint Configuration Management - Tracks the availability of specified URLs and manages associated status reports using a central JSON configuration file.
- HTTP Availability Checkers - Verifies website health using custom HTTP requests, headers, and expected status codes.
- Incident Management - Automates the creation and closure of incident reports to document outages and notify team members.
- GitHub Actions Uptime Monitors - A monitoring system that uses GitHub Actions to check endpoint availability and track response times.
- Service Uptime Monitors - Tracks the availability of web endpoints and services using HTTP and TCP checks to ensure they remain online.
- Response Time Tracking - Measures endpoint response times and records historical data for long-term performance analysis.
- Response Time Trend Analysis - Measures and visualizes endpoint response times over time to identify performance trends and stability issues.
- Webhook Notification Systems - Dispatches outage alerts to external communication platforms via programmable HTTP endpoints and API integrations.
- Static Site Hosting - Publishes the generated status website to a public branch to display real-time service health.
- GitHub Pages Deployments - Builds and publishes a dedicated status website to GitHub Pages based on monitoring configuration and history.
- Notification Routing Platforms - Routes outage alerts to multiple communication channels including chat, SMS, and email.
- SMS Notification Dispatch - Triggers immediate text message alerts through SMS gateways when services fail.
- Global Availability Monitoring - Executes availability checks from diverse geographical locations via Globalping to ensure global accessibility.
- Infrastructure Health Alerters - Sends immediate notifications via email, SMS, or chat platforms when monitored services fail or encounter errors.
- Content-Based Detection - Marks a site as down or degraded by checking for the presence or absence of specific text strings.
- Chat Integration Notifications - Delivers real-time outage alerts to messaging platforms via webhooks or bot APIs.
- Email Alert Notifications - Dispatches failure alerts to administrators via SMTP or hosted email services.
- Branding Customizations - Enables visual identity customization of the status page using custom logos, themes, and favicons.
- Status Badges - Provides a data endpoint for generating embeddable status badges that display real-time uptime and response time metrics.
- Uptime Badges - Exposes real-time uptime percentages and response times via JSON for use in external visual badges.
- Static Site Generators - Transforms monitoring data and configuration into a set of static HTML files for public status display.
- Self-Hosted Status Pages - Uptime monitor and status page powered by GitHub Actions.
