ASP.NET Core gRPC 健康檢查的實現方式


一. 前言

gRPC 服務實現健康檢查有兩種方式,前面在此文 ASP.NET Core gRPC 使用 Consul 服務注冊發現 中有提到過,這里歸納整理一下。gRPC 的健康檢查,官方是定義了標准的規則也就是 proto 的,所以這兩種方式都大同小異。

二. 方法一

自己手動添加 proto 文件,然后自己實現健康檢查服務。

新建一個 proto 文件,命名為 HealthCheck.proto

syntax = "proto3";

package grpc.health.v1;

message HealthCheckRequest {
	string service = 1;
}

message HealthCheckResponse {
	enum ServingStatus {
		UNKNOWN = 0;
		SERVING = 1;
		NOT_SERVING = 2;
	}
	ServingStatus status = 1;
}

service Health {
	rpc Check(HealthCheckRequest) returns (HealthCheckResponse);

	rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse);
}

這里面的內容不得更改,是官方標准,資料見后文

這里編譯一下項目,以便自動生成代碼。

然后,添加一個服務的實現類 HealthCheckService

public class HealthCheckService:Health.HealthBase
{
    public override Task<HealthCheckResponse> Check(HealthCheckRequest request, ServerCallContext context)
    {
        //TODO:檢查邏輯
        return Task.FromResult(new HealthCheckResponse(){Status = HealthCheckResponse.Types.ServingStatus.Serving});
    }

    public override async Task Watch(HealthCheckRequest request, IServerStreamWriter<HealthCheckResponse> responseStream, ServerCallContext context)
    {
        //TODO:檢查邏輯
        await responseStream.WriteAsync(new HealthCheckResponse()
            {Status = HealthCheckResponse.Types.ServingStatus.Serving});
    }
}

示例代碼直接返回了檢查結果,實際使用中應該在這里編寫檢查邏輯,然后根據情況返回相應的檢查結果。檢查結果有3種情況:

結果類型 說明
Unknown 未知狀態
Serving 正常
NotServing 異常,不能提供服務

最后別忘了注冊服務:

image-20191127151059008

健康檢查服務訪問日志

image-20191127151727397

三. 方法二

不用手動創建 proto 文件,直接安裝官方的現成組件,這里面包含了通過上面的標准 proto 文件生成的類。所以重寫實現類就行了。

通過 Nuget 安裝 Grpc.HealthCheck

image-20191128130433269

然后添加一個實現類 HealthCheckService 繼承 HealthServiceImpl 最后重寫方法,然后主要代碼都適合上面一致的:

public class HealthCheckService:HealthServiceImpl
{
    public override Task<HealthCheckResponse> Check(HealthCheckRequest request, ServerCallContext context)
    {
        //TODO:檢查邏輯
        return Task.FromResult(new HealthCheckResponse() { Status = HealthCheckResponse.Types.ServingStatus.Serving });
    }

    public override async Task Watch(HealthCheckRequest request, IServerStreamWriter<HealthCheckResponse> responseStream, ServerCallContext context)
    {
        //TODO:檢查邏輯
        await responseStream.WriteAsync(new HealthCheckResponse()
            { Status = HealthCheckResponse.Types.ServingStatus.Serving });
    }
}

后面操作步驟和方式一完全一樣,此處省略。

四. 參考資料


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM