Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_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 37df1535ea91
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_http_upstream_hc_module" 9 <module name="Module ngx_http_upstream_hc_module"
10 link="/en/docs/http/ngx_http_upstream_hc_module.html" 10 link="/en/docs/http/ngx_http_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_http_upstream_hc_module</literal> module 17 The <literal>ngx_http_upstream_hc_module</literal> module
126 126
127 <para> 127 <para>
128 The following optional parameters are supported: 128 The following optional parameters are supported:
129 <list type="tag"> 129 <list type="tag">
130 130
131 <tag-name id="interval"> 131 <tag-name id="health_check_interval">
132 <literal>interval</literal>=<value>time</value> 132 <literal>interval</literal>=<value>time</value>
133 </tag-name> 133 </tag-name>
134 <tag-desc> 134 <tag-desc>
135 sets the interval between two consecutive health checks, 135 sets the interval between two consecutive health checks,
136 by default, 5 seconds. 136 by default, 5 seconds.
143 sets the time within which 143 sets the time within which
144 each health check will be randomly delayed, 144 each health check will be randomly delayed,
145 by default, there is no delay. 145 by default, there is no delay.
146 </tag-desc> 146 </tag-desc>
147 147
148 <tag-name id="fails"> 148 <tag-name id="health_check_fails">
149 <literal>fails</literal>=<value>number</value> 149 <literal>fails</literal>=<value>number</value>
150 </tag-name> 150 </tag-name>
151 <tag-desc> 151 <tag-desc>
152 sets the number of consecutive failed health checks of a particular server 152 sets the number of consecutive failed health checks of a particular server
153 after which this server will be considered unhealthy, 153 after which this server will be considered unhealthy,
154 by default, 1. 154 by default, 1.
155 </tag-desc> 155 </tag-desc>
156 156
157 <tag-name id="passes"> 157 <tag-name id="health_check_passes">
158 <literal>passes</literal>=<value>number</value> 158 <literal>passes</literal>=<value>number</value>
159 </tag-name> 159 </tag-name>
160 <tag-desc> 160 <tag-desc>
161 sets the number of consecutive passed health checks of a particular server 161 sets the number of consecutive passed health checks of a particular server
162 after which the server will be considered healthy, 162 after which the server will be considered healthy,
163 by default, 1. 163 by default, 1.
164 </tag-desc> 164 </tag-desc>
165 165
166 <tag-name id="uri"> 166 <tag-name id="health_check_uri">
167 <literal>uri</literal>=<value>uri</value> 167 <literal>uri</literal>=<value>uri</value>
168 </tag-name> 168 </tag-name>
169 <tag-desc> 169 <tag-desc>
170 defines the URI used in health check requests, 170 defines the URI used in health check requests,
171 by default, “<literal>/</literal>”. 171 by default, “<literal>/</literal>”.
179 until the first health check is completed (1.11.7). 179 until the first health check is completed (1.11.7).
180 If the parameter is not specified, 180 If the parameter is not specified,
181 the server will be initially considered healthy. 181 the server will be initially considered healthy.
182 </tag-desc> 182 </tag-desc>
183 183
184 <tag-name id="hc_match"> 184 <tag-name id="health_check_match">
185 <literal>match</literal>=<value>name</value> 185 <literal>match</literal>=<value>name</value>
186 </tag-name> 186 </tag-name>
187 <tag-desc> 187 <tag-desc>
188 specifies the <literal>match</literal> block configuring the tests that a 188 specifies the <literal>match</literal> block configuring the tests that a
189 response should pass in order for a health check to pass. 189 response should pass in order for a health check to pass.