Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_upstream_module.xml @ 1891:6225d50b3cba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Replaced semicolon with dot in health_check.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 18 Jan 2017 15:35:43 +0300
parents 6f2c5a36b4d1
children a58b35cc0823
comparison
equal deleted inserted replaced
1890:82ef6dd12534 1891:6225d50b3cba
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_upstream_module" 9 <module name="Module ngx_stream_upstream_module"
10 link="/en/docs/stream/ngx_stream_upstream_module.html" 10 link="/en/docs/stream/ngx_stream_upstream_module.html"
11 lang="en" 11 lang="en"
12 rev="22"> 12 rev="23">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_upstream_module</literal> module (1.9.0) 17 The <literal>ngx_stream_upstream_module</literal> module (1.9.0)
501 <tag-name id="interval"> 501 <tag-name id="interval">
502 <literal>interval</literal>=<value>time</value> 502 <literal>interval</literal>=<value>time</value>
503 </tag-name> 503 </tag-name>
504 <tag-desc> 504 <tag-desc>
505 sets the interval between two consecutive health checks, 505 sets the interval between two consecutive health checks,
506 by default, 5 seconds; 506 by default, 5 seconds.
507 </tag-desc> 507 </tag-desc>
508 508
509 <tag-name id="health_check_jitter"> 509 <tag-name id="health_check_jitter">
510 <literal>jitter</literal>=<value>time</value> 510 <literal>jitter</literal>=<value>time</value>
511 </tag-name> 511 </tag-name>
512 <tag-desc> 512 <tag-desc>
513 sets the time within which 513 sets the time within which
514 each health check will be randomly delayed, 514 each health check will be randomly delayed,
515 by default, there is no delay; 515 by default, there is no delay.
516 </tag-desc> 516 </tag-desc>
517 517
518 <tag-name id="fails"> 518 <tag-name id="fails">
519 <literal>fails</literal>=<value>number</value> 519 <literal>fails</literal>=<value>number</value>
520 </tag-name> 520 </tag-name>
521 <tag-desc> 521 <tag-desc>
522 sets the number of consecutive failed health checks of a particular server 522 sets the number of consecutive failed health checks of a particular server
523 after which this server will be considered unhealthy, 523 after which this server will be considered unhealthy,
524 by default, 1; 524 by default, 1.
525 </tag-desc> 525 </tag-desc>
526 526
527 <tag-name id="passes"> 527 <tag-name id="passes">
528 <literal>passes</literal>=<value>number</value> 528 <literal>passes</literal>=<value>number</value>
529 </tag-name> 529 </tag-name>
530 <tag-desc> 530 <tag-desc>
531 sets the number of consecutive passed health checks of a particular server 531 sets the number of consecutive passed health checks of a particular server
532 after which the server will be considered healthy, 532 after which the server will be considered healthy,
533 by default, 1; 533 by default, 1.
534 </tag-desc> 534 </tag-desc>
535 535
536 <tag-name id="hc_match"> 536 <tag-name id="hc_match">
537 <literal>match</literal>=<value>name</value> 537 <literal>match</literal>=<value>name</value>
538 </tag-name> 538 </tag-name>
539 <tag-desc> 539 <tag-desc>
540 specifies the <literal>match</literal> block configuring the tests that a 540 specifies the <literal>match</literal> block configuring the tests that a
541 successful connection should pass in order for a health check to pass. 541 successful connection should pass in order for a health check to pass.
542 By default, 542 By default,
543 only the ability to establish a TCP connection with the server is checked; 543 only the ability to establish a TCP connection with the server is checked.
544 </tag-desc> 544 </tag-desc>
545 545
546 <tag-name id="health_check_port"> 546 <tag-name id="health_check_port">
547 <literal>port</literal>=<value>number</value> 547 <literal>port</literal>=<value>number</value>
548 </tag-name> 548 </tag-name>
549 <tag-desc> 549 <tag-desc>
550 defines the port used when connecting to a server 550 defines the port used when connecting to a server
551 to perform a health check (1.9.7); 551 to perform a health check (1.9.7).
552 by default, equals the <link id="server"/> port; 552 By default, equals the <link id="server"/> port.
553 </tag-desc> 553 </tag-desc>
554 554
555 <tag-name id="health_check_udp"> 555 <tag-name id="health_check_udp">
556 <literal>udp</literal> 556 <literal>udp</literal>
557 </tag-name> 557 </tag-name>