One-API项目监控配置指南：Prometheus与Grafana集成实践

在One-API项目中配置监控系统是确保服务稳定运行的重要环节。本文将详细介绍如何正确配置Prometheus和Grafana来监控One-API服务的各项指标。

基础环境准备

首先需要准备Docker环境，并创建以下docker-compose.yml文件：

services:
  prometheus:
    image: prom/prometheus:latest
    container_name: prometheus
    hostname: prometheus
    restart: always
    user: "472"
    ports:
      - "9090:9090"
    volumes:
      - ./prometheus.yml:/etc/prometheus/prometheus.yml
      - ./data:/prometheus
    command:
      - '--config.file=/etc/prometheus/prometheus.yml'
      - '--storage.tsdb.path=/prometheus'
    environment:
      - TZ=Asia/Shanghai
    networks:
      - prometheus_net

  grafana:
    image: grafana/grafana:latest
    container_name: grafana
    hostname: grafana
    restart: always
    user: "472"
    ports:
      - "9091:3000"
    volumes:
      - ./grafana/data:/var/lib/grafana
    depends_on:
      - prometheus
    networks:
      - prometheus_net

networks:
  prometheus_net:

Prometheus配置要点

One-API的metrics接口采用了基础认证机制，需要在Prometheus配置文件中正确配置认证信息：

global:
  scrape_interval: 15s

scrape_configs:
  - job_name: 'one_api'
    basic_auth:
      username: 'your_metrics_user'
      password: 'your_metrics_password'
    metrics_path: '/api/metrics'
    static_configs:
      - targets: ['one-hub:port']

关键配置说明：

1. basic_auth部分必须与One-API服务中配置的metrics认证信息一致
2. targets建议使用容器名称而非IP地址，避免因IP变动导致监控中断
3. metrics_path必须设置为/api/metrics

常见问题解决方案

连接失败问题

若出现Error scraping target错误，可能原因包括：

1. 网络配置问题：确保Prometheus和One-API容器在同一Docker网络中
2. 认证配置错误：检查用户名密码是否与One-API配置一致
3. 端口配置错误：确认target中指定的端口正确

认证失败问题

One-API的metrics接口认证逻辑如下：

func MetricsWithBasicAuth() gin.HandlerFunc {
	return func(c *gin.Context) {
		user := utils.GetOrDefault("metrics.user", "")
		password := utils.GetOrDefault("metrics.password", "")

		reqUser, reqPassword, hasAuth := c.Request.BasicAuth()
		if user == "" || password == "" || !hasAuth || reqUser != user || reqPassword != password {
			c.AbortWithStatus(http.StatusNotFound)
			return
		}
		c.Next()
	}
}

若认证失败，接口会返回404状态码，这是设计上的安全考虑。

Grafana仪表板配置

成功配置Prometheus后，可以在Grafana中导入预制的仪表板配置。One-API项目提供了标准的监控面板JSON配置，包含以下关键指标可视化：

1. API请求成功率
2. 各渠道请求分布
3. 响应时间百分位
4. 错误请求分类

建议根据实际业务需求对渠道名称/类型进行映射配置，其他指标保持默认即可获得完整的监控视图。

通过以上配置，运维团队可以全面掌握One-API服务的运行状态，及时发现并处理潜在问题，保障服务的稳定性和可靠性。