跳转至

Prometheus api

Prometheus API 默认未包含，参见 安装。

结构

{
  "listen": "127.0.0.1:9090",
  "path": "/metrics",
  "export": "sing-box",
  "basic_auth_username": "",
  "basic_auth_password": "",
  "label_whitelist": [],
  "label_blacklist": []
}

示例

{
  "experimental": {
    "prometheus_api": {
      "listen": "127.0.0.1:9090",
      "export": "my-sing-box"
    }
  }
}

字段

listen

Prometheus API 监听地址。为空时 Prometheus API 将被禁用。

path

指标路径，默认为 /metrics。

Prometheus 抓取配置中的 scrape_configs 路径必须与此值匹配。

export

所有指标上 export 标签的值，默认为 sing-box。

当将多个 sing-box 实例抓取到同一个 Prometheus 时，使用此字段区分它们。

basic_auth_username

Basic Auth 用户名。basic_auth_username 和 basic_auth_password 必须同时设置。

当 Prometheus API 监听非回环地址时，建议使用 Basic Auth。

basic_auth_password

Basic Auth 密码。basic_auth_username 和 basic_auth_password 必须同时设置。

当 Prometheus API 监听非回环地址时，建议使用 Basic Auth。

label_whitelist

每个连接指标中包含的标签键列表。

设置后，仅保留指定的标签键。export 标签始终包含。

与 label_blacklist 互斥。

label_blacklist

每个连接指标中排除的标签键列表。

设置后，除指定标签键外的所有标签键都会保留。export 标签不会被排除。

与 label_whitelist 互斥。

label_whitelist 和 label_blacklist 不能同时使用。