Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 1155:07402a11fd8d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Assigned IDs to tags describing variables.
author Vladimir Homutov <vl@nginx.com>
date Wed, 16 Apr 2014 13:55:53 +0400
parents 1594ed379f1f
children b8f0362f61e5
comparison
equal deleted inserted replaced
1154:b0e56cc57867 1155:07402a11fd8d
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_upstream_module" 10 <module name="Module ngx_http_upstream_module"
11 link="/en/docs/http/ngx_http_upstream_module.html" 11 link="/en/docs/http/ngx_http_upstream_module.html"
12 lang="en" 12 lang="en"
13 rev="19"> 13 rev="20">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_upstream_module</literal> module 18 The <literal>ngx_http_upstream_module</literal> module
1166 <para> 1166 <para>
1167 The <literal>ngx_http_upstream_module</literal> module 1167 The <literal>ngx_http_upstream_module</literal> module
1168 supports the following embedded variables: 1168 supports the following embedded variables:
1169 <list type="tag"> 1169 <list type="tag">
1170 1170
1171 <tag-name><var>$upstream_addr</var></tag-name> 1171 <tag-name id="var_upstream_addr"><var>$upstream_addr</var></tag-name>
1172 <tag-desc> 1172 <tag-desc>
1173 keeps the IP address and port of the server, 1173 keeps the IP address and port of the server,
1174 or the path to the UNIX-domain socket. 1174 or the path to the UNIX-domain socket.
1175 If several servers were contacted during request processing, 1175 If several servers were contacted during request processing,
1176 their addresses are separated by commas, e.g. 1176 their addresses are separated by commas, e.g.
1181 <link doc="ngx_http_core_module.xml" id="error_page"/>, 1181 <link doc="ngx_http_core_module.xml" id="error_page"/>,
1182 then the server addresses from different groups are separated by colons, e.g. 1182 then the server addresses from different groups are separated by colons, e.g.
1183 “<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock : 192.168.10.1:80, 192.168.10.2:80</literal>”. 1183 “<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock : 192.168.10.1:80, 192.168.10.2:80</literal>”.
1184 </tag-desc> 1184 </tag-desc>
1185 1185
1186 <tag-name><var>$upstream_cache_status</var></tag-name> 1186 <tag-name id="var_upstream_cache_status"><var>$upstream_cache_status</var>
1187 </tag-name>
1187 <tag-desc> 1188 <tag-desc>
1188 keeps the status of accessing a response cache (0.8.3). 1189 keeps the status of accessing a response cache (0.8.3).
1189 The status can be either “<literal>MISS</literal>”, 1190 The status can be either “<literal>MISS</literal>”,
1190 “<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”, 1191 “<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”,
1191 “<literal>STALE</literal>”, “<literal>UPDATING</literal>”, 1192 “<literal>STALE</literal>”, “<literal>UPDATING</literal>”,
1192 “<literal>REVALIDATED</literal>” or “<literal>HIT</literal>”. 1193 “<literal>REVALIDATED</literal>” or “<literal>HIT</literal>”.
1193 </tag-desc> 1194 </tag-desc>
1194 1195
1195 <tag-name><var>$upstream_response_length</var></tag-name> 1196 <tag-name id="var_upstream_response_length"><var>$upstream_response_length</var>
1197 </tag-name>
1196 <tag-desc> 1198 <tag-desc>
1197 keeps the lengths of responses obtained from the upstream servers (0.7.27); 1199 keeps the lengths of responses obtained from the upstream servers (0.7.27);
1198 lengths are kept in bytes. 1200 lengths are kept in bytes.
1199 Several response lengths are separated by commas and colons 1201 Several response lengths are separated by commas and colons
1200 like addresses in the <var>$upstream_addr</var> variable. 1202 like addresses in the <var>$upstream_addr</var> variable.
1201 </tag-desc> 1203 </tag-desc>
1202 1204
1203 <tag-name><var>$upstream_response_time</var></tag-name> 1205 <tag-name id="var_upstream_response_time"><var>$upstream_response_time</var>
1206 </tag-name>
1204 <tag-desc> 1207 <tag-desc>
1205 keeps times of responses obtained from upstream servers; 1208 keeps times of responses obtained from upstream servers;
1206 times are kept in seconds with a milliseconds resolution. 1209 times are kept in seconds with a milliseconds resolution.
1207 Several response times are separated by commas and colons 1210 Several response times are separated by commas and colons
1208 like addresses in the <var>$upstream_addr</var> variable. 1211 like addresses in the <var>$upstream_addr</var> variable.
1209 </tag-desc> 1212 </tag-desc>
1210 1213
1211 <tag-name><var>$upstream_status</var></tag-name> 1214 <tag-name id="var_upstream_status"><var>$upstream_status</var></tag-name>
1212 <tag-desc> 1215 <tag-desc>
1213 keeps codes of responses obtained from upstream servers. 1216 keeps codes of responses obtained from upstream servers.
1214 Several response codes are separated by commas and colons 1217 Several response codes are separated by commas and colons
1215 like addresses in the <var>$upstream_addr</var> variable. 1218 like addresses in the <var>$upstream_addr</var> variable.
1216 </tag-desc> 1219 </tag-desc>
1217 1220
1218 <tag-name><var>$upstream_http_...</var></tag-name> 1221 <tag-name id="var_upstream_http_"><var>$upstream_http_...</var></tag-name>
1219 <tag-desc> 1222 <tag-desc>
1220 keep server response header fields. 1223 keep server response header fields.
1221 For example, the <header>Server</header> response header field 1224 For example, the <header>Server</header> response header field
1222 is available through the <var>$upstream_http_server</var> variable. 1225 is available through the <var>$upstream_http_server</var> variable.
1223 The rules of converting header field names to variable names are the same 1226 The rules of converting header field names to variable names are the same