diff xml/en/docs/stream/ngx_stream_upstream_hc_module.xml @ 1951:f069d4b7a8df

Added udp example to stream_upstream_hc_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 24 Mar 2017 19:55:54 +0300
parents ef22a80a2696
children 9dd8c203a54a
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_upstream_hc_module.xml
+++ b/xml/en/docs/stream/ngx_stream_upstream_hc_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_upstream_hc_module"
         link="/en/docs/stream/ngx_stream_upstream_hc_module.html"
         lang="en"
-        rev="4">
+        rev="5">
 
 <section id="summary">
 
@@ -70,6 +70,29 @@ be considered unhealthy.
 </para>
 
 <para>
+Health checks can be configured for the UDP protocol:
+<example>
+upstream dns_upstream {
+
+    zone   dns_zone 64k;
+
+    server dns1.example.com:53;
+    server dns2.example.com:53;
+    server dns3.example.com:53;
+}
+
+server {
+    listen       53 udp;
+    proxy_pass   dns_upstream;
+    health_check udp;
+}
+</example>
+In this case, the absence of
+ICMP “<literal>Destination Unreachable</literal>” message is expected
+in reply to the sent string “<literal>nginx health check</literal>”.
+</para>
+
+<para>
 Health checks can also be configured to test data obtained from the server.
 Tests are configured separately using the <link id="match"/> directive
 and referenced in the <literal>match</literal> parameter