调试概览

您正在查看 Apigee X 文档。
查看 Apigee Edge 文档。

调试是一种用于对 Apigee 上运行的 API 代理进行问题排查和监控的工具。通过调试工具,您可以通过 API 代理流程探测每个步骤的详细信息。 Apigee 允许您收集显示 API 代理的整个请求/响应流的调试数据。这包括所有请求/响应参数以及在政策执行时对这些数据应用的转换。这对于 API 代理开发和部署期间的调试和问题排查十分重要。

使用调试

使用调试工具通过界面或 API 创建和管理调试会话(如使用调试中所述)。或者,您也可以下载调试会话,并离线查看和分析(如使用离线调试中所述)。

Apigee 支持对调试的使用

默认情况下,Apigee 允许 Apigee 支持团队使用您的 API 代理中的调试工具提供支持。

请注意以下事项:

  • Apigee 支持团队拥有对调试数据的只读权限。
  • Apigee 支持人员可能会要求您运行跟踪记录来捕获问题的相关信息,并提供跟踪记录会话 ID 或跟踪记录会话的链接,以便支持人员可以查看捕获的跟踪记录。由于保存的跟踪记录会话的有效时间仅有 24 小时,我们建议您下载跟踪记录会话并将其附加到创建的案例中,供支持人员离线查看。

Apigee Hybrid 用户

如果您使用的是 Apigee Hybrid,请参阅以下部分。

调试架构

下面说明了创建新的调试会话的过程:

启动调试会话的请求的概要视图您可以使用界面或 API 启动调试会话的请求。2. 管理层面使用 pub/sub 模型向运行时平面发出调试会话创建请求。3.Synchronizer 负责调试调试会话通知,可将创建请求传播到消息处理器。4.MPS 会收集调试数据,并将其流式传输到数据收集 pod。5. fluentd 会立即将调试数据写入 pod 的文件系统。6.UDCA 会根据 pod 的文件系统轮询新的数据文件。7. 如果发现新的数据文件,UDCA 就会将其上传到 UAP 服务。8. 然后,您可以通过 Apigee 混合服务(例如 Apigee 混合界面或 Apigee API)访问数据。

调试记录数据最多可在管理层面保存 24 小时。

前提条件

如果您使用的是 Apigee Hybrid,则必须确保已配置以下各项,然后才能使用调试功能:

服务帐号

  • apigee-synchronizer(角色:Apigee Synchronizer Manager)
  • apigee-udca(角色:Apigee Analytics Agent)

如需详细了解 v1.3 混合版本,请参阅适用于您的平台创建服务帐号,如下所示:

同步器