Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_upstream_hc_module.xml @ 1946:37df1535ea91

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moved info from http "health_check" and "match" to intro.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 30 Mar 2017 21:26:44 +0300
parents 88477c5d2751
children 8f9c685dfabd
comparison
equal deleted inserted replaced
1945:88477c5d2751 1946:37df1535ea91
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Модуль ngx_http_upstream_hc_module" 9 <module name="Модуль ngx_http_upstream_hc_module"
10 link="/ru/docs/http/ngx_http_upstream_hc_module.html" 10 link="/ru/docs/http/ngx_http_upstream_hc_module.html"
11 lang="ru" 11 lang="ru"
12 rev="1"> 12 rev="2">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 Модуль <literal>ngx_http_upstream_hc_module</literal> 17 Модуль <literal>ngx_http_upstream_hc_module</literal>
18 позволяет активировать периодические проверки работоспособности серверов в 18 позволяет активировать периодические проверки работоспособности серверов в
19 <link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>, 19 <link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>,
20 указанной в содержащем location. 20 указанной в содержащем location.
21 Группа должна находиться в
22 <link doc="ngx_http_upstream_module.xml" id="zone">зоне разделяемой памяти</link>.
23 </para>
24
25 <para>
26 Если проверка работоспособности была неуспешной,
27 то сервер признаётся неработоспособным.
28 Если для группы задано несколько проверок,
29 то при любой неуспешной проверке соответствующий сервер будет
30 считаться неработоспособным.
31 На неработоспособные серверы и серверы в состоянии “checking”
32 клиентские запросы передаваться не будут.
33 </para>
34
35 <para>
36 <note>
37 Обратите внимание, что при использовании проверок
38 большинство переменных имеют пустые значения.
39 </note>
21 </para> 40 </para>
22 41
23 <para> 42 <para>
24 <note> 43 <note>
25 Модуль доступен как часть 44 Модуль доступен как часть
50 proxy_pass http://dynamic; 69 proxy_pass http://dynamic;
51 health_check; 70 health_check;
52 } 71 }
53 } 72 }
54 </example> 73 </example>
55 </para> 74 Каждому серверу группы <literal>backend</literal>
56
57 </section>
58
59
60 <section id="directives" name="Директивы">
61
62 <directive name="health_check">
63 <syntax>[<value>параметры</value>]</syntax>
64 <default/>
65 <context>location</context>
66
67 <para>
68 Активирует периодические проверки работоспособности серверов в
69 <link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>,
70 указанной в содержащем location.
71 </para>
72
73 <para>
74 Могут быть заданы следующие необязательные параметры:
75 <list type="tag">
76
77 <tag-name id="interval">
78 <literal>interval</literal>=<value>время</value>
79 </tag-name>
80 <tag-desc>
81 задаёт интервал между двумя последовательными проверками,
82 по умолчанию 5 секунд.
83 </tag-desc>
84
85 <tag-name id="health_check_jitter">
86 <literal>jitter</literal>=<value>время</value>
87 </tag-name>
88 <tag-desc>
89 задаёт время, в пределах которого
90 случайным образом задерживается каждая проверка,
91 по умолчанию задержки нет.
92 </tag-desc>
93
94 <tag-name id="fails">
95 <literal>fails</literal>=<value>число</value>
96 </tag-name>
97 <tag-desc>
98 задаёт число последовательных неуспешных проверок для определённого сервера,
99 после которых сервер будет считаться неработоспособным,
100 по умолчанию 1.
101 </tag-desc>
102
103 <tag-name id="passes">
104 <literal>passes</literal>=<value>число</value>
105 </tag-name>
106 <tag-desc>
107 задаёт число последовательных успешных проверок для определённого сервера,
108 после которых сервер будет считаться работоспособным,
109 по умолчанию 1.
110 </tag-desc>
111
112 <tag-name id="uri">
113 <literal>uri</literal>=<value>uri</value>
114 </tag-name>
115 <tag-desc>
116 задаёт URI, используемый в запросах, проверяющих работоспособность,
117 по умолчанию “<literal>/</literal>”.
118 </tag-desc>
119
120 <tag-name id="health_check_mandatory">
121 <literal>mandatory</literal>
122 </tag-name>
123 <tag-desc>
124 устанавливает исходное состояние “checking” для сервера
125 до завершения первой проверки работоспособности (1.11.7).
126 Если параметр не указан,
127 то исходно сервер будет считаться работоспособным.
128 </tag-desc>
129
130 <tag-name id="hc_match">
131 <literal>match</literal>=<value>имя</value>
132 </tag-name>
133 <tag-desc>
134 указывает на блок <literal>match</literal> с условиями, которым должен
135 удовлетворять ответ, чтобы результат проверки считался успешным.
136 По умолчанию код ответа должен быть 2xx или 3xx.
137 </tag-desc>
138
139 <tag-name id="health_check_port">
140 <literal>port</literal>=<value>число</value>
141 </tag-name>
142 <tag-desc>
143 задаёт порт, используемый при подключении к серверу
144 для проверки его работоспособности (1.9.7).
145 По умолчанию совпадает с портом
146 <link doc="ngx_http_upstream_module.xml" id="server">сервера</link>.
147 </tag-desc>
148
149 </list>
150 </para>
151
152 <para>
153 В примере
154 <example>
155 location / {
156 proxy_pass http://backend;
157 health_check;
158 }
159 </example>
160 каждому серверу группы <literal>backend</literal>
161 с интервалом в 5 секунд посылаются запросы “<literal>/</literal>”. 75 с интервалом в 5 секунд посылаются запросы “<literal>/</literal>”.
162 Если происходит ошибка или таймаут при работе с сервером, или 76 Если происходит ошибка или таймаут при работе с сервером, или
163 код ответа проксируемого сервера не равен 77 код ответа проксируемого сервера не равен
164 2xx или 3xx, проверка считается неуспешной и сервер 78 2xx или 3xx, проверка считается неуспешной и сервер
165 признаётся неработоспособным. 79 признаётся неработоспособным.
166 На неработоспособные серверы и серверы в состоянии “checking”
167 клиентские запросы передаваться не будут.
168 </para> 80 </para>
169 81
170 <para> 82 <para>
171 Проверки работоспособности могут тестировать код ответа, 83 Проверки работоспособности могут тестировать код ответа,
172 наличие или отсутствие определённых полей заголовка и их значений, 84 наличие или отсутствие определённых полей заголовка и их значений,
194 В такой конфигурации успешный ответ на проверочный запрос 106 В такой конфигурации успешный ответ на проверочный запрос
195 должен иметь код 200, тип содержимого “<literal>text/html</literal>” 107 должен иметь код 200, тип содержимого “<literal>text/html</literal>”
196 и “<literal>Welcome to nginx!</literal>” в теле ответа. 108 и “<literal>Welcome to nginx!</literal>” в теле ответа.
197 </para> 109 </para>
198 110
199 <para> 111 </section>
200 Группа должна находиться в 112
201 <link doc="ngx_http_upstream_module.xml" id="zone">зоне разделяемой памяти</link>. 113
202 </para> 114 <section id="directives" name="Директивы">
203 115
204 <para> 116 <directive name="health_check">
205 Если для группы задано несколько проверок, 117 <syntax>[<value>параметры</value>]</syntax>
206 то при любой неуспешной проверке соответствующий сервер будет 118 <default/>
207 считаться неработоспособным. 119 <context>location</context>
208 </para> 120
209 121 <para>
210 <para> 122 Активирует периодические проверки работоспособности серверов в
211 <note> 123 <link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>,
212 Обратите внимание, что при использовании проверок 124 указанной в содержащем location.
213 большинство переменных имеют пустые значения. 125 </para>
214 </note> 126
127 <para>
128 Могут быть заданы следующие необязательные параметры:
129 <list type="tag">
130
131 <tag-name id="interval">
132 <literal>interval</literal>=<value>время</value>
133 </tag-name>
134 <tag-desc>
135 задаёт интервал между двумя последовательными проверками,
136 по умолчанию 5 секунд.
137 </tag-desc>
138
139 <tag-name id="health_check_jitter">
140 <literal>jitter</literal>=<value>время</value>
141 </tag-name>
142 <tag-desc>
143 задаёт время, в пределах которого
144 случайным образом задерживается каждая проверка,
145 по умолчанию задержки нет.
146 </tag-desc>
147
148 <tag-name id="fails">
149 <literal>fails</literal>=<value>число</value>
150 </tag-name>
151 <tag-desc>
152 задаёт число последовательных неуспешных проверок для определённого сервера,
153 после которых сервер будет считаться неработоспособным,
154 по умолчанию 1.
155 </tag-desc>
156
157 <tag-name id="passes">
158 <literal>passes</literal>=<value>число</value>
159 </tag-name>
160 <tag-desc>
161 задаёт число последовательных успешных проверок для определённого сервера,
162 после которых сервер будет считаться работоспособным,
163 по умолчанию 1.
164 </tag-desc>
165
166 <tag-name id="uri">
167 <literal>uri</literal>=<value>uri</value>
168 </tag-name>
169 <tag-desc>
170 задаёт URI, используемый в запросах, проверяющих работоспособность,
171 по умолчанию “<literal>/</literal>”.
172 </tag-desc>
173
174 <tag-name id="health_check_mandatory">
175 <literal>mandatory</literal>
176 </tag-name>
177 <tag-desc>
178 устанавливает исходное состояние “checking” для сервера
179 до завершения первой проверки работоспособности (1.11.7).
180 Если параметр не указан,
181 то исходно сервер будет считаться работоспособным.
182 </tag-desc>
183
184 <tag-name id="hc_match">
185 <literal>match</literal>=<value>имя</value>
186 </tag-name>
187 <tag-desc>
188 указывает на блок <literal>match</literal> с условиями, которым должен
189 удовлетворять ответ, чтобы результат проверки считался успешным.
190 По умолчанию код ответа должен быть 2xx или 3xx.
191 </tag-desc>
192
193 <tag-name id="health_check_port">
194 <literal>port</literal>=<value>число</value>
195 </tag-name>
196 <tag-desc>
197 задаёт порт, используемый при подключении к серверу
198 для проверки его работоспособности (1.9.7).
199 По умолчанию совпадает с портом
200 <link doc="ngx_http_upstream_module.xml" id="server">сервера</link>.
201 </tag-desc>
202
203 </list>
215 </para> 204 </para>
216 205
217 </directive> 206 </directive>
218 207
219 208