你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

教程:使用请求跟踪调试 API

本教程介绍如何在 Azure API 管理中检查(跟踪)请求处理。 跟踪有助于调试 API 并排查 API 问题。

在本教程中,你将了解如何执行以下操作:

  • 跟踪示例调用
  • 查看请求处理步骤

API inspector

先决条件

验证“允许跟踪”设置

必须为用于 API 的订阅启用“允许跟踪”设置。 如果使用的是内置所有访问订阅,则默认启用该设置。 若要在门户中进行验证,请导航至 API 管理实例,然后选择“订阅”。

Allow tracing for subscription

跟踪调用

  1. 登录到 Azure 门户,并导航到 API Management 实例。
  2. 选择“API”。
  3. 在 API 列表中选择“演示会议 API”。
  4. 选择“测试”选项卡。
  5. 选择“GetSpeakers”操作。
  6. 确认 HTTP 请求头包含“Ocp-Apim-Trace:True”和“Ocp-Apim-Subscription-Key”的有效值。 如果不包含,请选择“+ 添加标头”以添加标头。
  7. 选择“发送”以进行 API 调用。

Configure API tracing

提示

如果 HTTP 请求中没有自动填充 Ocp-Apim-Subscription-Key,则可以在门户中检索它。 选择“订阅”,然后打开订阅的上下文菜单 (…) 。 选择“显示/隐藏密钥”。 也可以按需再生成密钥。 然后,将密钥添加到标头。

查看跟踪信息

  1. 调用结束后,转到“HTTP 响应”中的“跟踪”选项卡。

  2. 选择以下任何链接,跳至详细的跟踪信息:“入站”、“后端”和“出站” 。

    Review response trace

    • 入站 - 显示从调用方收到的原始请求 API 管理和应用于该请求的策略。 例如,如果你在教程:转换和保护 API 中添加了策略,它们就会出现在此处。

    • 后端 - 显示 API 管理发送到 API 后端的请求以及收到的响应。

    • 出站 - 显示在将响应发送给调用方之前应用于该响应的策略。

    提示

    每个步骤还显示了自 API 管理收到请求以来消逝的时间。

  3. 在“消息”选项卡上,ocp-apim-trace-location 标头显示存储在 Azure blob 存储中的跟踪数据所在的位置 。 如果需要,请转到此位置以检索跟踪。

    Trace location in Azure Storage

后续步骤

在本教程中,你了解了如何执行以下操作:

  • 跟踪示例调用
  • 查看请求处理步骤

转到下一教程: