Module ngx_http_stub_status_module

From Get docs
Nginx/docs/latest/http/ngx http stub status module

Module ngx_http_stub_status_module

The ngx_http_stub_status_module module provides access to basic status information.

This module is not built by default, it should be enabled with the --with-http_stub_status_module configuration parameter.

Example Configuration

location = /basic_status {

This configuration creates a simple web page with basic status data which may look like as follows:

Active connections: 291
server accepts handled requests
 16630948 16630948 31070465
Reading: 6 Writing: 179 Waiting: 106


Syntax: stub_status;
Context: server, location

The basic status information will be accessible from the surrounding location.

In versions prior to 1.7.5, the directive syntax required an arbitrary argument, for example, “stub_status on”.


The following status information is provided:

Active connections
The current number of active client connections including Waiting connections.
The total number of accepted client connections.
The total number of handled connections. Generally, the parameter value is the same as accepts unless some resource limits have been reached (for example, the worker_connections limit).
The total number of client requests.
The current number of connections where nginx is reading the request header.
The current number of connections where nginx is writing the response back to the client.
The current number of idle client connections waiting for a request.

Embedded Variables

The ngx_http_stub_status_module module supports the following embedded variables (1.3.14):

same as the Active connections value;
same as the Reading value;
same as the Writing value;
same as the Waiting value.

© 2002-2021 Igor Sysoev
© 2011-2021 Nginx, Inc.
Licensed under the BSD License.