Nginx官方文档(三十六)【ngx_http_stub_status_module|ngx_http_sub_module】

「爱情、让人受尽委屈。」 2021-07-04 19:11 319阅读 0赞

# ngx\_http\_stub\_status\_module #

*  示例配置
 *  指令
    
     *  stub\_status
 *  数据
 *  内嵌变量

`ngx_http_stub_status_module` 模块提供对基本状态信息的访问的支持。

默认不构建此模块，可在构建时使用 `--with-http_stub_status_module` 配置参数启用。

## 示例配置 ##

location = /basic_status {
        stub_status;
    }

此配置将创建一个简单的网页，其基本状态数据可能如下：

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

## 指令 ##

### stub\_status ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>stub_status</strong>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">server、location</td> 
  </tr> 
 </tbody> 
</table>

可以从包含该指令的 location 访问基本状态信息。

> 在 1.7.5 之前的版本中，指令语法需要一个任意参数，例如 `stub_status on`。

## 数据 ##

提供以下状态信息：

*  `Active connections`
    
    当前活动客户端连接数，包括等待连接。
 *  `accepts`
    
    已接受的客户端连接总数。
 *  `handled`
    
    已处理连接的总数。通常，参数值与 `accept` 相同，除非已达到某些资源限制阈值（例如，worker\_connections 限制）。
 *  `requests`
    
    客户端请求的总数。
 *  `Reading`
    
    nginx 正在读取请求头的当前连接数。
 *  `Writing`
    
    nginx 将响应写回客户端的当前连接数。
 *  `Waiting`
    
    当前等待请求的空闲客户端连接数。

## 内嵌变量 ##

`ngx_http_stub_status_module` 模块支持以下内嵌变量（1.3.14）：

*  `$connections_active`
    
    与 `Active connections` 的值相同
 *  `$connections_reading`
    
    与 `Reading` 的值相同
 *  `$connections_writing`
    
    与 `Writing` 的值相同
 *  `$connections_waiting`
    
    与 `Waiting` 的值相同

## 原文档 ##

*  [http://nginx.org/en/docs/http/ngx\_http\_stub\_status\_module.html][http_nginx.org_en_docs_http_ngx_http_stub_status_module.html]

--------------------

# ngx\_http\_sub\_module #

*  示例配置
 *  指令
    
     *  sub\_filter
     *  sub\_filter\_last\_modified
     *  sub\_filter\_once
     *  sub\_filter\_types

`ngx_http_sub_module` 模块是一个过滤器，它通过替换指定的字符串来修改响应数据。

默认不构建此模块，可在构建时使用 `--with-http_sub_module` 配置参数启用。

## 示例配置 ##

location / {
        sub_filter '<a href="http://127.0.0.1:8080/'  '<a href="https://$host/';
        sub_filter '<img src="http://127.0.0.1:8080/' '<img src="https://$host/';
        sub_filter_once on;
    }

## 指令 ##

### sub\_filter ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>sub_filter</strong> <code>string replacement</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

设置要替换的字符串（`string`）和要替换成的字符串（`replacement`）。要替换的字符串匹配忽略大小写。要替换的字符串（1.9.4）和要替换成的字符串可以包含变量。可以在一个配置级别指定几个 `sub_filter` 指令（1.9.4）。当且仅当在当前级别上没有定义 `sub_filter` 指令时，这些指令才从上级继承。

### sub\_filter\_last\_modified ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>sub_filter_last_modified</strong> <code>on</code> | <code>off</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">sub_filter_last_modified off;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>提示</strong></td> 
   <td align="left">该指令在 1.5.1 版本中出现</td> 
  </tr> 
 </tbody> 
</table>

允许在替换期间保留原始响应中的 **Last-Modified** 头字段，用于响应缓存。

默认情况下，在处理期间修改响应的内容时，将删除头字段。

### sub\_filter\_once ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>sub_filter_once</strong> <code>on</code> | <code>off</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">sub_filter_once on;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

只查找一次要替换的每个字符串或重复查找。

### sub\_filter\_types ###

<table> 
 <thead> 
  <tr> 
   <th align="left">-</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><strong>语法</strong></td> 
   <td align="left"><strong>sub_filter_types</strong> <code>mime-type ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>默认</strong></td> 
   <td align="left">sub_filter_types text/html;</td> 
  </tr> 
  <tr> 
   <td align="left"><strong>上下文</strong></td> 
   <td align="left">http、server、location</td> 
  </tr> 
 </tbody> 
</table>

除了 **text/html** 之外，还指定在其他 MIME 类型的响应中启用字符串替换。特殊值 `*` 匹配任何 MIME 类型（0.8.29）。

## 原文档 ##

*  [http://nginx.org/en/docs/http/ngx\_http\_sub\_module.html][http_nginx.org_en_docs_http_ngx_http_sub_module.html]

[http_nginx.org_en_docs_http_ngx_http_stub_status_module.html]: http://nginx.org/en/docs/http/ngx_http_stub_status_module.html
[http_nginx.org_en_docs_http_ngx_http_sub_module.html]: http://nginx.org/en/docs/http/ngx_http_sub_module.html