什麼是 API 監控?可用性、回應時間與內容驗證

了解 API 監控要量測什麼、如何檢查須經身分驗證的 HTTP 回應,以及如何用指標、日誌與追蹤資料調查故障。

最佳實務
使用者操作路徑、網路與應用程式效能的主題插圖

庫存 API 回傳 200 OK,結帳還是可能卡住。假如回應的 stock 是 null,預期收到數字的結帳服務就無法判斷商品能不能買。要是 stock 是 0,結帳服務反而有足夠的資訊,可以正常顯示缺貨。

API 監控是確認端點能否依呼叫端的預期運作。 定期探測能在流量很少時照常送出請求。正式環境的指標、日誌與分散式追蹤則記錄實際進來的請求。拿測試品項查庫存一直正常,跟某個倉庫的查詢頻頻逾時,可以同時發生。

先決定怎樣的回應才算成功

假設用需要身分驗證的 GET /v1/inventory/SKU-42 查詢測試品項。除了 HTTP 200,還要檢查 stock 是不是非負整數。回應時間的門檻則依呼叫端實際能等多久來訂。

探測結果 可以判斷什麼
在目標時間內收到 HTTP 200 與 {"stock":0} 請求成功,品項缺貨
收到 HTTP 200 與 {"stock":null} 有收到回應,但內容不符合介面約定
已帶驗證資訊的探測收到 HTTP 401 檢查測試用認證資訊和身分驗證路徑
截止時間內沒收到回應 探測逾時,需比對網路路徑與服務端的資料

結帳服務只等庫存 API 兩秒,第三秒才送回的正確內容也來不及用了。分開記錄慢回應、逾時、狀態碼錯誤及內容驗證失敗,才看得出是哪一類問題增加。正式環境則可以按端點或操作查看請求量、錯誤率與 P95、P99 等長尾延遲。探測延遲只代表當次執行的路徑與輸入條件。 Google SRE 的四大黃金訊號(英文)

從接近呼叫端的網路探測

HTTP 探測屬於黑箱監控,從探測節點觀察端點的行為。對外合作夥伴使用的 API,可以選擇貼近對方的網路路徑。內部庫存服務則需要一個能解析網域名稱、也能連上目標的節點。經閘道的外部探測和直連服務的內部探測可能在不同地方失敗,兩者的結果值得分開看。 合成監控與探測位置

要監測第三方的付款或簡訊 API,先確認對方允許探測,並使用核准的測試端點或帳號。沙箱的回應只反映沙箱的情況。正式環境發生故障時,可以查應用程式對外呼叫的紀錄,區分身分驗證失敗、用量限制、網路逾時及供應商回傳的錯誤。只有單一節點失敗時,先從該節點看到的現象著手。

從需要身分驗證的讀取開始

用專供探測的認證資訊,權限縮到檢查所需的範圍。觀測雲的 HTTP 撥測(簡體中文)可以依 API 的要求設定標頭、HTTP 認證或用戶端憑證。要解析 JSON 並判斷 stock 等欄位,可使用 Pipeline 指令碼模式。若回應可能含有敏感資訊,可在隱私設定中選擇不儲存回應內容。告警通知應避免帶入認證資訊和完整回應。

不帶認證資訊、預期收到 401 Unauthorized,或使用不允許的方法、預期收到 405 Method Not Allowed,也可以各做成一項測試。這兩項各自確認請求被拒絕時的行為,應與認證成功的檢查分開。若服務要求短效權杖,應依核准的方式更新。若流程可從一個 HTTP 回應擷取值並傳給下一個請求,觀測雲的多步撥測(簡體中文)可用於串起這類流程。

必須測試寫入時,使用隔離的測試環境和專用資料。探測逾時後,服務端仍可能完成資料寫入或後續作業。應能在逾時之後找到並清除測試資料,且只在 API 的冪等性或去重規則足以保障的情況下重試。 HTTP 方法與狀態碼規範(英文)

對照探測失敗與正式環境請求

觀測雲設定頁上的連線測試不使用所選節點。設定排程後,先確認實際節點執行的結果,再設定異常偵測和恢復條件。通知裡保留端點、節點、時間和失敗條件,值班人員才能循線追查。等到連續失敗才通知可以減少短暫抖動造成的干擾,也會拉長偵測時間。

假設剛部署完就開始收到 stock: null,先看看同一時間的庫存 API 錯誤和延遲。觀測雲 APM(簡體中文)可以檢視已接入的服務所收集的追蹤和已關聯的日誌。如果探測送出的識別碼也有記在服務端,可用它查找同一個請求。沒有識別碼時,按端點、時間和環境縮小範圍。若請求在閘道就中斷,沒有到達已接入的服務,自然也不會出現在該服務的追蹤資料中。

探測成功率是依定義納入統計的探測中,有多少符合設定的條件。以使用者為準的服務水準目標(SLO)則可能採用正式環境符合統計條件的請求成功率。兩者分開追蹤,才不會在測試品項始終正常時,漏掉少數正式請求的問題。 可用性監控與量測口徑

取得專屬方案

聯絡我們

加入社群

微信扫码
加入官方交流群

立即體驗

在线开通,按量计费,真正的云服务!

立即開始

选择观测云版本

代码托管平台