cingulara/nats-client-metrics
cingulara
导出NATS客户端连接指标供Prometheus使用
下载次数: 0状态：社区镜像维护者：cingulara仓库类型：镜像最近更新：1 个月前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
NATS Client Metrics
概述
NATS Client Metrics是一个可在Docker或Kubernetes（k8s）环境中运行的工具，用于收集NATS客户端特定的连接指标。它能够显示服务器与客户端的连接状态，并输出基于Prometheus格式的指标字符串及帮助信息。该工具专为OpenRMF应用开发，旨在监控每个客户端的消息量、字节数等详细指标，而非仅提供服务器整体数据。
工具基于.NET Core 2.2实现了轻量级的/metrics Web API，无需运行繁重的Metrics中间件。目前仍处于开发阶段，需完善错误处理、证书支持、登录密码认证及测试功能，但已可在Kubernetes命名空间（适用于非暴露的Prometheus）和本地Docker Compose环境中正常工作。
核心功能与特性
- 收集NATS客户端特定连接指标，包括消息量、字节数、订阅数等
- 输出Prometheus兼容的指标格式，便于监控系统集成
- 轻量级设计，基于.NET Core 2.2构建，无需依赖繁重中间件
- 支持Docker和Kubernetes部署环境
- 适用于OpenRMF应用及其他需要监控NATS客户端活动的场景
构建与安装
构建应用
bashmake build
创建Docker镜像
bashmake docker
官方Docker镜像：https://hub.docker.com/r/cingulara/nats-client-metrics
使用方法
运行环境要求
- Docker或Kubernetes环境
- 可访问的NATS服务器指标端点（默认端口8222）
环境变量配置
运行时需通过环境变量配置关键参数，默认配置在Docker/Kubernetes环境中可能无法正常工作，需根据实际环境调整：
| 环境变量 | 描述 | 默认值 | 注意事项 |
|---|---|---|---|
| NATSMETRICSURL | NATS服务器指标端点URL | [***] | 在Docker/K8s中需改为实际NATS服务器地址，不可使用localhost |
| ASPNETCORE_ENVIRONMENT | .NET Core运行环境 | Development | 生产环境建议设置为Production |
| ASPNETCORE_URLS | 应用监听地址 | [***] | 定义应用对外提供服务的端口 |
Docker运行示例
bashdocker run -d \ -e "NATSMETRICSURL=http://nats-server:8222" \ -e "ASPNETCORE_ENVIRONMENT=Production" \ -e "ASPNETCORE_URLS=http://*:7778" \ -p 7778:7778 \ docker.xuanyuan.run/cingulara/nats-client-metrics
Grafana集成
可导入仪表板JSON文件到Grafana，配置Prometheus数据源后即可查看客户端指标可视化数据。
!Grafana仪表板
指标示例输出
工具输出的Prometheus指标格式如下（节选）：
# HELP Total Messages Incoming for this client. # TYPE gnatds_clients_in_msgs_total gauge gnatds_clients_in_msgs_total{server_id="[***]",clientname="openrmf_msg_controls"} 0 # HELP Total Messages Outgoing for this client. # TYPE gnatds_clients_out_msgs_total gauge gnatds_clients_out_msgs_total{server_id="[***]",clientname="openrmf_msg_controls"} 0 # HELP Total Pending Bytes for this client. # TYPE gnatds_clients_pending_bytes_total gauge gnatds_clients_pending_bytes_total{server_id="[***]",clientname="openrmf_msg_controls"} 0 # HELP Total Bytes Incoming for this client. # TYPE gnatds_clients_in_bytes_total gauge gnatds_clients_in_bytes_total{server_id="[***]",clientname="openrmf_msg_controls"} 0
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 nats-client-metrics 镜像标签
docker pull docker.xuanyuan.run/cingulara/nats-client-metrics:<标签>
DockerHub 原生拉取命令
docker pull cingulara/nats-client-metrics:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"