HowTo: Enable Nginx Status Page

last updated in Categories , ,

Apache has status page that can provide data about Apache. How do I enable and display such page using nginx server? How do I enable nginx status page on Linux or Unix-like operating systems?

Like Aapache (httpd), nginx has status page to give you information about Nginx’s server health including Active connections and other data. You can use this info to fine tune your server. Please note that you will get stats for entire Nginx server running. This can not be used to get info per virtual host i.e. you will get data for entire Nginx server only.

Make sure HttpStubStatusModule compiled

Type the following command to verify that HttpStubStatusModule is compiled and available to you:
nginx -V | grep --color -o http_stub_status

Enable Nginx status page on Linux/Unix

Edit nginx.conf, enter:
# vi nginx.conf
Update your server { ..... } block/context as follows (see how to deny access to IP address on nginx):

   location /nginx_status {
        # Turn on nginx stats
        stub_status on;

        # I do not need logs for stats
        access_log   off;

        # Security: Only allow access from 192.168.1.100 IP #
        allow 192.168.1.100;
   
        # Send rest of the world to /dev/null #
        deny all;
   }

Feel free to replace 192.168.1.100 with your actual IP address. This is a security feature as you do not want to show your status to the whole world.

Restart / reload nginx server

Type the following command to reload nginx:
# service nginx reload
OR
# nginx -s reload

How do I view nginx status page?

Fire a browser and type the url:
example.com/nginx_status
1.2.3.4/nginx_status
www.cyberciti.biz/nginx_status
Sample outputs:

Gif 01: Nginx status page in action (note I am refreshing screen to show you demo)
Gif 01: Nginx status page in action (note I am refreshing screen to show you demo)

Posted by: Vivek Gite

The author is the creator of nixCraft and a seasoned sysadmin, DevOps engineer, and a trainer for the Linux operating system/Unix shell scripting. Get the latest tutorials on SysAdmin, Linux/Unix and open source topics via RSS/XML feed or weekly email newsletter.

6 comment

  1. Hello,
    First, I wanna ask about “server load time”. Can you tell me how to configure it on nginx?
    Thanks b4

    1. What do you mean with “server load time”? That is going to depend on a lot of things, mainly your application, database access, etc.

      If you want to test the load time of your site you could use site like webpagetest.org

      1. I mean how to see our server total time (in second or ms) for each client request on our nginx server because from your tutorial only show :
        1. How many connection are on Nginx server
        2. How many connection are waiting,reading,writing
        3. total accept request on server
        Does Nginx have that setting that can see “server total time load”??
        Thank b4 for answering my question.
        *Note : I want to test my Nginx Server offline for my project..Sorry I’m Newbie

  2. nginx -V – output info to stderr, so
    nginx -V | grep –color -o http_stub_status
    should be replaced with
    nginx -V 2>&1 | grep –color -o http_stub_status

  3. Hi

    What if nginx instance have many server blocks. Does it shows for cumulative servers or just for any particular server?

    Thanks
    Vivek

    Have a question? Post it on our forum!

Tagged as: Tags , , , ,