健康检查

健康检查

背景

Dubbo-go 内置了基于 triple 协议的健康检查服务,帮助用户管理和监测服务健康状态,可在此查看 完整示例源码

使用方法

  • 框架在通过 instance 启动后会自动向框架中注册健康检查服务 grpc.health.v1.Health,用于记录并对外暴露每个triple服务的健康状态。
  • 健康检查服务可以通过发起 http 请求检查框架中服务的状态,也可以通过客户端调用该健康检查服务,调用的接口为grpc.health.v1.Health,方法为 check

1、通过客户端调用健康检查服务

启动 dubbo-go-samples/healthcheck/go-server 中的服务,通过下方客户端即可查看 greet.GreetService 的状态。

  1. package main
  2. import (
  3. "context"
  4. "dubbo.apache.org/dubbo-go/v3/client"
  5. _ "dubbo.apache.org/dubbo-go/v3/imports"
  6. health "dubbo.apache.org/dubbo-go/v3/protocol/triple/health/triple_health"
  7. "github.com/dubbogo/gost/log/logger"
  8. )
  9. func main() {
  10. cli, err := client.NewClient(
  11. client.WithClientURL("tri://127.0.0.1:20000"),
  12. )
  13. if err != nil {
  14. panic(err)
  15. }
  16. svc, err := health.NewHealth(cli)
  17. if err != nil {
  18. panic(err)
  19. }
  20. check, err := svc.Check(context.Background(), &health.HealthCheckRequest{Service: "greet.GreetService"})
  21. if err != nil {
  22. logger.Error(err)
  23. } else {
  24. logger.Info("greet.GreetService's health", check.String())
  25. }
  26. watch, err := svc.Watch(context.Background(), &health.HealthCheckRequest{Service: "greet.GreetService"})
  27. if err != nil {
  28. logger.Error(err)
  29. } else {
  30. if watch.Recv() {
  31. logger.Info("greet.GreetService's health", watch.Msg().String())
  32. }
  33. }
  34. }

启动后会有以下输出

  1. [greet.GreetService's health status:SERVING]
  2. [greet.GreetService's health status:SERVING]

2.通过发起http请求检查服务健康状态

启动 dubbo-go-samples/healthcheck/go-server 中的服务,发起下方http请求即可查看 greet.GreetService 的状态:

  1. POST /grpc.health.v1.Health/Check
  2. Host: 127.0.0.1:20000
  3. Content-Type: application/json
  4. {"service":"greet.GreetService"}

将会有以下输出

  1. {
  2. "status": "SERVING"
  3. }

更多内容

值得注意的是,当前框架中尚未建立完整的服务状态管理机制,dubbo-go 框架会将所有加载的服务设置为 SERVING 状态,但尚没有 NOT SERVING 设置机制(在满足某个特定条件的情况下将服务状态设置为 NOT SERVING)。

如果有需要,用户可通过扩展 dubbo-go 框架的方式,提供完整的服务状态管理能力,这样就可以查询到实时更新的服务状态,并根据服务状态进行流量转发。

部分参考资料:

最后修改 September 13, 2024: Refactor website structure (#2860) (1a4b998f54b)