Stub Status#

The module provides access to basic status information

When building from the source code, this module isn't built by default; it should be enabled with the ‑‑with‑http_stub_status_module build option.

In packages and images from our repos, the module is included in the build.

Configuration Example#

location = /basic_status {
    stub_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

Directives#

stub_status#

Syntax

stub_status;

Default

—

Context

server, location

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

Data#

The following status information is provided:

Active connections#

The current number of active client connections including Waiting connections.

accepts#

The total number of accepted client connections.

handled#

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).

requests#

The total number of client requests.

Reading#

The current number of connections where Angie is reading the request header.

Writing#

The current number of connections where Angie is writing the response back to the client.

Waiting#

The current number of idle client connections waiting for a request.

Built-in Variables#

$connections_active#

same as the Active connections value;

$connections_reading#

same as the Reading value;

$connections_writing#

same as the Writing value;

$connections_waiting#

same as the Waiting value.