Add system diagnostics health endpoint and UI by RickyVishwakarma · Pull Request #892 · eigent-ai/eigent

RickyVishwakarma · 2026-01-16T17:11:35Z

What does this PR do?

Adds a system diagnostics feature to make it easier to check if the backend
is ready before running workflows.

Backend

Extends the existing /health endpoint to report:
- Database connectivity
- Model configuration
- Tool registry availability

Frontend

Adds a /diagnostics page to show system status
Protects the page behind authentication
Uses existing routing and layout

Why is this needed?

Right now there is no easy way to verify whether the system
is fully set up. This helps with:

Debugging setup issues
Onboarding new users
Understanding runtime state

How was this tested?

Checked /health endpoint response
Loaded diagnostics page when logged in
Verified redirect to login when logged out

RickyVishwakarma · 2026-01-18T08:46:52Z

Hi maintainers 👋
This PR is ready for review.
Could someone please approve the workflow and review the changes when convenient?
Thanks!

Wendong-Fan · 2026-01-18T13:32:28Z

thanks @RickyVishwakarma for the contribution!

Wendong-Fan

thanks for the contribution, left some comments below

Wendong-Fan · 2026-01-18T16:08:34Z

backend/app/controller/health_controller.py

+    # -------------------------------
+    db_status = "unknown"
+    try:
+        from app.database import engine  # adjust path ONLY if needed


seems in app no database

Wendong-Fan · 2026-01-18T16:09:21Z

backend/app/controller/health_controller.py

+    # -------------------------------
+    tools_available = False
+    try:
+        from app.tools.registry import TOOL_REGISTRY  # adjust path if needed


no TOOL_REGISTRY in our project

no TOOL_REGISTRY in our project

Thanks for pointing this out! You’re right — I assumed a tool registry that doesn’t exist in the current codebase. I’ll remove this check and keep the health endpoint aligned with existing project structures.

Wendong-Fan · 2026-01-18T16:10:09Z

backend/app/controller/health_controller.py

+    model_api_key = os.getenv("MODEL_API_KEY")
+    model_name = os.getenv("MODEL_NAME")


no MODEL_API_KEY, no MODEL_NAME

no MODEL_API_KEY, no MODEL_NAME

Got it, thanks for clarifying. I’ll remove the model environment variable checks and avoid making assumptions about model configuration in this endpoint.

Wendong-Fan · 2026-01-18T16:10:56Z

src/pages/Diagnostics.tsx

