comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 731:f62328124e5b

Documented $upstream_cache_status and $upstream_response_length variables.
author Vladimir Homutov <vl@nginx.com>
date Tue, 16 Oct 2012 07:36:26 +0000
parents 841118e33f41
children e26a18eb5ccd
comparison
equal deleted inserted replaced
730:76e876c58dc0 731:f62328124e5b
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="1"> 13 rev="2">
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
389 <link doc="ngx_http_core_module.xml" id="error_page"/> 389 <link doc="ngx_http_core_module.xml" id="error_page"/>
390 then these server groups are separated by colons, e.g. 390 then these server groups are separated by colons, e.g.
391 “<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>”. 391 “<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>”.
392 </tag-desc> 392 </tag-desc>
393 393
394 <tag-name><var>$upstream_cache_status</var></tag-name>
395 <tag-desc>
396 keeps status of accessing a response cache (0.8.3).
397 The status can be one of “<literal>MISS</literal>”, 
398 “<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”,
399 “<literal>STALE</literal>”, “<literal>UPDATING</literal>” or
400 “<literal>HIT</literal>”.
401 </tag-desc>
402
403 <tag-name><var>$upstream_response_length</var></tag-name>
404 <tag-desc>
405 keeps lengths of responses obtained from upstream servers (0.7.27);
406 lengths are kept in bytes.
407 Several responses are separated by commas and colons
408 like in the <var>$upstream_addr</var> variable.
409 </tag-desc>
410
394 <tag-name><var>$upstream_response_time</var></tag-name> 411 <tag-name><var>$upstream_response_time</var></tag-name>
395 <tag-desc> 412 <tag-desc>
396 keeps servers response times in seconds with a milliseconds resolution. 413 keeps times of responses obtained from upstream servers;
397 Several responses are also separated by commas and colons. 414 times are kept in seconds with a milliseconds resolution.
415 Several responses are separated by commas and colons
416 like in the <var>$upstream_addr</var> variable.
398 </tag-desc> 417 </tag-desc>
399 418
400 <tag-name><var>$upstream_status</var></tag-name> 419 <tag-name><var>$upstream_status</var></tag-name>
401 <tag-desc> 420 <tag-desc>
402 keeps servers response codes. 421 keeps codes of responses obtained from upstream servers.
403 Several responses are also separated by commas and colons. 422 Several responses are separated by commas and colons
423 like in the <var>$upstream_addr</var> variable.
404 </tag-desc> 424 </tag-desc>
405 425
406 <tag-name><var>$upstream_http_...</var></tag-name> 426 <tag-name><var>$upstream_http_...</var></tag-name>
407 <tag-desc> 427 <tag-desc>
408 keep server response header fields. 428 keep server response header fields.
409 For example, the <header>Server</header> response header field 429 For example, the <header>Server</header> response header field
410 is made available through the <var>$upstream_http_server</var> variable. 430 is made available through the <var>$upstream_http_server</var> variable.
411 Note that only the last server’s response header fields are saved. 431 The rules of converting header field names to variable names are the same
432 as for variables starting with the
433 “<link doc="ngx_http_core_module.xml" id="variables">$http_</link>” prefix.
434 Only the last server’s response header fields are saved.
412 </tag-desc> 435 </tag-desc>
413 436
414 </list> 437 </list>
415 </para> 438 </para>
416 439