How to enable Tanzu Observability Proxy Health Checks

 

This article applies to:

Onboarding/Data Ingestion/Proxy/Integration

Feature Category: Ingestion 

 

Overview:

The ability to have proactive system performance and reliability begins with regular health checks to applications. Ensuring applications are up, healthy and ready to process incoming requests.  A health check provides insight and enables the operator to identify if there is an issue and if corrective action may required.  

 

Prerequisites:

  • Tanzu Observability Proxy 9.x

Note: Please refer to the documentation on upgrading the Wavefront Proxy if using other versions

 

Enable Health Checks:

To utilize this feature for the proxy endpoint health checks we need to edit the configuration file for the proxy. When enabling and configuring the proxy we can use the additional feature to validate the proxies availability to a load balancer pool for availability or for kubernetes to validate if a proxy restart is required.

 

Update wavefront.conf:

In the default wavefront.conf, there is a section for Managed HealthCheck Endpoint.  We've pasted an example below that enables the health check status to be returned for http://<<host>>:8880/status.  Since the httpHealthCheckPassStatusCode is configured, a return code '200' if healthy and '503' if it fails.

########################################### MANAGED HEALTHCHECK ENDPOINT ###############################################
## Comma-delimited list of ports to function as standalone healthchecks. May be used independently of
## httpHealthCheckAllPorts parameter. Default: none
httpHealthCheckPorts=8880
## When true, all listeners that support HTTP protocol also respond to healthcheck requests. May be
## used independently of httpHealthCheckPorts parameter. Default: false
httpHealthCheckAllPorts=true
## Healthcheck's path, for example, '/health'. Default: '/'
httpHealthCheckPath=/status
## Optional Content-Type to use in healthcheck response, for example, 'application/json'. Default: none
httpHealthCheckResponseContentType=text/plain
## HTTP status code for 'pass' health checks. Default: 200
httpHealthCheckPassStatusCode=200
## Optional response body to return with 'pass' health checks. Default: none
httpHealthCheckPassResponseBody=good to go!
## HTTP status code for 'fail' health checks. Default: 503
httpHealthCheckFailStatusCode=503
## Optional response body to return with 'fail' health checks. Default: none
httpHealthCheckFailResponseBody=try again later...
## Enables admin port to control healthcheck status per port. Default: none
adminApiListenerPort=8888
## Remote IPs must match this regex to access admin API
adminApiRemoteIpAllowRegex=^.*$

Example Test Output:

mceclip0.png

See also:

Wavefront Proxy Configuration

Proxy Github Repo

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk