Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_upstream_hc_module.xml @ 1948:25962922969a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moved info from stream "health_check" to intro.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 24 Mar 2017 19:53:23 +0300
parents 6b6d0e844bf7
children 8f9c685dfabd
comparison
equal deleted inserted replaced
1947:6b6d0e844bf7 1948:25962922969a
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_upstream_hc_module" 9 <module name="Module ngx_stream_upstream_hc_module"
10 link="/en/docs/stream/ngx_stream_upstream_hc_module.html" 10 link="/en/docs/stream/ngx_stream_upstream_hc_module.html"
11 lang="en" 11 lang="en"
12 rev="1"> 12 rev="2">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_upstream_hc_module</literal> module (1.9.0) 17 The <literal>ngx_stream_upstream_hc_module</literal> module (1.9.0)
20 The server group must reside in the 20 The server group must reside in the
21 <link doc="ngx_stream_upstream_module.xml" id="zone">shared memory</link>. 21 <link doc="ngx_stream_upstream_module.xml" id="zone">shared memory</link>.
22 </para> 22 </para>
23 23
24 <para> 24 <para>
25 If a health check fails, the server will be considered unhealthy.
26 If several health checks are defined for the same group of servers,
27 a single failure of any check will make the corresponding server be
28 considered unhealthy.
29 Client connections are not passed to unhealthy servers
30 and servers in the “checking” state.
31 </para>
32
33 <para>
25 <note> 34 <note>
26 This module is available as part of our 35 This module is available as part of our
27 <commercial_version>commercial subscription</commercial_version>. 36 <commercial_version>commercial subscription</commercial_version>.
28 </note> 37 </note>
29 </para> 38 </para>
50 listen 12346; 59 listen 12346;
51 proxy_pass tcp; 60 proxy_pass tcp;
52 health_check; 61 health_check;
53 } 62 }
54 </example> 63 </example>
64 With this configuration, nginx
65 will check the ability to establish a TCP connection to each server
66 in the <literal>tcp</literal> group every five seconds.
67 When a connection to the server cannot be established,
68 the health check will fail, and the server will
69 be considered unhealthy.
70 </para>
71
72 <para>
73 Health checks can also be configured to test data obtained from the server.
74 Tests are configured separately using the <link id="match"/> directive
75 and referenced in the <literal>match</literal> parameter
76 of the <link id="health_check"/> directive.
55 </para> 77 </para>
56 78
57 </section> 79 </section>
58 80
59 81
156 </tag-desc> 178 </tag-desc>
157 179
158 </list> 180 </list>
159 </para> 181 </para>
160 182
161 <para>
162 For example,
163 <example>
164 server {
165 proxy_pass backend;
166 health_check;
167 }
168 </example>
169 will check the ability to establish a TCP connection to each server
170 in the <literal>backend</literal> group every five seconds.
171 When a connection to the server cannot be established,
172 the health check will fail, and the server will
173 be considered unhealthy.
174 Client connections are not passed to unhealthy servers
175 and servers in the “checking” state.
176 </para>
177
178 <para>
179 Health checks can also be configured to test data obtained from the server.
180 Tests are configured separately using the <link id="match"/> directive
181 and referenced in the <literal>match</literal> parameter.
182 </para>
183
184 <para>
185 The server group must reside in the
186 <link doc="ngx_stream_upstream_module.xml" id="zone">shared memory</link>.
187 </para>
188
189 <para>
190 If several health checks are defined for the same group of servers,
191 a single failure of any check will make the corresponding server be
192 considered unhealthy.
193 </para>
194
195 </directive> 183 </directive>
196 184
197 185
198 <directive name="health_check_timeout"> 186 <directive name="health_check_timeout">
199 <syntax><value>timeout</value></syntax> 187 <syntax><value>timeout</value></syntax>