micrometermetrics/prometheus-rsocket-proxy

Prometheus RSocket Proxy 镜像文档

镜像概述

Prometheus RSocket Proxy 是一个基于 RSocket 协议的代理服务，旨在解决应用程序因网络限制无法接收入站连接（仅能建立出站连接）时的指标收集问题。该代理作为中间层，允许应用程序主动发起出站连接并推送指标，同时为 Prometheus 等监控系统提供标准的指标拉取端点，通常与 Micrometer 指标库配合使用，是分布式环境下受限网络中指标收集的解决方案。

核心功能和特性

• RSocket 协议支持：基于 RSocket 协议实现双向异步通信，支持请求-响应、请求-流等交互模式
• 出口连接优化：专为只能建立出站连接的应用程序设计，允许应用主动连接代理而非等待入站请求
• Prometheus 集成：提供符合 Prometheus 拉取规范的 HTTP 端点，支持监控系统标准指标采集流程
• Micrometer 兼容：与 Micrometer 指标库无缝集成，支持各类应用程序指标的标准化收集
• 多传输方式：支持 TCP、WebSocket 等多种 RSocket 传输方式，适应不同网络环境需求
• 轻量级设计：基于 Java 构建，资源占用低，适合容器化部署

使用场景

• 受限网络环境：应用程序部署在严格网络隔离环境（如防火墙后、容器平台私有网段），无法接收外部入站连接
• 动态扩展架构：应用实例频繁扩缩容或 IP 动态变化，难以配置固定的 Prometheus 抓取目标
• 边缘计算场景：边缘设备或边缘节点只能主动连接中心服务，无法暴露指标端口供中心系统访问
• 微服务监控：在微服务架构中，简化跨网络分区的指标收集，避免为每个服务配置复杂的网络规则

使用方法

基本 Docker 运行命令

bash
docker run -d \
  --name prometheus-rsocket-proxy \
  -p 9096:9096 \  # RSocket 服务端口（默认）
  -p 8080:8080 \  # HTTP 指标端点端口（供 Prometheus 拉取）
  micrometermetrics/prometheus-rsocket-proxy

Docker Compose 配置示例

yaml
version: '3.8'
services:
  prometheus-rsocket-proxy:
    image: micrometermetrics/prometheus-rsocket-proxy
    container_name: prometheus-rsocket-proxy
    ports:
      - "9096:9096"  # RSocket 服务端口
      - "8080:8080"  # HTTP 指标端点端口
    environment:
      - PROXY_SERVER_PORT=9096  # RSocket 服务监听端口
      - SERVER_PORT=8080        # HTTP 端点端口（Prometheus 拉取）
      - ROCKET_TRANSPORT=tcp    # 传输方式（tcp 或 websocket）
      - METRICS_PATH=/metrics   # Prometheus 拉取指标的 HTTP 路径
    restart: unless-stopped

应用程序集成步骤

1. 应用端配置：在使用 Micrometer 的应用中添加 RSocket 指标推送器依赖，配置代理服务地址（如 rsocket://proxy-host:9096）
2. 启动代理：通过 Docker 启动代理服务，确保应用可访问代理的 RSocket 端口
3. Prometheus 配置：在 Prometheus 的 prometheus.yml 中添加对代理 HTTP 端点的抓取配置：

   yaml
   scrape_configs:
     - job_name: 'rsocket-proxy'
       static_configs:
         - targets: ['proxy-host:8080']  # 代理的 HTTP 指标端点
   

配置参数

环境变量配置

自定义配置文件

如需更复杂配置，可通过挂载外部配置文件（如 application.yml）到容器 /app/config 目录：

yaml
# application.yml 示例
rsocket:
  server:
    port: 9096
    transport: tcp
server:
  port: 8080
management:
  endpoints:
    web:
      exposure:
        include: health,metrics
  metrics:
    export:
      prometheus:
        enabled: true

挂载命令示例：

bash
docker run -d \
  --name prometheus-rsocket-proxy \
  -p 9096:9096 \
  -p 8080:8080 \
  -v ./application.yml:/app/config/application.yml \
  micrometermetrics/prometheus-rsocket-proxy

注意事项

• 确保代理服务与应用程序之间网络可达，应用程序需正确配置代理地址
• 代理的 HTTP 端点需暴露给 Prometheus 服务器，以便完成指标拉取
• 根据实际网络环境选择合适的 RSocket 传输方式（TCP 适用于低延迟场景，WebSocket 适用于穿透 HTTP 代理场景）
• 生产环境中建议配置连接认证和加密（如 TLS）以保障数据安全