如何在Go的gqlgen中配置Kubernetes存活、就绪及启动探针？

gqlgen本身没有开箱即用的K8s存活（liveness）、就绪（readiness）、启动（startup）探针配置——它的核心聚焦于GraphQL代码生成和请求处理，这类运维级别的健康检查不在核心功能范围内。不过你完全可以在不启动额外Web服务器的前提下，复用gqlgen已有的HTTP服务器来实现这些探针。

核心思路：复用现有HTTP服务器添加探针端点 #

gqlgen的GraphQL请求处理基于Go的net/http包实现，你只需在同一个HTTP服务器上注册额外路由，处理不同类型的探针请求，无需额外启动新服务。

具体实现步骤 #

1. 定义探针逻辑
   根据不同探针的职责编写对应检查逻辑：

   • 启动探针（startup）：验证应用是否完成初始化（如GraphQL Schema加载、数据库连接初始化、依赖服务就绪等），初始化完成后才返回200状态码。
   • 存活探针（liveness）：验证应用是否正常运行，逻辑尽量轻量（比如简单返回200，或检查基础进程状态），避免耗时操作导致误判。
   • 就绪探针（readiness）：验证应用能否处理用户请求，需检查关键依赖可用性（如数据库连接是否正常、缓存服务是否可达等）。

2. 在现有HTTP服务器上注册探针路由
   改用ServeMux管理路由，同时添加探针端点：

   mux := http.NewServeMux()
   
   // 挂载gqlgen的GraphQL handler
   srv := handler.NewDefaultServer(generated.NewExecutableSchema(generated.Config{Resolvers: &resolvers.Resolver{}}))
   mux.Handle("/graphql", srv)
   
   // 启动探针：检查应用初始化状态
   var appInitialized bool // 初始化完成后设为true
   mux.HandleFunc("/startupz", func(w http.ResponseWriter, r *http.Request) {
       if !appInitialized {
           w.WriteHeader(http.StatusServiceUnavailable)
           w.Write([]byte("INITIALIZING"))
           return
       }
       w.WriteHeader(http.StatusOK)
       w.Write([]byte("READY"))
   })
   
   // 存活探针：简单检查进程存活状态
   mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
       w.WriteHeader(http.StatusOK)
       w.Write([]byte("ALIVE"))
   })
   
   // 就绪探针：检查关键依赖（如数据库）可用性
   mux.HandleFunc("/readyz", func(w http.ResponseWriter, r *http.Request) {
       // 示例：检查数据库连接
       if err := db.Ping(); err != nil {
           w.WriteHeader(http.StatusServiceUnavailable)
           w.Write([]byte("UNREADY"))
           return
       }
       // 可添加其他依赖检查（如Redis、消息队列等）
       w.WriteHeader(http.StatusOK)
       w.Write([]byte("READY"))
   })
   
   // 启动HTTP服务器
   log.Fatal(http.ListenAndServe(":8080", mux))
   

3. Kubernetes配置示例
   在Deployment的Pod模板中配置对应探针：

   spec:
     containers:
     - name: your-gqlgen-app
       image: your-image:tag
       ports:
       - containerPort: 8080
       startupProbe:
         httpGet:
           path: /startupz
           port: 8080
         failureThreshold: 30  # 根据应用初始化时间调整，失败30次判定启动失败
         periodSeconds: 10     # 每10秒检查一次
       livenessProbe:
         httpGet:
           path: /healthz
           port: 8080
         initialDelaySeconds: 5  # 启动5秒后开始检查
         periodSeconds: 10       # 每10秒检查一次
       readinessProbe:
         httpGet:
           path: /readyz
           port: 8080
         initialDelaySeconds: 3  # 启动3秒后开始检查
         periodSeconds: 5        # 每5秒检查一次
   

注意事项 #

• 探针检查逻辑必须轻量，避免长时间阻塞导致K8s误判应用状态。
• 就绪探针要覆盖所有影响请求处理的关键依赖，确保返回200时应用确实能正常服务。
• 启动探针的failureThreshold和periodSeconds要根据应用实际初始化耗时调整，给足启动时间。

内容的提问来源于stack exchange，提问作者user4695271