Invoking the Metrics Endpoint
To instruct Microservices Runtime to gather metrics, you invoke the metrics endpoint on the Microservices Runtime. The request URL would be:
http://<hostname>:<port>/metrics
Where <hostname> is the IP address or name of the machine and <port> is the port number where Microservices Runtime is running.
Invocation of the metrics endpoint is restricted to users with Administrator access.
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
metrics 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_METRICS_ENDPOINT_ACL to set the ACL whose members can invoke the
metrics 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 metrics endpoint is a predefined URL alias named “metrics” for the internal service that gathers statistics. Software AG does not recommend editing the predefined “metrics” 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 “metrics”, Microservices Runtime does not create a metrics URL alias that points to the internal service. Any invocations of the metrics endpoint will not result in the gathering and return of metrics. If you want to use the metrics gathering functionality, you need to rename your existing metrics URL alias name. Upon restart, Microservices Runtime creates a new metrics URL alias that corresponds to the metrics endpoint.