prometheus_metrics_port

功能描述

prometheus_metrics_port 用于设置 observer / arbserver 进程内嵌的 Prometheus /metrics HTTP exposer 的监听端口号。设置为 0 表示关闭 exposer，不对外暴露 metrics。

进程启动后，Prometheus 服务器可通过 GET /metrics 接口周期性拉取 CPU/内存/磁盘等仲裁基础指标以及日志流主从、选举测试、config_version、mode_version 等业务指标。

权限要求

• 查询配置项

  sys 租户和所有用户租户均可以使用 SHOW PARAMETERS 语句或视图 GV$OB_PARAMETERS 查询该配置项。

• 修改配置项

  仅 sys 租户可以修改该配置项，用户租户不能修改该配置项。

属性说明

使用说明

• 该配置项仅在进程启动时读取一次并绑定端口：端口值大于 0 时，进程会在 0.0.0.0:<port> 上启动 exposer；端口值为 0 时，进程仅在内部维护指标计数，但不对外暴露。

• 运行期通过 ALTER SYSTEM SET 语句修改该配置项，不会重新绑定端口，需要重启 observer / arbserver 进程后才生效。

• 部署 arbserver 或 observer 时，可通过启动参数或配置文件指定 exposer 的监听端口；部署环境需放通该端口的入向访问，由 Prometheus 服务器周期拉取 http://<host>:<prometheus_metrics_port>/metrics。

• 如不需要对外暴露 metrics（例如测试环境、内网采集走其他通道、或端口被占用），可将该配置项设置为 0，关闭 exposer。

• 如果启动时端口已被占用或监听失败，exposer 初始化会失败并自动关闭，所有指标不再更新，但不影响 observer / arbserver 进程正常启动，同时系统会在日志中记录 WARN 级别的监听错误信息（disable Prometheus monitoring）；待端口冲突问题解决后，需重启 observer / arbserver 进程才能恢复指标采集。

• 有关通过 Prometheus 采集仲裁服务监控指标的详细操作及指标说明，请参见 仲裁服务监控。

配置示例

该配置项的配置方法有两种：

方法一：部署时通过启动参数设置

在进程启动配置中追加端口参数，即可开启指标采集接口。示例如下：

observer ... -o prometheus_metrics_port=2886

使用默认配置时无需显式填写端口，进程会尝试监听 2886。如需关闭指标采集接口，将该参数设为 0 即可。示例如下：

observer ... -o prometheus_metrics_port=0

方法二：集群运行期通过 ALTER SYSTEM SET 语句修改

在集群运行期通过 ALTER SYSTEM SET 语句修改端口，重启 observer / arbserver 进程后生效。

1. 通过 ALTER SYSTEM SET 语句修改端口。

   obclient> ALTER SYSTEM SET prometheus_metrics_port = 2887;
   

2. 重启 observer / arbserver 进程后生效。

此时若想关闭指标采集接口，将 prometheus_metrics_port 的端口号改为 0 后，仍需重启进程才能生效。

进程启动后，可通过以下命令采集 metrics。

curl http://<host>:2886/metrics