# ngx\_http\_status\_module（过时） * [示例配置](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#example_configuration) * [指令](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#directives) * [status](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#status) * [status\_format](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#status_format) * [status\_zone](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#status_zone) * [数据](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#data) * [兼容性](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#compatibility) **1.13.10 版本起，该模块被 1.13.3 中的** [**ngx\_http\_api\_module**](https://github.com/DocsHome/nginx-docs/tree/f6135c42a499e9fab0adb433738fcf8cd4041627/模块参考/http/ngx_http_api_module.md) **模块所取代。** `ngx_http_status_module` 模块提供了访问各种状态信息的接口。 > 该模块作为我们[商业订阅](http://nginx.com/products/?_ga=2.221534609.863754713.1561447787-385379447.1523458179)的一部分提供。 ## 示例配置 ``` http { upstream backend { zone http_backend 64k; server backend1.example.com weight=5; server backend2.example.com; } proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m; server { server_name backend.example.com; location / { proxy_pass http://backend; proxy_cache cache_backend; health_check; } status_zone server_backend; } server { listen 127.0.0.1; location /upstream_conf { upstream_conf; } location /status { status; } location = /status.html { } } } stream { upstream backend { zone stream_backend 64k; server backend1.example.com:12345 weight=5; server backend2.example.com:12345; } server { listen 127.0.0.1:12345; proxy_pass backend; status_zone server_backend; health_check; } } ``` 使用此配置的状态请求示例： ``` http://127.0.0.1/status http://127.0.0.1/status/nginx_version http://127.0.0.1/status/caches/cache_backend http://127.0.0.1/status/upstreams http://127.0.0.1/status/upstreams/backend http://127.0.0.1/status/upstreams/backend/peers/1 http://127.0.0.1/status/upstreams/backend/peers/1/weight http://127.0.0.1/status/stream http://127.0.0.1/status/stream/upstreams http://127.0.0.1/status/stream/upstreams/backend http://127.0.0.1/status/stream/upstreams/backend/peers/1 http://127.0.0.1/status/stream/upstreams/backend/peers/1/weight ``` 简单监视页面随分发包一起提供，使用默认配置可以 `/status.html` 身份访问。它需要配置 location `/status` 和 `/status.html`，如上所示。 ## 指令 ### status | - | 说明 | | ------- | ----------- | | **语法** | **status**; | | **默认** | —— | | **上下文** | location | 可以从包含有指令的 location 访问状态信息。应[限制](/nginx-docs/he-xin-gong-neng/http/ngx_http_core_module.md#satisfy)访问此 location。 ### status\_format | - | 说明 | | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | **语法** |

status\_format json;
status\_format jsonp \[callback];

