Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_upstream_hc_module.xml @ 2632:52500ccb82c1
Updated docs for the upcoming NGINX Plus release.
| author | Yaroslav Zhuravlev <yar@nginx.com> |
|---|---|
| date | Fri, 04 Dec 2020 13:34:05 +0000 |
| parents | d5e576eb7677 |
| children | efb3d27dfa23 |
comparison
equal
deleted
inserted
replaced
| 2631:7da360f50017 | 2632:52500ccb82c1 |
|---|---|
| 199 to perform a health check (1.9.7). | 199 to perform a health check (1.9.7). |
| 200 By default, equals the | 200 By default, equals the |
| 201 <link doc="ngx_http_upstream_module.xml" id="server"/> port. | 201 <link doc="ngx_http_upstream_module.xml" id="server"/> port. |
| 202 </tag-desc> | 202 </tag-desc> |
| 203 | 203 |
| 204 <tag-name id="health_check_grpc"> | |
| 205 <literal>type</literal>=<literal>grpc</literal> | |
| 206 [<literal>grpc_service</literal>=<value>name</value>] | |
| 207 [<literal>grpc_status</literal>=<value>code</value>] | |
| 208 </tag-name> | |
| 209 <tag-desc> | |
| 210 enables periodic | |
| 211 <link url="https://github.com/grpc/grpc/blob/master/doc/health-checking.md#grpc-health-checking-protocol">health | |
| 212 checks</link> of a gRPC server | |
| 213 or a particular gRPC service specified with the optional | |
| 214 <literal>grpc_service</literal> parameter (1.19.5). | |
| 215 If the server does not support the gRPC Health Checking Protocol, | |
| 216 the optional <literal>grpc_status</literal> parameter can be used | |
| 217 to specify non-zero gRPC | |
| 218 <link url="https://github.com/grpc/grpc/blob/master/doc/statuscodes.md#status-codes-and-their-use-in-grpc">status</link> | |
| 219 (for example, | |
| 220 status code “<literal>12</literal>” / “<literal>UNIMPLEMENTED</literal>”) | |
| 221 that will be treated as healthy: | |
| 222 <example> | |
| 223 health_check mandatory type=grpc grpc_status=12; | |
| 224 </example> | |
| 225 The <literal>type</literal>=<literal>grpc</literal> parameter | |
| 226 must be specified after all other directive parameters, | |
| 227 <literal>grpc_service</literal> and <literal>grpc_status</literal> | |
| 228 must follow <literal>type</literal>=<literal>grpc</literal>. | |
| 229 The parameter is not compatible with | |
| 230 <link id="health_check_uri"><literal>uri</literal></link> or | |
| 231 <link id="health_check_match"><literal>match</literal></link> parameters. | |
| 232 </tag-desc> | |
| 233 | |
| 204 </list> | 234 </list> |
| 205 </para> | 235 </para> |
| 206 | 236 |
| 207 </directive> | 237 </directive> |
| 208 | 238 |