天天看點

API網關對全連路日志的支援

        api調用中經常需要對一些錯誤請求進行問題定位與排查,良好的日志記錄會大大提高我們排查問題的效率與準确性。

        api網關對全連路日志有着良好的支援,api提供者充分利用此功能後在問題排查中可以起到事半功倍的效果。

        api網關會為每個請求生成一個requestid,一般是uuid,并在日志中記錄這個請求是否被正常處理。

        api提供者需要在定義api入參時選擇系統參數carequestid,并映射射到後端期望的參數上,後端服務記錄此requestid到日志中即可,如果後端系統需要多個系統之間互相調用才能完成本次請求,那麼後端系統之間通信時也需要傳遞并記錄此requestid。

        當請求傳回給用戶端時,api網關會在response的header中添加requestid,key為:x-ca-request-id,當用戶端根據傳回的錯誤消息無法判斷錯誤請求的具體原因時,可以将requestid提供給api提供者排查錯誤詳細原因。

        因為從用戶端開始整個鍊路中都記錄了requestid,是以全連路日志分析就變得非常容易了!

API網關對全連路日志的支援

        至此api的全連路日志記錄搭建完畢。

繼續閱讀