FISH-333 Add Payara HealthCheck Service checkers to MicroProfile Health Readiness Checks

[MeroRai]

Description

Added Payara HealthCheck Service Checkers to MicroProfile Health Readiness Checks. The set-healthcheck-service-configuration asadmin command has a new options add-to-microprofile-health, which can be used to add a HealthCheck Service Checkers to MicroProfile Health and display its result on the MicroProfile Health endpoint. Below is an example of what the /health/ready endpoint returns:

{
  "status": "UP",
  "checks": [
    {
      "name": "HEAP",
      "status": "UP",
      "data": {
        "Message": "heap: init: 92.00 Mb, used: 204.93 Mb, committed: 332.00 Mb, max.: 455.50 Mbheap%: 45%",
        "HealthCheckStatus": "GOOD"
      }
    },
    {
      "name": "CPU-USAGE",
      "status": "UP",
      "data": {
        "Message": "CPU%: 6.42, Time CPU used: 5 minutes 11 seconds 774 milliseconds",
        "HealthCheckStatus": "GOOD"
      }
    }
  ]
}

Testing

Testing Performed

• Build test
• MicroProfile Health TCKS (TODO)

Testing Environment

Zulu JDK 1.8_222 on Elementary OS 0.4.1 Loki with Maven 3.5.4

Documentation

https://docs.payara.fish/community/docs/5.2020.7/documentation/payara-server/health-check-service/asadmin-commands.html#set-healthcheck-service-configuration

[jbee]

I think the way the bridge or adaptor between Payara and MP health checks is done needs to change. Configuration changes to the newly introduced flag should register or un-register the adaptor in MP health so that the checks can be processed as before without the servlet knowing about any special extra thing that needs to be done.

[jbee]

I think using the events is a good solution to link the two health check systems.

Only important comment is the one about NPE, I am pretty sure I have encountered NPEs in the past because options were null at some point before the whole thing is tuned on. So have a look again. Might no longer be the case or apply but in general I'd think the issue should be the same in isEnabled.

Otherwise just some comments for consideration.

[jbee]

Susan an I discussed the wording and he will clarify that the flag refers to MicroProfile. No further comments.

[MeroRai]

Jenkins test please

[MeroRai]

Jenkins test please