Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 1925:a58b35cc0823

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 88477c5d2751
comparison
equal deleted inserted replaced
1924:237a10fb98d2 1925:a58b35cc0823
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_upstream_module" 10 <module name="Module ngx_http_upstream_module"
11 link="/en/docs/http/ngx_http_upstream_module.html" 11 link="/en/docs/http/ngx_http_upstream_module.html"
12 lang="en" 12 lang="en"
13 rev="58"> 13 rev="59">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_upstream_module</literal> module 18 The <literal>ngx_http_upstream_module</literal> module
699 699
700 </directive> 700 </directive>
701 701
702 702
703 <directive name="least_time"> 703 <directive name="least_time">
704 <syntax><literal>header</literal> | <literal>last_byte</literal></syntax> 704 <syntax>
705 <literal>header</literal> |
706 <literal>last_byte</literal>
707 [<literal>inflight</literal>]</syntax>
705 <default/> 708 <default/>
706 <context>upstream</context> 709 <context>upstream</context>
707 <appeared-in>1.7.10</appeared-in> 710 <appeared-in>1.7.10</appeared-in>
708 711
709 <para> 712 <para>
719 time to receive the 722 time to receive the
720 <link id="var_upstream_header_time">response header</link> is used. 723 <link id="var_upstream_header_time">response header</link> is used.
721 If the <literal>last_byte</literal> parameter is specified, 724 If the <literal>last_byte</literal> parameter is specified,
722 time to receive the <link id="var_upstream_response_time">full response</link> 725 time to receive the <link id="var_upstream_response_time">full response</link>
723 is used. 726 is used.
727 If the <literal>inflight</literal> parameter is specified (1.11.6),
728 incomplete requests are also taken into account.
729 <note>
730 Prior to version 1.11.6, incomplete requests were taken into account by default.
731 </note>
724 </para> 732 </para>
725 733
726 <para> 734 <para>
727 <note> 735 <note>
728 This directive is available as part of our 736 This directive is available as part of our
786 <literal>uri</literal>=<value>uri</value> 794 <literal>uri</literal>=<value>uri</value>
787 </tag-name> 795 </tag-name>
788 <tag-desc> 796 <tag-desc>
789 defines the URI used in health check requests, 797 defines the URI used in health check requests,
790 by default, “<literal>/</literal>”. 798 by default, “<literal>/</literal>”.
799 </tag-desc>
800
801 <tag-name id="health_check_mandatory">
802 <literal>mandatory</literal>
803 </tag-name>
804 <tag-desc>
805 sets the initial “checking” state for a server
806 until the first health check is completed (1.11.7).
807 If the parameter is not specified,
808 the server will be initially considered healthy.
791 </tag-desc> 809 </tag-desc>
792 810
793 <tag-name id="hc_match"> 811 <tag-name id="hc_match">
794 <literal>match</literal>=<value>name</value> 812 <literal>match</literal>=<value>name</value>
795 </tag-name> 813 </tag-name>
823 server in the <literal>backend</literal> group every five seconds. 841 server in the <literal>backend</literal> group every five seconds.
824 If any communication error or timeout occurs, or a 842 If any communication error or timeout occurs, or a
825 proxied server responds with the status code other than 843 proxied server responds with the status code other than
826 2xx or 3xx, the health check will fail, and the server will 844 2xx or 3xx, the health check will fail, and the server will
827 be considered unhealthy. 845 be considered unhealthy.
828 Client requests are not passed to unhealthy servers. 846 Client requests are not passed to unhealthy servers
847 and servers in the “checking” state.
829 </para> 848 </para>
830 849
831 <para> 850 <para>
832 Health checks can be configured to test the status code of a response, 851 Health checks can be configured to test the status code of a response,
833 presence of certain header fields and their values, 852 presence of certain header fields and their values,
1042 <para> 1061 <para>
1043 The default value of the <literal>timeout</literal> parameter is 60 seconds. 1062 The default value of the <literal>timeout</literal> parameter is 60 seconds.
1044 </para> 1063 </para>
1045 1064
1046 <para> 1065 <para>
1066 <note>
1067 When using load balancer methods other than the default
1068 round-robin method, it is necessary to activate them before
1069 the <literal>queue</literal> directive.
1070 </note>
1071
1047 <note> 1072 <note>
1048 This directive is available as part of our 1073 This directive is available as part of our
1049 <commercial_version>commercial subscription</commercial_version>. 1074 <commercial_version>commercial subscription</commercial_version>.
1050 </note> 1075 </note>
1051 </para> 1076 </para>