diff options
| author | Joshua Harlow <harlowja@gmail.com> | 2016-08-23 23:41:00 -0700 |
|---|---|---|
| committer | Joshua Harlow <harlowja@gmail.com> | 2016-08-23 23:41:58 -0700 |
| commit | e782ca67a1c8c558f13de4a80c0f25c8d5a89bdb (patch) | |
| tree | 9baeffa77d132fc0c40238c97047c7876ed1bd6f /oslo_middleware | |
| parent | c29637eb799b27e0f0998561fbcb25b75071c3da (diff) | |
| download | oslo-middleware-e782ca67a1c8c558f13de4a80c0f25c8d5a89bdb.tar.gz | |
Show more healthcheck examples
Change-Id: I164b192f85ee9232a92ad7a5e99a3af647813dc8
Diffstat (limited to 'oslo_middleware')
| -rw-r--r-- | oslo_middleware/healthcheck/__init__.py | 203 |
1 files changed, 178 insertions, 25 deletions
diff --git a/oslo_middleware/healthcheck/__init__.py b/oslo_middleware/healthcheck/__init__.py index 62dd02e..ce2b03a 100644 --- a/oslo_middleware/healthcheck/__init__.py +++ b/oslo_middleware/healthcheck/__init__.py @@ -52,32 +52,187 @@ def _expand_template(contents, params): class Healthcheck(base.ConfigurableMiddleware): """Healthcheck middleware used for monitoring. - If the path is /healthcheck, it will respond 200 with "OK" as the body. - Or 503 with the reason as the body if one of the backend report - an application issue. + If the path is ``/healthcheck``, it will respond 200 with "OK" as + the body. Or a 503 with the reason as the body if one of the backends + reports an application issue. This is useful for the following reasons: - 1. Load balancers can 'ping' this url to determine service availability. - 2. Provides an endpoint that is similar to 'mod_status' in apache which - can provide details (or no details, depending on if configured) about - the activity of the server. - - Example requests/responses: - - $ curl -i -X HEAD "http://0.0.0.0:8775/healthcheck" - HTTP/1.1 204 No Content - Content-Type: text/plain; charset=UTF-8 - Content-Length: 0 - Date: Fri, 11 Sep 2015 18:55:08 GMT - - $ curl -i "http://0.0.0.0:8775/healthcheck" - HTTP/1.1 200 OK - Content-Type: text/plain; charset=UTF-8 - Content-Length: 2 - Date: Fri, 11 Sep 2015 18:55:43 GMT - - OK + * Load balancers can 'ping' this url to determine service availability. + * Provides an endpoint that is similar to 'mod_status' in apache which + can provide details (or no details, depending on if configured) about + the activity of the server. + * *(and more)* + + Example requests/responses (**not** detailed mode):: + + $ curl -i -X HEAD "http://0.0.0.0:8775/healthcheck" + HTTP/1.1 204 No Content + Content-Type: text/plain; charset=UTF-8 + Content-Length: 0 + Date: Fri, 11 Sep 2015 18:55:08 GMT + + $ curl -i -X GET "http://0.0.0.0:8775/healthcheck" + HTTP/1.1 200 OK + Content-Type: text/plain; charset=UTF-8 + Content-Length: 2 + Date: Fri, 11 Sep 2015 18:55:43 GMT + + OK + + $ curl -X GET -i -H "Accept: application/json" "http://0.0.0.0:8775/healthcheck" + HTTP/1.0 200 OK + Date: Wed, 24 Aug 2016 06:09:58 GMT + Content-Type: application/json + Content-Length: 63 + + { + "detailed": false, + "reasons": [ + "OK" + ] + } + + $ curl -X GET -i -H "Accept: text/html" "http://0.0.0.0:8775/healthcheck" + HTTP/1.0 200 OK + Date: Wed, 24 Aug 2016 06:10:42 GMT + Content-Type: text/html; charset=UTF-8 + Content-Length: 239 + + <HTML> + <HEAD><TITLE>Healthcheck Status</TITLE></HEAD> + <BODY> + + <H2>Result of 1 checks:</H2> + <TABLE bgcolor="#ffffff" border="1"> + <TBODY> + <TR> + + <TH> + Reason + </TH> + </TR> + <TR> + <TD>OK</TD> + </TR> + </TBODY> + </TABLE> + <HR></HR> + + </BODY> + + Example requests/responses (**detailed** mode):: + + $ curl -X GET -i -H "Accept: application/json" "http://0.0.0.0:8775/healthcheck" + HTTP/1.0 200 OK + Date: Wed, 24 Aug 2016 06:11:59 GMT + Content-Type: application/json + Content-Length: 3480 + + { + "detailed": true, + "gc": { + "counts": [ + 293, + 10, + 5 + ], + "threshold": [ + 700, + 10, + 10 + ] + }, + "greenthreads": [ + ... + ], + "now": "2016-08-24 06:11:59.419267", + "platform": "Linux-4.2.0-27-generic-x86_64-with-Ubuntu-14.04-trusty", + "python_version": "2.7.6 (default, Jun 22 2015, 17:58:13) \\n[GCC 4.8.2]", + "reasons": [ + { + "class": "HealthcheckResult", + "details": "Path '/tmp/dead' was not found", + "reason": "OK" + } + ], + "threads": [ + ... + ] + } + + $ curl -X GET -i -H "Accept: text/html" "http://0.0.0.0:8775/healthcheck" + HTTP/1.0 200 OK + Date: Wed, 24 Aug 2016 06:36:07 GMT + Content-Type: text/html; charset=UTF-8 + Content-Length: 6838 + + <HTML> + <HEAD><TITLE>Healthcheck Status</TITLE></HEAD> + <BODY> + <H1>Server status</H1> + <B>Server hostname:</B><PRE>...</PRE> + <B>Current time:</B><PRE>2016-08-24 06:36:07.302559</PRE> + <B>Python version:</B><PRE>2.7.6 (default, Jun 22 2015, 17:58:13) + [GCC 4.8.2]</PRE> + <B>Platform:</B><PRE>Linux-4.2.0-27-generic-x86_64-with-Ubuntu-14.04-trusty</PRE> + <HR></HR> + <H2>Garbage collector:</H2> + <B>Counts:</B><PRE>(77, 1, 6)</PRE> + <B>Thresholds:</B><PRE>(700, 10, 10)</PRE> + + <HR></HR> + <H2>Result of 1 checks:</H2> + <TABLE bgcolor="#ffffff" border="1"> + <TBODY> + <TR> + <TH> + Kind + </TH> + <TH> + Reason + </TH> + <TH> + Details + </TH> + + </TR> + <TR> + <TD>HealthcheckResult</TD> + <TD>OK</TD> + <TD>Path '/tmp/dead' was not found</TD> + </TR> + </TBODY> + </TABLE> + <HR></HR> + <H2>1 greenthread(s) active:</H2> + <TABLE bgcolor="#ffffff" border="1"> + <TBODY> + <TR> + <TD><PRE> File "oslo_middleware/healthcheck/__main__.py", line 94, in <module> + main() + File "oslo_middleware/healthcheck/__main__.py", line 90, in main + server.serve_forever() + ... + </PRE></TD> + </TR> + </TBODY> + </TABLE> + <HR></HR> + <H2>1 thread(s) active:</H2> + <TABLE bgcolor="#ffffff" border="1"> + <TBODY> + <TR> + <TD><PRE> File "oslo_middleware/healthcheck/__main__.py", line 94, in <module> + main() + File "oslo_middleware/healthcheck/__main__.py", line 90, in main + server.serve_forever() + .... + </TR> + </TBODY> + </TABLE> + </BODY> + </HTML> Example of paste configuration: @@ -92,7 +247,6 @@ class Healthcheck(base.ConfigurableMiddleware): [pipeline:public_api] pipeline = healthcheck sizelimit [...] public_service - Multiple filter sections can be defined if it desired to have pipelines with different healthcheck configuration, example: @@ -118,7 +272,6 @@ class Healthcheck(base.ConfigurableMiddleware): More details on available backends and their configuration can be found on this page: :doc:`healthcheck_plugins`. - """ NAMESPACE = "oslo.middleware.healthcheck" |