文档首页/ 应用运维管理 AOM/ 常见问题/ 采集管理/ 如何启用NGINX stub_status模块?
更新时间:2025-07-23 GMT+08:00

如何启用NGINX stub_status模块?

Nginx Prometheus Exporter是通过Nginx的stub_status模块对其进行监控,需要确保Nginx服务启用了stub_status模块。具体步骤如下:
  1. 登录到业务Nginx服务所在节点,以root权限用户执行以下命令检查Nginx是否已经启用stub_status模块(一般在/usr/local/nginx/sbin/nginx目录下执行):
    nginx -V 2>&1 | grep -o with-http_stub_status_module
    • 如果输出with-http_stub_status_module,则说明Nginx 已启用 stub_status模块。
    • 如果未输出任何结果,则可以使用--with-http_stub_status_module参数重新配置configure文件,来编译一个Nginx。示例如下:
      ./configure \
      ##在原基础上添加--with-http_stub_status_module参数进行编译。
      --with-http_stub_status_module
      make
      sudo make install
  2. 确认stub_status模块启用之后,在nginx.conf配置文件中添加如下配置(nginx.conf配置文件一般在/usr/local/nginx/conf目录下)。示例如下:
    1. 执行如下命令在vi编辑器中打开nginx.conf配置文件:
      vi /usr/local/nginx/conf/nginx.conf
    2. 输入“i”进入编辑模式,添加如下配置信息:
      server {
       listen 8080;  # 根据业务情况进行调整。侦听端口
       listen [::]:8080; # 根据业务情况进行调整,ipv6侦听端口
       server_name localhost; # 根据业务情况进行调整
       location = /stub_status { # 具体路径可根据业务情况进行调整
           stub_status on;
           access_log off;
           allow 127.0.0.1;
       }
      }
    3. 按“Esc”,输入:wq保存并退出。
  3. 配置修改完成后,重新启动Nginx服务。