Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💡 Real-Time Status Dashboard for GovTool Services #1826

Closed
6 tasks
spannercode opened this issue Aug 26, 2024 · 0 comments
Closed
6 tasks

💡 Real-Time Status Dashboard for GovTool Services #1826

spannercode opened this issue Aug 26, 2024 · 0 comments

Comments

@spannercode
Copy link
Contributor

spannercode commented Aug 26, 2024

Area

Other

Is there new design needed?

No

What?

Implement a real-time status dashboard that displays the operational status of all GovTool services. The dashboard should be accessible via a dedicated URL (status.< govtool-url >) and should provide users with clear and up-to-date information on the status of each service, including whether they are operational, experiencing issues, or currently down.

Why?

Currently, users of the GovTool have no way to find the status of services or infrastructure. When a service is down or experiencing issues, it can negatively impact their ability to perform tasks. A real-time status dashboard would provide users with a quick and easy way to check the status of these services, reducing uncertainty and enabling them to make informed decisions. This increased transparency builds trust and helps users manage their activities more effectively during outages or service disruptions.

How?

1. Develop a Status Page Interface: Create a dedicated web page at status. that displays the status of all GovTool services. The interface should be user-friendly, with visual indicators (e.g., green for operational, yellow for issues, red for down) that clearly show the status of each service.

2. Integrate Real-Time Monitoring: Implement real-time monitoring for all GovTool services. This monitoring should automatically update the status dashboard as changes occur, ensuring that users always see the most current information.

3. Add Status Details and History: Provide users with the option to view additional details about any ongoing issues, including estimated resolution times if available. Also, include a history section that shows past incidents for each service, allowing users to review previous outages and their resolutions.

4. Implement Notifications (optional): Consider adding a feature that allows users to subscribe to notifications (e.g., email, slack, SMS) for real-time alerts when the status of a service changes, helping them stay informed without needing to check the dashboard constantly.

5. Security and Performance Considerations: Ensure that the status page is secure, with access controls if necessary, and that it performs well even during large-scale outages when user traffic may be higher than usual.


Implementation
There are several open and closed sourced tools that can be used for this purpose. Here are a couple that I'm familiar with:

  1. Status Page (https://www.atlassian.com/software/statuspage)
  2. Uptime Kuma (https://github.com/louislam/uptime-kuma)

(Optional) User Story with acceptance criteria

View the Latest Status of GovTool Services

As a general ecosystem user,
I want to access the status page at status.,
So that I can view the most up-to-date status information for all the GovTool services.

Acceptance Criteria:

  • The status page is accessible via the URL status..
  • Upon visiting the status page, the user can see the current operational status of all GovTool services.
  • The status information is displayed in an easy-to-understand format, indicating whether each service is operational, experiencing issues, or down.
  • The status page is updated in real-time or at regular intervals to reflect the most recent status of the services.
  • The page includes a timestamp showing when the status was last updated.
  • Users can access additional details or history for each service if they need more information.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants