Apache APISIX 在独立模式下配置 OpenTelemetry 和 Prometheus 插件的实践指南

前言

Apache APISIX 作为一款高性能的云原生 API 网关，提供了丰富的插件生态。其中 OpenTelemetry 和 Prometheus 插件是监控和追踪 API 流量的重要工具。本文将详细介绍在独立模式下如何正确配置这两个插件，解决实际部署中可能遇到的问题。

独立模式下的配置特点

APISIX 的独立模式（standalone mode）不需要依赖 etcd 等外部配置中心，所有配置都通过 YAML 文件管理。这种模式虽然简化了部署，但在插件配置上与传统模式有些差异，需要特别注意。

OpenTelemetry 插件配置详解

OpenTelemetry 插件用于分布式追踪，配置不当会导致数据无法发送到收集器。以下是关键配置要点：

1. 全局配置：在 plugins 部分启用插件
2. 资源属性：定义服务名称、版本等元数据
3. 收集器地址：必须指定正确的收集器地址和端口

典型配置示例：

plugins:
  - name: opentelemetry
    resource:
      service.name: APISIX_GATEWAY
      service.version: 3.9.0
      service.instance.id: gateway-01
    collector:
      address: otel-collector:4318  # 使用服务名而非IP

常见问题排查：

• 确保收集器地址可访问（避免使用 127.0.0.1）
• 检查网络连通性（特别是 Docker 环境）
• 验证端口是否正确（通常 4318 用于 HTTP 协议）

Prometheus 插件配置技巧

在独立模式下使用 Prometheus 插件需要特别注意：

1. 启用导出服务：默认情况下需要显式启用
2. 访问控制：通过路由规则暴露指标端点
3. 安全考虑：建议添加认证保护指标端点

推荐配置方式：

plugin_attr:
  prometheus:
    enable_export_server: true
    export_uri: /metrics
    export_addr:
      ip: 0.0.0.0
      port: 9091

routes:
  - uri: /metrics
    plugins:
      prometheus: {}
      # 可添加basic-auth等安全插件
    upstream_id: "prometheus_metrics"

综合配置最佳实践

将两个插件结合使用时，建议采用以下结构：

plugins:
  - name: opentelemetry
  - name: prometheus

plugin_attr:
  opentelemetry:
    resource:
      service.name: APISIX_PROD
    collector:
      address: otel-collector.prod:4318
  prometheus:
    enable_export_server: true
    export_uri: /internal/metrics

routes:
  - uri: /internal/metrics
    plugins:
      prometheus: {}
      basic-auth: {}  # 添加认证

常见问题解决方案

1. 连接被拒绝错误：

   • 检查收集器服务是否运行
   • 验证网络策略（特别是 Kubernetes 或 Docker 环境）
   • 尝试使用服务名而非 IP 地址

2. 指标端点不可访问：

   • 确认 enable_export_server 设置为 true
   • 检查防火墙规则
   • 确保路由配置正确

3. 配置不生效：

   • 确认使用正确的配置层级（plugins vs plugin_attr）
   • 检查 YAML 缩进是否正确
   • 重启 APISIX 使配置生效

性能优化建议

1. 对于高流量环境，考虑调整采样率
2. 监控插件资源消耗
3. 定期检查导出数据的完整性和准确性

结语

通过本文的指导，开发者应该能够在 APISIX 独立模式下成功配置 OpenTelemetry 和 Prometheus 插件。正确的监控和追踪配置是保障 API 网关稳定运行的重要基础，建议在生产环境部署前充分测试验证。