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

annotate xml/en/docs/http/ngx_http_upstream_module.xml @ 956:488a3f738db0

Text revision of commercial modules.

author	Egor Nikitin <yegor.nikitin@gmail.com>
date	Fri, 02 Aug 2013 10:28:49 +0400
parents	28d580f1eb63
children	48ab154edf10

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"
955 28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	13 rev="6">
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
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 allows to define groups of servers that can be referenced
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	20 from the <link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>,
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	21 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>, and
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	22 <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	23 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 </section>
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
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28 <section id="example" name="Example Configuration">
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 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 <example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 upstream <emphasis>backend</emphasis> {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 server backend1.example.com weight=5;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 server backend2.example.com:8080;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 server unix:/tmp/backend3;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 server backup1.example.com:8080 backup;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 server backup2.example.com:8080 backup;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 server {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 location / {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 proxy_pass http://<emphasis>backend</emphasis>;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 </example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	49 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	50 Dynamically configurable group,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	51 available as part of our <commercial_version/> only:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	52 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	53 upstream <emphasis>appservers</emphasis> {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	54 zone appservers 64k;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	55
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	56 server appserv1.example.com weight=5;
955 28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	57 server appserv2.example.com:8080 fail_timeout=5s slow_start=30s;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	58 server 192.0.2.1 max_fails=3;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	59
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	60 server reserve1.example.com:8080 backup;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	61 server reserve2.example.com:8080 backup;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	62 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	63
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	64 server {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	65 location / {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	66 proxy_pass http://<emphasis>appservers</emphasis>;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	67 health_check;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	68 }
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 location /upstream_conf {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	71 upstream_conf;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	72 allow 127.0.0.1;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	73 deny all;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	74 }
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 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	77 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	78
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80
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 <section id="directives" name="Directives">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	84 <directive name="upstream">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	85 <syntax block="yes"><value>name</value></syntax>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	86 <default/>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	87 <context>http</context>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	88
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	89 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	90 Defines a group of servers.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	91 Servers can listen on different ports.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	92 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	93 can be mixed.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	94 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	95
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	96 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	97 Example:
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 upstream backend {
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	100 server backend1.example.com weight=5;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	101 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	102 server unix:/tmp/backend3;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	103 }
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	104 </example>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	105 </para>
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 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	108 By default, requests are distributed between servers using a
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	109 weighted round-robin balancing method.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	110 In the above example, each 7 requests will be distributed as follows:
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	111 5 requests to <literal>backend1.example.com</literal>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	112 and one request to each of second and third servers.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	113 If an error occurs when communicating with the server, a request will
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	114 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	115 servers will be tried.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	116 If a successful response could not be obtained from any of the servers,
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	117 the client will be returned the result of contacting the last server.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	118 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	119
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	120 </directive>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	121
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 name="server">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	124 <syntax><value>address</value> [<value>parameters</value>]</syntax>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	125 <default/>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	126 <context>upstream</context>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	127
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	128 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	129 Defines an <value>address</value> and other <value>parameters</value>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	130 of the server.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	131 An address can be specified as a domain name or IP address,
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	132 and an optional port, or as a UNIX-domain socket path
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	133 specified after the “<literal>unix:</literal>” prefix.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	134 If port is not specified, the port 80 is used.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	135 A domain name that resolves to several IP addresses essentially defines
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	136 multiple servers.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	137 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	138
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	139 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	140 The following parameters can be defined:
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	141 <list type="tag">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	142
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	143 <tag-name><literal>weight</literal>=<value>number</value></tag-name>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	144 <tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	145 sets a weight of the server, by default 1.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	146 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	147
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	148 <tag-name><literal>max_fails</literal>=<value>number</value></tag-name>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	149 <tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	150 sets a number of unsuccessful attempts to communicate with the server
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	151 during a time set by the <literal>fail_timeout</literal> parameter
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	152 after which it will be considered down for a period of time also set
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	153 by the <literal>fail_timeout</literal> parameter.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	154 By default, the number of unsuccessful attempts is set to 1.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	155 A value of zero disables accounting of attempts.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 917 diff changeset	156 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	157 <link doc="ngx_http_proxy_module.xml" id="proxy_next_upstream"/>,
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	158 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_next_upstream"/>, and
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	159 <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	160 directives.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	161 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	162
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	163 <tag-name><literal>fail_timeout</literal>=<value>time</value></tag-name>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	164 <tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	165 sets
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	166 <list type="bullet">
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	167
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	168 <listitem>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	169 a time during which the specified number of unsuccessful attempts to
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	170 communicate with the server should happen for the server to be
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	171 considered down;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	172 </listitem>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	173
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	174 <listitem>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	175 and a period of time the server will be considered down.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	176 </listitem>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	177
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	178 </list>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	179 By default, timeout is set to 10 seconds.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	180 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	181
955 28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	182 <tag-name><literal>slow_start</literal>=<value>time</value></tag-name>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	183 <tag-desc>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	184 sets the <value>time</value> during which the server will recover its weight
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	185 from zero to a nominal value, when unhealthy server becomes
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	186 <link id="health_check">healthy</link>,
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	187 or when the server becomes available after a period of time
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	188 it was considered down.
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	189 Default value is zero, i.e. slow start is disabled.
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	190 <note>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	191 This functionality is available as part of our <commercial_version/> only.
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	192 </note>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	193 </tag-desc>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	194
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	195 <tag-name><literal>backup</literal></tag-name>
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 marks the server as a backup server.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	198 It will be passed requests when the primary servers are down.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	199 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	200
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	201 <tag-name><literal>down</literal></tag-name>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	202 <tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	203 marks the server as permanently down; used along with
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	204 the <link id="ip_hash"/> directive.
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	205 </tag-desc>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	206
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	207 </list>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	208 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	209
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	210 <para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	211 Example:
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	212 <example>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	213 upstream backend {
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	214 server backend1.example.com weight=5;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	215 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	216 server unix:/tmp/backend3;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	217
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	218 server backup1.example.com:8080 backup;
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	219 }
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	220 </example>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	221 </para>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	222
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	223 </directive>
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	224
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	225
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	226 <directive name="zone">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	227 <syntax><value>name</value> <value>size</value></syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	228 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	229 <context>upstream</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	230
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	231 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	232 Makes the group dynamically configurable.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	233 Defines the <value>name</value> and <value>size</value> of a shared
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	234 memory zone that keeps group’s configuration and run-time state that are
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	235 shared between worker processes.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	236 Such groups allow to add, remove, and modify servers at run time.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	237 The configuration is accessible via a special location handled by
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	238 <link id="upstream_conf"/>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	239 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	240
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	241 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	242 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	243 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	244 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	245 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	246
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	247 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	248
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	249
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 <directive name="ip_hash">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 <syntax/>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 <default/>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 <context>upstream</context>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 <para>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	256 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	257 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	258 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	259 are used as a hashing key.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 The method ensures that requests of the same client will always be
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 passed to the same server except when this server is considered down
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 in which case client requests will be passed to another server and
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 most probably it will also be the same server.
542 a9e6a8613534 Documented IPv6 support in ip_hash. Ruslan Ermilov <ru@nginx.com> parents: 533 diff changeset	264 <note>
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 542 diff changeset	265 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	266 </note>
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 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	271 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	272 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	273 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276 Example:
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 <example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 upstream backend {
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 ip_hash;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 server backend1.example.com;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 server backend2.example.com;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 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	284 server backend4.example.com;
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 }
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 </example>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	289 <para>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	290 <note>
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 542 diff changeset	291 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	292 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	293 </note>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	294 </para>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	295
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 </directive>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	299 <directive name="keepalive">
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	300 <syntax><value>connections</value></syntax>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	301 <default/>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	302 <context>upstream</context>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	303 <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	304
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	305 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	306 Activates cache of connections to upstream servers.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	307 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	308
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	309 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	310 The <value>connections</value> parameter sets the maximum number of
654 841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	311 idle keepalive connections to upstream servers that are retained in
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	312 the cache per one worker process.
654 841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	313 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	314 are closed.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	315 <note>
654 841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	316 It should be particularly noted that <literal>keepalive</literal> directive
841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	317 does not limit the total number of connections that nginx worker process
841118e33f41 Refined the text about cache of connections to upstream servers. Ruslan Ermilov <ru@nginx.com> parents: 589 diff changeset	318 can open to upstream servers.
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	319 The <value>connections</value> parameter should be set low enough
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	320 to allow upstream servers to process additional new incoming
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	321 connections as well.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	322 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	323 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	324
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	325 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	326 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	327 <example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	328 upstream memcached_backend {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	329 server 127.0.0.1:11211;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	330 server 10.0.0.2:11211;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	331
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	332 keepalive 32;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	333 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	334
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	335 server {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	336 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	337
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	338 location /memcached/ {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	339 set $memcached_key $uri;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	340 memcached_pass memcached_backend;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	341 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	342
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	343 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	344 </example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	345 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	346
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	347 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	348 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	349 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	350 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	351 <example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	352 upstream http_backend {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	353 server 127.0.0.1:8080;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	354
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	355 keepalive 16;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	356 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	357
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	358 server {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	359 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	360
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	361 location /http/ {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	362 proxy_pass http://http_backend;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	363 proxy_http_version 1.1;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	364 proxy_set_header Connection "";
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	365 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	366 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	367 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	368 </example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	369 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	370
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	371 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	372 <note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	373 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	374 <header>Connection: Keep-Alive</header> header field to an upstream server,
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	375 though this is not recommended.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	376 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	377 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	378
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	379 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	380 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	381 <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	382 for keepalive connections to work:
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	383 <example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	384 upstream fastcgi_backend {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	385 server 127.0.0.1:9000;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	386
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	387 keepalive 8;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	388 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	389
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	390 server {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	391 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	392
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	393 location /fastcgi/ {
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	394 fastcgi_pass fastcgi_backend;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	395 fastcgi_keep_conn on;
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	396 ...
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	397 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	398 }
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	399 </example>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	400 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	401
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	402 <para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	403 <note>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	404 When using load balancer methods other than the default
316 1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	405 round-robin, it is necessary to activate them before
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	406 the <literal>keepalive</literal> directive.
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	407 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	408
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	409 <note>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	410 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	411 </note>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	412 </para>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	413
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	414 </directive>
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	415
1fb1c077658b Documented the following directives: "keepalive", "proxy_http_version", Ruslan Ermilov <ru@nginx.com> parents: 293 diff changeset	416
526 4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	417 <directive name="least_conn">
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	418 <syntax/>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	419 <default/>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	420 <context>upstream</context>
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	421 <appeared-in>1.3.1</appeared-in>
566 f8148fc88224 Documented 1.2.2 changes. Ruslan Ermilov <ru@nginx.com> parents: 542 diff changeset	422 <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	423
4f907cde0382 1.3.1 changes: ip_hash+weight, least_conn. Ruslan Ermilov <ru@nginx.com> parents: 316 diff changeset	424 <para>
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	425 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	426 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	427 taking into account weights of servers.
533 fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	428 If there are several such servers, they are tried using a
fb630c3c5039 Revamped the upstream documentation somewhat. Ruslan Ermilov <ru@nginx.com> parents: 526 diff changeset	429 weighted round-robin balancing method.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432 </directive>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	434
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	435 <directive name="health_check">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	436 <syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	437 [<literal>interval=</literal><value>time</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	438 <!--
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	439 [<literal>jitter=</literal><value>time</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	440 -->
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	441 [<literal>fails=</literal><value>number</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	442 [<literal>passes=</literal><value>number</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	443 [<literal>uri=</literal><value>uri</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	444 [<literal>match=</literal><value>name</value>]</syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	445
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	446 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	447 <context>location</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	448
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	449 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	450 Enables periodic health checks of the servers in a
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	451 <link id="upstream">group</link> referenced in the surrounding location.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	452 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	453
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	454 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	455 The following optional parameters are supported:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	456 <list type="bullet">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	457
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	458 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	459 <literal>interval</literal>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	460 sets the interval between two consecutive health checks,
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	461 by default, 5 seconds;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	462 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	463
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	464 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	465 <literal>fails</literal>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	466 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	467 after which this server will be considered unhealthy,
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	468 by default, 1;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	469 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	470
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	471 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	472 <literal>passes</literal>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	473 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	474 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	475 by default, 1;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	476 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	477
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	478 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	479 <literal>uri</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	480 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	481 by default, “<literal>/</literal>”;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	482 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	483
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	484 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	485 <literal>match</literal>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	486 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	487 response should pass in order for a health check to pass;
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	488 by default, the response should have status code 2xx or 3xx.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	489 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	490
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	491 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	492 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	493
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	494 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	495 For example,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	496 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	497 location / {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	498 proxy_pass http://backend;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	499 health_check;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	500 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	501 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	502 will send “<literal>/</literal>” requests to each
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	503 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	504 If any communication error or timeout occurs, or a
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	505 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	506 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	507 be considered unhealthy.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	508 Client requests are not passed to unhealthy servers.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	509 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	510
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	511 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	512 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	513 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	514 and the body contents.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	515 Tests are configured separately using the <link id="match"/> directive
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	516 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	517 For example:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	518 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	519 http {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	520 server {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	521 ...
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	522 location / {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	523 proxy_pass http://backend;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	524 health_check match=welcome;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	525 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	526 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	527
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	528 match welcome {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	529 status 200;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	530 header Content-Type = text/html;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	531 body ~ "Welcome to nginx!";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	532 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	533 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	534 </example>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	535 This configuration tells that for a health check to pass, the response to a
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	536 health check request should succeed,
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	537 have status 200, content type “<literal>text/html</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	538 and contain “<literal>Welcome to nginx!</literal>” in the body.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	539 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	540
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	541 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	542 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	543 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	544
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	545 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	546 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	547 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	548 considered unhealthy.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	549 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	550
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	551 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	552 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	553 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	554 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	555 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	556
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	557 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	558
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	559
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	560 <directive name="match">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	561 <syntax block="yes"><value>name</value></syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	562 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	563 <context>http</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	564
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	565 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	566 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	567 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	568
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	569 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	570 The following items can be tested in a response:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	571 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	572
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	573 <tag-name><literal>status 200;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	574 <tag-desc>status is 200</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	575
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	576 <tag-name><literal>status ! 500;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	577 <tag-desc>status is not 500</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	578
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	579 <tag-name><literal>status 200 204;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	580 <tag-desc>status is 200 or 204</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	581
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	582 <tag-name><literal>status ! 301 302;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	583 <tag-desc>status is neither 301 nor 302</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	584
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	585 <tag-name><literal>status 200-399;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	586 <tag-desc>status is in the 200..399 range</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	587
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	588 <tag-name><literal>status ! 400-599;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	589 <tag-desc>status is not in the 400..599 range</tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	590
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	591 <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	592 <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	593
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	594 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	595
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	596 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	597
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	598 <tag-name><literal>header Content-Type = text/html;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	599 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	600 header contains <header>Content-Type</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	601 with value <literal>text/html</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	602 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	603
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	604 <tag-name><literal>header Content-Type != text/html;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	605 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	606 header contains <header>Content-Type</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	607 with value other than <literal>text/html</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	608 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	609
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	610 <tag-name><literal>header Connection ~ close;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	611 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	612 header contains <header>Connection</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	613 with value matching regular expression <literal>close</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	614 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	615
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	616 <tag-name><literal>header Connection !~ close;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	617 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	618 header contains <header>Connection</header>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	619 with value not matching regular expression <literal>close</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	620 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	621
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	622 <tag-name><literal>header Host;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	623 <tag-desc>header contains <header>Host</header></tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	624
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	625 <tag-name><literal>header ! X-Accel-Redirect;</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	626 <tag-desc>header lacks <header>X-Accel-Redirect</header></tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	627
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	628 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	629
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	630 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	631
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	632 <tag-name><literal>body ~ "Welcome to nginx!";</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	633 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	634 body matches regular expression “<literal>Welcome to nginx!</literal>”
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	635 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	636
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	637 <tag-name><literal>body !~ "Welcome to nginx!";</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	638 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	639 body does not match regular expression “<literal>Welcome to nginx!</literal>”
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	640 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	641
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	642 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	643 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	644
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	645 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	646 If several tests are specified,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	647 the response matches only if it matches all tests.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	648 <note>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	649 Only the first 256k of the response body are examined.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	650 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	651 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	652
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	653 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	654 Examples:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	655 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	656 # status is 200, content type is "text/html",
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	657 # and body contains "Welcome to nginx!"
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	658 match welcome {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	659 status 200;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	660 header Content-Type = text/html;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	661 body ~ "Welcome to nginx!";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	662 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	663 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	664
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	665 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	666 # 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	667 match not_redirect {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	668 status ! 301-303 307;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	669 header ! Refresh;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	670 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	671 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	672
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	673 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	674 # status ok and not in maintenance mode
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	675 match server_ok {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	676 status 200-399;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	677 body !~ "maintenance mode";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	678 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	679 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	680
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	681 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	682
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	683 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	684 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	685 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	686 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	687 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	688
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	689 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	690
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	691
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	692 <directive name="sticky">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	693 <syntax/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	694 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	695 <context>upstream</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	696
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	697 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	698 Enables session affinity support.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	699 The session is an object that is used to uniquely identify and maintain the
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	700 state of a client during a given period of time.
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	701 If session affinity is enabled, requests from the same client are always passed
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	702 to the same server (in a group of servers) once a session has been created.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	703 The method that is used to create and track sessions must be specified in a
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	704 separate directive, for example, <link id="sticky_cookie_insert"/>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	705 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	706 upstream backend {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	707 server backend1.example.com;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	708 server backend2.example.com;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	709
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	710 sticky;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	711 sticky_cookie_insert "sticky";
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	712 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	713
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	714 server {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	715 location / {
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	716 proxy_pass http://backend;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	717 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	718 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	719 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	720 The directive must be specified after the <link id="ip_hash"/> or the
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	721 <link id="least_conn"/> directives.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	722 </para>
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 When the session affinity is enabled, a request is processed as follows:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	726 <list type="enum">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	727
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	728 <listitem>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	729 nginx looks up the session corresponding to the request.
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	730 If the session is found, the server identification data is extracted from it.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	731 This data is used by the server selection algorithm.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	732 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	733
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	734 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	735 The server to process the request is chosen according to the configured
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	736 balancing method, server information from the session, and the real state of
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	737 servers in a group (such as failed, up or down).
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	738 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	739
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	740 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	741 The request is passed to the chosen server for processing.
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	742 If the chosen server is not the one specified in the session
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	743 (for example, because it is down), the session is cleared
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	744 and the request is processed as if it had no session.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	745 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	746
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	747 <listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	748 The server returns the response.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	749 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	750
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	751 <listitem>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	752 If there is no session for the request, a new session
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	753 is created and the server identification data is stored in it.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	754 </listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	755
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	756 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	757 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	758
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	759 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	760 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	761 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	762 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	763 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	764
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	765 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	766
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	767
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	768 <directive name="sticky_cookie_insert">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	769 <syntax><value>name</value>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	770 [<literal>expires=</literal><value>time</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	771 [<literal>domain=</literal><value>host</value>]
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	772 [<literal>path=</literal><value>path</value>]</syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	773 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	774 <context>upstream</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	775
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	776 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	777 Enables and configures the session tracking method that is based on keeping
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	778 session information in HTTP cookies.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	779 The directive must be specified after the <link id="ip_hash"/> or the
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	780 <link id="least_conn"/> directives.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	781 Example:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	782 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	783 sticky_cookie_insert "srv_id" "expires=1h 7m" domain=example.com path=/;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	784 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	785 The first parameter sets the name of the cookie to be inserted or inspected.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	786 Additional parameters may be as follows:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	787 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	788
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	789 <tag-name><literal>expires</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	790 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	791 Sets the time for which a browser should keep the cookie.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	792 The parameter “<literal>max</literal>” sets the time to
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	793 “<literal>31 Dec 2037 23:55:55 GMT</literal>”.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	794 This is the maximum time understood by old browsers.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	795 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	796
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	797 <tag-name><literal>domain</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	798 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	799 Defines the domain for which the cookie is set.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	800 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	801
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	802 <tag-name><literal>path</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	803 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	804 Defines the path for which the cookie is set.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	805 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	806
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	807 </list>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	808 If some parameter is omitted, the corresponding cookie field is not set.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	809 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	810
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	811 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	812 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	813 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	814 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	815 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	816
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	817 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	818
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 <directive name="sticky_log_requests">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	821 <syntax><literal>debug</literal> \|
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	822 <literal>info</literal> \|
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	823 <literal>notice</literal> \|
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	824 <literal>warn</literal> \|
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	825 <literal>error</literal></syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	826 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	827 <context>upstream</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	828
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	829 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	830 Enables logging of session-related operations and sets the desired
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	831 logging level.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	832 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	833
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	834 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	835 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	836 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	837 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	838 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	839
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	840 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	841
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	842
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	843 <directive name="upstream_conf">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	844 <syntax/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	845 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	846 <context>location</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	847
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	848 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	849 Turns on the HTTP interface of upstream configuration in the surrounding
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	850 location.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	851 Access to this location should be
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	852 <link doc="ngx_http_core_module.xml" id="satisfy">limited</link>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	853 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	854
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	855 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	856 Configuration commands can be used to:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	857 <list type="bullet">
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 <listitem>view all primary or backup servers in a group;</listitem>
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 <listitem>view an individual server;</listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	862
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	863 <listitem>modify an individual server;</listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	864
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	865 <listitem>add a new server (see the note below);</listitem>
953 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 <listitem>remove an individual server.</listitem>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	868
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	869 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	870 <note>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	871 As noted in the <link id="server"/> directive, specifying a server
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	872 as a domain name may result in several servers being added to the group.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	873 Since addresses in a group are not required to be unique, individual
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	874 servers in a group can be uniquely referenced to only by their ID.
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	875 IDs are assigned automatically and shown on viewing of the group configuration.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	876 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	877 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	878
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	879 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	880 A configuration command consists of parameters passed as request arguments,
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	881 for example:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	882 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	883 http://127.0.0.1/upstream_conf?upstream=appservers
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	884 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	885 </para>
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 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	888 The following parameters are supported:
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 <list type="tag" compact="no">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	891
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	892 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	893 <literal>upstream=</literal><value>name</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	894 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	895 Selects a group.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	896 This parameter is mandatory.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	897 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	898
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	899 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	900 <literal>backup=</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	901 </tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	902 <tag-desc>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	903 If not set, selects primary servers in the group.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	904 If set, selects backup servers in the group.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	905 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	906
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	907 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	908 <literal>id=</literal><value>number</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	909 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	910 Selects an individual primary or backup server in the group.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	911 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	912
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	913 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	914 <literal>remove=</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	915 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	916 Removes an individual primary or backup server from the group.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	917 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	918
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	919 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	920 <literal>add=</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	921 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	922 Adds a new primary or backup server to the group.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	923 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	924
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	925 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	926 <literal>server=</literal><value>address</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	927 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	928 Same as the “<literal>address</literal>” parameter
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	929 of the <link id="server"/> directive.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	930 </tag-desc>
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 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	933 <literal>weight=</literal><value>number</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	934 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	935 Same as the “<literal>weight</literal>” parameter
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	936 of the <link id="server"/> directive.
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>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	940 <literal>max_fails=</literal><value>number</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	941 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	942 Same as the “<literal>max_fails</literal>” parameter
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	943 of the <link id="server"/> directive.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	944 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	945
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	946 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	947 <literal>fail_timeout=</literal><value>time</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	948 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	949 Same as the “<literal>fail_timeout</literal>” parameter
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	950 of the <link id="server"/> directive.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	951 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	952
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	953 <tag-name>
955 28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	954 <literal>slow_start=</literal><value>time</value></tag-name>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	955 <tag-desc>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	956 Same as the “<literal>slow_start</literal>” parameter
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	957 of the <link id="server"/> directive.
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	958 </tag-desc>
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	959
28d580f1eb63 Documented the "slow_start" parameter of the upstream "server" directive. Vladimir Homutov <vl@nginx.com> parents: 953 diff changeset	960 <tag-name>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	961 <literal>down=</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	962 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	963 Same as the “<literal>down</literal>” parameter
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	964 of the <link id="server"/> directive.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	965 </tag-desc>
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 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	968 <literal>up=</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	969 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	970 The opposite of the “<literal>down</literal>” parameter
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	971 of the <link id="server"/> directive.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	972 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	973
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	974 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	975
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	976 The first three parameters select a target the command applies to.
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	977 Without other parameters, the command shows configuration of the selected
488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	978 target.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	979 </para>
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 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	982 For example, to view the primary servers in the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	983 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	984 http://127.0.0.1/upstream_conf?upstream=appservers
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	985 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	986
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	987 To view the backup servers in the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	988 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	989 http://127.0.0.1/upstream_conf?upstream=appservers&backup=
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	990 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	991
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	992 To view an individual primary server in the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	993 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	994 http://127.0.0.1/upstream_conf?upstream=appservers&id=42
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	995 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	996
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	997 To view an individual backup server in the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	998 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	999 http://127.0.0.1/upstream_conf?upstream=appservers&backup=&id=42
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1000 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1001 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1002
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1003 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1004 To add a new primary or backup server to the group,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1005 specify its address in the “<literal>server=</literal>” parameter.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1006 Without other parameters specified, a server will be added with other
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1007 parameters set to their default values (see the <link id="server"/> directive).
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1008 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1009
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1010 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1011 For example, to add a new primary server to the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1012 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1013 http://127.0.0.1/upstream_conf?add=&upstream=appservers&server=127.0.0.1:8080
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1014 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1015
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1016 To add a new backup server to the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1017 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1018 http://127.0.0.1/upstream_conf?add=&upstream=appservers&backup=&server=127.0.0.1:8080
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1019 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1020
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1021 To add a new primary server to the group,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1022 set its parameters to non-default values
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1023 and mark it as “<literal>down</literal>” by sending:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1024 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1025 http://127.0.0.1/upstream_conf?add=&upstream=appservers&server=127.0.0.1:8080&weight=2&max_fails=3&fail_timeout=3s&down=
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1026 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1027 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1028
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1029 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1030 To remove an individual primary or backup server from the group,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1031 select it with the <literal>id=</literal> parameter.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1032 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1033
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1034 <para>
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1035 For example, to remove an individual primary server from the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1036 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1037 http://127.0.0.1/upstream_conf?remove=&upstream=appservers&id=42
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1038 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1039
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1040 To remove an individual backup server from the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1041 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1042 http://127.0.0.1/upstream_conf?remove=&upstream=appservers&backup=&id=42
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1043 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1044 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1045
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1046 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1047 To modify an individual primary or backup server in the group,
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1048 select it with the <literal>id=</literal> parameter.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1049 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1050
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1051 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1052 For example, to modify an individual primary server in the group
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1053 by marking it as “<literal>down</literal>”, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1054 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1055 http://127.0.0.1/upstream_conf?upstream=appservers&id=42&down=
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1056 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1057
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1058 To modify the address of an individual backup server in the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1059 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1060 http://127.0.0.1/upstream_conf?upstream=appservers&backup=&id=42&server=192.0.2.3:8123
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1061 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1062
956 488a3f738db0 Text revision of commercial modules. Egor Nikitin <yegor.nikitin@gmail.com> parents: 955 diff changeset	1063 To modify other parameters of an individual primary server in the group, send:
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1064 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1065 http://127.0.0.1/upstream_conf?upstream=appservers&id=42&max_fails=3&weight=4
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1066 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1067
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1068 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1069
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1070 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1071 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1072 This directive is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1073 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1074 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1075
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1076 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 942 diff changeset	1077
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1078 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1079
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1080
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1081 <section id="variables" name="Embedded Variables">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1082
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1083 <para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1084 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	1085 supports the following embedded variables:
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1086 <list type="tag">
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1087
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1088 <tag-name><var>$upstream_addr</var></tag-name>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1089 <tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1090 keeps an IP address and port of the server,
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1091 or a path to the UNIX-domain socket.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1092 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	1093 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	1094 “<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock</literal>”.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1095 If an internal redirect from one server group to another happened
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1096 using
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1097 <header>X-Accel-Redirect</header> or
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1098 <link doc="ngx_http_core_module.xml" id="error_page"/>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1099 then these server groups are separated by colons, e.g.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1100 “<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	1101 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1102
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1103 <tag-name><var>$upstream_cache_status</var></tag-name>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1104 <tag-desc>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1105 keeps status of accessing a response cache (0.8.3).
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1106 The status can be one of “<literal>MISS</literal>”,
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1107 “<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”,
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1108 “<literal>STALE</literal>”, “<literal>UPDATING</literal>” or
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1109 “<literal>HIT</literal>”.
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1110 </tag-desc>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1111
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1112 <tag-name><var>$upstream_response_length</var></tag-name>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1113 <tag-desc>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1114 keeps lengths of responses obtained from upstream servers (0.7.27);
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1115 lengths are kept in bytes.
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1116 Several responses are separated by commas and colons
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1117 like in the <var>$upstream_addr</var> variable.
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1118 </tag-desc>
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1119
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1120 <tag-name><var>$upstream_response_time</var></tag-name>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1121 <tag-desc>
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1122 keeps times of responses obtained from upstream servers;
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1123 times are kept in seconds with a milliseconds resolution.
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1124 Several responses are separated by commas and colons
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1125 like in the <var>$upstream_addr</var> variable.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1126 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1127
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1128 <tag-name><var>$upstream_status</var></tag-name>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1129 <tag-desc>
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1130 keeps codes of responses obtained from upstream servers.
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1131 Several responses are separated by commas and colons
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1132 like in the <var>$upstream_addr</var> variable.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1133 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1134
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1135 <tag-name><var>$upstream_http_...</var></tag-name>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1136 <tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1137 keep server response header fields.
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1138 For example, the <header>Server</header> response header field
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1139 is made available through the <var>$upstream_http_server</var> variable.
731 f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1140 The rules of converting header field names to variable names are the same
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1141 as for variables starting with the
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1142 “<link doc="ngx_http_core_module.xml" id="variables">$http_</link>” prefix.
f62328124e5b Documented $upstream_cache_status and $upstream_response_length variables. Vladimir Homutov <vl@nginx.com> parents: 654 diff changeset	1143 Only the last server’s response header fields are saved.
293 34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1144 </tag-desc>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1145
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1146 </list>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1147 </para>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1148
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1149 </section>
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1150
34246e706f48 English translation of the ngx_http_upstream_module documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1151 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_upstream_module.xml @ 956:488a3f738db0