How deerwalkrnd/status works
This project is the open‐source uptime monitor and status page powered by Upptime. In other words, it leverages GitHub’s ecosystem (Issues, Actions, Pages, and repository files) to continuously monitor the availability and response times of various services (for example, the various Deerwalk-related websites) and render their statuses on a public page.
Main Components
• GitHub Repository – Central repository where all config files, JSON data (in directories such as “api”, “graphs”, and “history”), and the status page source code (GitHub Pages) reside.
• GitHub Actions Workflows – These automation jobs (configured via YAML files in the .github/workflows directory) perform the actual uptime and response-time checks of the monitored endpoints.
• Monitored Service Endpoints – External websites and services (such as Deerwalk Classroom, Deerwalk Sifal School, etc.) whose status is being tracked.
• Data Storage – The “api” folder holds JSON files (with uptime and response-time data) and the “history” folder holds historic monitoring data. The “graphs” folder holds generated visualizations.
• Public Status Website – The GitHub Pages website that aggregates this information and displays it. This is essentially the front-end display of the system.
Relationships and Data Flow
• The GitHub Actions workflows periodically trigger the uptime monitoring tests for each target endpoint.
• Results (such as response time and uptime percentages) from each test are then written as JSON files into the “api” directory.
• These results are further processed (or visualized) and stored as images/graphs in the “graphs” directory.
• Historical data is maintained in the “history” directory.
• The data from these files is pulled into the static site (the status page) that is published via GitHub Pages. Visitors to the site see the updated status information with detailed metrics and visualizations.
• Incident reports are managed via GitHub Issues, which feed back into the system (and can be linked to Actions).
Architectural Patterns and Design Principles
• Serverless and Static Deployment – No dedicated backend server is required; all monitoring and display logic is implemented with GitHub Actions and static files.
• Event-Driven Workflows – Monitoring routines are scheduled and triggered by changes in repository state using GitHub Actions.
• Separation of Concerns – Monitoring (data collection), storage (JSON/history), visualization (graphs), and presentation (status page) are clearly separated into distinct directories and workflow steps.
• Extensibility – The use of modular monitoring scripts means that the system can be easily extended to monitor additional endpoints.
Relevant Technologies
• GitHub Actions – for running monitoring tasks automatically and reliably.
• GitHub Pages – for hosting the public status website.
• Upptime (an open-source project) – to tie all these components together.
• JSON and static assets – for storing monitoring data and generating graphs.
• Possibly additional libraries or tools (such as Node.js scripts) that process and generate the graphs/images.
Summary
Happy diagramming!