How to Enable NGINX Status Page?

NGINX is a high-performance web server that requires monitoring for optimal performance. The NGINX Status Page is a built-in module that provides real-time metrics about server activity, including active connections, request counts, and server uptime. This feature helps system administrators monitor performance, identify bottlenecks, and troubleshoot issues efficiently.

Understanding NGINX Status Page

The NGINX status page displays real-time performance data through the stub_status module. This lightweight monitoring tool provides essential metrics without significantly impacting server performance.

Key Metrics Displayed

The status page shows several important metrics

• Active Connections Current number of client connections to the server

• Accepts Total connections accepted since server start

• Handled Total connections successfully handled

• Requests Total number of client requests processed

• Reading Connections currently reading request headers

• Writing Connections currently writing responses to clients

• Waiting Idle connections waiting for new requests

These metrics help administrators understand server load, connection efficiency, and identify performance patterns over time.

Enabling NGINX Status Page

The status page is disabled by default and must be enabled in the NGINX configuration. Always create a backup of your configuration file before making changes.

Basic Configuration

Edit your NGINX configuration file (typically /etc/nginx/nginx.conf or /etc/nginx/sites-available/default) and add the following server block

server {
    listen 80;
    server_name localhost;
    
    location /nginx_status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        allow ::1;
        deny all;
    }
}

This configuration creates a status endpoint at /nginx_status that is only accessible from localhost (IPv4 and IPv6).

Advanced Configuration Examples

For network-specific access, modify the access controls

location /nginx_status {
    stub_status on;
    access_log off;
    allow 192.168.1.0/24;
    allow 10.0.0.0/8;
    deny all;
}

To add HTTP authentication for additional security

location /nginx_status {
    stub_status on;
    access_log off;
    allow 127.0.0.1;
    deny all;
    auth_basic "NGINX Status";
    auth_basic_user_file /etc/nginx/.htpasswd;
}

After making configuration changes, test the syntax and reload NGINX

sudo nginx -t
sudo nginx -s reload

Accessing and Interpreting the Status Page

Once enabled, access the status page by visiting http://your-server/nginx_status. The output displays

Active connections: 2
server accepts handled requests
 16630 16630 31070
Reading: 0 Writing: 1 Waiting: 1

Monitoring and Troubleshooting

Use the status page data to identify performance issues

• High "Waiting" connections May indicate slow backend processing

• Accepts > Handled Server rejecting connections due to resource limits

• High "Reading/Writing" Potential network or application bottlenecks

For automated monitoring, integrate the status page with monitoring tools like Prometheus, Zabbix, or custom scripts that parse the status output.

Security Considerations

Always restrict access to the status page using IP-based filtering or authentication. The status information can reveal server capacity and usage patterns that should not be publicly accessible. Consider using HTTPS and non-standard URLs for additional security.

Conclusion

The NGINX status page is an essential tool for monitoring web server performance and health. By enabling and properly securing this feature, administrators gain valuable insights into server metrics that help maintain optimal performance and quickly identify potential issues before they impact users.