Skip to content

Commit 9da86b3

Browse files
oopsguyoopsguy
committed
Update stream section
1 parent e7c481d commit 9da86b3

File tree

4 files changed

+532
-3
lines changed

4 files changed

+532
-3
lines changed

‎SUMMARY.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
- [ngx_stream_ssl_module](模块参考/stream/ngx_stream_ssl_module.md)
116116
- [ngx_stream_ssl_preread_module](模块参考/stream/ngx_stream_ssl_preread_module.md)
117117
- [ngx_stream_upstream_module](模块参考/stream/ngx_stream_upstream_module.md)
118-
- ngx_stream_upstream_hc_module
119-
- ngx_stream_zone_sync_module
118+
- [ngx_stream_upstream_hc_module](模块参考/stream/ngx_stream_upstream_hc_module.md)
119+
- [ngx_stream_zone_sync_module](模块参考/stream/ngx_stream_zone_sync_module.md)
120120
- 其他
121121
- [ngx_google_perftools_module](模块参考/google/ngx_google_perftools_module.md)

‎模块参考/stream/ngx_stream_ssl_module.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ openssl rand 80> ticket.key
411411
412412
- `$ssl_client_s_dn`
413413
414-
返回建立的SSL连接的客户端证书的 [RFC 2253](https://tools.ietf.org/html/rfc2253) **subject DN** 字符串（1.11.8）
414+
返回已建立的 SSL 连接的客户端证书的 [RFC 2253](https://tools.ietf.org/html/rfc2253) **subject DN** 字符串（1.11.8）
415415
416416
- `$ssl_client_serial`
417417

‎模块参考/stream/ngx_stream_upstream_hc_module.md‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# ngx_stream_upstream_hc_module
2+
3+
- [示例配置](#example_configuration)
4+
- [指令](#directives)
5+
- [health_check](#health_check)
6+
- [health_check_timeout](#health_check_timeout)
7+
- [match](#match)
8+
9+
`ngx_stream_upstream_hc_module` 模块（1.9.0）允许对[组](ngx_stream_upstream_module.md#upstream)中服务器启用定期健康检查。服务器组必须驻留在[共享内存](ngx_stream_upstream_module.md#zone)中。
10+
11+
如果健康检查失败，则服务器将被视为不可用。如果为同一组服务器定义了多个健康检查，则任何一次检查失败都会使相应的服务器不可用。客户端连接不会传递给不可用的服务器，并且服务器不会处于「检查」状态。
12+
13+
> 此模块为[商业订阅](http://nginx.com/products/?_ga=2.131045135.1858436578.1589555275-1645619674.1589555275)部分。
14+
15+
<a id="example_configuration"></a>
16+
17+
## 示例配置
18+
19+
```nginx
20+
upstream tcp {
21+
zone upstream_tcp 64k;
22+
23+
server backend1.example.com:12345 weight=5;
24+
server backend2.example.com:12345 fail_timeout=5s slow_start=30s;
25+
server 192.0.2.1:12345 max_fails=3;
26+
27+
server backup1.example.com:12345 backup;
28+
server backup2.example.com:12345 backup;
29+
}
30+
31+
server {
32+
listen 12346;
33+
proxy_pass tcp;
34+
health_check;
35+
}
36+
```
37+
38+
使用此配置，nginx 将每 5 秒钟检查是否能与 tcp 组中的每个服务器建立 TCP 连接。如果无法与服务器建立连接，则健康检查将失败，并且服务器将被视为不可用。
39+
40+
可以为 UDP 协议配置健康检查：
41+
42+
```nginx
43+
upstream dns_upstream {
44+
45+
zone dns_zone 64k;
46+
47+
server dns1.example.com:53;
48+
server dns2.example.com:53;
49+
server dns3.example.com:53;
50+
}
51+
52+
server {
53+
listen 53 udp;
54+
proxy_pass dns_upstream;
55+
health_check udp;
56+
}
57+
```
58+
59+
在这种情况下，nginx 将发送 `nginx health check` 字符串，期望得到的响应中没有 ICMP `Destination Unreachable` 消息。
60+
61+
健康检查也可以配置为[测试](#match)从服务器获得的数据。使用 `match` 指令单独配置测试规则，并在 [health_check](#health_check) 指令的 `match` 参数中引用测试规则。
62+
63+
<a id="directives"></a>
64+
65+
## 指令
66+
67+
### health_check
68+
69+
|\-|说明|
70+
|------:|------|
71+
|**语法**|**health_check** `[parameters]`;|
72+
|**默认**|——|
73+
|**上下文**|server|
74+
75+
对[组](ngx_stream_upstream_module.md#upstream)中服务器启用定期健康检查。
76+
77+
支持以下可选参数：
78+
79+
- `interval=time`
80+
81+
设置两次连续运行健康检查之间的间隔时间，默认为 5 秒。
82+
83+
- `jitter=time`
84+
85+
设置每次运行健康检查将随机延迟的时间，默认没有延迟。
86+
87+
- `fails=number`
88+
89+
设置指定服务器在连续运行健康检查失败次数达到 `number` 后，将被视为不可用，默认为 1。
90+
91+
- `passes=number`
92+
93+
设置指定服务器在连续通过健康检查次数达到 `number` 后，将被视为健康，默认为 1。
94+
95+
- `mandatory`
96+
97+
设置服务器的初始「检查中」（checking）状态，直到完成第一次健康检查运行（1.11.7）。客户端连接不会以「检查中」的状态传递到服务器。如果未指定该参数，则服务器初始状态将被视为健康。
98+
99+
- `match=name`
100+
101+
指定 `match` 块，该匹配块配置健康检查中正常的连接必须要通过的测试。默认情况下，对于 TCP，仅检查与服务器建立 TCP 的连接。对于 [UDP](#health_check_udp)，nginx 发送 `nginx health check` 字符串，期望得到的响应不应存在 ICMP `Destination Unreachable` 消息。
102+
103+
> 在 1.11.7 版本之前，默认情况下，UDP 运行健康检查需要带有 [send](#match_send) 和 [expect](#match_expect) 参数的 [match](#hc_match) 块。
104+
105+
- `port=number`
106+
107+
定义连接到服务器执行健康检查（1.9.7）时使用的端口，默认等于[服务器](ngx_stream_upstream_module.md#server)端口。
108+
109+
- `udp`
110+
111+
指定将 UDP 协议代替默认的 TCP 协议（1.9.13）用于健康检查。
112+
113+
### health_check_timeout
114+
115+
|\-|说明|
116+
|------:|------|
117+
|**语法**|**health_check_timeout** `name { ... }`;|
118+
|**默认**|——|
119+
|**上下文**|stream|
120+
121+
覆盖用于健康检查的 [proxy_timeout](ngx_stream_proxy_module.md#proxy_timeout) 值。
122+
123+
### match
124+
125+
|\-|说明|
126+
|------:|------|
127+
|**语法**|**match** `name { ... }`;|
128+
|**默认**|——|
129+
|**上下文**|stream|
130+
131+
定义用于验证对服务器运行健康检查返回的响应的具名测试集。
132+
133+
可以配置以下参数：
134+
135+
- `send string;`
136+
137+
向服务器发送一个 `string`（字符串）
138+
139+
- `expect string | ~ regex;`
140+
141+
从服务器获得的数据应匹配的文字字符串（1.9.12）或正则表达式。正则表达式以前 `~*` 修饰符（不区分大小写）或 `~` 修饰符（不区分大小写）指定。
142+
143+
`send` 和 `expect` 参数都可以包含带有 `\x` 前缀的十六进制文字，后跟两个十六进制数字，例如 `\x80`（1.9.12）。
144+
145+
如果满足以下条件，则通过健康检查：
146+
147+
- TCP 连接建立成功
148+
- 发送了来自 `send` 参数的 `string`（如果已指定）
149+
- 将从服务器获取的数据与来自 `expect` 参数的字符串或正则表达式匹配（如果已指定）
150+
- 经过的时间不超过 [health_check_timeout](#health_check_timeout) 指令中指定的值
151+
152+
示例：
153+
154+
```nginx
155+
upstream backend {
156+
zone upstream_backend 10m;
157+
server 127.0.0.1:12345;
158+
}
159+
160+
match http {
161+
send "GET / HTTP/1.0\r\nHost: localhost\r\n\r\n";
162+
expect ~ "200 OK";
163+
}
164+
165+
server {
166+
listen 12346;
167+
proxy_pass backend;
168+
health_check match=http;
169+
}
170+
```
171+
172+
> 仅检查从服务器获得的数据的首个 [proxy_buffer_size](ngx_stream_proxy_module.md#proxy_buffer_size) 字节。
173+
174+
## 原文档
175+
176+
[http://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html](http://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html)

0 commit comments

Comments
 (0)