logimethods/prometheus-nats-exporter

Prometheus NATS Exporter 镜像文档

镜像概述和主要用途

Prometheus NATS Exporter是一个用于将NATS服务器指标导出到Prometheus的工具，包含可执行应用程序和开发包。它能聚合多个NATS服务器的指定监控端点（varz、connz、subsz、routez）数据，通过单个Prometheus Exporter端点提供统一的监控指标，便于对NATS服务器进行集中监控和分析。

核心功能和特性

• 多指标类型支持：可收集NATS服务器的varz（通用指标）、connz（连接指标）、subz（订阅指标）、routez（路由指标）
• 多服务器聚合：支持同时监控多个NATS服务器，将指标聚合到单个端点
• 服务器标签识别：通过URL参数为服务器添加标签（server-id），便于在Prometheus中区分不同服务器
• 灵活配置选项：支持日志级别调整、监听地址/端口设置、TLS加密、日志输出方式（文件、syslog、远程syslog）等
• 高可用性：支持NATS服务器监控URL的自动重试（默认间隔30秒）
• API支持：提供简单易用的API，可嵌入到自定义代码中使用

使用场景和适用范围

• 监控单个或多个NATS服务器的运行状态和性能指标
• 集成到Prometheus+Grafana监控体系中，实现NATS服务器指标的可视化和告警
• 需要收集NATS服务器连接数、消息吞吐量、路由状态等关键指标的场景
• 对NATS服务器进行性能分析和问题排查

使用方法和配置说明

基本运行命令

通过Docker运行镜像，需指定至少一个监控指标类型（-varz、-connz、-routez、-subz）和NATS服务器监控URL：

bash
docker run logimethods/prometheus-nats-exporter -varz "http://localhost:5555" "http://localhost:5656"

命令参数说明

URL参数格式

URL参数支持为NATS服务器添加标签，格式为：<tag>,<url>，标签将作为server-id添加到Prometheus指标中，便于识别不同服务器：

bash
docker run logimethods/prometheus-nats-exporter -varz "production-denver-1,http://denver1.foobar.com:8222" "production-london-1,http://london1.foobar.com:8222"

监控端点

Exporter默认通过HTTP接口暴露指标，地址为：http://<监听地址>:<监听端口>/metrics（默认http://0.0.0.0:7777/metrics）。Prometheus可通过该端点拉取指标数据，示例输出：

text
# HELP gnatsd_varz_in_bytes in_bytes
# TYPE gnatsd_varz_in_bytes gauge
gnatsd_varz_in_bytes{server_id="production-denver-1"} 0
# HELP gnatsd_varz_in_msgs in_msgs
# TYPE gnatsd_varz_in_msgs gauge
gnatsd_varz_in_msgs{server_id="production-denver-1"} 0
# HELP gnatsd_varz_max_connections max_connections
# TYPE gnatsd_varz_max_connections gauge
gnatsd_varz_max_connections{server_id="production-denver-1"} 65536

API使用（嵌入式集成）

Exporter提供API可嵌入到Go代码中使用，步骤如下：

1. 导入包：

   go
   import (
     "github.com/nats-io/prometheus-nats-exporter/exporter"
   )
   

2. 配置并启动：

   go
   // 获取默认配置并修改
   opts := exporter.GetDefaultExporterOptions()
   opts.ListenAddress = "localhost"  // 监听地址
   opts.ListenPort = 8888            // 监听端口
   opts.GetVarz = true               // 启用varz指标收集
   
   // 创建Exporter实例
   exp := exporter.NewExporter(opts)
   
   // 添加NATS服务器（标签, URL）
   exp.AddServer("myserver", "http://localhost:8222")
   
   // 启动收集
   exp.Start()
   
   // 停止时调用
   // exp.Stop()
   
   // 阻塞直到停止
   // exp.WaitUntilDone()
   

扩展阅读

如需详细了解如何使用Prometheus和Grafana监控NATS，请参考监控指南。