mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-07-14 00:48:26 +08:00
Go: implement system healthz API (#15307)
## Summary - Add Go REST support for `GET /api/v1/system/healthz`. - Return Python-compatible `ok`/`nok` dependency fields for DB, Redis, document engine, and storage. - Return HTTP 200 only when all checks pass; otherwise return HTTP 500 with `_meta` failure details. - Add focused service coverage for the unhealthy dependency response when Go dependencies are not initialized. ## Scope This is a small, isolated slice of #15240. It avoids current open connector PRs (#15274, #15300, #15265, #15264), tenant/member PRs (#15295, #15301, #15276), MCP PRs (#15281, #15253, #15254, #15260, #15261, #15262), and the memory-message PR (#15256). Refs #15240
This commit is contained in:
@@ -55,6 +55,16 @@ func (h *SystemHandler) Health(c *gin.Context) {
|
||||
})
|
||||
}
|
||||
|
||||
// Healthz reports dependency health in the Python-compatible format.
|
||||
func (h *SystemHandler) Healthz(c *gin.Context) {
|
||||
result, allOK := h.systemService.Healthz(c.Request.Context())
|
||||
statusCode := http.StatusOK
|
||||
if !allOK {
|
||||
statusCode = http.StatusInternalServerError
|
||||
}
|
||||
c.JSON(statusCode, result)
|
||||
}
|
||||
|
||||
// GetConfig get system configuration
|
||||
// @Summary Get System Configuration
|
||||
// @Description Get system configuration including register enabled status
|
||||
|
||||
@@ -100,6 +100,7 @@ func (r *Router) Setup(engine *gin.Engine) {
|
||||
apiNoAuth.GET("/system/ping", r.systemHandler.Ping)
|
||||
apiNoAuth.GET("/system/config", r.systemHandler.GetConfig)
|
||||
apiNoAuth.GET("/system/version", r.systemHandler.GetVersion)
|
||||
apiNoAuth.GET("/system/healthz", r.systemHandler.Healthz)
|
||||
|
||||
// User login channels endpoint
|
||||
apiNoAuth.GET("/auth/login/channels", r.userHandler.GetLoginChannels)
|
||||
|
||||
@@ -17,8 +17,15 @@
|
||||
package service
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"ragflow/internal/cache"
|
||||
"ragflow/internal/dao"
|
||||
"ragflow/internal/engine"
|
||||
"ragflow/internal/server"
|
||||
"ragflow/internal/storage"
|
||||
"ragflow/internal/utility"
|
||||
"time"
|
||||
)
|
||||
|
||||
// SystemService system service
|
||||
@@ -53,6 +60,20 @@ type VersionResponse struct {
|
||||
Version string `json:"version"`
|
||||
}
|
||||
|
||||
type HealthzMeta struct {
|
||||
Elapsed string `json:"elapsed"`
|
||||
Error string `json:"error,omitempty"`
|
||||
}
|
||||
|
||||
type HealthzResponse struct {
|
||||
DB string `json:"db"`
|
||||
Redis string `json:"redis"`
|
||||
DocEngine string `json:"doc_engine"`
|
||||
Storage string `json:"storage"`
|
||||
Status string `json:"status"`
|
||||
Meta map[string]HealthzMeta `json:"_meta,omitempty"`
|
||||
}
|
||||
|
||||
// GetVersion get RAGFlow version
|
||||
func (s *SystemService) GetVersion() (*VersionResponse, error) {
|
||||
version := utility.GetRAGFlowVersion()
|
||||
@@ -60,3 +81,88 @@ func (s *SystemService) GetVersion() (*VersionResponse, error) {
|
||||
Version: version,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func okNok(ok bool) string {
|
||||
if ok {
|
||||
return "ok"
|
||||
}
|
||||
return "nok"
|
||||
}
|
||||
|
||||
func timedHealthCheck(check func() error) (bool, HealthzMeta) {
|
||||
start := time.Now()
|
||||
err := check()
|
||||
meta := HealthzMeta{
|
||||
Elapsed: fmt.Sprintf("%.1f", float64(time.Since(start).Microseconds())/1000.0),
|
||||
}
|
||||
if err != nil {
|
||||
meta.Error = err.Error()
|
||||
return false, meta
|
||||
}
|
||||
return true, meta
|
||||
}
|
||||
|
||||
// Healthz runs lightweight dependency checks for /api/v1/system/healthz.
|
||||
func (s *SystemService) Healthz(ctx context.Context) (*HealthzResponse, bool) {
|
||||
meta := map[string]HealthzMeta{}
|
||||
|
||||
dbOK, dbMeta := timedHealthCheck(func() error {
|
||||
if dao.DB == nil {
|
||||
return fmt.Errorf("database is not initialized")
|
||||
}
|
||||
sqlDB, err := dao.DB.DB()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return sqlDB.PingContext(ctx)
|
||||
})
|
||||
if !dbOK {
|
||||
meta["db"] = dbMeta
|
||||
}
|
||||
|
||||
redisOK, redisMeta := timedHealthCheck(func() error {
|
||||
redisClient := cache.Get()
|
||||
if redisClient == nil || !redisClient.Health() {
|
||||
return fmt.Errorf("redis is not healthy")
|
||||
}
|
||||
return nil
|
||||
})
|
||||
if !redisOK {
|
||||
meta["redis"] = redisMeta
|
||||
}
|
||||
|
||||
docOK, docMeta := timedHealthCheck(func() error {
|
||||
docEngine := engine.Get()
|
||||
if docEngine == nil {
|
||||
return fmt.Errorf("document engine is not initialized")
|
||||
}
|
||||
return docEngine.Ping(ctx)
|
||||
})
|
||||
if !docOK {
|
||||
meta["doc_engine"] = docMeta
|
||||
}
|
||||
|
||||
storageOK, storageMeta := timedHealthCheck(func() error {
|
||||
store := storage.GetStorageFactory().GetStorage()
|
||||
if store == nil || !store.Health() {
|
||||
return fmt.Errorf("storage is not healthy")
|
||||
}
|
||||
return nil
|
||||
})
|
||||
if !storageOK {
|
||||
meta["storage"] = storageMeta
|
||||
}
|
||||
|
||||
allOK := dbOK && redisOK && docOK && storageOK
|
||||
result := &HealthzResponse{
|
||||
DB: okNok(dbOK),
|
||||
Redis: okNok(redisOK),
|
||||
DocEngine: okNok(docOK),
|
||||
Storage: okNok(storageOK),
|
||||
Status: okNok(allOK),
|
||||
}
|
||||
if len(meta) > 0 {
|
||||
result.Meta = meta
|
||||
}
|
||||
return result, allOK
|
||||
}
|
||||
|
||||
19
internal/service/system_test.go
Normal file
19
internal/service/system_test.go
Normal file
@@ -0,0 +1,19 @@
|
||||
package service
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestSystemServiceHealthzReportsUnhealthyDependencies(t *testing.T) {
|
||||
result, allOK := NewSystemService().Healthz(t.Context())
|
||||
if allOK {
|
||||
t.Fatal("allOK=true, want false without initialized dependencies")
|
||||
}
|
||||
if result.Status != "nok" {
|
||||
t.Fatalf("status=%q, want nok", result.Status)
|
||||
}
|
||||
if result.DB != "nok" || result.Redis != "nok" || result.DocEngine != "nok" || result.Storage != "nok" {
|
||||
t.Fatalf("unexpected health result: %+v", result)
|
||||
}
|
||||
if len(result.Meta) == 0 {
|
||||
t.Fatal("expected failure metadata")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user