解剖Nginx·模块开发篇（5）解读内置非默认模块 ngx_http_stub_status_module

最新推荐文章于 2025-09-13 03:41:10 发布

原创

最新推荐文章于 2025-09-13 03:41:10 发布 · 1.1w 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#module #nginx #null #server #command

本文深入剖析了Nginx内置非默认模块ngx_http_stub_status_module，用于提供Nginx状态信息。内容包括模块背景、简单示例、指令介绍和源码分析，详细解释了如何通过该模块获取和理解Nginx的连接、请求等统计数据。

解剖Nginx·模块开发篇（5）解读内置非默认模块 ngx_http_stub_status_module

作者：柳大·Poechant（钟超）
邮箱：zhongchao.ustc#gmail.com（# -> @）
博客：Blog.youkuaiyun.com/Poechant
日期：June 3^nd, 2012

1 Background

ngx_http_stub_status_module 是一个 Nginx 的内置 HTTP 模块，该模块可以提供 Nginx 的状态信息。默认情况下这个模块是不被编译进来的，所以在编译 Nginx 时要指定加载该模块：

--with-http_stub_status_module

当然了，如果你是重新编译，仅仅-s reload是不够的，可能需要用到平滑升级：《高性能Web服务器Nginx的配置与部署研究（14）平滑升级你的Nginx》。

为什么拿它做例子？因为它也是个足够短小精悍的模块，是一个典型 handler 模块。那么以后我们讲解模块的过程，都是：

简要的介绍
使用的实例
指令介绍
源码分析
1. 先上源码
2. 分析

2 Simple example

location /nginx_status {
  # copied from http://blog.kovyrin.net/2006/04/29/monitoring-nginx-with-rrdtool/
  stub_status on;
  access_log   off;
  allow SOME.IP.ADD.RESS;
  deny all;
}

我们假设你是在本机上实验，并且开启的是 80 端口，那么在浏览器中输入：

http://localhost/nginx_status

会看到这样的信息：

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

其含义很容易理解：

第一行
- 当前的活跃连接数：291
第二行
- 服务器已接受的连接数：16630948（accepted connection #）
- 服务器已处理的连接数：16630948（handled connection #）
- 服务器已处理的请求：31070465（可以算出，平均每个连接有 1.8 个请求）（handled connection #）
第三行