调试概览

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

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

调试数据收集和传输

Apigee 网关节点会收集调试会话数据并将其缓存在内部，然后再将该数据传输到云中的控制平面。然后，该数据会共享到调试会话界面，供运营商进行分析。

如果您使用调试遮盖，Apigee 会在网关节点中执行遮盖，然后再将调试数据传输到控制平面。

使用调试

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

Apigee 支持对调试的使用

Only customers can trigger a debug session, but Apigee Support can access non-deleted past debug sessions during the course of a support case to help troubleshoot proxy-specific issues.

Note the following:

  • Apigee Support has read-only permission to Debug data.
  • Apigee Support may request that you run a debug to capture information about an issue, and that you provide the debug session ID or a link to the debug session so that Support may review the captured debug. Since saved debug sessions are valid for only 24 hours, we recommend that you download the debug session and attach it to the case opened with Support to enable offline viewing.

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 Hybrid 用户的重要信息。

支持数据驻留

旧版 Apigee Hybrid 不支持数据驻留功能。

其他要求

  • 您必须配置 apigee-udca 服务账号。请参阅指定配置替换。
  • 所有 Synchronizer 节点上的时钟应同步且采用世界协调时间 (UTC)。