[ADP-45] API 監控

指導原則

• 所有受眾層級等於或高於 PARTNER_EXTERNAL 的 API 端點都應該(SHOULD)持續監控。
  • 理由: 監控這些端點確保外部合作夥伴和用戶獲得預期的服務水準，並且可以及時識別和解決任何問題。

  INFO

  關於 API 受眾請參考 ADP-752。

• 在決定淘汰(棄用或停用)外部 API 之前，應該(SHOULD)對其使用模式進行徹底檢查。
  • 理由: 了解 API 被使用的頻率和方式有助於評估其移除的影響。這確保不會突然中斷外部合作夥伴或客戶使用的關鍵功能，從而避免干擾他們的服務和工作流程。
• 應該(SHOULD)定期與內部和外部利益相關者溝通監控實踐和即將發生的 API 環境變化。
  • 理由: 透明的溝通確保利益相關者充分了解他們所依賴的 API 的狀態和變化，從而培養信任和合作。
• 應該(SHOULD)維護所有監控活動、指南和流程的全面文件，以確保一致性和連續性。
  • 理由: 良好記錄的實踐有助於更好地理解、培訓和審核監控活動，確保它們可以持續一致地遵循和改進。
• 應該(SHOULD)持續審查和更新監控實踐，以符合不斷發展的安全和隱私法規。
  • 理由: 定期審查和更新確保監控實踐保持有效，並符合最新的法律和監管要求，保護用戶數據和組織完整性。

實施細節

• 持續監控工具和技術
  • 使用提供 API 使用情況、性能和錯誤率實時洞察的監控工具。
  • 實施警報機制，以檢測可能表明潛在問題或濫用的異常模式或使用量激增。
  • 確保安全存儲日誌和指標，並可用於歷史分析和審計目的。
  • 監控特定關鍵績效指標(KPI)，如回應時間、錯誤率和吞吐量。為這些指標設置適當的閾值。
• 淘汰前的使用分析
  • 在具有代表性的時期內收集詳細的使用統計數據，包括活躍用戶數量、請求量和回應時間。
  • 識別關鍵利益相關者，並提前溝通計劃的變更，必要時為他們提供替代方案或遷移路徑。
  • 記錄用於證明 API 淘汰的分析過程和決策標準，確保透明度和問責制。
• 利益相關者反饋
  • 將 API 消費者的反饋機制納入監控過程，以持續改進 API 品質和相關性。