nginx-site: xml/en/docs/http/ngx_http_upstream

annotate xml/en/docs/http/ngx_http_upstream_module.xml @ 1800:9d722e4153ab

Documented the "max_conns" parameter as opensource.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Wed, 28 Sep 2016 20:25:42 +0300
parents	031566771bbd
children	592f9fa804f6

rev	line source
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	3 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	6 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 566 diff changeset	7
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 <module name="Module ngx_http_upstream_module"
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 link="/en/docs/http/ngx_http_upstream_module.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	12 lang="en"
1800 9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	13 rev="50">
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="summary">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 The <literal>ngx_http_upstream_module</literal> module
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	19 is used to define groups of servers that can be referenced
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	20 by the <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>,
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1155 diff changeset	21 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1186 diff changeset	22 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>,
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1155 diff changeset	23 <link doc="ngx_http_scgi_module.xml" id="scgi_pass"/>, and
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	24 <link doc="ngx_http_memcached_module.xml" id="memcached_pass"/> directives.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 <section id="example" name="Example Configuration">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 <example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 upstream <emphasis>backend</emphasis> {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 server backend1.example.com weight=5;
1424 410e0683b6b4 Rolled back changes in the example of the upstream module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1423 diff changeset	36 server backend2.example.com:8080;
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 server unix:/tmp/backend3;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 server backup1.example.com:8080 backup;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 server backup2.example.com:8080 backup;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 server {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 location / {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 proxy_pass http://<emphasis>backend</emphasis>;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 </example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	51 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	52 Dynamically configurable group,
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	53 available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	54 <commercial_version>commercial subscription</commercial_version>:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	55 <example>
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	56 resolver 10.0.0.1;
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	57
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	58 upstream <emphasis>dynamic</emphasis> {
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	59 zone upstream_dynamic 64k;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	60
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	61 server backend1.example.com weight=5;
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	62 server backend2.example.com:8080 fail_timeout=5s slow_start=30s;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	63 server 192.0.2.1 max_fails=3;
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	64 server backend3.example.com resolve;
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	65 server backend4.example.com service=http resolve;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	66
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	67 server backup1.example.com:8080 backup;
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	68 server backup2.example.com:8080 backup;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	69 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	70
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	71 server {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	72 location / {
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	73 proxy_pass http://<emphasis>dynamic</emphasis>;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	74 health_check;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	75 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	76 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	77 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	78 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	79
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 <section id="directives" name="Directives">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	85 <directive name="upstream">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	86 <syntax block="yes"><value>name</value></syntax>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	87 <default/>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	88 <context>http</context>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	89
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	90 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	91 Defines a group of servers.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	92 Servers can listen on different ports.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	93 In addition, servers listening on TCP and UNIX-domain sockets
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	94 can be mixed.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	95 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	96
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	97 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	98 Example:
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	99 <example>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	100 upstream backend {
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	101 server backend1.example.com weight=5;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	102 server 127.0.0.1:8080 max_fails=3 fail_timeout=30s;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	103 server unix:/tmp/backend3;
1126 2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	104
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	105 server backup1.example.com backup;
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	106 }
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	107 </example>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	108 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	109
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	110 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	111 By default, requests are distributed between the servers using a
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	112 weighted round-robin balancing method.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	113 In the above example, each 7 requests will be distributed as follows:
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	114 5 requests go to <literal>backend1.example.com</literal>
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	115 and one request to each of the second and third servers.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	116 If an error occurs during communication with a server, the request will
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	117 be passed to the next server, and so on until all of the functioning
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	118 servers will be tried.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	119 If a successful response could not be obtained from any of the servers,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	120 the client will receive the result of the communication with the last server.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	121 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	122
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	123 </directive>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	124
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	125
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	126 <directive name="server">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	127 <syntax><value>address</value> [<value>parameters</value>]</syntax>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	128 <default/>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	129 <context>upstream</context>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	130
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	131 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	132 Defines the <value>address</value> and other <value>parameters</value>
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	133 of a server.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	134 The address can be specified as a domain name or IP address,
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	135 with an optional port, or as a UNIX-domain socket path
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	136 specified after the “<literal>unix:</literal>” prefix.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	137 If a port is not specified, the port 80 is used.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	138 A domain name that resolves to several IP addresses defines
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	139 multiple servers at once.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	140 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	141
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	142 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	143 The following parameters can be defined:
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	144 <list type="tag">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	145
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	146 <tag-name id="weight">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	147 <literal>weight</literal>=<value>number</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	148 </tag-name>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	149 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	150 sets the weight of the server, by default, 1.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	151 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	152
1800 9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	153 <tag-name id="max_conns">
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	154 <literal>max_conns</literal>=<value>number</value>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	155 </tag-name>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	156 <tag-desc>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	157 limits the maximum <value>number</value> of simultaneous active
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	158 connections to the proxied server (1.11.5).
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	159 Default value is zero, meaning there is no limit.
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	160 <note>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	161 When <link id="keepalive"/> connections and multiple
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	162 <link doc="../ngx_core_module.xml" id="worker_processes">workers</link>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	163 are enabled,
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	164 the total number of connections to the proxied server
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	165 may exceed the <literal>max_conns</literal> value.
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	166 </note>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	167 <note>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	168 Since version 1.5.9 and prior to version 1.11.5,
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	169 this parameter was available as part of our
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	170 <commercial_version>commercial subscription</commercial_version>.
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	171 </note>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	172 </tag-desc>
9d722e4153ab Documented the "max_conns" parameter as opensource. Yaroslav Zhuravlev <yar@nginx.com> parents: 1783 diff changeset	173
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	174 <tag-name id="max_fails">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	175 <literal>max_fails</literal>=<value>number</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	176 </tag-name>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	177 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	178 sets the number of unsuccessful attempts to communicate with the server
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	179 that should happen in the duration set by the <literal>fail_timeout</literal>
968 fa19bacf6e1e Unified upstream server up/down state terminology. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	180 parameter to consider the server unavailable for a duration also set by the
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	181 <literal>fail_timeout</literal> parameter.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	182 By default, the number of unsuccessful attempts is set to 1.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	183 The zero value disables the accounting of attempts.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	184 What is considered an unsuccessful attempt is defined by the
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	185 <link doc="ngx_http_proxy_module.xml" id="proxy_next_upstream"/>,
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1155 diff changeset	186 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_next_upstream"/>,
1194 9264fdb6c833 Added links to uwsgi. Ruslan Ermilov <ru@nginx.com> parents: 1186 diff changeset	187 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_next_upstream"/>,
1181 b8f0362f61e5 Added links to scgi. Yaroslav Zhuravlev <yar@nginx.com> parents: 1155 diff changeset	188 <link doc="ngx_http_scgi_module.xml" id="scgi_next_upstream"/>, and
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	189 <link doc="ngx_http_memcached_module.xml" id="memcached_next_upstream"/>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	190 directives.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	191 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	192
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	193 <tag-name id="fail_timeout">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	194 <literal>fail_timeout</literal>=<value>time</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	195 </tag-name>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	196 <tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	197 sets
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	198 <list type="bullet">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	199
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	200 <listitem>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	201 the time during which the specified number of unsuccessful attempts to
968 fa19bacf6e1e Unified upstream server up/down state terminology. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	202 communicate with the server should happen to consider the server unavailable;
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	203 </listitem>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	204
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	205 <listitem>
968 fa19bacf6e1e Unified upstream server up/down state terminology. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	206 and the period of time the server will be considered unavailable.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	207 </listitem>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	208
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	209 </list>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	210 By default, the parameter is set to 10 seconds.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	211 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	212
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	213 <tag-name id="backup">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	214 <literal>backup</literal>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	215 </tag-name>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	216 <tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	217 marks the server as a backup server.
968 fa19bacf6e1e Unified upstream server up/down state terminology. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	218 It will be passed requests when the primary servers are unavailable.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	219 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	220
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	221 <tag-name id="down">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	222 <literal>down</literal>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	223 </tag-name>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	224 <tag-desc>
1410 f5dcc23b214f Deleted info about hash and ip_hash from the down parameter. Yaroslav Zhuravlev <yar@nginx.com> parents: 1393 diff changeset	225 marks the server as permanently unavailable.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	226 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	227
1126 2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	228 </list>
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	229 </para>
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	230
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	231 <para>
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	232 Additionally,
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	233 the following parameters are available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	234 <commercial_version>commercial subscription</commercial_version>:
1126 2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	235 <list type="tag">
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	236
1124 d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	237 <tag-name id="resolve">
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	238 <literal>resolve</literal>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	239 </tag-name>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	240 <tag-desc>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	241 monitors changes of the IP addresses
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	242 that correspond to a domain name of the server,
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	243 and automatically modifies the upstream configuration
1127 948c853f5d22 Upstream: improved "server resolve". Ruslan Ermilov <ru@nginx.com> parents: 1126 diff changeset	244 without the need of restarting nginx (1.5.12).
1581 201bf8fa69e5 Added shared memory requirement to resolver in http and stream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1561 diff changeset	245 The server group must reside in the <link id="zone">shared memory</link>.
1124 d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	246 <para>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	247 In order for this parameter to work,
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	248 the <link doc="ngx_http_core_module.xml" id="resolver"/> directive
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	249 must be specified in the
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	250 <link doc="ngx_http_core_module.xml" id="http"/> block.
1127 948c853f5d22 Upstream: improved "server resolve". Ruslan Ermilov <ru@nginx.com> parents: 1126 diff changeset	251 Example:
1124 d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	252 <example>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	253 http {
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	254 resolver 10.0.0.1;
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	255
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	256 upstream u {
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	257 zone ...;
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	258 ...
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	259 server example.com resolve;
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	260 }
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	261 }
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	262 </example>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	263 </para>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	264 </tag-desc>
d790333947f4 Upstream: the "resolve" parameter of the "server" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1123 diff changeset	265
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	266 <tag-name id="route">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	267 <literal>route</literal>=<value>string</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	268 </tag-name>
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	269 <tag-desc>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	270 sets the server route name.
1126 2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	271 </tag-desc>
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	272
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	273 <tag-name id="service">
1700 1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	274 <literal>service</literal>=<value>name</value>
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	275 </tag-name>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	276 <tag-desc>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	277 enables resolving of DNS
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	278 <link url="https://tools.ietf.org/html/rfc2782">SRV</link>
1700 1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	279 records and sets the service <value>name</value> (1.9.13).
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	280 In order for this parameter to work, it is necessary to specify
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	281 the <link id="resolve"/> parameter for the server
1700 1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	282 and specify a hostname without a port number.
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	283 <para>
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	284 If the service name does not contain a dot (“<literal>.</literal>”), then
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	285 the <link url="https://tools.ietf.org/html/rfc2782">RFC</link>-compliant name
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	286 is constructed
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	287 and the TCP protocol is added to the service prefix.
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	288 For example, to look up the
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	289 <literal>_http._tcp.backend.example.com</literal> SRV record,
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	290 it is necessary to specify the directive:
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	291 <example>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	292 server backend.example.com service=http resolve;
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	293 </example>
1700 1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	294 If the service name contains one or more dots, then the name is constructed
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	295 by joining the service prefix and the server name.
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	296 For example, to look up the <literal>_http._tcp.backend.example.com</literal>
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	297 and <literal>server1.backend.example.com</literal> SRV records,
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	298 it is necessary to specify the directives:
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	299 <example>
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	300 server backend.example.com service=_http._tcp resolve;
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	301 server example.com service=server1.backend resolve;
1dbef8ab47c7 Updated description of service parameter in upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1680 diff changeset	302 </example>
1680 57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	303 </para>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	304
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	305 <para>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	306 Highest-priority SRV records
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	307 (records with the same lowest-number priority value)
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	308 are resolved as primary servers,
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	309 the rest of SRV records are resolved as backup servers.
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	310 If the <link id="backup"/> parameter is specified for the server,
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	311 high-priority SRV records are resolved as backup servers,
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	312 the rest of SRV records are ignored.
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	313 </para>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	314 </tag-desc>
57c3f36b3b6a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	315
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	316 <tag-name id="slow_start">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	317 <literal>slow_start</literal>=<value>time</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	318 </tag-name>
1126 2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	319 <tag-desc>
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	320 sets the <value>time</value> during which the server will recover its weight
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	321 from zero to a nominal value, when unhealthy server becomes
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	322 <link id="health_check">healthy</link>,
2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	323 or when the server becomes available after a period of time
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	324 it was considered <link id="fail_timeout">unavailable</link>.
1126 2e28d1c4a0a2 Upstream: revised layout of the "server" directive. Ruslan Ermilov <ru@nginx.com> parents: 1125 diff changeset	325 Default value is zero, i.e. slow start is disabled.
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	326 </tag-desc>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	327
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	328 </list>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	329 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	330
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	331 <para>
969 7c542520b8f7 Added note about behavior of a single server in an upstream. Vladimir Homutov <vl@nginx.com> parents: 968 diff changeset	332 <note>
7c542520b8f7 Added note about behavior of a single server in an upstream. Vladimir Homutov <vl@nginx.com> parents: 968 diff changeset	333 If there is only a single server in a group, <literal>max_fails</literal>,
7c542520b8f7 Added note about behavior of a single server in an upstream. Vladimir Homutov <vl@nginx.com> parents: 968 diff changeset	334 <literal>fail_timeout</literal> and <literal>slow_start</literal> parameters
7c542520b8f7 Added note about behavior of a single server in an upstream. Vladimir Homutov <vl@nginx.com> parents: 968 diff changeset	335 are ignored, and such a server will never be considered unavailable.
7c542520b8f7 Added note about behavior of a single server in an upstream. Vladimir Homutov <vl@nginx.com> parents: 968 diff changeset	336 </note>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	337 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	338
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	339 </directive>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	340
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	341
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	342 <directive name="zone">
1495 8d134b482cc3 Documented zone usage with many upstreams. Yaroslav Zhuravlev <yar@nginx.com> parents: 1481 diff changeset	343 <syntax><value>name</value> [<value>size</value>]</syntax>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	344 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	345 <context>upstream</context>
1461 4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	346 <appeared-in>1.9.0</appeared-in>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	347
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	348 <para>
1123 9a9aa8e9d12c Rephrased the "zone" directive, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1122 diff changeset	349 Defines the <value>name</value> and <value>size</value> of the shared
9a9aa8e9d12c Rephrased the "zone" directive, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1122 diff changeset	350 memory zone that keeps the group’s configuration and run-time state that are
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	351 shared between worker processes.
1495 8d134b482cc3 Documented zone usage with many upstreams. Yaroslav Zhuravlev <yar@nginx.com> parents: 1481 diff changeset	352 Several groups may share the same zone.
8d134b482cc3 Documented zone usage with many upstreams. Yaroslav Zhuravlev <yar@nginx.com> parents: 1481 diff changeset	353 In this case, it is enough to specify the <value>size</value> only once.
1461 4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	354 </para>
4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	355
4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	356 <para>
4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	357 Additionally,
4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	358 as part of our <commercial_version>commercial subscription</commercial_version>,
4e5cab61e548 Documented status of the zone directive in ngx_http_upstream module. Vladimir Homutov <vl@nginx.com> parents: 1450 diff changeset	359 such groups allow changing the group membership
1123 9a9aa8e9d12c Rephrased the "zone" directive, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1122 diff changeset	360 or modifying the settings of a particular server
9a9aa8e9d12c Rephrased the "zone" directive, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1122 diff changeset	361 without the need of restarting nginx.
9a9aa8e9d12c Rephrased the "zone" directive, translated into Russian. Yaroslav Zhuravlev <yar@nginx.com> parents: 1122 diff changeset	362 The configuration is accessible via a special location
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	363 handled by
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	364 <link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf"/>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	365 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	366
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	367 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	368
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	369
1636 44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	370 <directive name="state">
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	371 <syntax><value>file</value></syntax>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	372 <default/>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	373 <context>upstream</context>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	374 <appeared-in>1.9.7</appeared-in>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	375
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	376 <para>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	377 Specifies a <value>file</value> that keeps the state
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	378 of the dynamically configurable group.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	379 The state is currently limited to the list of servers with their parameters.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	380 The file is read when parsing the configuration and is updated each time
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	381 the upstream configuration is
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	382 <link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf">changed</link>.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	383 Changing the file content directly should be avoided.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	384 The directive cannot be used
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	385 along with the <link id="server"/> directive.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	386 </para>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	387
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	388 <para>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	389 <note>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	390 Changes made during
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	391 <link doc="../control.xml" id="reconfiguration">configuration reload</link>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	392 or <link doc="../control.xml" id="upgrade">binary upgrade</link>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	393 can be lost.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	394 </note>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	395 </para>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	396
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	397 <para>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	398 <note>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	399 This directive is available as part of our
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	400 <commercial_version>commercial subscription</commercial_version>.
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	401 </note>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	402 </para>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	403
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	404 </directive>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	405
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	406
1230 6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	407 <directive name="hash">
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	408 <syntax><value>key</value> [<literal>consistent</literal>]</syntax>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	409 <default/>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	410 <context>upstream</context>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	411 <appeared-in>1.7.2</appeared-in>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	412
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	413 <para>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	414 Specifies a load balancing method for a server group
1367 f1e14d87d833 Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1348 diff changeset	415 where the client-server mapping is based on the hashed <value>key</value> value.
1230 6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	416 The <value>key</value> can contain text, variables, and their combinations.
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	417 Note that adding or removing a server from the group
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	418 may result in remapping most of the keys to different servers.
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	419 The method is compatible with the
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	420 <link url="http://search.cpan.org/perldoc?Cache%3A%3AMemcached">Cache::Memcached</link>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	421 Perl library.
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	422 </para>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	423
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	424 <para>
1367 f1e14d87d833 Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1348 diff changeset	425 If the <literal>consistent</literal> parameter is specified
1230 6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	426 the <link url="http://www.last.fm/user/RJ/journal/2007/04/10/392555/">ketama</link>
1367 f1e14d87d833 Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1348 diff changeset	427 consistent hashing method will be used instead.
1230 6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	428 The method ensures that only a few keys
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	429 will be remapped to different servers
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	430 when a server is added to or removed from the group.
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	431 This helps to achieve a higher cache hit ratio for caching servers.
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	432 The method is compatible with the
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	433 <link url="http://search.cpan.org/perldoc?Cache%3A%3AMemcached%3A%3AFast">Cache::Memcached::Fast</link>
1236 def99e640654 Fixed grammar. Sergey Kandaurov <pluknet@nginx.com> parents: 1233 diff changeset	434 Perl library with the <value>ketama_points</value> parameter set to 160.
1230 6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	435 </para>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	436
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	437 </directive>
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	438
6cc809881694 Upstream: added the "hash" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1194 diff changeset	439
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440 <directive name="ip_hash">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 <syntax/>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 <default/>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443 <context>upstream</context>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 <para>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	446 Specifies that a group should use a load balancing method where requests
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447 are distributed between servers based on client IP addresses.
542 a9e6a8613534 Documented IPv6 support in ip_hash. Ruslan Ermilov <ru@nginx.com> parents: 533 diff changeset	448 The first three octets of the client IPv4 address, or the entire IPv6 address,
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	449 are used as a hashing key.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	450 The method ensures that requests from the same client will always be
968 fa19bacf6e1e Unified upstream server up/down state terminology. Vladimir Homutov <vl@nginx.com> parents: 966 diff changeset	451 passed to the same server except when this server is unavailable.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	452 In the latter case client requests will be passed to another server.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	453 Most probably, it will always be the same server as well.
542 a9e6a8613534 Documented IPv6 support in ip_hash. Ruslan Ermilov <ru@nginx.com> parents: 533 diff changeset	454 <note>
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 542 diff changeset	455 IPv6 addresses are supported starting from versions 1.3.2 and 1.2.2.
542 a9e6a8613534 Documented IPv6 support in ip_hash. Ruslan Ermilov <ru@nginx.com> parents: 533 diff changeset	456 </note>
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 If one of the servers needs to be temporarily removed, it should
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461 be marked with the <literal>down</literal> parameter in
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 order to preserve the current hashing of client IP addresses.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 Example:
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467 <example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	468 upstream backend {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469 ip_hash;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 server backend1.example.com;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472 server backend2.example.com;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473 server backend3.example.com <emphasis>down</emphasis>;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	474 server backend4.example.com;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 </example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	479 <para>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	480 <note>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	481 Until versions 1.3.1 and 1.2.2, it was not possible to specify a weight for
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	482 servers using the <literal>ip_hash</literal> load balancing method.
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	483 </note>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	484 </para>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	485
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486 </directive>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	487
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	488
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	489 <directive name="keepalive">
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	490 <syntax><value>connections</value></syntax>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	491 <default/>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	492 <context>upstream</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	493 <appeared-in>1.1.4</appeared-in>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	494
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	495 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	496 Activates the cache for connections to upstream servers.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	497 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	498
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	499 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	500 The <value>connections</value> parameter sets the maximum number of
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	501 idle keepalive connections to upstream servers that are preserved in
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	502 the cache of each worker process.
654 841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	503 When this number is exceeded, the least recently used connections
841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	504 are closed.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	505 <note>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	506 It should be particularly noted that the <literal>keepalive</literal> directive
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	507 does not limit the total number of connections to upstream servers
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	508 that an nginx worker process can open.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	509 The <value>connections</value> parameter should be set to a number small enough
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	510 to let upstream servers process new incoming connections as well.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	511 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	512 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	513
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	514 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	515 Example configuration of memcached upstream with keepalive connections:
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	516 <example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	517 upstream memcached_backend {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	518 server 127.0.0.1:11211;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	519 server 10.0.0.2:11211;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	520
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	521 keepalive 32;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	522 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	523
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	524 server {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	525 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	526
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	527 location /memcached/ {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	528 set $memcached_key $uri;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	529 memcached_pass memcached_backend;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	530 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	531
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	532 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	533 </example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	534 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	535
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	536 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	537 For HTTP, the <link doc="ngx_http_proxy_module.xml" id="proxy_http_version"/>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	538 directive should be set to “<literal>1.1</literal>”
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	539 and the <header>Connection</header> header field should be cleared:
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	540 <example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	541 upstream http_backend {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	542 server 127.0.0.1:8080;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	543
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	544 keepalive 16;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	545 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	546
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	547 server {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	548 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	549
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	550 location /http/ {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	551 proxy_pass http://http_backend;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	552 proxy_http_version 1.1;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	553 proxy_set_header Connection "";
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	554 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	555 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	556 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	557 </example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	558 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	559
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	560 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	561 <note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	562 Alternatively, HTTP/1.0 persistent connections can be used by passing the
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	563 <header>Connection: Keep-Alive</header> header field to an upstream server,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	564 though this method is not recommended.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	565 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	566 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	567
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	568 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	569 For FastCGI servers, it is required to set
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	570 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_keep_conn"/>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	571 for keepalive connections to work:
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	572 <example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	573 upstream fastcgi_backend {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	574 server 127.0.0.1:9000;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	575
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	576 keepalive 8;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	577 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	578
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	579 server {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	580 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	581
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	582 location /fastcgi/ {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	583 fastcgi_pass fastcgi_backend;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	584 fastcgi_keep_conn on;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	585 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	586 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	587 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	588 </example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	589 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	590
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	591 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	592 <note>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	593 When using load balancer methods other than the default
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	594 round-robin method, it is necessary to activate them before
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	595 the <literal>keepalive</literal> directive.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	596 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	597
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	598 <note>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	599 SCGI and uwsgi protocols do not have a notion of keepalive connections.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	600 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	601 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	602
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	603 </directive>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	604
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	605
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	606 <directive name="ntlm">
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	607 <syntax/>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	608 <default/>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	609 <context>upstream</context>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	610 <appeared-in>1.9.2</appeared-in>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	611
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	612 <para>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	613 Allows proxying requests with
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	614 <link url="https://en.wikipedia.org/wiki/Integrated_Windows_Authentication">NTLM
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	615 Authentication</link>.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	616 The upstream connection is bound to the client connection
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	617 once the client sends a request with the <header>Authorization</header>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	618 header field value
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	619 starting with “<literal>Negotiate</literal>” or “<literal>NTLM</literal>”.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	620 Further client requests will be proxied through the same upstream connection,
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	621 keeping the authentication context.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	622 </para>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	623
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	624 <para>
1587 c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	625 In order for NTLM authentication to work,
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	626 it is necessary to enable keepalive connections to upstream servers.
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	627 The <link doc="ngx_http_proxy_module.xml" id="proxy_http_version"/>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	628 directive should be set to “<literal>1.1</literal>”
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	629 and the <header>Connection</header> header field should be cleared:
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	630 <example>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	631 upstream http_backend {
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	632 server 127.0.0.1:8080;
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	633
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	634 ntlm;
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	635 }
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	636
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	637 server {
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	638 ...
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	639
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	640 location /http/ {
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	641 proxy_pass http://http_backend;
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	642 proxy_http_version 1.1;
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	643 proxy_set_header Connection "";
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	644 ...
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	645 }
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	646 }
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	647 </example>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	648 </para>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	649
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	650 <para>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	651 <note>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	652 When using load balancer methods other than the default
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	653 round-robin method, it is necessary to activate them before
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	654 the <literal>ntlm</literal> directive.
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	655 </note>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	656 </para>
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	657
c2a0a18e65ba Added keepalive info for ntlm. Yaroslav Zhuravlev <yar@nginx.com> parents: 1581 diff changeset	658 <para>
1561 ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	659 <note>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	660 This directive is available as part of our
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	661 <commercial_version>commercial subscription</commercial_version>.
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	662 </note>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	663 </para>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	664
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	665 </directive>
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	666
ed420c318557 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1544 diff changeset	667
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	668 <directive name="least_conn">
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	669 <syntax/>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	670 <default/>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	671 <context>upstream</context>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	672 <appeared-in>1.3.1</appeared-in>
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 542 diff changeset	673 <appeared-in>1.2.2</appeared-in>
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	674
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	675 <para>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	676 Specifies that a group should use a load balancing method where a request
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	677 is passed to the server with the least number of active connections,
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	678 taking into account weights of servers.
1232 ab2ea38f3512 Upstream: least_conn description corresponds to the Russian text. Yaroslav Zhuravlev <yar@nginx.com> parents: 1230 diff changeset	679 If there are several such servers, they are tried in turn using a
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	680 weighted round-robin balancing method.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	681 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	682
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	683 </directive>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	684
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	685
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	686 <directive name="least_time">
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	687 <syntax><literal>header</literal> \| <literal>last_byte</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	688 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	689 <context>upstream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	690 <appeared-in>1.7.10</appeared-in>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	691
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	692 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	693 Specifies that a group should use a load balancing method where a request
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	694 is passed to the server with the least average response time and
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	695 least number of active connections, taking into account weights of servers.
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	696 If there are several such servers, they are tried in turn using a
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	697 weighted round-robin balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	698 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	699
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	700 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	701 If the <literal>header</literal> parameter is specified,
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	702 time to receive the
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	703 <link id="var_upstream_header_time">response header</link> is used.
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	704 If the <literal>last_byte</literal> parameter is specified,
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	705 time to receive the <link id="var_upstream_response_time">full response</link>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	706 is used.
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	707 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	708
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	709 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	710 <note>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	711 This directive is available as part of our
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	712 <commercial_version>commercial subscription</commercial_version>.
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	713 </note>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	714 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	715
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	716 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	717
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	718
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	719 <directive name="health_check">
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	720 <syntax>[<value>parameters</value>]</syntax>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	721 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	722 <context>location</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	723
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	724 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	725 Enables periodic health checks of the servers in a
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	726 <link id="upstream">group</link> referenced in the surrounding location.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	727 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	728
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	729 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	730 The following optional parameters are supported:
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	731 <list type="tag">
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	732
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	733 <tag-name id="interval">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	734 <literal>interval</literal>=<value>time</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	735 </tag-name>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	736 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	737 sets the interval between two consecutive health checks,
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	738 by default, 5 seconds;
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	739 </tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	740
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	741 <tag-name id="fails">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	742 <literal>fails</literal>=<value>number</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	743 </tag-name>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	744 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	745 sets the number of consecutive failed health checks of a particular server
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	746 after which this server will be considered unhealthy,
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	747 by default, 1;
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	748 </tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	749
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	750 <tag-name id="passes">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	751 <literal>passes</literal>=<value>number</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	752 </tag-name>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	753 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	754 sets the number of consecutive passed health checks of a particular server
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	755 after which the server will be considered healthy,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	756 by default, 1;
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	757 </tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	758
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	759 <tag-name id="uri">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	760 <literal>uri</literal>=<value>uri</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	761 </tag-name>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	762 <tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	763 defines the URI used in health check requests,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	764 by default, “<literal>/</literal>”;
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	765 </tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	766
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	767 <tag-name id="hc_match">
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	768 <literal>match</literal>=<value>name</value>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	769 </tag-name>
2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	770 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	771 specifies the <literal>match</literal> block configuring the tests that a
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	772 response should pass in order for a health check to pass;
1636 44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	773 by default, the response should have status code 2xx or 3xx;
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	774 </tag-desc>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	775
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	776 <tag-name id="health_check_port">
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	777 <literal>port</literal>=<value>number</value>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	778 </tag-name>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	779 <tag-desc>
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	780 defines the port used when connecting to a server
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	781 to perform a health check (1.9.7);
44c4323144c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 1625 diff changeset	782 by default, equals the <link id="server"/> port.
1241 2246339a6a93 Upstream: added IDs for "server" and "health_check" params. Yaroslav Zhuravlev <yar@nginx.com> parents: 1236 diff changeset	783 </tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	784
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	785 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	786 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	787
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	788 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	789 For example,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	790 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	791 location / {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	792 proxy_pass http://backend;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	793 health_check;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	794 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	795 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	796 will send “<literal>/</literal>” requests to each
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	797 server in the <literal>backend</literal> group every five seconds.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	798 If any communication error or timeout occurs, or a
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	799 proxied server responds with the status code other than
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	800 2xx or 3xx, the health check will fail, and the server will
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	801 be considered unhealthy.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	802 Client requests are not passed to unhealthy servers.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	803 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	804
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	805 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	806 Health checks can be configured to test the status code of a response,
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	807 presence of certain header fields and their values,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	808 and the body contents.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	809 Tests are configured separately using the <link id="match"/> directive
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	810 and referenced in the <literal>match</literal> parameter.
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	811 For example:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	812 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	813 http {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	814 server {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	815 ...
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	816 location / {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	817 proxy_pass http://backend;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	818 health_check match=welcome;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	819 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	820 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	821
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	822 match welcome {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	823 status 200;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	824 header Content-Type = text/html;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	825 body ~ "Welcome to nginx!";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	826 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	827 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	828 </example>
1722 61aca81458a0 Corrected sentence in the upstream module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1700 diff changeset	829 This configuration shows that in order for a health check to pass, the response
61aca81458a0 Corrected sentence in the upstream module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1700 diff changeset	830 to a health check request should succeed,
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	831 have status 200, content type “<literal>text/html</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	832 and contain “<literal>Welcome to nginx!</literal>” in the body.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	833 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	834
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	835 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	836 The server group must reside in the <link id="zone">shared memory</link>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	837 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	838
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	839 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	840 If several health checks are defined for the same group of servers,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	841 a single failure of any check will make the corresponding server be
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	842 considered unhealthy.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	843 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	844
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	845 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	846 <note>
1348 5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	847 Please note that most of the variables will have empty values
5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	848 when used with health checks.
5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	849 </note>
5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	850 </para>
5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	851
5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	852 <para>
5e45198fa991 Documented that with health checks most variables are useless. Ruslan Ermilov <ru@nginx.com> parents: 1259 diff changeset	853 <note>
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	854 This directive is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	855 <commercial_version>commercial subscription</commercial_version>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	856 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	857 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	858
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	859 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	860
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	861
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	862 <directive name="match">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	863 <syntax block="yes"><value>name</value></syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	864 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	865 <context>http</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	866
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	867 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	868 Defines the named test set used to verify responses to health check requests.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	869 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	870
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	871 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	872 The following items can be tested in a response:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	873 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	874
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	875 <tag-name><literal>status 200;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	876 <tag-desc>status is 200</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	877
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	878 <tag-name><literal>status ! 500;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	879 <tag-desc>status is not 500</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	880
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	881 <tag-name><literal>status 200 204;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	882 <tag-desc>status is 200 or 204</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	883
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	884 <tag-name><literal>status ! 301 302;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	885 <tag-desc>status is neither 301 nor 302</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	886
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	887 <tag-name><literal>status 200-399;</literal></tag-name>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	888 <tag-desc>status is in the range from 200 to 399</tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	889
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	890 <tag-name><literal>status ! 400-599;</literal></tag-name>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	891 <tag-desc>status is not in the range from 400 to 599</tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	892
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	893 <tag-name><literal>status 301-303 307;</literal></tag-name>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	894 <tag-desc>status is either 301, 302, 303, or 307</tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	895
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	896 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	897
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	898 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	899
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	900 <tag-name><literal>header Content-Type = text/html;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	901 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	902 header contains <header>Content-Type</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	903 with value <literal>text/html</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	904 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	905
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	906 <tag-name><literal>header Content-Type != text/html;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	907 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	908 header contains <header>Content-Type</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	909 with value other than <literal>text/html</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	910 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	911
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	912 <tag-name><literal>header Connection ~ close;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	913 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	914 header contains <header>Connection</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	915 with value matching regular expression <literal>close</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	916 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	917
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	918 <tag-name><literal>header Connection !~ close;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	919 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	920 header contains <header>Connection</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	921 with value not matching regular expression <literal>close</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	922 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	923
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	924 <tag-name><literal>header Host;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	925 <tag-desc>header contains <header>Host</header></tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	926
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	927 <tag-name><literal>header ! X-Accel-Redirect;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	928 <tag-desc>header lacks <header>X-Accel-Redirect</header></tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	929
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	930 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	931
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	932 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	933
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	934 <tag-name><literal>body ~ "Welcome to nginx!";</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	935 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	936 body matches regular expression “<literal>Welcome to nginx!</literal>”
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	937 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	938
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	939 <tag-name><literal>body !~ "Welcome to nginx!";</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	940 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	941 body does not match regular expression “<literal>Welcome to nginx!</literal>”
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	942 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	943
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	944 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	945 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	946
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	947 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	948 If several tests are specified,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	949 the response matches only if it matches all tests.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	950 <note>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	951 Only the first 256k of the response body are examined.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	952 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	953 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	954
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	955 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	956 Examples:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	957 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	958 # status is 200, content type is "text/html",
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	959 # and body contains "Welcome to nginx!"
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	960 match welcome {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	961 status 200;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	962 header Content-Type = text/html;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	963 body ~ "Welcome to nginx!";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	964 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	965 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	966
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	967 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	968 # status is not one of 301, 302, 303, or 307, and header does not have "Refresh:"
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	969 match not_redirect {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	970 status ! 301-303 307;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	971 header ! Refresh;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	972 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	973 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	974
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	975 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	976 # status ok and not in maintenance mode
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	977 match server_ok {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	978 status 200-399;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	979 body !~ "maintenance mode";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	980 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	981 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	982
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	983 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	984
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	985 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	986 <note>
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	987 This directive is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	988 <commercial_version>commercial subscription</commercial_version>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	989 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	990 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	991
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	992 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	993
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	994
1125 9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	995 <directive name="queue">
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	996 <syntax>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	997 <value>number</value>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	998 [<literal>timeout</literal>=<value>time</value>]</syntax>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	999 <default/>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1000 <context>upstream</context>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1001 <appeared-in>1.5.12</appeared-in>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1002
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1003 <para>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1004 If an upstream server cannot be selected immediately
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1005 while processing a request,
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1006 and there are the servers in the group that have reached the
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1007 <link id="max_conns"/> limit,
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1008 the request will be placed into the queue.
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1009 The directive specifies the maximum number of requests that can be in the queue
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1010 at the same time.
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1011 If the queue is filled up,
1543 08242a0abf11 Fixed grammar in the upstream queue directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1504 diff changeset	1012 or the server to pass the request to cannot be selected within
1125 9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1013 the time period specified in the <literal>timeout</literal> parameter,
1625 0ba4b2e561bd Added 502 error to the "queue" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	1014 the <http-status code="502" text="Bad Gateway"/>
0ba4b2e561bd Added 502 error to the "queue" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1587 diff changeset	1015 error will be returned to the client.
1125 9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1016 </para>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1017
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1018 <para>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1019 The default value of the <literal>timeout</literal> parameter is 60 seconds.
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1020 </para>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1021
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1022 <para>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1023 <note>
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	1024 This directive is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	1025 <commercial_version>commercial subscription</commercial_version>.
1125 9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1026 </note>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1027 </para>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1028
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1029 </directive>
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1030
9a95b9026a16 Upstream: reallocated the "queue" directive. Ruslan Ermilov <ru@nginx.com> parents: 1124 diff changeset	1031
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1032 <directive name="sticky">
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1033 <syntax>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1034 <literal>cookie</literal> <value>name</value>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1035 [<literal>expires=</literal><value>time</value>]
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1036 [<literal>domain=</literal><value>domain</value>]
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1037 [<literal>httponly</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1038 [<literal>secure</literal>]
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1039 [<literal>path=</literal><value>path</value>]</syntax>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1040 <syntax>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1041 <literal>route</literal> <value>$variable</value> ...</syntax>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1042 <syntax>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1043 <literal>learn</literal>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1044 <literal>create=</literal><value>$variable</value>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1045 <literal>lookup=</literal><value>$variable</value>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1046 <literal>zone=</literal><value>name</value>:<value>size</value>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1047 [<literal>timeout=</literal><value>time</value>]</syntax>
987 edd505634357 Documented the "sticky" directive. Vladimir Homutov <vl@nginx.com> parents: 981 diff changeset	1048 <default/>
edd505634357 Documented the "sticky" directive. Vladimir Homutov <vl@nginx.com> parents: 981 diff changeset	1049 <context>upstream</context>
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1050 <appeared-in>1.5.7</appeared-in>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1051
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1052 <para>
962 f3754c623e6b Minor editing of the stiky_cookie_insert directive. Egor Nikitin <yegor.nikitin@gmail.com> parents: 960 diff changeset	1053 Enables session affinity, which causes requests from the same client to be
960 48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1054 passed to the same server in a group of servers.
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1055 Three methods are available:
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1056 <list type="tag">
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1057 <tag-name id="sticky_cookie"><literal>cookie</literal></tag-name>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1058 <tag-desc>
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1059
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1060 <para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1061 When the <literal>cookie</literal> method is used, information about the
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1062 designated server is passed in an HTTP cookie generated by nginx:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1063 <example>
960 48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1064 upstream backend {
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1065 server backend1.example.com;
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1066 server backend2.example.com;
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1067
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1068 sticky cookie srv_id expires=1h domain=.example.com path=/;
960 48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1069 }
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1070 </example>
960 48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1071 </para>
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1072
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1073 <para>
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1074 A request that comes from a client not yet bound to a particular server
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1075 is passed to the server selected by the configured balancing method.
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1076 Further requests with this cookie will be passed to the designated server.
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1077 If the designated server cannot process a request, the new server is
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1078 selected as if the client has not been bound yet.
960 48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1079 </para>
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1080
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1081 <para>
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1082 The first parameter sets the name of the cookie to be set or inspected.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1083 Additional parameters may be as follows:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1084 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1085
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1086 <tag-name><literal>expires=</literal><value>time</value></tag-name>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1087 <tag-desc>
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1088 Sets the <value>time</value> for which a browser should keep the cookie.
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1089 The special value <literal>max</literal> will cause the cookie to expire on
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1090 “<literal>31 Dec 2037 23:55:55 GMT</literal>”.
960 48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1091 If the parameter is not specified, it will cause the cookie to expire at
48ab154edf10 Upstream: removed obsoleted directives in the "sticky" module. Vladimir Homutov <vl@nginx.com> parents: 956 diff changeset	1092 the end of a browser session.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1093 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1094
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1095 <tag-name><literal>domain=</literal><value>domain</value></tag-name>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1096 <tag-desc>
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1097 Defines the <value>domain</value> for which the cookie is set.
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1098 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1099
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1100 <tag-name><literal>httponly</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1101 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1102 Adds the <literal>HttpOnly</literal> attribute to the cookie (1.7.11).
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1103 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1104
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1105 <tag-name><literal>secure</literal></tag-name>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1106 <tag-desc>
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1107 Adds the <literal>Secure</literal> attribute to the cookie (1.7.11).
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1108
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1109 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1110
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1111 <tag-name><literal>path=</literal><value>path</value></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1112 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1424 diff changeset	1113 Defines the <value>path</value> for which the cookie is set.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1114 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1115
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1116 </list>
981 fc35441b4856 Fixed grammar. Vladimir Homutov <vl@nginx.com> parents: 969 diff changeset	1117 If any parameters are omitted, the corresponding cookie fields are not set.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1118 </para>
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1119 </tag-desc>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1120
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1121 <tag-name id="sticky_route"><literal>route</literal></tag-name>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1122 <tag-desc>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1123
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1124 <para>
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1125 When the <literal>route</literal> method is used, proxied server assigns
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1126 client a route on receipt of the first request.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1127 All subsequent requests from this client will carry routing information
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1128 in a cookie or URI.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1129 This information is compared with the “<literal>route</literal>” parameter
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1130 of the <link id="server"/> directive to identify the server to which the
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1131 request should be proxied.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1132 If the designated server cannot process a request, the new server is
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1133 selected by the configured balancing method as if there is no routing
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1134 information in the request.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1135 </para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1136
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1137 <para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1138 The parameters of the <literal>route</literal> method specify variables that
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1139 may contain routing information.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1140 The first non-empty variable is used to find the matching server.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1141 </para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1142
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1143 <para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1144 Example:
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1145 <example>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1146 map $cookie_jsessionid $route_cookie {
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1147 ~.+\.(?P<route>\w+)$ $route;
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1148 }
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1149
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1150 map $request_uri $route_uri {
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1151 ~jsessionid=.+\.(?P<route>\w+)$ $route;
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1152 }
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1153
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1154 upstream backend {
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1155 server backend1.example.com route=a;
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1156 server backend2.example.com route=b;
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1157
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1158 sticky route $route_cookie $route_uri;
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1159 }
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1160 </example>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1161 Here, the route is taken from the “<literal>JSESSIONID</literal>” cookie
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1162 if present in a request.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1163 Otherwise, the route from the URI is used.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1164 </para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1165
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1166 </tag-desc>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1167
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1168 <tag-name id="sticky_learn"><literal>learn</literal></tag-name>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1169 <tag-desc>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1170 <para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1171 When the <literal>learn</literal> method (1.7.1) is used, nginx
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1172 analyzes upstream server responses and learns server-initiated sessions
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1173 usually passed in an HTTP cookie.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1174 <example>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1175 upstream backend {
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1176 server backend1.example.com:8080;
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1177 server backend2.example.com:8081;
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1178
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1179 sticky learn
1544 627a9309011c Renamed cookie in the example of the sticky directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1543 diff changeset	1180 create=$upstream_cookie_examplecookie
627a9309011c Renamed cookie in the example of the sticky directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1543 diff changeset	1181 lookup=$cookie_examplecookie
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1182 zone=client_sessions:1m;
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1183 }
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1184 </example>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1185
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1186 In the example, the upstream server creates a session by setting the
1544 627a9309011c Renamed cookie in the example of the sticky directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1543 diff changeset	1187 cookie “<literal>EXAMPLECOOKIE</literal>” in the response.
1259 954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1188 Further requests with this cookie will be passed to the same server.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1189 If the server cannot process the request, the new server is
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1190 selected as if the client has not been bound yet.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1191 </para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1192
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1193 <para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1194 The parameters <literal>create</literal> and <literal>lookup</literal>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1195 specify variables that indicate how new sessions are created and existing
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1196 sessions are searched, respectively.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1197 Both parameters may be specified more than once, in which case the first
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1198 non-empty variable is used.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1199 </para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1200
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1201 <para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1202 Sessions are stored in a shared memory zone, whose <value>name</value> and
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1203 <value>size</value> are configured by the <literal>zone</literal> parameter.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1204 One megabyte zone can store about 8000 sessions on the 64-bit platform.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1205 The sessions that are not accessed during the time specified by the
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1206 <literal>timeout</literal> parameter get removed from the zone.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1207 By default, <literal>timeout</literal> is set to 10 minutes.
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1208 </para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1209
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1210 </tag-desc>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1211 </list>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1212 </para>
954dcc02cb63 Upstream: "session learn" sticky method and upstream_conf changes. Ruslan Ermilov <ru@nginx.com> parents: 1241 diff changeset	1213
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1214 <para>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1215 <note>
1128 1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	1216 This directive is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>. Ruslan Ermilov <ru@nginx.com> parents: 1127 diff changeset	1217 <commercial_version>commercial subscription</commercial_version>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1218 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1219 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1220
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1221 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1222
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1223
1026 3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1224 <directive name="sticky_cookie_insert">
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1225 <syntax><value>name</value>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1226 [<literal>expires=</literal><value>time</value>]
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1227 [<literal>domain=</literal><value>domain</value>]
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1228 [<literal>path=</literal><value>path</value>]</syntax>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1229 <default/>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1230 <context>upstream</context>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1231
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1232 <para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1233 This directive is obsolete since version 1.5.7.
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1234 An equivalent
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1235 <link id="sticky"/> directive with a new syntax should be used instead:
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1236 <note>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1237 <literal>sticky cookie</literal> <value>name</value>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1238 [<literal>expires=</literal><value>time</value>]
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1239 [<literal>domain=</literal><value>domain</value>]
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1240 [<literal>path=</literal><value>path</value>];
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1241 </note>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1242 </para>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1243
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1244 </directive>
3056640d5022 Upstream: documented new "sticky" features. Ruslan Ermilov <ru@nginx.com> parents: 1011 diff changeset	1245
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1246 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1247
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1248
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1249 <section id="variables" name="Embedded Variables">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1250
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1251 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1252 The <literal>ngx_http_upstream_module</literal> module
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1253 supports the following embedded variables:
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1254 <list type="tag">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1255
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1256 <tag-name id="var_upstream_addr"><var>$upstream_addr</var></tag-name>
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1257 <tag-desc>
1391 0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1258 keeps the IP address and port,
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1259 or the path to the UNIX-domain socket of the upstream server.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1260 If several servers were contacted during request processing,
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1261 their addresses are separated by commas, e.g.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1262 “<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock</literal>”.
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	1263 If an internal redirect from one server group to another happens,
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	1264 initiated by
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1265 <header>X-Accel-Redirect</header> or
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	1266 <link doc="ngx_http_core_module.xml" id="error_page"/>,
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	1267 then the server addresses from different groups are separated by colons, e.g.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1268 “<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>”.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1269 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1270
1783 031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1271 <tag-name id="var_upstream_bytes_received"><var>$upstream_bytes_received</var></tag-name>
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1272 <tag-desc>
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1273 number of bytes received from an upstream server (1.11.4).
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1274 Values from several connections
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1275 are separated by commas and colons like addresses in the
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1276 <link id="var_upstream_addr">$upstream_addr</link> variable.
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1277 </tag-desc>
031566771bbd Documented $upstream_bytes_received for http upstream. Yaroslav Zhuravlev <yar@nginx.com> parents: 1722 diff changeset	1278
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1279 <tag-name id="var_upstream_cache_status"><var>$upstream_cache_status</var>
07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1280 </tag-name>
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1281 <tag-desc>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 962 diff changeset	1282 keeps the status of accessing a response cache (0.8.3).
1075 6c021feec587 Removed unjustified non-breakable spaces. Ruslan Ermilov <ru@nginx.com> parents: 1026 diff changeset	1283 The status can be either “<literal>MISS</literal>”,
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1284 “<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”,
1011 2ad2f30efdf2 Documented the "fastcgi_" and "proxy_cache_revalidate" directives. Vladimir Homutov <vl@nginx.com> parents: 1003 diff changeset	1285 “<literal>STALE</literal>”, “<literal>UPDATING</literal>”,
1391 0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1286 “<literal>REVALIDATED</literal>”, or “<literal>HIT</literal>”.
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1287 </tag-desc>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1288
1481 f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1289 <tag-name id="var_upstream_connect_time"><var>$upstream_connect_time</var>
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1290 </tag-name>
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1291 <tag-desc>
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1292 keeps time spent on establishing a connection with the upstream server (1.9.1);
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1293 the time is kept in seconds with millisecond resolution.
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1294 In case of SSL, includes time spent on handshake.
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1295 Times of several connections
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1296 are separated by commas and colons like addresses in the
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1297 <link id="var_upstream_addr">$upstream_addr</link> variable.
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1298 </tag-desc>
f29398a167d0 Documented the upstream_connect_time variable. Yaroslav Zhuravlev <yar@nginx.com> parents: 1461 diff changeset	1299
1186 8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1300 <tag-name id="var_upstream_cookie_"><var>$upstream_cookie_</var><value>name</value>
8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1301 </tag-name>
8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1302 <tag-desc>
8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1303 cookie with the specified <value>name</value> sent by the upstream server
8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1304 in the <header>Set-Cookie</header> response header field (1.7.1).
1391 0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1305 Only the cookies from the response of the last server are saved.
1186 8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1306 </tag-desc>
8125bec5c7a1 Upstream: documented the $upstream_cookie_* variables. Ruslan Ermilov <ru@nginx.com> parents: 1181 diff changeset	1307
1393 15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1308 <tag-name id="var_upstream_header_time"><var>$upstream_header_time</var>
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1309 </tag-name>
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1310 <tag-desc>
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1311 keeps time
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1312 spent on receiving the response header from the upstream server (1.7.10);
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1313 the time is kept in seconds with millisecond resolution.
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1314 Times of several responses
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1315 are separated by commas and colons like addresses in the
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1316 <link id="var_upstream_addr">$upstream_addr</link> variable.
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1317 </tag-desc>
15e8779f0ceb Documented the $upstream_header_time variable. Ruslan Ermilov <ru@nginx.com> parents: 1392 diff changeset	1318
1392 82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1319 <tag-name id="var_upstream_http_"><var>$upstream_http_</var><value>name</value></tag-name>
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1320 <tag-desc>
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1321 keep server response header fields.
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1322 For example, the <header>Server</header> response header field
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1323 is available through the <var>$upstream_http_server</var> variable.
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1324 The rules of converting header field names to variable names are the same
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1325 as for the variables that start with the
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1326 “<link doc="ngx_http_core_module.xml" id="var_http_">$http_</link>” prefix.
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1327 Only the header fields from the response of the last server are saved.
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1328 </tag-desc>
82e62822abe8 Sorted upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1391 diff changeset	1329
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1330 <tag-name id="var_upstream_response_length"><var>$upstream_response_length</var>
07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1331 </tag-name>
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1332 <tag-desc>
1391 0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1333 keeps the length of the response obtained from the upstream server (0.7.27);
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1334 the length is kept in bytes.
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1335 Lengths of several responses
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1336 are separated by commas and colons like addresses in the
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1337 <link id="var_upstream_addr">$upstream_addr</link> variable.
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1338 </tag-desc>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1339
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1340 <tag-name id="var_upstream_response_time"><var>$upstream_response_time</var>
07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1341 </tag-name>
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1342 <tag-desc>
1391 0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1343 keeps time spent on receiving the response from the upstream server;
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1344 the time is kept in seconds with millisecond resolution.
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1345 Times of several responses
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1346 are separated by commas and colons like addresses in the
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1347 <link id="var_upstream_addr">$upstream_addr</link> variable.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1348 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1349
1155 07402a11fd8d Assigned IDs to tags describing variables. Vladimir Homutov <vl@nginx.com> parents: 1128 diff changeset	1350 <tag-name id="var_upstream_status"><var>$upstream_status</var></tag-name>
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1351 <tag-desc>
1391 0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1352 keeps status code of the response obtained from the upstream server.
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1353 Status codes of several responses
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1354 are separated by commas and colons like addresses in the
0702cc081c63 Revised descriptions of upstream module variables. Ruslan Ermilov <ru@nginx.com> parents: 1386 diff changeset	1355 <link id="var_upstream_addr">$upstream_addr</link> variable.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1356 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1357
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1358 </list>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1359 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1360
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1361 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1362
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1363 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_upstream_module.xml @ 1800:9d722e4153ab