Azure API 管理中的可观测性

适用于：所有 API 管理层级

可观测性是指通过系统产生的数据了解系统内部状态的能力，以及探索这些数据以回答有关发生了什么事件及其原因的问题的能力。

Azure API 管理可以帮助组织集中管理所有 API。 由于它充当所有 API 流量的单一入口点，因此它是观测 API 的理想位置。

概述

使用 Azure API 管理，可以选择使用托管网关或 自承载网关。

下表总结了 API 管理支持的用于操作 API 的所有可观测性功能，以及这些功能支持哪些部署模型。 API 发布者和其他有权操作或管理 API 管理实例的人可以使用这些功能。

注释

对于使用开发人员门户的 API 使用者，可以使用内置 API 报表。 报表仅在前 90 天内提供有关其单个 API 使用情况的信息。

Tool 适用于 数据滞后4 Retention 采样 数据类型 支持的部署模型
请求跟踪 （API 检查器） 测试和调试 即时 最近 100 条追踪 已按请求启用 请求跟踪 托管、自承载、Azure Arc
内置分析 报告和监视 分钟 生存期 100% 报表和日志 托管
Azure Monitor 指标 报告和监视 分钟 90 天（升级后可延期） 100% Metrics 托管、自承载2、Azure Arc
Azure Monitor 日志 报告、监视和调试 分钟 31 天/5GB（升级后可延期） 100%（可调整） 日志 托管1、自托管3、Azure Arc3
Azure 应用程序见解 报告、监视和调试 秒 90 天/5GB（升级后可延期） Custom 日志、指标 托管1、自托管1、Azure Arc1
通过 Azure 事件中心登录 自定义场景 秒 由用户管理 Custom Custom 托管1、自托管1、Azure Arc1
OpenTelemetry 监测 分钟 由用户管理 100% Metrics 自托管2

1 可选，具体取决于 Azure API 管理中的功能配置。
2 可选，具体取决于网关的配置。
3自承载网关 当前不会将诊断日志发送到 Azure Monitor。 但是，可以在部署了自承载网关的本地环境中配置日志并将其持久保存到本地。 有关详细信息，请参阅 配置自承载网关的本地指标和日志。
4 除了请求跟踪之外，API 管理中的所有日志记录都以异步方式进行。

最佳做法

以下做法可以增强 API 可观测性：

  • 精细监视：启用 每方法 指标，以便深入了解响应时间和错误率。
  • 主动警报：为错误率和低成功 率 建立每种方法警报，使用速率而不是计数来确保准确性。
  • 分布式跟踪：启用 跟踪 以识别性能瓶颈并解决问题。
  • 资源标记：将 标记应用于 API ，以便进行准确的成本跟踪和分配。

相关内容

  • Last updated on