API 网关接入

当您使用火山引擎 API 网关（API Gateway，APIG）产品时，允许接入托管 Prometheus 服务，实现对 APIG 实例和服务的监控。本文为您介绍 APIG 接入的流程和步骤。

背景信息

API 网关是基于云原生的、高扩展、高可用的云上网关托管服务。在传统流量网关的基础上，集成丰富的服务发现和服务治理能力，打通微服务架构的内外部网络，快速实现各服务之间、服务与客户端之间的安全通信。

前提条件

• 已在火山引擎注册并开通 VMP、APIG 服务。
• 已创建托管 Prometheus 工作区，详情请参见 创建工作区。

操作步骤

1. 登录 API 网关控制台。
2. 在左侧菜单栏中选择 实例管理，单击 创建实例。在 可观测性 配置项中，完成 APIG 实例的可观测性配置。
   

   配置项	说明
   监控告警	API 网关对接火山引擎的 VMP 服务，为您提供网关基础指标的免费监控和告警能力。如需使用监控告警功能，请打开当前开关。 Prometheus 工作区：开启监控告警后必选配置。选择前提条件中准备的 Prometheus 工作区，网关当前实例下的所有监控数据会采集并存储在您绑定的 Prometheus 工作区下。 注意 绑定 Prometheus 工作区后不支持更改。 删除 Prometheus 工作区可能会导致网关的监控数据永久丢失，请谨慎操作。
   开启告警	是否开启默认告警通知。开启后，APIG 将提供默认告警用于监控您业务的稳定性。 告警聚合策略：开启告警后必选配置。选择前提条件中准备的告警聚合策略。告警聚合策略用来指定系统中的告警聚合周期和通知周期。 告警通知策略：开启告警后可选配置。选择前提条件中准备的告警通知策略。 告警通知策略用来指定不同等级的告警发生时，需要接收告警的告警联系人组。如不配置，则仅生成告警事件，不会发送告警通知。 说明 您可自定义修改告警规则，详细操作可参见 托管 Prometheus 告警规则。

3. 其他配置项的配置方法，详情请参见 创建实例。
4. 在 确认订单 界面勾选 协议，单击 提交订单。完成创建实例。

查看信息

指标

您可以使用托管 Prometheus 的 Explore 功能来快速查询和展示指标数据。详情请参见 指标查询。

大盘

您可以通过以下方法，查看 APIG 的指标大盘：

• 在 APIG 实例管理页面中，查看 APIG 实例的监控大盘，详情请参见 查看实例监控信息。
• 自建 Grafana，并通过 Grafana 查看指标和创建大盘。详情请参见 在容器服务集群中部署 Grafana 并接入工作区。

告警

您可以在托管 Prometheus 的告警中心配置 APIG 实例的相关告警。详情请参见 创建告警规则 或 配置告警规则。