| | **默认** | `status_format json` | | **上下文** | http、server、location | 默认情况下，状态信息以 JSON 格式输出。 或以输出为 JSONP 格式输出，`callback` 参数指定回调函数的名称。参数值可以包含变量。如果省略参数，或计算的值为空字符串，则使用 `"ngx_status_jsonp_callback"`。 ### status\_zone | - | 说明 | | ------- | ----------------- | | **语法** | **status\_zone**; | | **默认** | —— | | **上下文** | server | 允许在指定的 `zone` 中收集虚拟 [http](/nginx-docs/he-xin-gong-neng/http/ngx_http_core_module.md#server) 或[流](https://github.com/DocsHome/nginx-docs/tree/f6135c42a499e9fab0adb433738fcf8cd4041627/模块参考/http/ngx_stream_core_module.md#server)（1.7.11）服务器状态信息。多个服务器可能共享同一个区域（zone）。 ## 数据 提供以下状态信息： * `version` 提供的数据集的版本。目前的版本是 8。 * `nginx_version` nginx 的版本。 * `nginx_build` nginx 的构建名称。 * `address` 接受状态请求的服务器的地址。 * `generation` 配置[重新加载](/nginx-docs/readme/kong-zhi-nginx.md#reconfiguration)的总数。 * `load_timestamp` 上次重新加载配置的时间，自 Epoch 后的毫秒数。 * `timestamp` Epoch 后的当前时间（以毫秒为单位）。 * `pid` 处理状态请求的 worker 进程的 ID。 * `ppid` 启动 [worker 进程](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#pid)的主进程的 ID。 * `processes` * `respawned` 异常终止和重生的子进程的总数。 * `connections` * `accepted` 已接受的客户端连接总数。 * `dropped` 已删除的客户端连接总数。 * `active` 当前活动客户端连接数。 * `idle` 当前空闲客户端连接数。 * `ssl` * `handshakes` SSL 握手成功的总数。 * `handshakes_failed` SSL 握手失败的总数。 * `session_reuses` SSL 握手期间会话​​重用的总次数。 * `requests` * `total` 客户端请求总次数。 * `current` 当前的客户端请求数。 * `server_zones` 对于每个 [status\_zone](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#status_zone)： * `ngx_http_status_module.html` 当前正在处理的客户端请求数。 * `requests` 从客户端收到的客户端请求总数。 * `responses` * `total` 发送给客户的响应总数。 * `1xx, 2xx, 3xx, 4xx, 5xx` 状态代码为 1xx、2xx、3xx、4xx 和 5xx 的响应数。 * `discarded` 在未发送响应的情况下完成的请求总数。 * `received` 从客户端收到的总字节数。 * `sent` 发送给客户端的总字节数。 * `slabs` 对于每个使用了 slab 分配器的共享内存区域： * `pages` * `used` 当前使用的内存页数。 * `free` 当前可用内存页数。 * `slots` 对于每个内存插槽大小（8、16、32、64、128 等），提供以下数据： * `used` 当前使用的内存槽数。 * `free` 当前可用的内存槽数。 * `reqs` 尝试分配指定大小内存的总次数。 * `fails` 尝试分配指定大小内存的失败次数。 * `upstreams` 对于每个[动态可配置组](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#zone)，提供以下数据： * `peers` 对于每个 [server](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#server)，提供以下数据： * `id` 服务器的 ID。 * `server` 一个服务器[地址](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#server)。 * `name` [server](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#server) 指令中指定的服务器的名称。 * `service` [server](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#server) 指令的服务参数值。 * `backup` 一个布尔值，指示服务器是否为备份服务器。 * `weight` 服务器的权重。 * `state` 当前状态，可以是 `up`、`draining`、`down`、`unavail`、`checking` 或 `unhealthy` 之一。 * `active` 当前活动连接数。 * `max_conns` 服务器的 [max\_conns](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#max_conns) 限制。 * `requests` 转发到此服务器的客户端请求总数。 * `responses` * `total` 从此服务器获取的响应总数。 * `1xx, 2xx, 3xx, 4xx, 5xx` 状态代码为 1xx、2xx、3xx、4xx 和 5xx 的响应数。 * `sent` 发送到此服务器的总字节数。 * `received` 从此服务器接收的总字节数。 * `fails` 与服务器通信失败的总次数。 * `unavail` 由于尝试不成功的次数达到 [max\_fails](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#max_fails) 阈值，服务器对客户端请求变为不可用的次数（状态为 `unavail`）。 * `health_checks` * `checks` 进行[健康检查](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_hc_module.md#health_check)的请求总数。 * `fails` 健康检查失败的次数。 * `unhealthy` 服务器变为不健康的次数（状态 `unhealthy`）。 * `last_passed` 布尔值，表示上次运行状况检查请求是否成功并通过了[测试](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_hc_module.md#match)。 * `downtime` 服务器处于 `unavail`、`checking` 和 `unhealthy` 状态的总时间。 * `downstart` 服务器变为 `unavail`、`checking` 或 `unhealthy` 时的时间（自 Epoch 以来的毫秒数）。 * `selected` 上次选择的服务器处理一个请求的时间（自 Epoch 以来的毫秒数）（1.7.5）。 * `header_time` 从服务器获取[响应头](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#var_upstream_header_time)的平均时间（1.7.10）。在 1.11.6 版之前，该字段仅在使用 [least\_time](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#least_time) 负载均衡方法时可用。 * `response_time` 从服务器获得[完整响应](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#var_upstream_response_time)的平均时间（1.7.10）。在 1.11.6 版之前，该字段仅在使用 [least\_time](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#least_time) 负载均衡方法时可用。 * `keepalive` 当前空闲的 [keepalive](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#keepalive) 连接数。 * `zombies` 当前从组中删除但仍处理活动客户端请求的服务器数。 * `zone` 保持组配置和运行时状态的共享内存[区域](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#zone)的名称。 * `queue` 对于请求[队列](/nginx-docs/he-xin-gong-neng/http/ngx_http_upstream_module.md#queue)，提供以下数据： * `size` 队列中当前的请求数。 * `max_size` 可以同时在队列中的最大请求数。 * `overflows` 由于队列溢出而拒绝的请求总数。 * `caches` 对于每个缓存（由 [proxy\_cache\_path](/nginx-docs/he-xin-gong-neng/http/ngx_http_proxy_module.md#proxy_cache_path) 等配置）： * `size` 当前缓存的大小。 * `max_size` 配置中指定的缓存最大大小限制。 * `cold` 一个布尔值，标识**缓存加载器**（cache loade）进程是否仍在将数据从磁盘加载到缓存中。 * `hit, stale, updating, revalidated` * `responses` 从缓存中读取的响应总次数（由于 [proxy\_cache\_use\_stale](/nginx-docs/he-xin-gong-neng/http/ngx_http_proxy_module.md#proxy_cache_use_stale) 等而导致的命中或过时响应）。 * `bytes` 从缓存中读取的总字节数。 * `miss, expired, bypass` * `responses` 未从缓存中获取的响应总数（由于 [proxy\_cache\_bypass](/nginx-docs/he-xin-gong-neng/http/ngx_http_proxy_module.md#proxy_cache_bypass) 等原因导致的未命中、过期或绕过）。 * `bytes` 从代理服务器读取的总字节数。 * `responses_written` 写入缓存的响应总数。 * `bytes_written` 写入缓存的总字节数。 * `stream` * `server_zones` 对于每个 [status\_zone](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#status_zone)： * `processing` 当前正在处理的客户端连接数。 * `connections` 从客户端接受的连接总数。 * `sessions` * `total` 已完成的客户会话总数。 * `2xx, 4xx, 5xx` 已完成的会话数，状态代码为 2xx、4xx 或 5xx。 * `discarded` 在不创建会话的情况下完成的连接总数。 * `received` 从客户端收到的总字节数。 * `sent` 发送给客户端的总字节数。 * `upstreams` 对于每个[动态可配置组](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#zone)，提供以下数据： * `peers` 对于每个[服务器](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#server)，提供以下数据： * `id` 服务器的 ID。 * `server` 一个服务器[地址](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#server)。 * `name` [server](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#server) 指令中指定的服务器的名称。 * `service` [server](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#server) 指令的 [servive](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#service) 参数值。 * `backup` 一个布尔值，标识服务器是否为一个[备份](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#backup)服务器。 * `weight` 服务器的[权重](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#weight)。 * `state` 当前状态，可以是 `up`、`down`、`unavail`、`checking` 或 `unhealthy` 之一。 * `active` 当前的连接数。 * `max_conns` 服务器的 [max\_conns](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#max_conns) 限制。 * `connections` 转发到此服务器的客户端连接总数。 * `connect_time` 连接上游（upstream）服务器的平均时间。在 1.11.6 版之前，该字段仅在使用 [least\_time](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#least_time) 负载均衡方法时可用。 * `first_byte_time` 接收第一个数据字节的平均时间。在 1.11.6 版之前，该字段仅在使用 [least\_time](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#least_time) 负载均衡时可用。 * `response_time` 接收最后一个数据字节的平均时间。在 1.11.6 版之前，该字段仅在使用[least\_time](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#least_time) 负载均衡方法时可用。 * `sent` 发送到此服务器的总字节数。 * `received` 从此服务器接收的总字节数。 * `fails` 与服务器通信失败的总次数。 * `unavail` 由于尝试不成功次数达到 [max\_fails](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#max_fails) 阈值，服务器对客户端连接变为不可用的次数（状态为 `unavail`） * `health_checks` * `checks` [健康检查](https://github.com/DocsHome/nginx-docs/tree/f6135c42a499e9fab0adb433738fcf8cd4041627/模块参考/stream/ngx_stream_upstream_hc_module.md#health_check)的请求总数。 * `fails` 健康检查失败的次数。 * `unhealthy` 服务器处于不健康的次数（状态 `unhealthy`）。 * `last_passed` 布尔值，表示上次运行状况检查请求是否成功并通过了[测试](https://github.com/DocsHome/nginx-docs/tree/f6135c42a499e9fab0adb433738fcf8cd4041627/模块参考/stream/ngx_stream_upstream_hc_module.md#match)。 * `downtime` 服务器处于 `unavail`、`checking` 和 `unhealthy` 状态的总时间。 * `downstart` 服务器变为 `unavail`、`checking` 或 `unhealthy` 时的时间（自 Epoch 以来的毫秒数）。 * `selected` 上次选中的服务器处理连接的时间（自 Epoch 以来的毫秒数）。 * `zombies` 当前已从组中删除但仍处理活动客户端连接的服务器数。 * `zone` 保持组配置和运行时状态的共享内存[区域](/nginx-docs/he-xin-gong-neng/stream/ngx_stream_upstream_module.md#zone)的名称。 ## 兼容性 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 8 中添加了 [http](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#upstreams) 和 [stream](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#stream_upstreams) upstreams 的 [zone](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#zone) 字段。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 8 中添加了 [slab](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#slabs) 状态数据。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 8 中添加了[检查](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#state)状态。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 8 中添加了 [http](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#upstreams) 和 [stream](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#stream_upstreams) upstream 的 [name](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#name) 和 [service](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#service) 字段。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 8 中添加了 [nginx\_build](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#nginx_build) 和 [ppid](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#ppid) 字段。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 7 中添加了 [session](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#sessions) 状态数据和流 [server\_zones](https://github.com/DocsHome/nginx-docs/tree/f6135c42a499e9fab0adb433738fcf8cd4041627/模块参考/http/stream_server_zones/README.md) 中的 [discarded](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#stream_discarded) 字段。 * [zombies](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#zombies) 字段是从[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 6 的 nginx [调试](/nginx-docs/readme/tiao-shi-ri-zhi.md)版本移过来的。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 6 中添加了 [ssl](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#ssl) 状态数据。 * [server\_zones](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#server_zones) 中的 [discarded](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#discarded) 字段已在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 6 中添加。 * [queue](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#queue) 状态数据已在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 6 中添加。 * [pid](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#pid) 字段已在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 6 中添加。 * [upstreams](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#upstreams) 中的服务器列表已移至[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 6 中的对应项。 * 在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 5 中删除了 upstream 服务器的 `keepalive` 字段。 * [stream](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#stream) 状态数据已在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 5 中添加。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 5 中添加了 [generation](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#generation) 字段。 * [processes](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#processes)中的 [respawned](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#respawned) 字段已在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 5 中添加。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 5 中添加了 upstreams 中的 [header\_time](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#header_time) 和 [response\_time](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#response_time) 字段。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 4 中添加了 upstreams 中的 [selected](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#selected) 字段。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 4 中添加了upstreams 的 [draining](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#draining) 状态。 * upstreams 中的 [id](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#id) 和 [max\_conns](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#max_conns) 字段已在[版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 3 中添加。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 3 中添加了 [caches](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#caches) 中的 `revalidated` 字段。 * [版本](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#version) 2 中添加了 [server\_zones](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#server_zones)、[caches](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#caches) 和 [load\_timestamp](/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md#load_timestamp) 状态数据。 ## 原文档 --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docshome.gitbook.io/nginx-docs/he-xin-gong-neng/http/ngx_http_status_module.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.