Update Directory locations and properties page to include reference to /health directory. #8091
Description
Document: Directory locations and properties
http://openliberty.io/docs/latest/reference/directory-locations-properties.html
Please describe the problem you are having with the documentation. Is information missing, inaccurate, or unclear? Tell us about the context where you encountered the problem so we can understand how to address it.
Recently, a user of the file-based health checks which was a feature enhancement for mpHealth-4.0 was unable to find information regarding the location of the /health directory in the directory location page.: https://openliberty.io/docs/latest/reference/directory-locations-properties.html
We have information listed here https://openliberty.io/docs/latest/health-check-microservices.html#_microprofile_health_v4_0 but it may be useful for users to find the location through the directory location page.
For context, to enable the file-based health check when using mpHealth-4.0, the user needs to configure the checkInterval attribute.
For example:
<mpHealth checkInterval="10s" />
Upon validation that the server is capable for the read/write operations require for the file-based health check, the /health directory is created at
<server.output.dir>/health. When the server is shut down (or the feature is removed), the health directory is deleted.
For updating the documentation, we would like to add a /health directory under the the server_name section, we can add a /health directory . image for reference:
The description we can use:
When file-based health check is enabled for the
mpHealth-4.0feature, the/healthdirectory is created to contain thestarted,liveandreadyhealth check files. This directory and its contents are deleted upon server shut down or if thempHealthfeature is unloaded. For more information about file-based health checks see the file-based health check overview.