API可观测

更新时间: 2024-12-18 13:29:45

本文旨在为您介绍原API网关的可观测能力。包括API调用日志、API监控和告警、以及配置Trace链路追踪,这些功能确保您能够全面了解和监控API的运行状态,提升系统稳定性和性能优化的能力。

API调用日志

原API网关调用日志,包括以下内容:

  • 通过日志服务查看API调用日志

    API网关和日志服务实现无缝集成,通过日志服务您可以进行实时日志查询、下载、多维度统计分析等。详细内容包括:

    • 日志在线查询:可根据日志中任意关键字进行快速的精确、模糊检索,可用于问题定位或者统计查询。

    • 详细调用日志:您可以检索API调用的详细日志包含如下表所示字段。

    • 使用日志服务查看API日志:您可通过日志服务来查看API网关的调用日志。

  • 配置记录HTTP请求应答日志

    您可设置记录API网关接收到的HTTP请求以及返回给客户端的HTTP应答。

    说明

    此功能仅支持专享实例。

具体详情,请参见API调用日志

API监控和告警

原API网关的监控和告警,包括以下内容:

  • API网关监控

    API网关的监控支持查看region(地域)、分组、以及API的监控图表,详细内容包括:

    • Region监控

    • 实例监控(仅专享实例)

    • 分组监控

    • API监控

  • API报警设置

    您可以通过云监控对发布在API网关上的API配置报警,以便随时了解API服务运行情况,保障其稳定性和可靠性。

  • 如何配置出访连接池告警

    日志服务支持根据定义的检查频率、触发条件等配置告警规则,并在满足条件时触发告警,可以使用日志服务来进行告警。

    当出访连接池不够用时,API网关就会给客户端返回Backend service connect failed `Connection lease request time out`。这个报错记录在日志中的errorMessage字段中,我们可以根据这个报错信息来配置告警,配置文档可参考快速设置日志告警

具体详情,请参见API监控和告警

配置Trace链路追踪

重要

本功能仅支持专享实例。

您可在API网关控制台配置Trace链路追踪,将日志上传到阿里云链路追踪平台。Tracing Analysis提供了全面的调用链路还原、请求量统计、链路拓扑和应用依赖等分析工具,能够显著提升用户的开发诊断效率。包含以下内容:

  • 链路追踪如何授权。

  • API网关如何配置Trace链路追踪。

具体详情,请参见配置Trace链路追踪

上一篇: 跨域资源共享(CORS) 下一篇: API调用日志