Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 2139:f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Mon, 09 Apr 2018 11:52:48 +0300 |
parents | 4cafd82e5007 |
children | 2c56f91c304a |
comparison
equal
deleted
inserted
replaced
2138:cf86c259c9a0 | 2139:f6e578b1b02d |
---|---|
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="69"> | 13 rev="70"> |
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 |
818 <literal>learn</literal> | 818 <literal>learn</literal> |
819 <literal>create=</literal><value>$variable</value> | 819 <literal>create=</literal><value>$variable</value> |
820 <literal>lookup=</literal><value>$variable</value> | 820 <literal>lookup=</literal><value>$variable</value> |
821 <literal>zone=</literal><value>name</value>:<value>size</value> | 821 <literal>zone=</literal><value>name</value>:<value>size</value> |
822 [<literal>timeout=</literal><value>time</value>] | 822 [<literal>timeout=</literal><value>time</value>] |
823 [<literal>header</literal>]</syntax> | 823 [<literal>header</literal>] |
824 [<literal>sync</literal>]</syntax> | |
824 <default/> | 825 <default/> |
825 <context>upstream</context> | 826 <context>upstream</context> |
826 <appeared-in>1.5.7</appeared-in> | 827 <appeared-in>1.5.7</appeared-in> |
827 | 828 |
828 <para> | 829 <para> |
998 </para> | 999 </para> |
999 | 1000 |
1000 <para> | 1001 <para> |
1001 Sessions are stored in a shared memory zone, whose <value>name</value> and | 1002 Sessions are stored in a shared memory zone, whose <value>name</value> and |
1002 <value>size</value> are configured by the <literal>zone</literal> parameter. | 1003 <value>size</value> are configured by the <literal>zone</literal> parameter. |
1003 One megabyte zone can store about 8000 sessions on the 64-bit platform. | 1004 One megabyte zone can store about 4000 sessions on the 64-bit platform. |
1004 The sessions that are not accessed during the time specified by the | 1005 The sessions that are not accessed during the time specified by the |
1005 <literal>timeout</literal> parameter get removed from the zone. | 1006 <literal>timeout</literal> parameter get removed from the zone. |
1006 By default, <literal>timeout</literal> is set to 10 minutes. | 1007 By default, <literal>timeout</literal> is set to 10 minutes. |
1007 </para> | 1008 </para> |
1008 | 1009 |
1009 <para id="sticky_learn_header"> | 1010 <para id="sticky_learn_header"> |
1010 The <literal>header</literal> parameter (1.13.1) allows creating a session | 1011 The <literal>header</literal> parameter (1.13.1) allows creating a session |
1011 right after receiving response headers from the upstream server. | 1012 right after receiving response headers from the upstream server. |
1013 </para> | |
1014 | |
1015 <para id="sticky_learn_sync"> | |
1016 The <literal>sync</literal> parameter (1.13.8) enables | |
1017 <link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link> | |
1018 of the shared memory zone. | |
1012 </para> | 1019 </para> |
1013 | 1020 |
1014 </tag-desc> | 1021 </tag-desc> |
1015 </list> | 1022 </list> |
1016 </para> | 1023 </para> |
1131 as for the variables that start with the | 1138 as for the variables that start with the |
1132 “<link doc="ngx_http_core_module.xml" id="var_http_">$http_</link>” prefix. | 1139 “<link doc="ngx_http_core_module.xml" id="var_http_">$http_</link>” prefix. |
1133 Only the header fields from the response of the last server are saved. | 1140 Only the header fields from the response of the last server are saved. |
1134 </tag-desc> | 1141 </tag-desc> |
1135 | 1142 |
1143 <tag-name id="var_upstream_queue_time"><var>$upstream_queue_time</var></tag-name> | |
1144 <tag-desc> | |
1145 keeps time the request spent in the upstream <link id="queue">queue</link> | |
1146 (1.13.9); | |
1147 the time is kept in seconds with millisecond resolution. | |
1148 Times of several responses | |
1149 are separated by commas and colons like addresses in the | |
1150 <link id="var_upstream_addr">$upstream_addr</link> variable. | |
1151 </tag-desc> | |
1152 | |
1136 <tag-name id="var_upstream_response_length"><var>$upstream_response_length</var> | 1153 <tag-name id="var_upstream_response_length"><var>$upstream_response_length</var> |
1137 </tag-name> | 1154 </tag-name> |
1138 <tag-desc> | 1155 <tag-desc> |
1139 keeps the length of the response obtained from the upstream server (0.7.27); | 1156 keeps the length of the response obtained from the upstream server (0.7.27); |
1140 the length is kept in bytes. | 1157 the length is kept in bytes. |