分享一種接口的日誌格式

概述

咱們在項目的開發中會接觸到各類各樣的接口,有咱們給他方提供接口,也有咱們請求他方的接口。當咱們進行接口排錯時,接口的日誌顯的尤其重要,好比,請求了哪些接口?耗時多久?狀態碼是什麼?web

場景

好比咱們要開發一個接口,該接口有 3 個子流程,每一個子流程又分別請求了第三方的 HTTP 接口,而後再進行邏輯處理,返回結果,這時接口日誌你會怎麼記?微信

日誌參數

假如咱們須要記錄如下參數:編輯器

  • 請求信息 request
    • 請求地址 url
    • 請求體 body
    • 請求方法 method
    • 請求頭 header
    • 請求超時時間 ttl
  • 響應信息 response
    • 響應頭 header
    • 狀態碼 status_code
    • 狀態信息 status_msg
    • 響應體 body
  • 對話信息 dialogs
    • 請求信息 request
      • 請求地址 url
      • 請求體 body
      • 請求方法 method
      • 請求頭 header
      • 請求超時時間 ttl
    • 響應信息 response
      • 響應頭 header
      • 狀態碼 status_code
      • 狀態信息 status_msg
      • 響應體 body
    • 執行時間 cost_seconds
    • ps: 當請求多個接口時,上面的結構爲多組
  • 請求時間 req_time
  • 執行時間 cost_seconds

案例

咱們提供一個對外接口,/user/create,這裏面的邏輯是須要查詢 3 個 HTTP 接口才能完成,那麼日誌記錄應該是這樣的。url



本文分享自微信公衆號 - 新亮筆記(XinLiangTalk)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。spa

相關文章
相關標籤/搜索