11About
22===== 
3- ` nginx_http_upstream_check_module `  - support upstream servers health check with Nginx .
3+ ` nginx_http_upstream_check_module `  - support upstream servers health check with NGINX .
44This module has a custom json format to better fit the kibana beats.
55
66Synopsis
@@ -51,28 +51,26 @@ Add the health check for the upstream servers.
5151
5252The parameters' meanings are:
5353*  ` interval ` : the check request's interval time.
54- *  ` fall ` (fall_count): After fall_count check failures, the server is marked down.
55- *  ` rise ` (rise_count): After rise_count check success, the server is marked up.
54+ *  ` fall ` (` fall_count ` ): After fall_count check failures, the server is marked down.
55+ *  ` rise ` (` rise_count ` ): After rise_count check success, the server is marked up.
5656*  ` timeout ` : the check request's timeout.
5757*  ` default_down ` : set initial state of backend server, default is down.
5858*  ` port ` : specify the check port in the backend servers.
5959  It can be different with the original servers port.
6060  Default the port is 0 and it means the same as the original backend server.
6161*  ` type ` : the check protocol type:
62-     1 .  ` tcp `  is a simple tcp socket connect and peek one byte.
63-     2 .  ` ssl_hello `  sends a client ssl hello packet and receives the
64-        server ssl hello packet.
65-     3 .  ` http `  sends a http request packet, receives and parses the http
66-        response to diagnose if the upstream server is alive.
67-     4 .  ` https `  establishes a https connection and sends a http request
68-        packet, receives and parses the http response to diagnose if the
69-        upstream server is alive.
70-     5 .  ` mysql `  connects to the mysql server, receives the greeting
71-        response to diagnose if the upstream server is alive.
72-     6 .  ` ajp `  sends a AJP Cping packet, receives and parses the AJP
73-        Cpong response to diagnose if the upstream server is alive.
74-     7 .  ` fastcgi `  send a fastcgi request, receives and parses the
75-        fastcgi response to diagnose if the upstream server is alive.
62+   -  ` tcp `  is a simple TCP connector for connecting and viewing a single byte.
63+   -  ` http `  sends an http request packet, receives and analyzes the HTTP
64+     response packet for diagnostics if the upstream server is alive.
65+   -  ` https `  establishes a https connection and sends an http request packet,
66+     receives and analyzes the http response to diagnose if the previous server is alive.
67+   -  ` ssl_hello `  sends the ` SSL Hello `  packet to the client and receives the ` SSL Hello `  server packet.
68+   -  ` mysql `  connects to the MySQL server, receives a greeting response
69+     to diagnose whether the previous upstream server is working.
70+   -  ` ajp `  sends an AJP Cping packet, receives and analyzes the AJP Cpong
71+     response to diagnose if the previous server is working.
72+   -  ` fastcgi `  sends a FastCGI request, receives and analyzes
73+     the FastCGI response to diagnose the upstream server is working.
7674
7775
7876check_http_send
@@ -272,12 +270,12 @@ like this:
272270    $ make 
273271    $ make install 
274272
275- Note that, the nginx-sticky-module also needs the original check.patch.
273+ Note that, the nginx-sticky-module also needs the original ` check* .patch ` .
276274
277275Compatibility
278276============= 
279-      *    The module version 0.1.5 should be compatibility with 0.7.67+
280-      *    The module version 0.1.8 should be compatibility with Nginx-1.0.14+
277+ *  The module version 0.1.5 should be compatibility with 0.7.67+
278+ *  The module version 0.1.8 should be compatibility with Nginx-1.0.14+
281279
282280Notes
283281===== 
@@ -291,20 +289,19 @@ Known Issues
291289============ 
292290
293291
294- Changelogs
292+ [ Changelogs] ( /CHANGELOG.md ) 
295293========== 
296-   v0.3
297-     * Support keepalive check requests
298-     * FastCGI check requests
299-     * JSON/CSV check status page support
300-   v0.1
301-     * First release
302- 
303- Authors
294+ 
295+ Authors and Contributors
304296======= 
297+ The following individuals authored the bulk of this module:
298+ 
305299*  Weibin Yao(姚伟斌) * yaoweibin at gmail dot com* 
306300*  Matthieu Tourne
307301
302+ A list of all the individuals who have contributed can be found by visiting the
303+ [ contributors page] ( https://github.com/nginx-modules/nginx_upstream_check_module/graphs/contributors ) .
304+ 
308305Copyright & License
309306=================== 
310307
0 commit comments