通过

可支持性：合作伙伴的最佳做法

  • 项目

本文档提供有关 Fabric 合作伙伴如何为其客户提供支持的指南。 它涵盖了维护、保存和关联重要请求标头的最佳做法，以及日志记录、监视和支持的建议。

概述

Fabric 允许第三方合作伙伴使用 Fabric 开发工具包将其服务集成到平台中。 本文档概述了合作伙伴应遵循的可支持性做法，确保进行有效的排除故障和客户支持。

请求标头

Fabric 在客户和 Fabric 之间的请求中公开了两个重要标头，这对可支持性至关重要：

  • ActivityId：开发人员可以使用的全局唯一 ID，在 Fabric 用户与工作负载交互时，此 ID 可将请求与系统相关联。
  • RequestId：可帮助我们 (Fabric) 将请求与跟踪相关联的全局唯一 ID，这将有助于我们调查问题并提供帮助。 如果无法使用 ActivityId 确定最终问题，可以在报告问题时向我们提供 RequestId。 确保维护和保存 RequestId，以便稍后轻松提供。

可支持性的最佳做法

为了有效地支持客户，必须维护、保存和关联这些 ID。 下面是一些最佳做法：

1. 日志记录

  • 保留日志：确保日志保留足够长的时间，以便进行有效的故障排除。
  • 详细日志记录：在所有相关日志条目中包含 ActivityId 和 RequestId。 这有助于通过系统跟踪请求流。

2. 监视

  • 实时监视：进行实时监视，以便在出现问题时检测和发出警报。 这包括监视请求速率、错误率和系统性能。
  • 与标头相关联：确保监视工具可以使用 ActivityId 和 RequestId 关联日志和指标。 这有助于快速发现和诊断问题。

3. 支持

  • 客户支持：培训支持团队在处理客户问题时请求 ActivityId 和 RequestId。 这将加快故障排除过程。
  • 文档：在报告问题时，向客户提供关于如何获取和使用这些 ID 的清晰文档。

工作流示例

  1. 日志条目：收到请求后，记录 ActivityId 和 RequestId 以及其他相关信息。
  2. 监视器：使用监视工具实时跟踪请求，并与 ID 相关联。
  3. 故障排除：如果出现问题，使用 ActivityId 和 RequestId 通过日志和系统来跟踪请求。
  4. 支持：客户报告问题时，请求 ActivityId 和 RequestId 来快速找到相关日志并提供帮助。 如果最终无法确定问题，请向 Fabric 支持提供 RequestId，以便进行进一步调查。

结束语

通过遵循这些最佳做法，合作伙伴可以在 Fabric 数据平台上有效地支持其客户，确保无缝高效地进行故障排除。 适当的日志记录、监视、请求管理和支持协议对于保持优质的服务质量和高客户满意度至关重要。