Integration Server 10.11 | Microservices Runtime Guide | Prometheus Metrics | Prometheus Labels
 
Prometheus Labels
Prometheus metrics can contain labels which can be used with a metric to differentiate metrics returned by the metrics endpoint from each other. For example the label service="createCustomer" used with the metric sag_is_service_requests_total indicates that the metric describes the total number of requests made in the last polling interval for the service createCustomer. Whereas the label service="updateCustomer" used with the same metric indicates the total number of requests made in the last polling interval for the service updateCustomer.
The following table identifies the Prometheus labels that may be associated with a Prometheus metric returned by the metrics endpoint.
Prometheus Label
Description
apiCat
API Category for a service invocation.
*API_GRAPHQL
*API_ODATA
*API_REST
*API_SOAP
*API_WEBSOCKET (Outbound service calls to a remote WebSocket listener only.)
code
An integer value associated with the metric. The code relates to the type of service that is executing. For example, a service that receives an HTTP response will have an HTTP status code.
execStat
The execution state of the service. The execStat can be one of the following values:
*Y for service success.
*N for service failure.
*U for unknown which indicates the service had not yet executed completion at the time the metrics were gathered.
host.
Host name of theMicroservices Runtime in the format: <hostname|ipaddress> .
name
Name associate with the metric. The name value varies and depends on the data in the metric. For example, if the metric is for a service, the name might be the service name. If the metric is for a memory-related metric, the name might be the memory pool name.
origin
Origin for the service invocation. The type of origin information will vary per apiCat. For example for a service invocation for an API_REST call, the origin is the REST resource endpoint. For an API_SOAP call, the origin is a service endpoint.
poolType
Type of memory pool as returned by java.lang.management.MemoryPoolMXBean.getType. The type name varies depending on the JDK implementation.
service
Fully qualified name of a service.