dockerinfratest/push-exporter

push-exporter Docker镜像文档

镜像概述和主要用途

push-exporter是一款轻量级指标导出器镜像，专为监控各类推送（push）任务设计。该镜像通过采集推送操作的关键指标（如成功率、延迟、失败原因等），并以Prometheus兼容格式暴露指标接口，帮助用户实时掌握推送服务状态，及时发现异常并优化推送性能。支持HTTP/HTTPS、WebSocket、MQTT等多种推送协议，适用于API推送、消息队列、移动端通知等场景。

核心功能和特性

• 多协议支持：兼容HTTP/HTTPS、WebSocket、MQTT等主流推送协议，适配各类推送服务架构。
• 关键指标采集：实时收集推送成功率、平均延迟、失败率、失败原因分类（超时/连接错误/权限问题等）、吞吐量等核心指标。
• 灵活配置：支持自定义监控标签（如服务名称、环境标识）、指标采集间隔、阈值告警规则，满足个性化监控需求。
• 轻量级设计：基于Alpine Linux构建，镜像体积小（<20MB），资源占用低（CPU<5%，内存<30MB），适合边缘环境和容器化部署。
• Prometheus兼容：提供标准/metrics接口，可直接接入Prometheus、Grafana等监控系统，支持指标可视化和告警配置。

使用场景和适用范围

适用场景

• API推送服务监控：如第三方API接口推送数据的成功率和响应速度追踪。
• 消息队列推送：监控Kafka、RabbitMQ等消息队列的消息投递状态。
• 移动端推送通知：跟踪APNs、FCM等平台的推送送达率和用户点击数据。
• 内部服务间推送：微服务架构中服务间事件推送的可靠性监控。

适用对象

• DevOps团队：构建推送链路监控告警体系。
• SRE工程师：保障推送服务SLA（如99.9%成功率）。
• 开发人员：调试推送功能异常，优化性能瓶颈。

使用方法和配置说明

基本部署（Docker Run）

bash
docker run -d \
  --name push-exporter \
  -p 9234:9234 \  # 默认监听端口
  -e PUSH_TARGETS="https://api.example.com/push,ws://mqtt.example.com:8083" \  # 目标推送服务列表（逗号分隔）
  -e SCRAPE_INTERVAL=10s \  # 指标采集间隔
  -e LOG_LEVEL=info \  # 日志级别（debug/info/warn/error）
  myregistry/push-exporter:latest

Docker Compose配置

yaml
version: '3.8'
services:
  push-exporter:
    image: myregistry/push-exporter:latest
    container_name: push-exporter
    ports:
      - "9234:9234"
    environment:
      - PUSH_TARGETS="https://api.example.com/push,ws://mqtt.example.com:8083"
      - SCRAPE_INTERVAL=10s
      - LOG_LEVEL=info
      - CUSTOM_LABELS="service=user-notify,env=prod"  # 自定义监控标签
    restart: unless-stopped

配置参数说明

配置文件挂载（高级配置）

如需更复杂配置（如按协议自定义监控规则），可通过挂载配置文件实现。配置文件为YAML格式，示例：

yaml
# push-exporter-config.yaml
targets:
  - url: "https://api.example.com/push"
    protocol: http
    timeout: 5s
    labels:
      service: "order-push"
  - url: "ws://mqtt.example.com:8083"
    protocol: websocket
    scrape_interval: 20s
global:
  log_level: warn
  custom_labels:
    env: prod

挂载命令：

bash
docker run -d \
  --name push-exporter \
  -p 9234:9234 \
  -v $(pwd)/push-exporter-config.yaml:/app/config.yaml \  # 挂载配置文件
  myregistry/push-exporter:latest --config /app/config.yaml

指标接口与监控集成

启动后，通过 http://<容器IP>:9234/metrics 访问指标接口，示例指标：

push_success_total{target="https://api.example.com/push",service="order-push"} 1250
push_failure_total{target="https://api.example.com/push",reason="timeout",service="order-push"} 12
push_latency_seconds_avg{target="https://api.example.com/push",service="order-push"} 0.85

可在Prometheus中添加如下抓取配置：

yaml
scrape_configs:
  - job_name: 'push-exporter'
    static_configs:
      - targets: ['push-exporter:9234']  # 容器名或IP:端口

注意事项

1. 确保目标推送服务网络可访问，否则无法采集指标。
2. 高并发推送场景建议调大 SCRAPE_INTERVAL（如30s），避免指标采集影响推送性能。
3. 自定义标签需符合Prometheus标签命名规范（仅包含字母、数字、下划线、冒号）。