Mercurial > hg > nginx-site
diff xml/en/docs/stream/ngx_stream_upstream_module.xml @ 1925:a58b35cc0823
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 08 Mar 2017 18:05:46 +0300 |
parents | 6225d50b3cba |
children | 6b6d0e844bf7 |
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_upstream_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Module ngx_stream_upstream_module" link="/en/docs/stream/ngx_stream_upstream_module.html" lang="en" - rev="23"> + rev="24"> <section id="summary"> @@ -451,9 +451,11 @@ <directive name="least_time"> -<syntax><literal>connect</literal> | - <literal>first_byte</literal> | - <literal>last_byte</literal></syntax> +<syntax> + <literal>connect</literal> | + <literal>first_byte</literal> | + <literal>last_byte</literal> + [<literal>inflight</literal>]</syntax> <default/> <context>upstream</context> @@ -472,6 +474,12 @@ time to receive the first byte of data is used. If the <literal>last_byte</literal> is specified, time to receive the last byte of data is used. +If the <literal>inflight</literal> parameter is specified (1.11.6), +incomplete connections are also taken into account. +<note> +Prior to version 1.11.6, +incomplete connections were taken into account by default. +</note> </para> <para> @@ -533,14 +541,33 @@ by default, 1. </tag-desc> +<tag-name id="health_check_mandatory"> +<literal>mandatory</literal> +</tag-name> +<tag-desc> +sets the initial “checking” state for a server +until the first health check is completed (1.11.7). +If the parameter is not specified, +the server will be initially considered healthy. +</tag-desc> + <tag-name id="hc_match"> <literal>match</literal>=<value>name</value> </tag-name> <tag-desc> specifies the <literal>match</literal> block configuring the tests that a successful connection should pass in order for a health check to pass. -By default, -only the ability to establish a TCP connection with the server is checked. +By default, for TCP, only the ability +to establish a TCP connection with the server is checked. +For <link id="health_check_udp">UDP</link>, the absence of +ICMP “<literal>Destination Unreachable</literal>” message is expected +in reply to the sent string “<literal>nginx health check</literal>”. +<note> +Prior to version 1.11.7, by default, UDP health check +required a <link id="hc_match">match</link> block with the +<link id="match_send">send</link> and <link id="match_expect">expect</link> +parameters. +</note> </tag-desc> <tag-name id="health_check_port"> @@ -557,10 +584,7 @@ </tag-name> <tag-desc> specifies that the <literal>UDP</literal> protocol should be used for -health checks instead of the default <literal>TCP</literal> protocol (1.9.13); -requires a <link id="hc_match">match</link> block with the -<link id="match_send">send</link> and <link id="match_expect">expect</link> -parameters. +health checks instead of the default <literal>TCP</literal> protocol (1.9.13). </tag-desc> </list> @@ -579,7 +603,8 @@ When a connection to the server cannot be established, the health check will fail, and the server will be considered unhealthy. -Client connections are not passed to unhealthy servers. +Client connections are not passed to unhealthy servers +and servers in the “checking” state. </para> <para>