Apache APISIX 可观测性实践：全方位监控你的 API 服务-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00054/article/details/148377819

Apache APISIX 可观测性实践：全方位监控你的 API 服务

apisix Apisix是一个基于Nginx的API网关，主要用于微服务架构中的API管理和服务发现。它的特点是高性能、轻量级、易于配置等。适用于API管理和负载均衡场景。项目地址: https://gitcode.com/gh_mirrors/api/apisix

什么是 API 可观测性？

在现代微服务架构中，API 可观测性已经成为系统健康管理的重要组成部分。它通过收集、分析和可视化 API 运行时的各种数据，帮助开发者快速发现、诊断和解决问题。API 可观测性主要包含三大支柱：日志（Logging）、指标（Metrics）和链路追踪（Tracing）。

Apache APISIX 作为高性能 API 网关，提供了丰富的可观测性插件，让开发者能够轻松构建完整的 API 监控体系。

日志监控：记录 API 访问详情

日志是 API 可观测性的基础，它记录了每个请求的详细信息。APISIX 提供了多种日志插件，可以将日志发送到不同的目标系统：

本地日志：默认情况下，APISIX 会将访问日志和错误日志存储在 ./apisix/logs/ 目录下
远程日志服务：通过插件可将日志发送到 HTTP 服务器、TCP/UDP 服务、消息队列（Kafka/RocketMQ）等

实战：使用 http-logger 插件

http-logger 插件是最常用的日志插件之一，它可以将 API 访问日志以 HTTP 请求的形式发送到指定的日志收集服务。以下是配置示例：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
  "plugins": {
    "http-logger": {
      "uri": "http://你的日志服务器地址"
    }
  },
  "upstream_id": "1",
  "uri": "/get"
}'

配置完成后，所有访问 /get 的请求日志都会被发送到指定的日志服务器。日志内容通常包含：

请求时间
客户端IP
请求方法
响应状态码
处理时间
请求头信息等

指标监控：量化 API 性能

指标是结构化的数值数据，能够直观反映 API 的运行状态。APISIX 的指标监控主要通过 prometheus 插件实现。

Prometheus 监控配置

启用 Prometheus 插件非常简单：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
  "uri": "/get",
  "plugins": {
    "prometheus": {}
  },
  "upstream_id": "1"
}'

APISIX 会自动暴露以下关键指标：

请求总数和状态码分布
请求延迟（P99/P95/P50）
带宽使用情况
上游服务健康状态
插件执行情况

Grafana 可视化

结合 Grafana，你可以创建丰富的监控仪表板，直观展示：

API 流量趋势
错误率变化
响应时间分布
热点API排名

APISIX 官方提供了预制的 Grafana 仪表板模板，开箱即用。

链路追踪：可视化请求路径

在微服务架构中，一个请求可能经过多个服务。链路追踪可以记录请求的完整路径，帮助开发者理解系统行为和分析性能瓶颈。

Zipkin 集成示例

APISIX 的 zipkin 插件可以轻松实现分布式追踪：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
  "methods": ["GET"],
  "uri": "/get",
  "plugins": {
    "zipkin": {
      "endpoint": "http://127.0.0.1:9411/api/v2/spans",
      "sample_ratio": 1
    }
  },
  "upstream_id": "1"
}'

链路追踪可以提供：