+  const [error, setError] = useState("");
+
+  useEffect(() => {
+    fetch("/health")


i think use /health would not be able to access to the right backend

i think use /health would not be able to access to the right backend

Thanks for the note — makes sense. I’ll update the frontend to use the existing backend access pattern instead of calling /health directly.

…ckyVishwakarma/eigent into feat/diagnostics-health-check

RickyVishwakarma · 2026-01-18T17:07:45Z

Thanks for the review! I’ve updated the diagnostics page to use the proper backend path and removed assumptions about model and tool fields so it aligns with the current health endpoint.

bytecii · 2026-01-19T21:57:23Z

backend/app/controller/health_controller.py

-    return response

+    # Database connectivity check
+    db_status = "unknown"


Can we make these status as string enum?

src/pages/Diagnostics.tsx

Wendong-Fan

Thanks for working on the diagnostics feature! The idea of surfacing system health info is great. I found a few issues that need to be addressed before this can be merged.

Wendong-Fan · 2026-01-30T20:22:38Z

backend/app/controller/health_controller.py

+    # Database connectivity check
+    db_status = "unknown"
+    try:
+        from app.database import engine  # existing project database engine


This import will always fail because there is no app.database module in backend/. The backend/ is the local agent backend and has no database.

The database engine lives in server/app/component/database.py (the self-deploy server). If the goal is to add a DB health check for self-deploy users, this should be added to server/app/controller/health_controller.py instead, with:

from app.component.database import engine

As it stands, this silently catches the ImportError and always reports db_status = "error", which is misleading.

Wendong-Fan · 2026-01-30T20:22:38Z

backend/app/controller/health_controller.py

+    db_status = "unknown"
+    try:
+        from app.database import engine  # existing project database engine
+        with engine.connect() as conn:


Minor note: engine.connect() is a synchronous call inside an async def handler, which would block the event loop. If this gets moved to server/, consider either making the handler a regular def (FastAPI will run it in a threadpool automatically) or using run_in_executor.

Wendong-Fan · 2026-01-30T20:22:38Z

src/pages/Diagnostics.tsx

+
+  useEffect(() => {
+    fetch("/api/health")
+      .then((res) => {


The project uses centralized API utilities (fetchGet / proxyFetchGet from @/api/http) for all backend calls. Using raw fetch("/api/health") here will:

Not resolve the correct backend URL (Electron uses a dynamic port via getBaseURL())

Not include auth headers

Not work in production

Should be something like:

import { fetchGet } from "@/api/http"; fetchGet("/health").then(setData).catch(...);

Wendong-Fan · 2026-01-30T20:22:38Z

src/pages/Diagnostics.tsx

@@ -0,0 +1,45 @@
+import { useEffect, useState } from "react";


Missing the Apache 2.0 license header that all source files in this project use. Please add the standard copyright block at the top.

RickyVishwakarma · 2026-03-22T10:24:57Z

Thanks for the review! I’ve addressed the comments and updated the backend and diagnostics page accordingly. Also resolved the merge conflicts.

RickyVishwakarma · 2026-03-22T16:50:21Z

Thanks for the detailed review! I’ve updated the health endpoint to align with the backend structure, removed the database-related logic, and switched the diagnostics page to use the existing API utilities. I also cleaned up the routing changes and resolved conflicts. Please let me know if anything else needs adjustment.

RickyVishwakarma and others added 4 commits January 16, 2026 22:32

Add system diagnostics health endpoint and UI

d7e2524

Merge branch 'main' into feat/diagnostics-health-check

d418a98

Merge branch 'main' into feat/diagnostics-health-check

d3722a9

Merge branch 'main' into feat/diagnostics-health-check

917dbd7

Wendong-Fan requested review from Wendong-Fan and nitpicker55555 January 18, 2026 13:32

Merge branch 'main' into feat/diagnostics-health-check

f2a8a35

Wendong-Fan reviewed Jan 18, 2026

View reviewed changes

RickyVishwakarma added 2 commits January 18, 2026 22:37

Fix diagnostics page to align with backend health response

89ed2a8

Merge branch 'feat/diagnostics-health-check' of https://github.com/Ri…

a7892a9

…ckyVishwakarma/eigent into feat/diagnostics-health-check

RickyVishwakarma added 2 commits January 19, 2026 09:58

Merge branch 'main' into feat/diagnostics-health-check

3dce37a

Merge branch 'main' into feat/diagnostics-health-check

12538f7

bytecii reviewed Jan 19, 2026

View reviewed changes

RickyVishwakarma and others added 2 commits January 21, 2026 21:23

Merge branch 'main' into feat/diagnostics-health-check

e5e91f3

Merge branch 'main' into feat/diagnostics-health-check

22fd45e

Wendong-Fan requested changes Jan 30, 2026

View reviewed changes

Wendong-Fan added the Waiting for Update label Jan 30, 2026

RickyVishwakarma added 3 commits March 22, 2026 15:50

Address review feedback: align health endpoint and diagnostics page

4bea985

Address review feedback: align health endpoint and diagnostics page

16ad08f

Resolve merge conflicts with upstream

4b98687

RickyVishwakarma requested review from Wendong-Fan and bytecii March 22, 2026 16:59

Merge branch 'main' into feat/diagnostics-health-check

a28af9b

		model_api_key = os.getenv("MODEL_API_KEY")
		model_name = os.getenv("MODEL_NAME")

		@@ -0,0 +1,45 @@
		import { useEffect, useState } from "react";

Conversation

RickyVishwakarma commented Jan 16, 2026

What does this PR do?

Backend

Frontend

Why is this needed?

How was this tested?

Uh oh!

RickyVishwakarma commented Jan 18, 2026

Uh oh!

Wendong-Fan commented Jan 18, 2026

Uh oh!

Wendong-Fan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RickyVishwakarma commented Jan 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Wendong-Fan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RickyVishwakarma commented Mar 22, 2026

Uh oh!

RickyVishwakarma commented Mar 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants