錯誤碼收集以及gRPC中的錯誤碼轉(zhuǎn)化

最近項(xiàng)目中為了將具體出錯信息向前端暴露出來叽唱,所以需要定義具體的錯誤碼格式煞茫,主要有如下幾個問題需要解決。

  1. 錯誤碼的定義地消。
  2. 因?yàn)殄e誤碼是分布在代碼的各個模塊中,因此最好使用自動化代碼生成工具將錯誤碼收集起來畏妖,類似與K8S中的根據(jù)相應(yīng)的tag來生成代碼脉执。
  3. 由于底層很多命令是通過gRPC調(diào)用來完成的,如何將錯誤碼和錯誤信息返回給客戶端也是需要解決的問題瓜客。默認(rèn)情況下client端返回給server端的錯誤碼是經(jīng)過封裝處理的适瓦。

錯誤碼的定義

  • 錯誤碼是按照各組件來劃分的,其格式為:AA-BB-CCCC

    • A: 項(xiàng)目或模塊名稱; 比如rbd, ceph, docker, disk等谱仪。
    • B: 具體子模塊玻熙;比如rbd中的volume,snapshot, volume migration等等疯攒。
    • C: 具體錯誤編號嗦随;自增且唯一表示具體某一種錯誤。
  • 注意以下規(guī)范:

    1. 錯誤碼的格式為16進(jìn)制大寫敬尺,例如1A-F3-001C
    2. AA-BB-CCCC中子模塊BB如果為01則表示common的部分枚尼。例如02-01-XXXX表示一些通用的rbd錯誤碼。
    3. 0000保留不使用砂吞,0001統(tǒng)一表示unspecified error署恍。每個子模塊有自己的0001編碼盯质,代表屬于這個子模塊的unspecified error概而。

錯誤碼

錯誤碼分散于各模塊中呼巷,錯誤碼定義在xxx_error.go文件中赎瑰,其中xxx代表對應(yīng)的模塊。其格式如下:

// ErrCodeRbd defines the id of rbd module
// +ErrCode
const ErrCodeRbd = 0x02
 
// the sub module of rbd
// +ErrCode=Rbd
const (
    ErrCodeRbdCommon = iota + 1
    ErrCodeRbdVolume
    ErrCodeRbdSnapshot
    ErrCodeRbdVolumeMigration
    ErrCodeRbdReplication
    ErrCodeRbdTrash
)
 
// list of rbd common error codes
// +ErrCode=Rbd,Common
const (
    ErrCodeRbdCommonUnspecifiedError = iota + 1
)
 
// ErrCodeRbdCommonToMessage is map of common error code to their messages
var ErrCodeRbdCommonToMessage = map[int]string{
    ErrCodeRbdCommonUnspecifiedError: "the %s operation failed due to unspecified error",
}
......

錯誤碼文件中的內(nèi)容大致如下:

  1. 首先定義的是模塊ID餐曼,其為常量類型鲜漩,命名時以ErrCode開頭宇整,后面跟著模塊名鳞青,例如Rbd为朋。命名格式為:ErrCodeAA习寸。 value部分為16進(jìn)制值霞溪。
  2. 接著是子模塊的定義鸯匹,01代表common殴蓬,然后根據(jù)各子模塊進(jìn)行擴(kuò)展即可染厅。命名格式為:ErrCodeAABB
  3. 接著是各子模塊對應(yīng)的具體錯誤ID肖粮。命名格式為:ErrCodeAABBCC
  4. 接著是錯誤ID對應(yīng)的message信息涩馆。命名格式為:ErrCodeAABBToMessage

錯誤碼中Tag的設(shè)置

由于錯誤碼分散在代碼的各個模塊中凌净,為了更好的收集所有的錯誤碼并生成對應(yīng)的json文件供前端使用冰寻,所以采用的是k8s方案中的gengo自動化代碼生成斩芭。代碼分支見microyahoo/gengo

Tag的定義

如上面的代碼片段所示划乖,tag緊挨著const定義琴庵,以+ErrCode開頭迷殿。
例如上面定義了三個tag

// +ErrCode  加在模塊的上面庆寺,代表這是具體的一個模塊懦尝。
// +ErrCode=Rbd 加在具體的子模塊上面陵霉,代表這是模塊下的子模塊信息撩匕,可能有多個止毕。
// +ErrCode=Rbd,Common 加在具體子模塊對應(yīng)的錯誤信息上面扁凛,代表子模塊有很多具體的錯誤信息

其中第二個tag以+ErrCode開頭谨朝,后面跟著具體的模塊字币,是以鍵值對的形式展示的洗出。第三個tag也是以+ErrCode開頭阱洪,后面跟著具體的模塊以及子模塊,其中模塊和子模塊之間以逗號分隔,中間沒有空格盔粹。

自動化生成的json文件如下:

{
    "01-01-0001": {
        "desc": "CommonUnspecifiedError"
    },
    "01-01-0002": {
        "desc": "CommonJSONUnmarshalError"
    },
    "01-01-0003": {
        "desc": "CommonJSONMarshalError"
    },
    "02-01-0001": {
        "desc": "RbdCommonUnspecifiedError"
    },
    "02-02-0001": {
        "desc": "RbdVolumeUnknownParameter"
    },
    "02-02-0002": {
        "desc": "RbdVolumeNoEntry"
    }
}

gRPC error處理

由于代碼中運(yùn)用了很多gRPC調(diào)用去其他節(jié)點(diǎn)執(zhí)行相應(yīng)的命令玻佩,而gRPC server會將我們執(zhí)行命令返回結(jié)果的錯誤信息封裝成statusError咬崔,這樣客戶端拿到的error是處理之后的垮斯,不是我們上述自定義的error,因此也就無法獲取定義的錯誤碼和其他自定義的錯誤信息熊杨。具體可以參見google.golang.org/grpc/status/status.go文件晶府。

 41 // statusError is an alias of a status proto.  It implements error and Status,
 42 // and a nil statusError should never be returned by this package.
 43 type statusError spb.Status
 44
 45 func (se *statusError) Error() string {
 46     p := (*spb.Status)(se)
 47     return fmt.Sprintf("rpc error: code = %s desc = %s", codes.Code(p.GetCode()), p.GetMessage())
 48 }
 49
 50 func (se *statusError) GRPCStatus() *Status {
 51     return &Status{s: (*spb.Status)(se)}
 52 }

此問題可以通過分別在server和client端添加自定義的一元攔截器進(jìn)行處理川陆。過程大致如下:

  1. client端發(fā)起gRPC調(diào)用较沪,server接收請求后執(zhí)行相應(yīng)的命令,如果執(zhí)行失敗將錯誤信息中的錯誤碼和錯誤信息進(jìn)行封裝成可序列化的控轿。error.proto文件定義如下所示解幽,這樣生成的error.pb.go中的Error實(shí)現(xiàn)了proto.Message接口躲株,可被序列化之后被client接收并解析。
  1 syntax = "proto3";
  2
  3 package pb;
  4
  5 message Error {
  6   string code = 1;
  7   string message = 2;
  8   string details = 3;
  9 }

server端一元攔截器如下所示:

// ServerErrorInterceptor transfer a error to status error
func ServerErrorInterceptor(ctx context.Context, req interface{},
    info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
    resp, err := handler(ctx, req)
    return resp, toStatusError(err)
}

func toStatusError(err error) error {
    if err == nil {
        return nil
    }
    cause := errors.Cause(err)
    pbErr := &pb.Error{
        Details: cause.Error(),
    }
    if coder, ok := cause.(errors.Coder); ok {
        pbErr.Code = coder.Code()
        pbErr.Message = coder.Message()
        pbErr.Details = coder.Details()
    }
    st := status.New(codes.Internal, cause.Error())
    st, e := st.WithDetails(pbErr)
    if e != nil {
        // make sure pbErr implements proto.Message interface
        return errors.NewCommonError(errors.ErrCodeCommonJSONMarshalError, e, pbErr.String())
    }
    return st.Err()
}

Server端的攔截器主要是將我們定義的帶錯誤碼的error轉(zhuǎn)化為可被序列化的rpc pb.Error,然后調(diào)用Status.WithDetails()進(jìn)行序列化磨德,這樣client端攔截器拿到序列化后的pb.Error典挑,返回我們一個實(shí)現(xiàn)了errors.Coder接口的error您觉。這樣client就能獲取定義的錯誤碼琳水,錯誤信息等等在孝。

  1. client一元攔截器收到server端返回的錯誤信息后進(jìn)行解析。
func ClientErrorInterceptor(ctx context.Context, method string, req, reply interface{},
    cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
    err := invoker(ctx, method, req, reply, cc, opts...)
    if err == nil {
        return nil
    }
    cause := errors.Cause(err)
    st, ok := status.FromError(cause)
    if ok {
        details := st.Details()
        if details != nil && len(details) > 0 {
            if pbErr, ok := details[0].(*pb.Error); ok {
                return newRPCClientError(pbErr.Code, pbErr.Message, pbErr.Details)
            }
        }
    }
    return err
}

