How Do I Enable the Nginx stub_status Module?

Updated on 2025-01-07 GMT+08:00

View PDF

Nginx Prometheus Exporter monitors the Nginx service using the stub_status module. Ensure that this module is enabled. Perform the following operations:

Log in to the node where the Nginx service is deployed and run the following command in the /usr/local/nginx/sbin/nginx directory to check whether the stub_status module is enabled:
```
nginx -V 2>&1 | grep -o with-http_stub_status_module
```
- If with-http_stub_status_module is returned, the stub_status module is enabled.
- If no result is returned, enable the stub_status module by setting --with-http_stub_status_module in the configuration file. Example:
```
./configure \
## Add the --with-http_stub_status_module parameter.
--with-http_stub_status_module
make
sudo make install
```

After the stub_status module is enabled, add the following content to the nginx.conf file in the /usr/local/nginx/conf directory: Example:

server {
 listen 8080;  # Listening port. Set this parameter based on service requirements.
 listen [::]:8080; # IPv6 listening port. Set this parameter based on service requirements.
 server_name localhost; # Set this parameter based on service requirements.
 location = /stub_status { # Path. Set this parameter based on service requirements.
     stub_status on;
     access_log off;
     allow 127.0.0.1;
 }
}

Restart the Nginx service.

Parent topic: Collection Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel