WuKongIM Docs

Prometheus 指标

/metrics 的注册条件、格式和安全边界。

编辑此页报告文档问题

ANY /metrics 仅在应用装配 Prometheus Handler 时注册;未装配时路由不存在并返回 404。响应是 Prometheus exposition,不是 JSON,也不属于 Product HTTP 合同。采集器应使用 GET

scrape_configs:
  - job_name: wukongim
    static_configs:
      - targets: ['127.0.0.1:5001']

入口没有内建认证,恢复维护期间仍可读取。仅在监控网络暴露;跨不可信网络时由外层提供 TLS 和认证。告警应基于同一版本和代表性负载建立基线,并同时观察延迟分位数、队列、拒绝、丢弃和节点偏斜。

指标用于趋势和告警,不单独证明节点就绪或拓扑变更安全。接流量仍看 /readyz

GET/metrics

配置 Metrics Handler 后返回 Prometheus exposition;否则该路由不存在。

响应主体

text/plain

"# HELP wukongim_connections Current Gateway sessions\n# TYPE wukongim_connections gauge\nwukongim_connections 42\n"