支援性:合作夥伴的最佳做法
本文件提供 Fabric 合作夥伴如何支援其客戶的指引。 文中介紹了維護、儲存和關聯重要要求標頭的最佳做法,以及記錄、監視及支援方面的建議。
概觀
Fabric 可讓第三方合作夥伴使用 Fabric 開發套件將其服務整合至平台。 本文件概述合作夥伴應遵循的支援性做法,以確保有效的疑難排解和客戶支援。
要求標頭
Fabric 會在客戶與 Fabric 之間提出的要求中,公開兩個重要標頭,這對於支援性至關重要:
- ActivityId:開發人員可以使用全域唯一 ID,在 Fabric 使用者與您的工作負載互動時,將要求與您的系統相互關聯。
- RequestId:全域唯一 ID,可協助我們 (Fabric) 將您的要求與我們的追蹤相互關聯,這有助於我們調查問題並為您提供協助。 如果您無法使用
ActivityId
來判定您的端點問題,可在報告問題時提供RequestId
給我們。 請確定您維護並儲存RequestId
以便稍後輕鬆提供。
支援性最佳做法
若要有效地支援您的客戶,請務必維護、儲存這些 ID 並相互關聯。 這裡有一些最佳做法:
1. 記錄
- 保留記錄:確定記錄保留足夠的期間,以允許有效的疑難排解。
- 詳細記錄:在所有相關記錄項目中包含
ActivityId
和RequestId
。 這可協助您透過系統追蹤要求的流程。
2. 監視
- 即時監視:實作即時監視,以偵測問題並在發生時警示。 這包括監視要求率、錯誤率和系統效能。
- 與標頭相互關聯:確定您的監視工具可使用
ActivityId
和RequestId
來相互關聯記錄和計量。 這會協助您快速找出並診斷問題。
3. 支援
- 客戶支援:訓練您的支援小組,以在處理客戶問題時詢問
ActivityId
和RequestId
。 這會加速疑難排解程序。 - 文件:向您的客戶提供清晰的文件,說明如何在報告問題時取得和使用這些 ID。
範例工作流程
- 記錄項目:收到要求時,記錄
ActivityId
和RequestId
以及其他相關資訊。 - 監視:使用監視工具來即時追蹤要求,並與 ID 相互關聯。
- 疑難排解:如果發生問題,使用
ActivityId
和RequestId
透過您的記錄和系統來追蹤要求。 - 支援:客戶報告問題後,要求
ActivityId
和RequestId
以快速找出相關的記錄並提供協助。 如果無法在您的端點確定問題,請提供RequestId
至 Fabric 支援以進一步調查。
結論
藉由遵循這些最佳做法,合作夥伴可在 Fabric 資料平台上有效地支援其客戶,以確保順暢且有效的疑難排解程序。 適當的記錄、監視、要求管理和支援通訊協定,對於維護高品質和客戶滿意度至關重要。