messagebird/pushprom

Pushprom

镜像概述和主要用途

Pushprom是一个HTTP/UDP代理，用于连接Prometheus Go客户端。由于Prometheus官方未提供PHP客户端，且PHP应用因状态跟踪困难难以自行实现Prometheus指标收集，Pushprom应运而生，作为中间层帮助PHP应用集成Prometheus监控。

核心功能和特性

• 多协议支持：同时支持HTTP和UDP协议接收指标数据
• Prometheus兼容：与Prometheus Go客户端无缝对接，遵循Prometheus指标规范
• 简单部署：可通过Docker容器快速部署
• 灵活配置：支持自定义HTTP和UDP监听地址
• 调试模式：提供调试日志功能，便于问题排查

使用场景和适用范围

• PHP应用需要集成Prometheus监控时
• 需要通过HTTP或UDP协议推送指标数据的场景
• 无法直接使用Prometheus Go客户端的环境

使用方法和配置说明

部署方式

Docker容器构建

通过源码构建Docker容器：

bash
make container

Docker运行示例

假设构建的镜像名为pushprom，基本运行命令：

bash
docker run -d -p 9090:9090 -p 9091:9091 --name pushprom pushprom

配置参数

运行时可通过命令行参数配置：

• -debug：启用调试日志
• -http-listen-address string：HTTP监听地址（默认":9091"），用于接收指标请求和暴露Prometheus metrics
• -udp-listen-address string：UDP监听地址（默认":9090"），用于接收UDP指标请求

查看帮助信息：

bash
docker run --rm pushprom pushprom -h

协议使用说明

HTTP协议

通过HTTP POST请求推送指标数据，端点为/，Content-Type需设置为application/json。

示例：

bash
curl -H "Content-type: application/json" -X POST -d '{"type": "counter", "name": "gophers", "help": "little burrowing rodents", "method": "inc"}' http://127.0.0.1:9091/

UDP协议

通过UDP数据包推送指标数据，适用于对速度要求高但可接受偶尔丢包的场景。

示例：

bash
echo '{"type": "counter", "name": "gophers", "help": "little burrowing rodents", "method": "inc"}' | nc -u -w1 127.0.0.1 9090

指标数据格式

推送的JSON payload（Delta）格式如下：

json
{
  "type": "gauge",          // 指标类型，如gauge、counter等
  "name": "trees",          // 指标名称
  "help": "the amount of trees in the forest.",  // 指标描述
  "method": "add",          // 操作方法，如add、inc等
  "value": 3002,            // 指标值（部分方法需提供）
  "labels": {               // 指标标签
    "species": "araucaria angustifolia",
    "job": "tree-counter-bot"
  }
}

注意事项

• Prometheus Go客户端不允许注册同名但不同help信息或标签的指标。若已注册指标name为gophers，后续推送相同name但不同help或labels的指标将失败，需重启Pushprom。

客户端支持

目前提供两种PHP客户端：

• https://github.com/messagebird/pushprom-php-client
• https://github.com/messagebird/pushprom-yii2-client

替代方案对比

Pushgateway

https://github.com/prometheus/pushgateway%E6%98%AFPrometheus%E7%9A%84%E6%8C%87%E6%A0%87%E7%BC%93%E5%AD%98%E5%B7%A5%E5%85%B7%EF%BC%8C%E5%85%B6%E6%98%8E%E7%A1%AE%E4%B8%8D%E6%98%AF%E8%81%9A%E5%90%88%E5%99%A8%EF%BC%8C%E8%BF%99%E6%98%AF%E4%B8%8EPushprom%E6%9C%80%E6%98%BE%E8%91%97%E7%9A%84%E5%8C%BA%E5%88%AB%E3%80%82

测试

bash
make test

许可证

Pushprom基于BSD 2-Clause许可证开源。版权所有 (c) 2016, MessageBird