Invoking the Health Gauge
You can invoke the health gauge via the health endpoint on the Microservices Runtime. When Microservices Runtime runs in a Docker container, you can use the health endpoint to monitor the state of the container from tools such as Kubernetes.
The request URL for the health endpoint is:
http://<hostname>:<port>/health
Where <hostname> is the IP address or name of the machine and <port> is the port number where Microservices Runtime is running.
For a
Microservices Runtime or an
Integration Server running in a Docker container that was created using the is_container.bat/sh script, the default ACL for accessing the
healths endpoint is “Anonymous”, which means authentication is not required when the endpoint is invoked. For all other
Microservices Runtimes or an
Integration Servers, the default ACL is “Administrator”, which means that authentication is required to access the endpoint. However, you can use the environment variable SAG_IS_HEALTH_ENDPOINT_ACL to set the ACL whose members can invoke the
health endpoint. For more information about environment variables, see
webMethods Integration Server Administrator’s Guide
Environment Variables Defined in
Integration Server and
Microservices Runtime .
Note:
The health endpoint is a predefined URL alias named “health” for the internal service that executes all enabled health indicators. Software AG does not recommend editing the predefined “health” URL alias. If you migrate to Microservices Runtime version 10.3 or higher from an earlier version and you already have a URL alias named “health”, Microservices Runtime does not create a health URL alias that points to the internal service. Any invocations of the health endpoint will not result in execution of health indicators. If you want to use the health gauge and the associated health indicators, you need to rename your existing health URL alias. Upon restart, Microservices Runtime creates a new health URL alias that corresponds to the health endpoint.