通過API管理,可以快速對所屬服務項目的API進行限流和告警設置。本文為您介紹如何對API進行限流和告警配置。
權限說明
超級管理員、項目管理員、運維人員支持配置API的限流和告警。
限流設置
在Dataphin首頁的頂部菜單欄,選擇服務 > 運維。
單擊左側導航欄的API運維,在API運維頁面,單擊目標API操作列下的限流。
在API限流配置對話框中,配置參數。
參數
描述
限流狀態
選擇限流狀態。
單位時間
選擇限流的單位,系統提供的單位時間包括:sec、min、hour、day。
API流量限制
填寫API限流的數據。例如,企業所購買的總流量為每秒查詢率是500,如果單位時間選擇sec,則API流量限制填寫的數據應該小于等于500。
App流量限制
填寫API的下游App的流量控制。填寫APP流量限制的規則:
APP流量限制對API下的所有App生效。
APP流量限制必須小于等于API流量限制。
API流量限制的優先級大于APP流量限制。例如,API流量限制為每秒查詢率是1000,App1的流量限制為每秒查詢率是500,App2的流量限制為每秒查詢率是500,App3的流量限制為每秒查詢率是500,各App流量限制的總和大于API的流量限制,但流量限制的上限為API流量限制。
當APP流量限制大于API流量限制時,系統會給出報錯信息。
添加App
單擊添加APP,配置應用、限流次數。填寫限流次數的規則:
特殊App的限流次數必須小于等于API流量限制。
特殊App的限流次數大于API流量限制時,系統會給出報錯信息。
單擊確定,完成API限流的配置。
如果一個時間窗口內的請求達到限制速率,則系統通過排隊、等待或降級等方式,來保護系統。
告警設置
在API運維頁面,單擊目標API操作列下的告警。
在API告警頁面,配置API告警信息。
參數
描述
監控指標
選擇告警規則的API監控指標。監控指標包括:
調用次數:單位時間內,調用API的總次數。
錯誤率:單位時間內,API調用錯誤總次數/API調用總次數。
平均響應時長:單位時間內,API調用總時長/API調用總次數。
單位時間
選擇API調用的單位時間。單位時間包括1min 、5min、10min、30min、60min。
操作符
選擇監控指標與觸發閾值的比較的操作符。操作符包括=,>=,<=, <,>, !=。
觸發閾值
填寫告警規則的觸發閾值。
通知方式
選擇告警信息通知的方式。
通知人
選擇告警信息的接收人。
靜默期
在短時間內多次告警,可以設置一個靜默期,在發送告警信息后的靜默期期間,系統不再重復發送相同API告警規則的信息。
單擊確定,完成API的告警配置。
應用調用API運行過程中,如果觸發了監控告警規則,系統會給您發送告警消息,便于您及時發現并處理異常。