Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_upstream_hc_module.xml @ 1949:8f9c685dfabd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated IDs in "health_check" directives.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 30 Mar 2017 21:26:44 +0300
parents 25962922969a
children ef22a80a2696
comparison
equal deleted inserted replaced
1948:25962922969a 1949:8f9c685dfabd
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="2"> 12 rev="3">
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)
93 93
94 <para> 94 <para>
95 The following optional parameters are supported: 95 The following optional parameters are supported:
96 <list type="tag"> 96 <list type="tag">
97 97
98 <tag-name id="interval"> 98 <tag-name id="health_check_interval">
99 <literal>interval</literal>=<value>time</value> 99 <literal>interval</literal>=<value>time</value>
100 </tag-name> 100 </tag-name>
101 <tag-desc> 101 <tag-desc>
102 sets the interval between two consecutive health checks, 102 sets the interval between two consecutive health checks,
103 by default, 5 seconds. 103 by default, 5 seconds.
110 sets the time within which 110 sets the time within which
111 each health check will be randomly delayed, 111 each health check will be randomly delayed,
112 by default, there is no delay. 112 by default, there is no delay.
113 </tag-desc> 113 </tag-desc>
114 114
115 <tag-name id="fails"> 115 <tag-name id="health_check_fails">
116 <literal>fails</literal>=<value>number</value> 116 <literal>fails</literal>=<value>number</value>
117 </tag-name> 117 </tag-name>
118 <tag-desc> 118 <tag-desc>
119 sets the number of consecutive failed health checks of a particular server 119 sets the number of consecutive failed health checks of a particular server
120 after which this server will be considered unhealthy, 120 after which this server will be considered unhealthy,
121 by default, 1. 121 by default, 1.
122 </tag-desc> 122 </tag-desc>
123 123
124 <tag-name id="passes"> 124 <tag-name id="health_check_passes">
125 <literal>passes</literal>=<value>number</value> 125 <literal>passes</literal>=<value>number</value>
126 </tag-name> 126 </tag-name>
127 <tag-desc> 127 <tag-desc>
128 sets the number of consecutive passed health checks of a particular server 128 sets the number of consecutive passed health checks of a particular server
129 after which the server will be considered healthy, 129 after which the server will be considered healthy,
138 until the first health check is completed (1.11.7). 138 until the first health check is completed (1.11.7).
139 If the parameter is not specified, 139 If the parameter is not specified,
140 the server will be initially considered healthy. 140 the server will be initially considered healthy.
141 </tag-desc> 141 </tag-desc>
142 142
143 <tag-name id="hc_match"> 143 <tag-name id="health_check_match">
144 <literal>match</literal>=<value>name</value> 144 <literal>match</literal>=<value>name</value>
145 </tag-name> 145 </tag-name>
146 <tag-desc> 146 <tag-desc>
147 specifies the <literal>match</literal> block configuring the tests that a 147 specifies the <literal>match</literal> block configuring the tests that a
148 successful connection should pass in order for a health check to pass. 148 successful connection should pass in order for a health check to pass.