<!-- review: finished -->

<a id="http-stub-status"></a>

# Stub Status

The module provides access to basic server status information.

When [building from the source code](https://en.angie.software//angie/docs/installation/sourcebuild.md#sourcebuild),
this module isn't built by default;
it should be enabled with the
`‑‑with‑http_stub_status_module`
[build option](https://en.angie.software//angie/docs/installation/sourcebuild.md#configure).

In packages and images from [our repos](https://en.angie.software//angie/docs/installation/index.md#install-packages),
the module is included in the build.

<a id="configuration-example-43"></a>

## Configuration Example

```nginx
location = /basic_status {
    stub_status;
}
```

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

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

<a id="directives-46"></a>

## Directives

<a id="index-0"></a>

<a id="id1"></a>

### stub_status

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `stub_status`;   |
|------------------------------------------------------------------------------------------|------------------|
| Default                                                                                  | —                |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | server, location |

The status information will be accessible from the surrounding location.

<a id="data"></a>

## Data

The following status information is provided:

<a id="samp-active-connections"></a>

### `Active connections`

The current number of active client connections including Waiting connections.

<a id="samp-accepts"></a>

### `accepts`

The total number of accepted client connections.

<a id="samp-handled"></a>

### `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](https://en.angie.software//angie/docs/configuration/modules/core.md#worker-connections) limit).

<a id="samp-requests"></a>

### `requests`

The total number of client requests.

<a id="samp-reading"></a>

### `Reading`

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

<a id="samp-writing"></a>

### `Writing`

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

<a id="samp-waiting"></a>

### `Waiting`

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

<a id="built-in-variables-13"></a>

## Built-in Variables

<a id="v-connections-active"></a>

### `$connections_active`

Same as the Active connections value.

<a id="v-connections-reading"></a>

### `$connections_reading`

Same as the Reading value.

<a id="v-connections-writing"></a>

### `$connections_writing`

Same as the Writing value.

<a id="v-connections-waiting"></a>

### `$connections_waiting`

Same as the Waiting value.