一元攔截器在執(zhí)行完調(diào)用后對錯誤信息進(jìn)行處理顾彰,其中status.FromError從錯誤信息中獲取Status涨享,而Status.Details()方法會將錯誤信息反序列化成我們前面定義的pb.Error,這樣我們就能拿到定義的錯誤碼吁讨,錯誤信息建丧,以及details了翎朱。

References

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末争舞,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子流译,更是在濱河造成了極大的恐慌福澡,老刑警劉巖革砸,帶你破解...
    沈念sama閱讀 219,427評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異效拭,居然都是意外死亡缎患,警方通過查閱死者的電腦和手機(jī)挤渔,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,551評論 3 395
  • 文/潘曉璐 我一進(jìn)店門嫉父,熙熙樓的掌柜王于貴愁眉苦臉地迎上來绕辖,“玉大人仪际,你說我怎么就攤上這事∩婕耄” “怎么了伴栓?”我有些...
    開封第一講書人閱讀 165,747評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長饺窿。 經(jīng)常有香客問我肚医,道長,這世上最難降的妖魔是什么你稚? 我笑而不...
    開封第一講書人閱讀 58,939評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮乾闰,結(jié)果婚禮上涯肩,老公的妹妹穿的比我還像新娘病苗。我一直安慰自己硫朦,他們只是感情好咬展,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,955評論 6 392
  • 文/花漫 我一把揭開白布涮总。 她就那樣靜靜地躺著瀑梗,像睡著了一般。 火紅的嫁衣襯著肌膚如雪亿鲜。 梳的紋絲不亂的頭發(fā)上狡门,一...
    開封第一講書人閱讀 51,737評論 1 305
  • 那天,我揣著相機(jī)與錄音叛复,去河邊找鬼褐奥。 笑死撬码,一個胖子當(dāng)著我的面吹牛呜笑,可吹牛的內(nèi)容都是我干的叫胁。 我是一名探鬼主播微谓,決...
    沈念sama閱讀 40,448評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼姻氨!你這毒婦竟也來了哼绑?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,352評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎壳咕,沒想到半個月后谓厘,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,834評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,992評論 3 338
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了讨跟。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片止喷。...
    茶點(diǎn)故事閱讀 40,133評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡句喜,死狀恐怖咳胃,靈堂內(nèi)的尸體忽然破棺而出展懈,到底是詐尸還是另有隱情存崖,我是刑警寧澤来惧,帶...
    沈念sama閱讀 35,815評論 5 346
  • 正文 年R本政府宣布隅居,位于F島的核電站胎源,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏赞季。R本人自食惡果不足惜申钩,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,477評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望瘪阁。 院中可真熱鬧撒遣,春花似錦邮偎、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,022評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽廉涕。三九已至泻云,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間狐蜕,已是汗流浹背宠纯。 一陣腳步聲響...
    開封第一講書人閱讀 33,147評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留层释,地道東北人婆瓜。 一個月前我還...
    沈念sama閱讀 48,398評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像贡羔,于是被迫代替她去往敵國和親廉白。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,077評論 2 355

推薦閱讀更多精彩內(nèi)容

  • error code(錯誤代碼)=2000是無效的像素格式乖寒。error code(錯誤代碼)=2001是指定的驅(qū)動...
    Heikki_閱讀 1,800評論 0 4
  • (目前有點(diǎn)亂猴蹂,先貼上來,等以后有時間在整理吧宵统。這個問題一直想拿出來分享晕讲,還有兩個博客覆获,都是相關(guān)的马澈,一點(diǎn)點(diǎn)發(fā)出來) ...
    kamiSDY閱讀 4,380評論 0 2
  • 標(biāo)簽(空格分隔): google restful api design 當(dāng)前版本的API設(shè)計指南發(fā)布時間:2017...
    主君_05c4閱讀 3,926評論 0 5
  • 原文出處:gRPC gRPC分享 概述 gRPC 一開始由 google 開發(fā),是一款語言中立弄息、平臺中立痊班、開源的遠(yuǎn)...
    小波同學(xué)閱讀 7,223評論 0 18
  • 01 前前前同事李不悔,上個月跳槽了摹量。 李不悔新去的涤伐,是一家規(guī)模為原公司十倍的大型集團(tuán),他的月薪缨称,翻了三倍凝果,突破兩...
    隨性而活閱讀 156評論 0 0