caltechads/nginx_statsd_sidecar

nginx_statsd_sidecar

镜像概述和主要用途

nginx_statsd_sidecar 是一个专门设计用于与运行 nginx 的 Docker 容器一起部署的 sidecar 容器。其核心用途是从 nginx 的 ngx_http_stub_status_module 模块收集统计数据，并将这些数据发送到 statsd 服务器，实现对 nginx 请求和连接状态的实时监控。

核心功能和特性

• 统计数据收集：抓取并报告 nginx 的关键指标，包括：
  • requests：自上次抓取以来 nginx 处理的请求数
  • active_connections：当前活跃的 nginx 连接数
  • reading：处于读取状态的活跃连接数
  • writing：处于写入状态的活跃连接数
  • waiting：处于等待状态的活跃连接数
• 可配置轮询间隔：默认每 10 秒轮询一次 nginx 统计数据，轮询频率可通过环境变量灵活调整。
• statsd 集成：将收集的统计数据标准化后发送到 statsd 服务器，支持与监控系统（如 Graphite、Prometheus+StatsD Exporter 等）集成。

使用场景和适用范围

适用于需要监控 nginx 运行状态的各类环境，尤其是：

• 微服务架构中，作为 nginx 反向代理/API 网关的配套监控组件
• 需要实时跟踪 nginx 连接状态（活跃连接、读写等待状态）的生产环境
• 已部署 statsd 监控系统，需整合 nginx 性能指标的场景

使用方法和配置说明

部署前提

• 运行中的 nginx 容器需启用 ngx_http_stub_status_module 模块，并配置可访问的状态页面（如 /nginx_status）。
• 需有可访问的 statsd 服务器（用于接收和处理统计数据）。

基本部署示例（Docker Compose）

yaml
version: '3'
services:
  nginx:
    image: nginx
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf:ro  # 挂载包含stub_status配置的nginx.conf
    # nginx.conf 示例配置（需启用stub_status）：
    # http {
    #   server {
    #     location /nginx_status {
    #       stub_status on;
    #       allow 172.17.0.0/16;  # 允许sidecar容器所在网络访问（根据实际网络调整）
    #       deny all;
    #     }
    #   }
    # }

  nginx-statsd-sidecar:
    image: nginx_statsd_sidecar
    environment:
      - NGINX_STATUS_URL=http://nginx/nginx_status  # nginx状态页面URL（需与nginx配置对应）
      - STATSD_HOST=statsd-service  # statsd服务器主机名或IP（必填）
      - STATSD_PORT=8125            # statsd服务器端口（默认8125）
      - POLL_INTERVAL=10            # 轮询间隔（秒），默认10秒
    depends_on:
      - nginx

配置参数（环境变量）

完整文档

完整使用文档请参见 [***]