golang consul-grpc 服務註冊與發現

在微服務架構裡面，每個小服務都是由很多節點組成，節點的新增刪除故障希望能對下游透明，因此有必要引入一種服務的自動註冊和發現機制，而 consul 提供了完整的解決方案，並且內建了對 GRPC 以及 HTTP 服務的支援

總體架構

• 服務呼叫: client 直連 server 呼叫服務
• 服務註冊: 服務端將服務的資訊註冊到 consul 裡
• 服務發現: 客戶端從 consul 裡發現服務資訊，主要是服務的地址
• 健康檢查: consul 檢查伺服器的健康狀態

服務註冊

服務端將服務資訊註冊到 consul 裡，這個註冊可以在服務啟動可以提供服務的時候完成

完整程式碼參考: https://github.com/hatlonely/hellogolang/blob/master/sample/addservice/internal/grpcsr/consul_register.go

config := api.DefaultConfig()
config.Address = r.Address
client, err := api.NewClient(config)
if err != nil {
    panic(err)
}
agent := client.Agent()

IP := localIP()
reg := &api.AgentServiceRegistration{
        ID:      fmt.Sprintf("%v-%v-%v", r.Service, IP, r.Port), // 服務節點的名稱
        Name:    fmt.Sprintf("grpc.health.v1.%v", r.Service),    // 服務名稱
        Tags:    r.Tag,                                          // tag，可以為空
        Port:    r.Port,                                         // 服務埠
        Address: IP,                                             // 服務 IP
        Check: &api.AgentServiceCheck{     // 健康檢查
            Interval: r.Interval.String(), // 健康檢查間隔
            // grpc 支援，執行健康檢查的地址，service 會傳到 Health.Check 函式中
            GRPC:     fmt.Sprintf("%v:%v/%v", IP, r.Port, r.Service), 
            DeregisterCriticalServiceAfter: r.DeregisterCriticalServiceAfter.String(), // 登出時間，相當於過期時間
        },
    }

if err := agent.ServiceRegister(reg); err != nil {
    panic(err)
}

服務發現

客戶端從 consul 裡發現服務資訊，主要是服務的地址

完整程式碼參考: https://github.com/hatlonely/hellogolang/blob/master/sample/addservice/internal/grpclb/consul_resolver.go

services, metainfo, err := w.client.Health().Service(w.service, "", true, &api.QueryOptions{
    WaitIndex: w.lastIndex, // 同步點，這個呼叫將一直阻塞，直到有新的更新
})
if err != nil {
    logrus.Warn("error retrieving instances from Consul: %v", err)
}
w.lastIndex = metainfo.LastIndex

addrs := map[string]struct{}{}
for _, service := range services {
    addrs[net.JoinHostPort(service.Service.Address, strconv.Itoa(service.Service.Port))] = struct{}{}
}

健康檢查

consul 檢查伺服器的健康狀態，consul 用 google.golang.org/grpc/health/grpc_health_v1.HealthServer 介面，實現了對 grpc健康檢查的支援，所以我們只需要實現先這個介面，consul 就能利用這個介面作健康檢查了

完整程式碼參考: https://github.com/hatlonely/hellogolang/blob/master/sample/addservice/cmd/server/main.go

// HealthImpl 健康檢查實現
type HealthImpl struct{}

// Check 實現健康檢查介面，這裡直接返回健康狀態，這裡也可以有更復雜的健康檢查策略，比如根據伺服器負載來返回
func (h *HealthImpl) Check(ctx context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error) {
    return &grpc_health_v1.HealthCheckResponse{
        Status: grpc_health_v1.HealthCheckResponse_SERVING,
    }, nil
}

grpc_health_v1.RegisterHealthServer(server, &HealthImpl{})

參考連結

• 完整工程程式碼: https://github.com/hatlonely/hellogolang/tree/master/sample/addservice
• consul 健康檢查 api: https://www.consul.io/api/agent/check.html
• consul 服務註冊 api: https://www.consul.io/api/agent/service.html
• grpc 健康檢查: https://github.com/grpc/grpc/blob/master/doc/health-checking.md

轉載請註明出處 本文連結：http://www.hatlonely.com/2018/06/23/golang-consul-grpc-%E6%9C%8D%E5%8A%A1%E6%B3%A8%E5%86%8C%E4%B8%8E%E5%8F%91%E7%8E%B0/