GSoC'25 idea: IHR status page

[romain-fontugne]

Things breaks easily, so we need a status page that tells us which service are running as usual and which one are not. This page could also provide a machine readable JSON object so that we can automate email alerts when something is not running as usual.

Steps:

• implement a status page for all API endpoints, websites (ihr, ihr-archive, iyp), and IYP database
• add a machine readable format of the page
• automatic email notification when something is down

[Chayan8837]

The status page idea is great for ensuring reliability and quick issue resolution.

Hi, I'm Chayan Das, currently in my 2nd year at IIIT Gwalior, and I'm excited to contribute to this project.

To solve the issue of creating a status page for monitoring various services, I propose building a centralized status dashboard using a simple web interface that can display real-time information about the status of all API endpoints, websites (IHR, IHR-Archive, IYP), and the IYP database.

Plan

1. API Endpoint Monitoring:

   • Set up periodic health checks for the APIs and websites to ensure they are up and running.

2. Machine-readable Format:

   • Provide the status in JSON format to enable automation (such as email notifications) for when a service goes down.

3. Automated Alerts:

   • Integrate with services like NodeMailer or similar tools to send email alerts if any service fails or deviates from normal operations.

This approach will help in the quick identification of issues and automate the response process, ensuring smoother and more efficient management of services.

[Aryash2003]

To implement status page I would be using HTTPS request using python request library to process the running services on the website and write a python script generate the response email when there is a service failure and export JSON file for the same.
For API endpoints I will be using method GET and find all services running status and export them on the page which will get dynamically updated.
For frontend I will be integrating JavaScript to fetch JSON endpoints data and show them.
I think this would be a great project to contribute in.

[dpgiakatos]

@romain-fontugne are we considering using an open-source tool for this, such as Upptime (https://upptime.js.org/), or do we want to re-implement it? Since there are already existing open-source tools available, it might be more efficient to use one of them and modify it, rather than reinventing the wheel.

[itz-rajshekhar18]

@romain-fontugne This is my pathway for the problem statement (Idea)
Project Details
Goal
Develop a system to monitor and display the status of:

APIs: IHR, IHR-Archive, and IYP
Websites: IHR, IHR-Archive, and IYP
Database: IYP database
This includes:

Real-time health checks.
JSON output for automation.
Automatic email notifications during downtimes.
Plan

1. API and Website Monitoring

Perform periodic health checks by:
Sending HTTP requests to API endpoints and websites.
Checking response status codes (e.g., 200 OK vs errors like 500 or 404).
Measuring response time to detect latency issues.
For the database, periodically execute a test query to ensure connectivity.
2. Machine-Readable Format

Create a JSON endpoint (/status.json) that provides real-time status in a structured format

3. Automated Alerts

Set up an email notification system:
Use libraries like NodeMailer (Node.js) or smtplib (Python) to send alerts.
Trigger alerts when:
A service goes down.
Latency exceeds a predefined threshold (e.g., >500ms).

Here’s how you can refine your proposal into a detailed and professional format:

Proposal for GSoC: Centralized Status Dashboard
Introduction
Hi, I'm Chayan Das, a 2nd-year undergraduate student at IIIT Gwalior, and I’m thrilled to contribute to this project. To address the need for real-time service monitoring, I propose developing a Centralized Status Dashboard to ensure the reliability and quick resolution of issues in critical services like APIs, websites, and databases.

The dashboard will provide a user-friendly interface displaying service statuses, a machine-readable JSON format for automation, and automated alerts for instant notifications during outages.

Project Details
Goal
Develop a system to monitor and display the status of:

APIs: IHR, IHR-Archive, and IYP
Websites: IHR, IHR-Archive, and IYP
Database: IYP database
This includes:

Real-time health checks.
JSON output for automation.
Automatic email notifications during downtimes.
Plan

1. API and Website Monitoring

Perform periodic health checks by:
Sending HTTP requests to API endpoints and websites.
Checking response status codes (e.g., 200 OK vs errors like 500 or 404).
Measuring response time to detect latency issues.
For the database, periodically execute a test query to ensure connectivity.
2. Machine-Readable Format

Create a JSON endpoint (/status.json) that provides real-time status in a structured format:
json
Copy
Edit
{
"services": [
{
"name": "IHR API",
"type": "API",
"status": "Running",
"response_time": "150ms",
"last_checked": "2025-01-22T10:00:00Z"
},
{
"name": "IYP Database",
"type": "Database",
"status": "Down",
"error": "Connection Timeout",
"last_checked": "2025-01-22T10:00:00Z"
}
]
}
3. Automated Alerts

Set up an email notification system:
Use libraries like NodeMailer (Node.js) or smtplib (Python) to send alerts.
Trigger alerts when:
A service goes down.
Latency exceeds a predefined threshold (e.g., >500ms).

4. Frontend Dashboard

Build a simple web interface to display:
Service names.
Current status (Running/Down).
Last checked time.
Response time.
Use technologies like HTML/CSS, Bootstrap, or React for a clean UI.

5. Deployment and Maintenance

Deploy the system on platforms like Heroku, AWS, or Vercel.
Use a task scheduler (e.g., cron jobs or Celery) to automate periodic health checks.

Benefits
Transparency: Provides a single source of truth for service status.
Efficiency: Automates incident detection and notification.
Reliability: Helps reduce downtime by enabling quick identification and resolution of issues.