boynux/squid-exporter

Squid Prometheus Exporter

镜像概述和主要用途

Squid Prometheus Exporter是一款用于将Squid代理服务器指标导出为Prometheus格式的工具。通过该导出器，用户可将Squid的各类性能指标（如请求计数、服务时间等）提供给Prometheus进行收集和监控。

注意：自1.0版本起，指标名称和部分参数发生变化，请务必查阅文档并相应更新部署配置！

核心功能和特性

新功能

• 支持通过环境变量配置导出器
• 支持为指标添加自定义标签

已实现特性

• Squid计数器：
  • ✅ 客户端HTTP
  • ✅ 服务器HTTP
  • ✅ 服务器ALL
  • ✅ 服务器FTP
  • ✅ 服务器Other
  • ✅ Swap
• Squid服务时间：
  • ✅ HTTP请求
  • ✅ 缓存未命中
  • ✅ 缓存命中
  • ✅ 近命中
  • ✅ DNS查找
• ✅ Squid认证（基础认证）

待实现特性

• Squid计数器：ICP、CD、页面错误、其他
• Squid服务时间：未修改回复、ICP查询
• 直方图
• 其他指标

使用场景和适用范围

适用于需要对Squid代理服务器进行性能监控的环境，通过Prometheus收集导出的指标，可实现对Squid请求量、缓存效率、服务响应时间等关键指标的实时监控和分析。

使用方法和配置说明

基本使用

命令行直接运行

bash
squid-exporter -squid-hostname "localhost" -squid-port 3128

Prometheus配置

在Prometheus配置文件中添加如下内容，从localhost:9301/metrics抓取指标：

yaml
- job_name: squid
  # 本地部署squid-exporter，监控本地Squid实例
  target_groups:
    - targets: ['localhost:9301']

命令行参数

通过-help获取所有参数，命令行参数优先级高于默认配置和环境变量：

bash
squid-exporter -help

环境变量配置

支持以下环境变量覆盖默认参数：

Docker部署示例

基础设置（Squid与导出器同机运行）

bash
docker run --net=host -d boynux/squid-exporter

Squid运行在不同主机

bash
docker run -p 9301:9301 -d boynux/squid-exporter -squid-hostname "192.168.0.2" -squid-port 3128 -listen ":9301"

使用环境变量配置

bash
docker run -p 9301:9301 -d \
  -e SQUID_PORT="3128" \
  -e SQUID_HOSTNAME="192.168.0.2" \
  -e SQUID_EXPORTER_LISTEN=":9301" \
  boynux/squid-exporter

常见问题（FAQ）

Q: 导出器未上报指标？

A: 通常是导出器无法连接Squid服务器或Squid配置管理器权限未正确设置。排查步骤：

1. 确认导出器服务可访问Squid服务器IP（可通过telnet <squid-ip> <squid-port>测试）。
2. 确保Squid配置允许导出器查询，需添加类似配置（172.20.0.0/16为导出器所在网络，也可指定单个IP）：

# http_access allow manager localhost
acl prometheus src 172.20.0.0/16
http_access allow manager prometheus

构建信息

该项目使用Go语言开发，支持常规Go应用的构建（含交叉编译）。若不熟悉Go，可从https://github.com/boynux/squid-exporter/releases%E4%B8%8B%E8%BD%BD%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%EF%BC%8C%E6%88%96%E9%80%9A%E8%BF%87%E4%BB%A5%E4%B8%8B%E5%91%BD%E4%BB%A4%E6%9E%84%E5%BB%BA%EF%BC%9A

bash
go install https://github.com/boynux/squid-exporter

构建后的二进制文件位于$GOPATH/bin/squid-exporter。

贡献与版权

欢迎提交Pull Request和Issue。项目采用MIT许可证。