Health Check Facility

SPOT provides a customized health check facility upon start-up of the STEP Application Server. Customized scripts can be developed to test upstream or downstream services that have a dependency on STEP. If a health check fails, the application server will fail to start up.

Scripts placed in /admin/healthcheck.d of the directory where STEP is installed are executed by SPOT before attempting to start the application server.

The health check scripts must conform to the following rules:

  • Failed checks must exit with a code >0; otherwise, the script needs to exit with a code of 0.
  • Multiple scripts will be executed in ascending order based on the script name.
  • Ensure script output is written to STDOUT as this will be captured and written during execution to /diag/logs/pre-start-toolbox.app.jar.log of the directory where STEP is installed.